Dataset

• Implements: IDataset

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

Initializers

import com.aliyun.ros.cdk.pai.Dataset;
Dataset.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .datasetName(java.lang.String)
    .datasetName(IResolvable)
    .dataSourceType(java.lang.String)
    .dataSourceType(IResolvable)
    .property(java.lang.String)
    .property(IResolvable)
    .uri(java.lang.String)
    .uri(IResolvable)
    .workspaceId(java.lang.String)
    .workspaceId(IResolvable)
//  .accessibility(java.lang.String)
//  .accessibility(IResolvable)
//  .dataType(java.lang.String)
//  .dataType(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .options(java.lang.String)
//  .options(IResolvable)
//  .sourceId(java.lang.String)
//  .sourceId(IResolvable)
//  .sourceType(java.lang.String)
//  .sourceType(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

datasetName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property datasetName: The name of the dataset.

The naming rules are as follows:

• Start with a lowercase letter, uppercase letter, number, or Chinese.
• Can contain an underscore (_) or a dash (-).
• 1~127 characters in length.

dataSourceType^Required

• Type: java.lang.String OR com.aliyun.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).

property^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property property: The properties of the dataset.

The following values are supported:

• FILE: FILE.
• DIRECTORY: folder.

uri^Required

• Type: java.lang.String OR com.aliyun.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>.

workspaceId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.

accessibility^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property accessibility: Workspace visibility.

The following values are supported:

• PRIVATE (default): indicates that the workspace is visible to itself and the administrator.
• PUBLIC: The workspace is visible to all users.

dataType^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dataType: The dataset type.

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

• COMMON: COMMON.
• PIC: picture.
• TEXT: TEXT.
• VIDEO: VIDEO.
• AUDIO: AUDIO.

description^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: Custom descriptions of datasets to distinguish between different datasets.

options^Optional

• Type: java.lang.String OR com.aliyun.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.

sourceId^Optional

• Type: java.lang.String OR com.aliyun.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.

sourceType^Optional

• Type: java.lang.String OR com.aliyun.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.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.pai.Dataset;
Dataset.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrAccessibility^Required

public java.lang.Object getAttrAccessibility();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Accessibility: Workspace visibility.

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The creation time of the resource.

attrDatasetId^Required

public java.lang.Object getAttrDatasetId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DatasetId: The first ID of the resource.

attrDatasetName^Required

public java.lang.Object getAttrDatasetName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DatasetName: The name of the dataset.

attrDataSourceType^Required

public java.lang.Object getAttrDataSourceType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DataSourceType: The data source type.

attrDataType^Required

public java.lang.Object getAttrDataType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DataType: The dataset type.

The default value is COMMON.

attrDescription^Required

public java.lang.Object getAttrDescription();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrGmtModifiedTime^Required

public java.lang.Object getAttrGmtModifiedTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute GmtModifiedTime: Update time.

attrOptions^Required

public java.lang.Object getAttrOptions();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrOwnerId^Required

public java.lang.Object getAttrOwnerId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute OwnerId: The ID of the primary account.

attrProperty^Required

public java.lang.Object getAttrProperty();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Property: The properties of the dataset.

attrSourceId^Required

public java.lang.Object getAttrSourceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SourceId: The data source ID.

attrSourceType^Required

public java.lang.Object getAttrSourceType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SourceType: The data source type.

The default value is USER.

attrUri^Required

public java.lang.Object getAttrUri();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrUserId^Required

public java.lang.Object getAttrUserId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrWorkspaceId^Required

public java.lang.Object getAttrWorkspaceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

props^Required

public DatasetProps getProps();

• Type: DatasetProps