DatasetVersion
- Implements: IDatasetVersion
This class encapsulates and extends the ROS resource type ALIYUN::PAI::DatasetVersion.
Initializers
import com.aliyun.ros.cdk.pai.DatasetVersion;
DatasetVersion.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.datasetId(java.lang.String)
.datasetId(IResolvable)
.dataSourceType(java.lang.String)
.dataSourceType(IResolvable)
.property(java.lang.String)
.property(IResolvable)
.uri(java.lang.String)
.uri(IResolvable)
// .dataCount(java.lang.Number)
// .dataCount(IResolvable)
// .dataSize(java.lang.Number)
// .dataSize(IResolvable)
// .description(java.lang.String)
// .description(IResolvable)
// .labels(IResolvable)
// .labels(java.util.List<IResolvable)
// .labels(LabelsProperty>)
// .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. |
datasetId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property datasetId: The ID 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:\/\/ |
dataCount | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property dataCount: The number of dataset files, in units of pieces. |
dataSize | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property dataSize: The size of the dataset file in bytes. |
description | java.lang.String OR com.aliyun.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 | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property labels: Dataset version tag list. |
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
datasetIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property datasetId: The ID of the dataset.
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).
- CPFS
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:\/\/
dataCountOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property dataCount: The number of dataset files, in units of pieces.
dataSizeOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property dataSize: The size of the dataset file in bytes.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: To create a custom description for dataset versions in order to distinguish between different versions of the dataset.
labelsOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
LabelsProperty>
Property labels: Dataset version tag list.
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.pai.DatasetVersion;
DatasetVersion.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrVersionName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VersionName: Dataset version name. |
props | DatasetVersionProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
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
attrVersionNameRequired
public java.lang.Object getAttrVersionName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VersionName: Dataset version name.
propsRequired
public DatasetVersionProps getProps();
- Type: DatasetVersionProps