Dataset
- Implements: IDataset
This class encapsulates and extends the ROS resource type ALIYUN::PAI::Dataset.
Initializers
import { Dataset } from '@alicloud/ros-cdk-pai'
new Dataset(scope: Construct, id: string, props: DatasetProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | DatasetProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: DatasetProps
enableResourcePropertyConstraintOptional
- Type: boolean
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 toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
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: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { Dataset } from '@alicloud/ros-cdk-pai'
Dataset.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
ref | string | No description. |
stack | @alicloud/ros-cdk-core.Stack | The stack in which this resource is defined. |
resource | @alicloud/ros-cdk-core.RosResource | No description. |
attrAccessibility | string | @alicloud/ros-cdk-core.IResolvable | Attribute Accessibility: Workspace visibility. |
attrCreateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The creation time of the resource. |
attrDatasetId | string | @alicloud/ros-cdk-core.IResolvable | Attribute DatasetId: The first ID of the resource. |
attrDatasetName | string | @alicloud/ros-cdk-core.IResolvable | Attribute DatasetName: The name of the dataset. |
attrDataSourceType | string | @alicloud/ros-cdk-core.IResolvable | Attribute DataSourceType: The data source type. |
attrDataType | string | @alicloud/ros-cdk-core.IResolvable | Attribute DataType: The dataset type. |
attrDescription | string | @alicloud/ros-cdk-core.IResolvable | Attribute Description: Custom descriptions of datasets to distinguish between different datasets. |
attrGmtModifiedTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute GmtModifiedTime: Update time. |
attrOptions | string | @alicloud/ros-cdk-core.IResolvable | Attribute Options: The extended field, which is of the JsonString type. |
attrOwnerId | string | @alicloud/ros-cdk-core.IResolvable | Attribute OwnerId: The ID of the primary account. |
attrProperty | string | @alicloud/ros-cdk-core.IResolvable | Attribute Property: The properties of the dataset. |
attrSourceId | string | @alicloud/ros-cdk-core.IResolvable | Attribute SourceId: The data source ID. |
attrSourceType | string | @alicloud/ros-cdk-core.IResolvable | Attribute SourceType: The data source type. |
attrUri | string | @alicloud/ros-cdk-core.IResolvable | Attribute Uri: The Uri configuration sample is as follows:. |
attrUserId | string | @alicloud/ros-cdk-core.IResolvable | Attribute UserId: The ID of the user to which the dataset belongs. |
attrWorkspaceId | string | @alicloud/ros-cdk-core.IResolvable | Attribute WorkspaceId: The ID of the workspace where the dataset is located. |
props | DatasetProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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 readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrAccessibilityRequired
public readonly attrAccessibility: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Accessibility: Workspace visibility.
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: The creation time of the resource.
attrDatasetIdRequired
public readonly attrDatasetId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DatasetId: The first ID of the resource.
attrDatasetNameRequired
public readonly attrDatasetName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DatasetName: The name of the dataset.
attrDataSourceTypeRequired
public readonly attrDataSourceType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DataSourceType: The data source type.
attrDataTypeRequired
public readonly attrDataType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DataType: The dataset type.
The default value is COMMON.
attrDescriptionRequired
public readonly attrDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Description: Custom descriptions of datasets to distinguish between different datasets.
attrGmtModifiedTimeRequired
public readonly attrGmtModifiedTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute GmtModifiedTime: Update time.
attrOptionsRequired
public readonly attrOptions: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Options: The extended field, which is of the JsonString type.
attrOwnerIdRequired
public readonly attrOwnerId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute OwnerId: The ID of the primary account.
attrPropertyRequired
public readonly attrProperty: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Property: The properties of the dataset.
attrSourceIdRequired
public readonly attrSourceId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SourceId: The data source ID.
attrSourceTypeRequired
public readonly attrSourceType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SourceType: The data source type.
The default value is USER.
attrUriRequired
public readonly attrUri: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Uri: The Uri configuration sample is as follows:.
attrUserIdRequired
public readonly attrUserId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute UserId: The ID of the user to which the dataset belongs.
attrWorkspaceIdRequired
public readonly attrWorkspaceId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute WorkspaceId: The ID of the workspace where the dataset is located.
propsRequired
public readonly props: DatasetProps;
- Type: DatasetProps