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]¶
- is_data_profiling_enabled: Optional[StrictBool]¶
- is_auto_ml_enabled: Optional[StrictBool]¶
- is_bda_extraction_enabled: Optional[StrictBool]¶
- 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]]¶
- data_category: Optional[StrictStr]¶
- data_category_config: Optional[RegisteredDatasetDataCategoryConfig]¶
- dataset_type: Optional[StrictStr]¶
- raw_description: Optional[StrictStr]¶
- ser_de: Optional[StrictStr]¶
- data_source_id: Optional[StrictStr]¶
- datasource_name: Optional[StrictStr]¶
- is_data_validation_enabled: Optional[StrictBool]¶
- is_translate_ai_results_enabled: Optional[StrictBool]¶
- assume_role: Optional[StrictStr]¶
- skip_trash: Optional[StrictStr]¶
- target_table_prep_mode: Optional[StrictStr]¶
- dataset_key_options: Optional[StrictStr]¶
- column_table_constraints: Optional[StrictStr]¶
- dynamodb_table_name: Optional[StrictStr]¶
- iceberg_table_options: Optional[RegisteredDatasetIcebergTableOptions]¶
- hudi_table_options: Optional[RegisteredDatasetHudiTableOptions]¶
- database_host: Optional[StrictStr]¶
- database_port: Optional[StrictStr]¶
- database_name: Optional[StrictStr]¶
- database_table_name: Optional[StrictStr]¶
- jdbc_connection_string: Optional[StrictStr]¶
- odbc_connection_string: Optional[StrictStr]¶
- database_view_name: Optional[StrictStr]¶
- current_version: Optional[StrictStr]¶
- sql_statement: Optional[StrictStr]¶
- view_type: Optional[StrictStr]¶
- view_versions: Optional[List[RegisteredDatasetViewVersionsInner]]¶
- 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].
- 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), 'assume_role': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='AssumeRole', alias_priority=2), 'column_table_constraints': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='ColumnTableConstraints', 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), 'current_version': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='CurrentVersion', alias_priority=2), 'data_category': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DataCategory', alias_priority=2), 'data_category_config': FieldInfo(annotation=Union[RegisteredDatasetDataCategoryConfig, NoneType], required=False, alias='DataCategoryConfig', 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_source_id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DataSourceId', alias_priority=2), 'data_stewards': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, alias='DataStewards', alias_priority=2), 'database_host': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatabaseHost', alias_priority=2), 'database_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatabaseName', alias_priority=2), 'database_port': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatabasePort', alias_priority=2), 'database_table_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatabaseTableName', alias_priority=2), 'database_view_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatabaseViewName', 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_key_options': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatasetKeyOptions', 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), 'dataset_type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatasetType', alias_priority=2), 'datasource_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatasourceName', 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), 'dynamodb_table_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DynamodbTableName', 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), 'hudi_table_options': FieldInfo(annotation=Union[RegisteredDatasetHudiTableOptions, NoneType], required=False, alias='HudiTableOptions', alias_priority=2), 'iceberg_table_options': FieldInfo(annotation=Union[RegisteredDatasetIcebergTableOptions, NoneType], required=False, alias='IcebergTableOptions', alias_priority=2), 'is_active': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='IsActive', alias_priority=2), 'is_auto_ml_enabled': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsAutoMLEnabled', alias_priority=2), 'is_bda_extraction_enabled': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsBDAExtractionEnabled', alias_priority=2), 'is_data_cleanup_enabled': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsDataCleanupEnabled', alias_priority=2), 'is_data_profiling_enabled': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsDataProfilingEnabled', alias_priority=2), 'is_data_validation_enabled': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsDataValidationEnabled', alias_priority=2), 'is_owner': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsOwner', alias_priority=2), 'is_translate_ai_results_enabled': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsTranslateAIResultsEnabled', alias_priority=2), 'jdbc_connection_string': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='JdbcConnectionString', 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), 'odbc_connection_string': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='OdbcConnectionString', alias_priority=2), 'partitioned': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Partitioned', alias_priority=2), 'raw_description': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='RawDescription', 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), 'ser_de': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='SerDe', 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), 'skip_trash': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='SkipTrash', alias_priority=2), 'sql_statement': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='SqlStatement', 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), 'target_table_prep_mode': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='TargetTablePrepMode', alias_priority=2), 'tenant_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='TenantName', alias_priority=2), 'view_type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='ViewType', alias_priority=2), 'view_versions': FieldInfo(annotation=Union[List[RegisteredDatasetViewVersionsInner], NoneType], required=False, alias='ViewVersions', 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