Skip to content

ChangesetSummary

Source code in docs_src/capo_finspace_data/types/changeset_summary.py
class ChangesetSummary(TypedDict, closed=True):
    changeset_id: NotRequired["capo_finspace_data.types.changeset_id.ChangesetId"]
    """<p>The unique identifier for a Changeset.</p>"""
    changeset_arn: NotRequired["capo_finspace_data.types.changeset_arn.ChangesetArn"]
    """<p>The ARN identifier of the Changeset.</p>"""
    dataset_id: NotRequired["capo_finspace_data.types.dataset_id.DatasetId"]
    """<p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>"""
    change_type: NotRequired["capo_finspace_data.types.change_type.ChangeType"]
    """<p>Type that indicates how a Changeset is applied to a Dataset.</p> <ul> <li> <p> <code>REPLACE</code> – Changeset is considered as a replacement to all prior loaded Changesets.</p> </li> <li> <p> <code>APPEND</code> – Changeset is considered as an addition to the end of all prior loaded Changesets.</p> </li> <li> <p> <code>MODIFY</code> – Changeset is considered as a replacement to a specific prior ingested Changeset.</p> </li> </ul>"""
    source_params: NotRequired["capo_finspace_data.types.source_params.SourceParams"]
    """<p>Options that define the location of the data being ingested.</p>"""
    format_params: NotRequired["capo_finspace_data.types.format_params.FormatParams"]
    """<p>Options that define the structure of the source file(s).</p>"""
    create_time: "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    """<p>The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"""
    status: NotRequired["capo_finspace_data.types.ingestion_status.IngestionStatus"]
    """<p>Status of the Changeset ingestion.</p> <ul> <li> <p> <code>PENDING</code> – Changeset is pending creation.</p> </li> <li> <p> <code>FAILED</code> – Changeset creation has failed.</p> </li> <li> <p> <code>SUCCESS</code> – Changeset creation has succeeded.</p> </li> <li> <p> <code>RUNNING</code> – Changeset creation is running.</p> </li> <li> <p> <code>STOP_REQUESTED</code> – User requested Changeset creation to stop.</p> </li> </ul>"""
    error_info: NotRequired[
        "capo_finspace_data.types.changeset_error_info.ChangesetErrorInfo"
    ]
    """<p>The structure with error messages.</p>"""
    active_until_timestamp: NotRequired[
        "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    ]
    """<p>Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"""
    active_from_timestamp: NotRequired[
        "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    ]
    """<p>Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"""
    updates_changeset_id: NotRequired[
        "capo_finspace_data.types.changeset_id.ChangesetId"
    ]
    """<p>The unique identifier of the Changeset that is updated.</p>"""
    updated_by_changeset_id: NotRequired[
        "capo_finspace_data.types.changeset_id.ChangesetId"
    ]
    """<p>The unique identifier of the updated Changeset.</p>"""

active_from_timestamp instance-attribute

active_from_timestamp: NotRequired[TimestampEpoch]

Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

active_until_timestamp instance-attribute

active_until_timestamp: NotRequired[TimestampEpoch]

Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

change_type instance-attribute

change_type: NotRequired[ChangeType]

Type that indicates how a Changeset is applied to a Dataset.

  • REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.

  • APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.

  • MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.

changeset_arn instance-attribute

changeset_arn: NotRequired[ChangesetArn]

The ARN identifier of the Changeset.

changeset_id instance-attribute

changeset_id: NotRequired[ChangesetId]

The unique identifier for a Changeset.

create_time instance-attribute

create_time: TimestampEpoch

The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

dataset_id instance-attribute

dataset_id: NotRequired[DatasetId]

The unique identifier for the FinSpace Dataset in which the Changeset is created.

error_info instance-attribute

error_info: NotRequired[ChangesetErrorInfo]

The structure with error messages.

format_params instance-attribute

format_params: NotRequired[FormatParams]

Options that define the structure of the source file(s).

source_params instance-attribute

source_params: NotRequired[SourceParams]

Options that define the location of the data being ingested.

status instance-attribute

status: NotRequired[IngestionStatus]

Status of the Changeset ingestion.

  • PENDING – Changeset is pending creation.

  • FAILED – Changeset creation has failed.

  • SUCCESS – Changeset creation has succeeded.

  • RUNNING – Changeset creation is running.

  • STOP_REQUESTED – User requested Changeset creation to stop.

updated_by_changeset_id instance-attribute

updated_by_changeset_id: NotRequired[ChangesetId]

The unique identifier of the updated Changeset.

updates_changeset_id instance-attribute

updates_changeset_id: NotRequired[ChangesetId]

The unique identifier of the Changeset that is updated.