Skip to content

CreateDatasetRequest

Source code in docs_src/capo_finspace_data/types/create_dataset_request.py
class CreateDatasetRequest(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_title: "capo_finspace_data.types.dataset_title.DatasetTitle"
    """<p>Display title for a FinSpace Dataset.</p>"""
    kind: "capo_finspace_data.types.dataset_kind.DatasetKind"
    """<p>The format in which 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>Description of a Dataset.</p>"""
    owner_info: NotRequired[
        "capo_finspace_data.types.dataset_owner_info.DatasetOwnerInfo"
    ]
    """<p>Contact information for a Dataset owner.</p>"""
    permission_group_params: (
        "capo_finspace_data.types.permission_group_params.PermissionGroupParams"
    )
    """<p>Permission group parameters for Dataset permissions.</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]

Description of a Dataset.

dataset_title instance-attribute

dataset_title: DatasetTitle

Display title for a FinSpace Dataset.

kind instance-attribute

The format in which Dataset data is structured.

  • TABULAR – Data is structured in a tabular format.

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

owner_info instance-attribute

owner_info: NotRequired[DatasetOwnerInfo]

Contact information for a Dataset owner.

permission_group_params instance-attribute

permission_group_params: PermissionGroupParams

Permission group parameters for Dataset permissions.

schema_definition instance-attribute

schema_definition: NotRequired[SchemaUnion]

Definition for a schema on a tabular Dataset.