GetKxDataviewResponse ¶

class GetKxDataviewResponse(TypedDict, closed=True):
    database_name: NotRequired["capo_finspace.types.database_name.DatabaseName"]
    """<p> The name of the database where you created the dataview.</p>"""
    dataview_name: NotRequired["capo_finspace.types.kx_dataview_name.KxDataviewName"]
    """<p>A unique identifier for the dataview.</p>"""
    az_mode: NotRequired["capo_finspace.types.kx_az_mode.KxAzMode"]
    """<p>The number of availability zones you want to assign per volume. Currently, FinSpace only supports <code>SINGLE</code> for volumes. This places dataview in a single AZ.</p>"""
    availability_zone_id: NotRequired[
        "capo_finspace.types.availability_zone_id.AvailabilityZoneId"
    ]
    """<p> The identifier of the availability zones. </p>"""
    changeset_id: NotRequired["capo_finspace.types.changeset_id.ChangesetId"]
    """<p> A unique identifier of the changeset that you want to use to ingest data. </p>"""
    segment_configurations: NotRequired[
        "capo_finspace.types.kx_dataview_segment_configuration_list.KxDataviewSegmentConfigurationList"
    ]
    """<p> The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. </p>"""
    active_versions: NotRequired[
        "capo_finspace.types.kx_dataview_active_version_list.KxDataviewActiveVersionList"
    ]
    """<p> The current active changeset versions of the database on the given dataview. </p>"""
    description: NotRequired["capo_finspace.types.description.Description"]
    """<p>A description of the dataview.</p>"""
    auto_update: "capo_finspace.types.boolean_value.booleanValue"
    """<p>The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.</p>"""
    read_write: "capo_finspace.types.boolean_value.booleanValue"
    """<p>Returns True if the dataview is created as writeable and False otherwise. </p>"""
    environment_id: NotRequired["capo_finspace.types.environment_id.EnvironmentId"]
    """<p>A unique identifier for the kdb environment, from where you want to retrieve the dataview details.</p>"""
    created_timestamp: NotRequired["capo_finspace.types.timestamp.Timestamp"]
    """<p>The timestamp at which the dataview 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>"""
    last_modified_timestamp: NotRequired["capo_finspace.types.timestamp.Timestamp"]
    """<p> The last time that the dataview was updated 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.types.kx_dataview_status.KxDataviewStatus"]
    """<p> The status of dataview creation.</p> <ul> <li> <p> <code>CREATING</code> – The dataview creation is in progress.</p> </li> <li> <p> <code>UPDATING</code> – The dataview is in the process of being updated.</p> </li> <li> <p> <code>ACTIVE</code> – The dataview is active.</p> </li> </ul>"""
    status_reason: NotRequired[
        "capo_finspace.types.kx_dataview_status_reason.KxDataviewStatusReason"
    ]
    """<p> The error message when a failed state occurs. </p>"""