DatasetVersion

• Implements: IDatasetVersion

This class encapsulates and extends the ROS resource type ALIYUN::PAI::DatasetVersion.

Initializers

import ros_cdk_pai
ros_cdk_pai.DatasetVersion(
  scope: Construct,
  id: str,
  dataset_id: typing.Union[str, IResolvable],
  data_source_type: typing.Union[str, IResolvable],
  property: typing.Union[str, IResolvable],
  uri: typing.Union[str, IResolvable],
  data_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  data_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  labels: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, LabelsProperty]]] = None,
  options: typing.Union[str, IResolvable] = None,
  source_id: typing.Union[str, IResolvable] = None,
  source_type: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

dataset_id^Required

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

Property datasetId: The ID of the dataset.

data_source_type^Required

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

Property dataSourceType: The data source type.

The following values are supported:

• OSS: Alibaba Cloud Object Storage (OSS).
• NAS: Alibaba cloud file storage (NAS).
• CPFS

property^Required

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

Property property: The properties of the dataset.

The following values are supported:

• FILE: FILE.
• DIRECTORY: folder.

uri^Required

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

Property uri: The Uri configuration sample is as follows: - The data source type is OSS:'oss:\/\/bucket.endpoint\/object' - The data source type is NAS: The general NAS format is: 'nas:\/\/.region\/subpath\/to\/dir\/'; CPFS1.0:'nas:\/\/.region\/subpath\/to\/dir \/'; CPFS2.0:'nas:\/\/.region\/\/'. CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-<8-bit ascii characters>;CPFS2.0 is cpfs-<16 ascii characters>.

data_count^Optional

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

Property dataCount: The number of dataset files, in units of pieces.

data_size^Optional

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

Property dataSize: The size of the dataset file in bytes.

description^Optional

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

Property description: To create a custom description for dataset versions in order to distinguish between different versions of the dataset.

labels^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, LabelsProperty]]]

Property labels: Dataset version tag list.

options^Optional

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

Property options: The extended field, which is of the JsonString type.

When DLC uses a dataset, you can specify the default Mount path for the dataset by configuring the mountPath field.

source_id^Optional

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

Property sourceId: The data source ID.

• When the SourceType is USER, SourceId can be customized.
• When SourceType is ITAG, that is, when the iTAG module labels the data set generated by the result, SourceId is the task ID of ITAG.
• When SourceType is PAI_PUBLIC_DATASET, that is, a dataset created using PAI public datasets, SourceId is empty by default.

source_type^Optional

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

Property sourceType: The data source type.

The default value is USER. The following values are supported:

• PAI-PUBLIC-DATASET:PAI public dataset.
• ITAG: The dataset generated by the iTAG module annotation result.
• USER: The data set registered by the USER.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_pai
ros_cdk_pai.DatasetVersion.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_version_name^Required

attr_version_name: typing.Union[str, IResolvable]

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

Attribute VersionName: Dataset version name.

props^Required

props: DatasetVersionProps

• Type: DatasetVersionProps