Skip to content

UpdateKxDataviewResponse

Source code in docs_src/capo_finspace/types/update_kx_dataview_response.py
class UpdateKxDataviewResponse(TypedDict, closed=True):
    environment_id: NotRequired["capo_finspace.types.environment_id.EnvironmentId"]
    """<p>A unique identifier for the kdb environment, where you want to update the dataview.</p>"""
    database_name: NotRequired["capo_finspace.types.database_name.DatabaseName"]
    """<p> The name of the database. </p>"""
    dataview_name: NotRequired["capo_finspace.types.kx_dataview_name.KxDataviewName"]
    """<p> The name of the database under which the dataview was created. </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 for the changeset.</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>"""
    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>"""
    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>"""
    description: NotRequired["capo_finspace.types.description.Description"]
    """<p>A description of the dataview.</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>"""

active_versions instance-attribute

active_versions: NotRequired[KxDataviewActiveVersionList]

The current active changeset versions of the database on the given dataview.

auto_update instance-attribute

auto_update: booleanValue

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.

availability_zone_id instance-attribute

availability_zone_id: NotRequired[AvailabilityZoneId]

The identifier of the availability zones.

az_mode instance-attribute

az_mode: NotRequired[KxAzMode]

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

changeset_id instance-attribute

changeset_id: NotRequired[ChangesetId]

A unique identifier for the changeset.

created_timestamp instance-attribute

created_timestamp: NotRequired[Timestamp]

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.

database_name instance-attribute

database_name: NotRequired[DatabaseName]

The name of the database.

dataview_name instance-attribute

dataview_name: NotRequired[KxDataviewName]

The name of the database under which the dataview was created.

description instance-attribute

description: NotRequired[Description]

A description of the dataview.

environment_id instance-attribute

environment_id: NotRequired[EnvironmentId]

A unique identifier for the kdb environment, where you want to update the dataview.

last_modified_timestamp instance-attribute

last_modified_timestamp: NotRequired[Timestamp]

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.

read_write instance-attribute

read_write: booleanValue

Returns True if the dataview is created as writeable and False otherwise.

segment_configurations instance-attribute

segment_configurations: NotRequired[KxDataviewSegmentConfigurationList]

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.

status instance-attribute

status: NotRequired[KxDataviewStatus]

The status of dataview creation.

  • CREATING – The dataview creation is in progress.

  • UPDATING – The dataview is in the process of being updated.

  • ACTIVE – The dataview is active.