RegisteredDatasetList¶
- pydantic model openapi_client.models.registered_dataset_list.RegisteredDatasetList¶
Paginated response for GET /datasets. Pagination contract - when next_available is “yes”, more pages exist. For OpenSearch path, pass next_cursor as cursor param. For DynamoDB path, increment offset.
- Fields:
- field datasets: List[RegisteredDataset] [Required]¶
Array of dataset items matching the query. Fields in each item depend on projectionExpression.
- field next_available: Optional[StrictStr] = None¶
Whether more pages are available. “yes” means call again with incremented offset or the returned next_cursor.
- field count: Optional[StrictInt] = None¶
Number of datasets in the current page.
- field total_count: Optional[StrictInt] = None¶
Total number of datasets matching the query (DynamoDB path). On OpenSearch path this is the total hit count.
- field next_cursor: Optional[StrictStr] = None¶
Opaque Base64url-encoded cursor for the next page. Present only when listingSource=opensearch AND next_available is “yes”. Pass as the cursor query parameter in the next request.
- field listing_source: Optional[StrictStr] = None¶
Which backend served this response. Present only when the OpenSearch path was used.
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- classmethod from_json(json_str)¶
Create an instance of RegisteredDatasetList from a JSON string
- Return type:
Optional[Self]
- to_dict()¶
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)¶
Create an instance of RegisteredDatasetList from a dict
- Return type:
Optional[Self]