DatasourceFlowsDetails

pydantic model openapi_client.models.datasource_flows_details.DatasourceFlowsDetails

Details of a datasource dataflow. Keys vary by DataflowType.

Fields:

• additional_task_stats (str | None)

• cdc_tracking_method (str | None)

• create_dataset (bool | None)

• created_by (str | None)

• creation_time (str | None)

• data_format (str | None)

• dataflow_config (openapi_client.models.datasource_flows_details_dataflow_config.DatasourceFlowsDetailsDataflowConfig | None)

• dataflow_description (str | None)

• dataflow_id (str | None)

• dataflow_name (str | None)

• dataflow_status (str | None)

• dataflow_type (str | None)

• dataset_details (List[openapi_client.models.datasource_flows_details_dataset_details_inner.DatasourceFlowsDetailsDatasetDetailsInner] | None)

• datasource_id (str | None)

• datasource_name (str | None)

• end_time (str | None)

• file_type (str | None)

• full_load_progress_percent (int | None)

• ingestion_type (str | None)

• items_config (List[openapi_client.models.datasource_flows_details_items_config_inner.DatasourceFlowsDetailsItemsConfigInner] | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• message (str | None)

• metadata_update_message (str | None)

• metadata_update_status (str | None)

• process_type (str | None)

• registered_datasets (str | None)

• resource_origin (str | None)

• schedule_id (List[str] | None)

• schedules (List[openapi_client.models.schedule_details_inner.ScheduleDetailsInner] | None)

• stopped_time (str | None)

• target_location (str | None)

• task_stats (List[openapi_client.models.dataflow_task_stats_entry.DataflowTaskStatsEntry] | None)

field schedule_id: Optional[List[StrictStr]] = None (alias 'ScheduleId')

IDs of schedules linked to this dataflow.

field dataflow_type: Optional[StrictStr] = None (alias 'DataflowType')

Discriminator for the dataflow implementation. Set at create time: tasks (JDBC Bulkload), kafka-connect (JDBC Advanced Load), flows (SaaS), consumers (Streams), arcgis (ArcGIS).

field dataflow_id: Optional[StrictStr] = None (alias 'DataflowId')

Unique ID of the dataflow (uuid4).

field ingestion_type: Optional[StrictStr] = None (alias 'IngestionType')

Ingestion mode copied from or associated with the parent datasource when present on the flow item (e.g. bulkdataload, advanceddataload).

field dataflow_name: Optional[StrictStr] = None (alias 'DataflowName')

Display name of the dataflow.

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

ID of the parent datasource.

field dataflow_status: Optional[StrictStr] = None (alias 'DataflowStatus')

Current lifecycle / run status of the dataflow. Values are type-specific (e.g. ready, running, stopped, active, failed, deleted, creating). JDBC Bulkload may refresh this from DMS on GET; SaaS may refresh from AppFlow.

field metadata_update_status: Optional[StrictStr] = None (alias 'MetadataUpdateStatus')

Status of the most recent metadata or config update on the dataflow, such as in-progress, completed, or failed. Independent of DataflowStatus.

field metadata_update_message: Optional[StrictStr] = None (alias 'MetadataUpdateMessage')

Message describing the most recent metadata or config update on the dataflow.

field process_type: Optional[StrictStr] = None (alias 'ProcessType')

Load mode. Common values: full-load, cdc, full-load-and-cdc.

field cdc_tracking_method: Optional[StrictStr] = None (alias 'CDCTrackingMethod')

How CDC changes are tracked for ArcGIS datasources.

field target_location: Optional[StrictStr] = None (alias 'TargetLocation')

Where ingested data is written, such as s3, s3athena, or redshift.

field create_dataset: Optional[StrictBool] = None (alias 'CreateDataset')

Whether the dataflow creates new Amorphic datasets or uses existing ones.

field dataset_details: Optional[List[DatasourceFlowsDetailsDatasetDetailsInner]] = None (alias 'DatasetDetails')

Per-table or per-dataset configuration used for registration and load.

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

Human-readable status / failure message for the dataflow.

field data_format: Optional[StrictStr] = None (alias 'DataFormat')

Output file format for the dataflow, such as csv, json, and parquet.

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

When the dataflow was created.

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

User who created the dataflow.

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

User who last updated the dataflow.

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

When the dataflow was last updated.

field stopped_time: Optional[StrictStr] = None (alias 'StoppedTime')

When the dataflow last stopped.

field end_time: Optional[StrictStr] = None (alias 'EndTime')

When the dataflow run ended.

field full_load_progress_percent: Optional[StrictInt] = None (alias 'FullLoadProgressPercent')

Full-load completion percent from 0 to 100.

field task_stats: Optional[List[DataflowTaskStatsEntry]] = None (alias 'TaskStats')

Per-table load / CDC statistics for the dataflow.

field additional_task_stats: Optional[StrictStr] = None (alias 'AdditionalTaskStats')

Whether more table statistics pages are available beyond the first page.

field items_config: Optional[List[DatasourceFlowsDetailsItemsConfigInner]] = None (alias 'ItemsConfig')

ArcGIS items and layers to process.

field schedules: Optional[List[ScheduleDetailsInner]] = None (alias 'Schedules')

Linked schedule records loaded on GET for JDBC Bulkload, JDBC Advanced Load, and ArcGIS datasources. Not populated by the SaaS or Streams GET handlers.

field registered_datasets: Optional[StrictStr] = None (alias 'RegisteredDatasets')

Dataset ID linked to the dataflow. On single GET: returned for Streams as a single DatasetId string.

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

Display name of the parent datasource.

field dataflow_description: Optional[StrictStr] = None (alias 'DataflowDescription')

Free-text description of the dataflow.

field file_type: Optional[StrictStr] = None (alias 'FileType')

File type of delivered data for Streams datasources.

field resource_origin: Optional[StrictStr] = None (alias 'ResourceOrigin')

How the dataflow was created, such as API or AWSConsole.

field dataflow_config: Optional[DatasourceFlowsDetailsDataflowConfig] = None (alias 'DataflowConfig')

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

Return type:

Optional[Self]