RegisteredDataset

class openapi_client.models.registered_dataset.RegisteredDataset(**data)[source]

Bases: BaseModel

dataset_id: Optional[StrictStr]
dataset_name: Optional[StrictStr]
display_name: Optional[StrictStr]
dataset_description: Optional[StrictStr]
data_classification: Optional[List[StrictStr]]
domain: Optional[StrictStr]
domain_display_name: Optional[StrictStr]
partitioned: Optional[StrictStr]
file_type: Optional[StrictStr]
target_location: Optional[StrictStr]
keywords: Optional[List[StrictStr]]
dataset_schema: Optional[List[ColumnNameAndType]]
table_update: Optional[StrictStr]
data_metrics_collection_options: Optional[DataMetricsCollectionOptions]
sync_to_s3_options: Optional[RegisteredDatasetSyncToS3Options]
dwh_table_name: Optional[StrictStr]
last_modified: Optional[StrictStr]
last_modified_by: Optional[StrictStr]
error_message: Optional[StrictStr]
table_update_column: Optional[StrictStr]
registration_status: Optional[StrictStr]
created_by: Optional[StrictStr]
creation_date: Optional[StrictStr]
is_active: Optional[StrictStr]
access_type: Optional[StrictStr]
is_owner: Optional[StrictBool]
file_delimiter: Optional[StrictStr]
skip_file_header: Optional[StrictBool]
connection_details: Optional[ConnectionDetails]
schedules: Optional[List[RegisteredDatasetSchedulesInner]]
dataset_report: Optional[RegisteredDatasetDatasetReport]
datasource_type: Optional[StrictStr]
is_data_cleanup_enabled: Optional[StrictBool]
malware_detection_options: Optional[MalwareDetectionOptions]
skip_lz_process: Optional[StrictBool]
tenant_name: Optional[StrictStr]
are_ai_services_enabled: Optional[StrictBool]
dataset_s3_path: Optional[StrictStr]
dataset_status: Optional[StrictStr]
s3_athena_table_name: Optional[StrictStr]
data_stewards: Optional[List[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 RegisteredDataset 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 RegisteredDataset from a dict

Return type:

Optional[Self]

model_fields: ClassVar[dict[str, FieldInfo]] = {'access_type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='AccessType', alias_priority=2), 'are_ai_services_enabled': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='AreAIServicesEnabled', alias_priority=2), 'connection_details': FieldInfo(annotation=Union[ConnectionDetails, NoneType], required=False, alias='ConnectionDetails', alias_priority=2), 'created_by': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='CreatedBy', alias_priority=2), 'creation_date': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='CreationDate', alias_priority=2), 'data_classification': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, alias='DataClassification', alias_priority=2), 'data_metrics_collection_options': FieldInfo(annotation=Union[DataMetricsCollectionOptions, NoneType], required=False, alias='DataMetricsCollectionOptions', alias_priority=2), 'data_stewards': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, alias='DataStewards', alias_priority=2), 'dataset_description': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatasetDescription', alias_priority=2), 'dataset_id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatasetId', alias_priority=2), 'dataset_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatasetName', alias_priority=2), 'dataset_report': FieldInfo(annotation=Union[RegisteredDatasetDatasetReport, NoneType], required=False, alias='DatasetReport', alias_priority=2), 'dataset_s3_path': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatasetS3Path', alias_priority=2), 'dataset_schema': FieldInfo(annotation=Union[List[ColumnNameAndType], NoneType], required=False, alias='DatasetSchema', alias_priority=2), 'dataset_status': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatasetStatus', alias_priority=2), 'datasource_type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatasourceType', alias_priority=2), 'display_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DisplayName', alias_priority=2), 'domain': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Domain', alias_priority=2), 'domain_display_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DomainDisplayName', alias_priority=2), 'dwh_table_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DWHTableName', alias_priority=2), 'error_message': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='ErrorMessage', alias_priority=2), 'file_delimiter': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='FileDelimiter', alias_priority=2), 'file_type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='FileType', alias_priority=2), 'is_active': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='IsActive', alias_priority=2), 'is_data_cleanup_enabled': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsDataCleanupEnabled', alias_priority=2), 'is_owner': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsOwner', alias_priority=2), 'keywords': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, alias='Keywords', alias_priority=2), 'last_modified': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='LastModified', alias_priority=2), 'last_modified_by': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='LastModifiedBy', alias_priority=2), 'malware_detection_options': FieldInfo(annotation=Union[MalwareDetectionOptions, NoneType], required=False, alias='MalwareDetectionOptions', alias_priority=2), 'partitioned': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Partitioned', alias_priority=2), 'registration_status': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='RegistrationStatus', alias_priority=2), 's3_athena_table_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='S3AthenaTableName', alias_priority=2), 'schedules': FieldInfo(annotation=Union[List[RegisteredDatasetSchedulesInner], NoneType], required=False, alias='Schedules', alias_priority=2), 'skip_file_header': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='SkipFileHeader', alias_priority=2), 'skip_lz_process': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='SkipLZProcess', alias_priority=2), 'sync_to_s3_options': FieldInfo(annotation=Union[RegisteredDatasetSyncToS3Options, NoneType], required=False, alias='SyncToS3Options', alias_priority=2), 'table_update': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='TableUpdate', alias_priority=2), 'table_update_column': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='TableUpdateColumn', alias_priority=2), 'target_location': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='TargetLocation', alias_priority=2), 'tenant_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='TenantName', alias_priority=2)}

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