Skip to content

Dataset

This class encapsulates and extends the ROS resource type ALIYUN::PAI::Dataset, which is used to create a 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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
datasetName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property datasetName: The name of the dataset.
dataSourceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dataSourceType: The data source type.
property java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property property: The properties of the dataset.
uri 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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property workspaceId: The ID of the workspace where the dataset is located.
accessibility java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accessibility: Workspace visibility.
dataType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dataType: The dataset type.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Custom descriptions of datasets to distinguish between different datasets.
options java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property options: The extended field, which is of the JsonString type.
sourceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceId: The data source ID.
sourceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceType: The data source type.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

datasetNameRequired

  • 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.

dataSourceTypeRequired

  • 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).

propertyRequired

  • 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.

uriRequired

  • 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>.

workspaceIdRequired

  • 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.

accessibilityOptional

  • 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.

dataTypeOptional

  • 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.

descriptionOptional

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

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

optionsOptional

  • 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.

sourceIdOptional

  • 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.

sourceTypeOptional

  • 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

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrAccessibility com.aliyun.ros.cdk.core.IResolvable Attribute Accessibility: Workspace visibility.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The creation time of the resource.
attrDatasetId com.aliyun.ros.cdk.core.IResolvable Attribute DatasetId: The first ID of the resource.
attrDatasetName com.aliyun.ros.cdk.core.IResolvable Attribute DatasetName: The name of the dataset.
attrDataSourceType com.aliyun.ros.cdk.core.IResolvable Attribute DataSourceType: The data source type.
attrDataType com.aliyun.ros.cdk.core.IResolvable Attribute DataType: The dataset type.
attrDescription com.aliyun.ros.cdk.core.IResolvable Attribute Description: Custom descriptions of datasets to distinguish between different datasets.
attrGmtModifiedTime com.aliyun.ros.cdk.core.IResolvable Attribute GmtModifiedTime: Update time.
attrOptions com.aliyun.ros.cdk.core.IResolvable Attribute Options: The extended field, which is of the JsonString type.
attrOwnerId com.aliyun.ros.cdk.core.IResolvable Attribute OwnerId: The ID of the primary account.
attrProperty com.aliyun.ros.cdk.core.IResolvable Attribute Property: The properties of the dataset.
attrSourceId com.aliyun.ros.cdk.core.IResolvable Attribute SourceId: The data source ID.
attrSourceType com.aliyun.ros.cdk.core.IResolvable Attribute SourceType: The data source type.
attrUri com.aliyun.ros.cdk.core.IResolvable Attribute Uri: The Uri configuration sample is as follows:.
attrUserId com.aliyun.ros.cdk.core.IResolvable Attribute UserId: The ID of the user to which the dataset belongs.
attrWorkspaceId com.aliyun.ros.cdk.core.IResolvable Attribute WorkspaceId: The ID of the workspace where the dataset is located.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAccessibilityRequired 

public IResolvable getAttrAccessibility();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Accessibility: Workspace visibility.

attrCreateTimeRequired 

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The creation time of the resource.

attrDatasetIdRequired 

public IResolvable getAttrDatasetId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DatasetId: The first ID of the resource.

attrDatasetNameRequired 

public IResolvable getAttrDatasetName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DatasetName: The name of the dataset.

attrDataSourceTypeRequired 

public IResolvable getAttrDataSourceType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DataSourceType: The data source type.

attrDataTypeRequired 

public IResolvable getAttrDataType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DataType: The dataset type.

The default value is COMMON.

attrDescriptionRequired 

public IResolvable getAttrDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrGmtModifiedTimeRequired 

public IResolvable getAttrGmtModifiedTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute GmtModifiedTime: Update time.

attrOptionsRequired 

public IResolvable getAttrOptions();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrOwnerIdRequired 

public IResolvable getAttrOwnerId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OwnerId: The ID of the primary account.

attrPropertyRequired 

public IResolvable getAttrProperty();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Property: The properties of the dataset.

attrSourceIdRequired 

public IResolvable getAttrSourceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SourceId: The data source ID.

attrSourceTypeRequired 

public IResolvable getAttrSourceType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SourceType: The data source type.

The default value is USER.

attrUriRequired 

public IResolvable getAttrUri();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrUserIdRequired 

public IResolvable getAttrUserId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrWorkspaceIdRequired 

public IResolvable getAttrWorkspaceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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