Skip to content

Dataset

This class encapsulates and extends the ROS resource type DATASOURCE::PAI::Dataset.

Initializers 

from ros_cdk_pai import datasource
datasource.Dataset(
  scope: Construct,
  id: str,
  dataset_id: typing.Union[str, IResolvable],
  workspace_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
dataset_id typing.Union[str, ros_cdk_core.IResolvable] Property datasetId: The first ID of the resource.
workspace_id typing.Union[str, ros_cdk_core.IResolvable] Property workspaceId: The ID of the workspace where the dataset is located.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

dataset_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property datasetId: The first ID of the resource.

workspace_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property workspaceId: The ID of the workspace where the dataset is located.

For details about how to obtain the workspace ID, see [ListWorkspaces]. If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.

refresh_optionsOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

from ros_cdk_pai import datasource
datasource.Dataset.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_accessibility ros_cdk_core.IResolvable Attribute Accessibility: Workspace visibility.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The creation time of the resource.
attr_dataset_id ros_cdk_core.IResolvable Attribute DatasetId: The first ID of the resource.
attr_dataset_name ros_cdk_core.IResolvable Attribute DatasetName: The name of the dataset.
attr_data_source_type ros_cdk_core.IResolvable Attribute DataSourceType: The data source type.
attr_data_type ros_cdk_core.IResolvable Attribute DataType: The dataset type.
attr_description ros_cdk_core.IResolvable Attribute Description: Custom descriptions of datasets to distinguish between different datasets.
attr_gmt_modified_time ros_cdk_core.IResolvable Attribute GmtModifiedTime: Update time.
attr_options ros_cdk_core.IResolvable Attribute Options: The extended field, which is of the JsonString type.
attr_owner_id ros_cdk_core.IResolvable Attribute OwnerId: The ID of the primary account.
attr_property ros_cdk_core.IResolvable Attribute Property: The properties of the dataset.
attr_source_id ros_cdk_core.IResolvable Attribute SourceId: The data source ID.
attr_source_type ros_cdk_core.IResolvable Attribute SourceType: The data source type.
attr_uri ros_cdk_core.IResolvable Attribute Uri: The Uri configuration sample is as follows:.
attr_user_id ros_cdk_core.IResolvable Attribute UserId: The ID of the user to which the dataset belongs.
attr_workspace_id ros_cdk_core.IResolvable Attribute WorkspaceId: The ID of the workspace where the dataset is located.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_accessibilityRequired 

attr_accessibility: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Accessibility: Workspace visibility.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The creation time of the resource.

attr_dataset_idRequired 

attr_dataset_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DatasetId: The first ID of the resource.

attr_dataset_nameRequired 

attr_dataset_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DatasetName: The name of the dataset.

attr_data_source_typeRequired 

attr_data_source_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DataSourceType: The data source type.

attr_data_typeRequired 

attr_data_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DataType: The dataset type.

The default value is COMMON.

attr_descriptionRequired 

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: Custom descriptions of datasets to distinguish between different datasets.

attr_gmt_modified_timeRequired 

attr_gmt_modified_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute GmtModifiedTime: Update time.

attr_optionsRequired 

attr_options: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Options: The extended field, which is of the JsonString type.

attr_owner_idRequired 

attr_owner_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OwnerId: The ID of the primary account.

attr_propertyRequired 

attr_property: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Property: The properties of the dataset.

attr_source_idRequired 

attr_source_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SourceId: The data source ID.

attr_source_typeRequired 

attr_source_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SourceType: The data source type.

The default value is USER.

attr_uriRequired 

attr_uri: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Uri: The Uri configuration sample is as follows:.

attr_user_idRequired 

attr_user_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UserId: The ID of the user to which the dataset belongs.

attr_workspace_idRequired 

attr_workspace_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute WorkspaceId: The ID of the workspace where the dataset is located.