Skip to content

UpdateDatasetRequest

Source code in docs_src/capo_finspace_data/types/update_dataset_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class UpdateDatasetRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_finspace_data.types.client_token.ClientToken"]
    """<p>A token that ensures idempotency. This token expires in 10 minutes.</p>"""
    dataset_id: "capo_finspace_data.types.dataset_id.DatasetId"
    """<p>The unique identifier for the Dataset to update.</p>"""
    dataset_title: "capo_finspace_data.types.dataset_title.DatasetTitle"
    """<p>A display title for the Dataset.</p>"""
    kind: "capo_finspace_data.types.dataset_kind.DatasetKind"
    """<p>The format in which the Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> – Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p> </li> </ul>"""
    dataset_description: NotRequired[
        "capo_finspace_data.types.dataset_description.DatasetDescription"
    ]
    """<p>A description for the Dataset.</p>"""
    alias: NotRequired["capo_finspace_data.types.alias_string.AliasString"]
    """<p>The unique resource identifier for a Dataset.</p>"""
    schema_definition: NotRequired["capo_finspace_data.types.schema_union.SchemaUnion"]
    """<p>Definition for a schema on a tabular Dataset.</p>"""

alias instance-attribute 

alias: NotRequired[AliasString]

The unique resource identifier for a Dataset.

client_token instance-attribute 

client_token: NotRequired[ClientToken]

A token that ensures idempotency. This token expires in 10 minutes.

dataset_description instance-attribute 

dataset_description: NotRequired[DatasetDescription]

A description for the Dataset.

dataset_id instance-attribute 

dataset_id: DatasetId

The unique identifier for the Dataset to update.

dataset_title instance-attribute 

dataset_title: DatasetTitle

A display title for the Dataset.

kind instance-attribute 

kind: DatasetKind

The format in which the Dataset data is structured.

  • TABULAR – Data is structured in a tabular format.

  • NON_TABULAR – Data is structured in a non-tabular format.

schema_definition instance-attribute 

schema_definition: NotRequired[SchemaUnion]

Definition for a schema on a tabular Dataset.