DatasetMetadata¶

class openapi_client.models.dataset_metadata.DatasetMetadata(**data)[source]¶

Bases: BaseModel

dataset_name: StrictStr¶

display_name: Optional[StrictStr]¶

dataset_description: StrictStr¶

data_classification: Optional[List[StrictStr]]¶

domain: StrictStr¶

dataset_type: StrictStr¶

file_type: Optional[StrictStr]¶

target_location: StrictStr¶

keywords: List[StrictStr]¶

table_update: Optional[StrictStr]¶

file_delimiter: Optional[StrictStr]¶

skip_file_header: Optional[StrictBool]¶

skip_lz_process: Optional[StrictBool]¶

datasource_type: Optional[StrictStr]¶

table_name: Optional[StrictStr]¶

directory_path: Optional[StrictStr]¶

is_data_profiling_enabled: Optional[StrictBool]¶

is_data_cleanup_enabled: Optional[StrictBool]¶

malware_detection_options: Optional[MalwareDetectionOptions]¶

target_table_prep_mode: Optional[StrictStr]¶

is_data_validation_enabled: Optional[StrictBool]¶

are_ai_services_enabled: Optional[StrictBool]¶

is_translate_ai_results_enabled: Optional[StrictBool]¶

life_cycle_policy_status: Optional[StrictStr]¶

life_cycle_rules: Optional[DatasetLifeCycleRules]¶

data_metrics_collection_options: Optional[DataMetricsCollectionOptions]¶

advanced_config: Optional[AdvancedConfig]¶

datasource_id: Optional[StrictStr]¶

dataset_s3_path: Optional[StrictStr]¶

ser_de: Optional[StrictStr]¶

view_type: Optional[StrictStr]¶

sql_statement: Optional[StrictStr]¶

encoding: Optional[StrictStr]¶

assume_role: Optional[StrictStr]¶

is_delta_lake_table: Optional[StrictBool]¶

skip_trash: Optional[StrictBool]¶

auto_refresh: Optional[StrictBool]¶

data_cleanup_duration: Optional[StrictInt]¶

update_schema: Optional[StrictStr]¶

dataset_schema: Optional[List[ColumnNameAndType]]¶

skip_row_count: Optional[Dict[str, Dict[str, Any]]]¶

hudi_table_options: Optional[Dict[str, Dict[str, Any]]]¶

iceberg_table_options: Optional[Dict[str, Dict[str, Any]]]¶

precombine_key: Optional[StrictStr]¶

primary_key: Optional[StrictStr]¶

storage_type: Optional[StrictStr]¶

input_regex: Optional[StrictStr]¶

partition_keys: Optional[List[KeySchema]]¶

global_secondary_indexes: Optional[List[KeySchema]]¶

local_secondary_indexes: Optional[List[KeySchema]]¶

dist_key: Optional[StrictStr]¶

dist_type: Optional[StrictStr]¶

is_identity_needed: Optional[StrictStr]¶

sort_keys: Optional[StrictStr]¶

sort_type: Optional[StrictStr]¶

record_keys: Optional[List[StrictStr]]¶

pagination_type: Optional[StrictStr]¶

pagination_header_key: Optional[StrictStr]¶

catalog_id: Optional[StrictStr]¶

cors_dataset: Optional[StrictStr]¶

partition_key: Optional[KeySchema]¶

sort_key: Optional[KeySchema]¶

primary_keys: Optional[List[StrictStr]]¶

unique_columns: Optional[List[StrictStr]]¶

not_null_columns: Optional[List[StrictStr]]¶

dq_constraints: Optional[List[Dict[str, Any]]]¶

are_auto_constraint_suggestions_enabled: Optional[StrictBool]¶

data_conversion_params: Optional[Dict[str, Any]]¶

column_table_constraints: Optional[Dict[str, Any]]¶

dataset_key_options: Optional[Dict[str, Any]]¶

latest_record_indicator: Optional[ColumnNameAndType]¶

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 DatasetMetadata 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 DatasetMetadata from a dict

Return type:: Optional[Self]

model_fields: ClassVar[dict[str, FieldInfo]] = {'advanced_config': FieldInfo(annotation=Union[AdvancedConfig, NoneType], required=False, alias='AdvancedConfig', alias_priority=2), 'are_ai_services_enabled': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='AreAIServicesEnabled', alias_priority=2), 'are_auto_constraint_suggestions_enabled': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='AreAutoConstraintSuggestionsEnabled', alias_priority=2), 'assume_role': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='AssumeRole', alias_priority=2), 'auto_refresh': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='AutoRefresh', alias_priority=2), 'catalog_id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='CatalogId', alias_priority=2), 'column_table_constraints': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False, alias='ColumnTableConstraints', alias_priority=2), 'cors_dataset': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='CORSDataset', alias_priority=2), 'data_classification': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, alias='DataClassification', alias_priority=2), 'data_cleanup_duration': FieldInfo(annotation=Union[Annotated[int, Strict(strict=True)], NoneType], required=False, alias='DataCleanupDuration', alias_priority=2), 'data_conversion_params': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False, alias='DataConversionParams', alias_priority=2), 'data_metrics_collection_options': FieldInfo(annotation=Union[DataMetricsCollectionOptions, NoneType], required=False, alias='DataMetricsCollectionOptions', alias_priority=2), 'dataset_description': FieldInfo(annotation=str, required=True, alias='DatasetDescription', alias_priority=2, metadata=[Strict(strict=True)]), 'dataset_key_options': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False, alias='DatasetKeyOptions', alias_priority=2), 'dataset_name': FieldInfo(annotation=str, required=True, alias='DatasetName', alias_priority=2, metadata=[Strict(strict=True)]), '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_type': FieldInfo(annotation=str, required=True, alias='DatasetType', alias_priority=2, metadata=[Strict(strict=True)]), 'datasource_id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatasourceId', alias_priority=2), 'datasource_type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatasourceType', alias_priority=2), 'directory_path': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DirectoryPath', alias_priority=2), 'display_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DisplayName', alias_priority=2), 'dist_key': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DistKey', alias_priority=2), 'dist_type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DistType', alias_priority=2), 'domain': FieldInfo(annotation=str, required=True, alias='Domain', alias_priority=2, metadata=[Strict(strict=True)]), 'dq_constraints': FieldInfo(annotation=Union[List[Dict[str, Any]], NoneType], required=False, alias='DqConstraints', alias_priority=2), 'encoding': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Encoding', 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), 'global_secondary_indexes': FieldInfo(annotation=Union[List[KeySchema], NoneType], required=False, alias='GlobalSecondaryIndexes', alias_priority=2), 'hudi_table_options': FieldInfo(annotation=Union[Dict[str, Dict[str, Any]], NoneType], required=False, alias='HudiTableOptions', alias_priority=2), 'iceberg_table_options': FieldInfo(annotation=Union[Dict[str, Dict[str, Any]], NoneType], required=False, alias='IcebergTableOptions', alias_priority=2), 'input_regex': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='InputRegex', 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_delta_lake_table': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsDeltaLakeTable', alias_priority=2), 'is_identity_needed': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='IsIdentityNeeded', alias_priority=2), 'is_translate_ai_results_enabled': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsTranslateAIResultsEnabled', alias_priority=2), 'keywords': FieldInfo(annotation=List[Annotated[str, Strict(strict=True)]], required=True, alias='Keywords', alias_priority=2), 'latest_record_indicator': FieldInfo(annotation=Union[ColumnNameAndType, NoneType], required=False, alias='LatestRecordIndicator', alias_priority=2), 'life_cycle_policy_status': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='LifeCyclePolicyStatus', alias_priority=2), 'life_cycle_rules': FieldInfo(annotation=Union[DatasetLifeCycleRules, NoneType], required=False, alias='LifeCycleRules', alias_priority=2), 'local_secondary_indexes': FieldInfo(annotation=Union[List[KeySchema], NoneType], required=False, alias='LocalSecondaryIndexes', alias_priority=2), 'malware_detection_options': FieldInfo(annotation=Union[MalwareDetectionOptions, NoneType], required=False, alias='MalwareDetectionOptions', alias_priority=2), 'not_null_columns': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, alias='NotNullColumns', alias_priority=2), 'pagination_header_key': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='PaginationHeaderKey', alias_priority=2), 'pagination_type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='PaginationType', alias_priority=2), 'partition_key': FieldInfo(annotation=Union[KeySchema, NoneType], required=False, alias='PartitionKey', alias_priority=2), 'partition_keys': FieldInfo(annotation=Union[List[KeySchema], NoneType], required=False, alias='PartitionKeys', alias_priority=2), 'precombine_key': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='PrecombineKey', alias_priority=2), 'primary_key': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='PrimaryKey', alias_priority=2), 'primary_keys': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, alias='PrimaryKeys', alias_priority=2), 'record_keys': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, alias='RecordKeys', 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_row_count': FieldInfo(annotation=Union[Dict[str, Dict[str, Any]], NoneType], required=False, alias='SkipRowCount', alias_priority=2), 'skip_trash': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='SkipTrash', alias_priority=2), 'sort_key': FieldInfo(annotation=Union[KeySchema, NoneType], required=False, alias='SortKey', alias_priority=2), 'sort_keys': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='SortKeys', alias_priority=2), 'sort_type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='SortType', alias_priority=2), 'sql_statement': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='SqlStatement', alias_priority=2), 'storage_type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='StorageType', alias_priority=2), 'table_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='TableName', alias_priority=2), 'table_update': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='TableUpdate', alias_priority=2), 'target_location': FieldInfo(annotation=str, required=True, alias='TargetLocation', alias_priority=2, metadata=[Strict(strict=True)]), 'target_table_prep_mode': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='TargetTablePrepMode', alias_priority=2), 'unique_columns': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, alias='UniqueColumns', alias_priority=2), 'update_schema': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='UpdateSchema', alias_priority=2), 'view_type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='ViewType', 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