Skip to content

DatasetProps

Properties for defining a Dataset.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-pai-dataset

Initializer 

import com.aliyun.ros.cdk.pai.DatasetProps;
DatasetProps.builder()
    .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();

Properties

Name Type 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.

datasetNameRequired 

public java.lang.Object getDatasetName();
  • 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 

public java.lang.Object getDataSourceType();
  • 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 

public java.lang.Object getProperty();
  • 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 

public java.lang.Object getUri();
  • 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 

public java.lang.Object getWorkspaceId();
  • 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 

public java.lang.Object getAccessibility();
  • 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 

public java.lang.Object getDataType();
  • 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 

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

optionsOptional 

public java.lang.Object getOptions();
  • 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 

public java.lang.Object getSourceId();
  • 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 

public java.lang.Object getSourceType();
  • 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.