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 { 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

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

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

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

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
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 @alicloud/ros-cdk-core.IResolvable Attribute Accessibility: Workspace visibility.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The creation time of the resource.
attrDatasetId @alicloud/ros-cdk-core.IResolvable Attribute DatasetId: The first ID of the resource.
attrDatasetName @alicloud/ros-cdk-core.IResolvable Attribute DatasetName: The name of the dataset.
attrDataSourceType @alicloud/ros-cdk-core.IResolvable Attribute DataSourceType: The data source type.
attrDataType @alicloud/ros-cdk-core.IResolvable Attribute DataType: The dataset type.
attrDescription @alicloud/ros-cdk-core.IResolvable Attribute Description: Custom descriptions of datasets to distinguish between different datasets.
attrGmtModifiedTime @alicloud/ros-cdk-core.IResolvable Attribute GmtModifiedTime: Update time.
attrOptions @alicloud/ros-cdk-core.IResolvable Attribute Options: The extended field, which is of the JsonString type.
attrOwnerId @alicloud/ros-cdk-core.IResolvable Attribute OwnerId: The ID of the primary account.
attrProperty @alicloud/ros-cdk-core.IResolvable Attribute Property: The properties of the dataset.
attrSourceId @alicloud/ros-cdk-core.IResolvable Attribute SourceId: The data source ID.
attrSourceType @alicloud/ros-cdk-core.IResolvable Attribute SourceType: The data source type.
attrUri @alicloud/ros-cdk-core.IResolvable Attribute Uri: The Uri configuration sample is as follows:.
attrUserId @alicloud/ros-cdk-core.IResolvable Attribute UserId: The ID of the user to which the dataset belongs.
attrWorkspaceId @alicloud/ros-cdk-core.IResolvable Attribute WorkspaceId: The ID of the workspace where the dataset is located.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

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: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Accessibility: Workspace visibility.

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The creation time of the resource.

attrDatasetIdRequired 

public readonly attrDatasetId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DatasetId: The first ID of the resource.

attrDatasetNameRequired 

public readonly attrDatasetName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DatasetName: The name of the dataset.

attrDataSourceTypeRequired 

public readonly attrDataSourceType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DataSourceType: The data source type.

attrDataTypeRequired 

public readonly attrDataType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DataType: The dataset type.

The default value is COMMON.

attrDescriptionRequired 

public readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrGmtModifiedTimeRequired 

public readonly attrGmtModifiedTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute GmtModifiedTime: Update time.

attrOptionsRequired 

public readonly attrOptions: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrOwnerIdRequired 

public readonly attrOwnerId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute OwnerId: The ID of the primary account.

attrPropertyRequired 

public readonly attrProperty: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Property: The properties of the dataset.

attrSourceIdRequired 

public readonly attrSourceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SourceId: The data source ID.

attrSourceTypeRequired 

public readonly attrSourceType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SourceType: The data source type.

The default value is USER.

attrUriRequired 

public readonly attrUri: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrUserIdRequired 

public readonly attrUserId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrWorkspaceIdRequired 

public readonly attrWorkspaceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

For details about how to obtain the workspace ID, see ListWorkspaces.