DatasourceEntityDetails

pydantic model openapi_client.models.datasource_entity_details.DatasourceEntityDetails

Request body for creating an entity or response containing entity details.

Fields:

• active_time (str | None)

• auto_termination_time (str | None)

• created_by (str | None)

• created_time (str | None)

• creation_time (str | None)

• dataflows (List[openapi_client.models.datasource_entity_details_dataflows_inner.DatasourceEntityDetailsDataflowsInner] | None)

• datasource_id (str | None)

• datasource_name (str | None)

• description (str | None)

• entity_config (openapi_client.models.datasource_entity_details_entity_config.DatasourceEntityDetailsEntityConfig | None)

• entity_id (str | None)

• entity_name (str | None)

• entity_status (str | None)

• entity_type (str | None)

• estimated_cost (str | None)

• instance_exists (bool | None)

• is_auto_terminate_enabled (bool | None)

• is_global_entity (bool | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• message (str | None)

• presigned_url (str | None)

field entity_id: Optional[StrictStr] = None (alias 'EntityId')

Entity ID. Required on Streams create from get_presigned_url. Generated by the server for JDBC create.

field entity_type: Optional[StrictStr] = None (alias 'EntityType')

Entity kind on responses: instances (JDBC Bulkload), kafka-cluster (JDBC Advanced Load), or functions (Streams). Server-set on create; not required in the create body.

field entity_name: Optional[StrictStr] = None (alias 'EntityName')

Display name of the entity.

field entity_status: Optional[StrictStr] = None (alias 'EntityStatus')

Current entity status such as creating, available, or scheduled.

field description: Optional[StrictStr] = None (alias 'Description')

Optional entity description.

field datasource_id: Optional[StrictStr] = None (alias 'DatasourceId')

Owning datasource ID.

field datasource_name: Optional[StrictStr] = None (alias 'DatasourceName')

Owning datasource name.

field creation_time: Optional[StrictStr] = None (alias 'CreationTime')

Entity creation timestamp.

field is_global_entity: Optional[StrictBool] = None (alias 'IsGlobalEntity')

Whether the entity is reusable across datasources with the same public accessibility.

field message: Optional[StrictStr] = None (alias 'Message')

Status or progress message.

field instance_exists: Optional[StrictBool] = None (alias 'InstanceExists')

JDBC Bulk Load only. Returned as false when the DMS replication instance backing the entity no longer exists, meaning the entity metadata is stale and can be deleted. Omitted when the instance is present.

field presigned_url: Optional[StrictStr] = None (alias 'PresignedUrl')

S3 upload URL. Returned on Streams entity GET for zip upload or update.

field entity_config: Optional[DatasourceEntityDetailsEntityConfig] = None (alias 'EntityConfig')

field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')

Last modification timestamp.

field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')

User who last modified the entity.

field created_by: Optional[StrictStr] = None (alias 'CreatedBy')

User who created the entity.

field created_time: Optional[StrictStr] = None (alias 'CreatedTime')

Alternate creation timestamp field when present.

field is_auto_terminate_enabled: Optional[StrictBool] = None (alias 'IsAutoTerminateEnabled')

Whether auto-termination is enabled. Defaults to false on create.

field auto_termination_time: Optional[StrictStr] = None (alias 'AutoTerminationTime')

Required when IsAutoTerminateEnabled is true.

field active_time: Optional[StrictStr] = None (alias 'ActiveTime')

Active runtime duration for JDBC Bulk Load list cost calculation.

field estimated_cost: Optional[StrictStr] = None (alias 'EstimatedCost')

Estimated cost for the entity when available.

field dataflows: Optional[List[DatasourceEntityDetailsDataflowsInner]] = None (alias 'Dataflows')

Dataflows currently attached to this entity.

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

Return type:

Optional[Self]