Dataset
- Implements: com.aliyun.ros.cdk.pai.datasource.IDataset
This class encapsulates and extends the ROS resource type DATASOURCE::PAI::Dataset.
Initializers
import com.aliyun.ros.cdk.pai.datasource.Dataset;
Dataset.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.datasetId(java.lang.String)
.datasetId(IResolvable)
.workspaceId(java.lang.String)
.workspaceId(IResolvable)
// .refreshOptions(java.lang.String)
// .refreshOptions(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 first ID of the resource. |
workspaceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property workspaceId: The ID of the workspace where the dataset is located. |
refreshOptions | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
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 first ID of the resource.
workspaceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property workspaceId: The ID of the workspace where the dataset is located.
For details about how to obtain the workspace ID, see [ListWorkspaces]. If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.
refreshOptionsOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
Valid values:
- Never: Never refresh the datasource resource when the stack is updated.
- Always: Always refresh the datasource resource when the stack is updated. Default is Never.
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.datasource.Dataset;
Dataset.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. |
attrAccessibility | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Accessibility: Workspace visibility. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The creation time of the resource. |
attrDatasetId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DatasetId: The first ID of the resource. |
attrDatasetName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DatasetName: The name of the dataset. |
attrDataSourceType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DataSourceType: The data source type. |
attrDataType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DataType: The dataset type. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: Custom descriptions of datasets to distinguish between different datasets. |
attrGmtModifiedTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute GmtModifiedTime: Update time. |
attrOptions | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Options: The extended field, which is of the JsonString type. |
attrOwnerId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute OwnerId: The ID of the primary account. |
attrProperty | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Property: The properties of the dataset. |
attrSourceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SourceId: The data source ID. |
attrSourceType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SourceType: The data source type. |
attrUri | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Uri: The Uri configuration sample is as follows:. |
attrUserId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UserId: The ID of the user to which the dataset belongs. |
attrWorkspaceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute WorkspaceId: The ID of the workspace where the dataset is located. |
props | DatasetProps | 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
attrAccessibilityRequired
public java.lang.Object getAttrAccessibility();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Accessibility: Workspace visibility.
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The creation time of the resource.
attrDatasetIdRequired
public java.lang.Object getAttrDatasetId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DatasetId: The first ID of the resource.
attrDatasetNameRequired
public java.lang.Object getAttrDatasetName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DatasetName: The name of the dataset.
attrDataSourceTypeRequired
public java.lang.Object getAttrDataSourceType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DataSourceType: The data source type.
attrDataTypeRequired
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.
attrDescriptionRequired
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.
attrGmtModifiedTimeRequired
public java.lang.Object getAttrGmtModifiedTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute GmtModifiedTime: Update time.
attrOptionsRequired
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.
attrOwnerIdRequired
public java.lang.Object getAttrOwnerId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute OwnerId: The ID of the primary account.
attrPropertyRequired
public java.lang.Object getAttrProperty();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Property: The properties of the dataset.
attrSourceIdRequired
public java.lang.Object getAttrSourceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SourceId: The data source ID.
attrSourceTypeRequired
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.
attrUriRequired
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:.
attrUserIdRequired
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.
attrWorkspaceIdRequired
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.
propsRequired
public DatasetProps getProps();
- Type: DatasetProps