DatasourceDetailsDatasourceConfigPaginationConfig

class openapi_client.models.datasource_details_datasource_config_pagination_config.DatasourceDetailsDatasourceConfigPaginationConfig(**data)[source]

Bases: BaseModel

Pagination configuration. Required properties depend on PaginationType value.

data_key: Optional[StrictStr]
page_param: Optional[StrictStr]
size_param: Optional[StrictStr]
size_value: Optional[StrictInt]
limit_param: Optional[StrictStr]
offset_param: Optional[StrictStr]
limit_value: Optional[StrictInt]
cursor_param: Optional[StrictStr]
cursor_path_in_response: Optional[StrictStr]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_str()[source]

Returns the string representation of the model using alias

Return type:

str

to_json()[source]

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)[source]

Create an instance of DatasourceDetailsDatasourceConfigPaginationConfig from a JSON string

Return type:

Optional[Self]

to_dict()[source]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)[source]

Create an instance of DatasourceDetailsDatasourceConfigPaginationConfig from a dict

Return type:

Optional[Self]

model_fields: ClassVar[dict[str, FieldInfo]] = {'cursor_param': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='CursorParam', alias_priority=2, description='Parameter name for cursor (required for Cursor pagination)'), 'cursor_path_in_response': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='CursorPathInResponse', alias_priority=2, description='Path to next cursor in response (required for Cursor pagination)'), 'data_key': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DataKey', alias_priority=2, description='Key in response containing the data array (required for all pagination types)'), 'limit_param': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='LimitParam', alias_priority=2, description='Parameter name for limit (required for Offset pagination)'), 'limit_value': FieldInfo(annotation=Union[Annotated[int, Strict(strict=True)], NoneType], required=False, alias='LimitValue', alias_priority=2, description='Limit value (required for Offset pagination)'), 'offset_param': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='OffsetParam', alias_priority=2, description='Parameter name for offset (required for Offset pagination)'), 'page_param': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='PageParam', alias_priority=2, description='Parameter name for page number (required for Page pagination)'), 'size_param': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='SizeParam', alias_priority=2, description='Parameter name for page size (required for Page pagination)'), 'size_value': FieldInfo(annotation=Union[Annotated[int, Strict(strict=True)], NoneType], required=False, alias='SizeValue', alias_priority=2, description='Page size value (required for Page pagination)')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(__context)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:
  • self (BaseModel) – The BaseModel instance.

  • __context (Any) – The context.

Return type:

None