Run

• Implements: IRun

This class encapsulates and extends the ROS resource type ALIYUN::PAI::Run.

Initializers

import { Run } from '@alicloud/ros-cdk-pai'
new Run(scope: Construct, id: string, props: RunProps, enableResourcePropertyConstraint?: boolean)

scope^Required

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

id^Required

• Type: string

props^Required

• Type: RunProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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.

session^Required

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

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDependency

public addDependency(resource: Resource): void

resource^Required

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

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

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

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { Run } from '@alicloud/ros-cdk-pai'
Run.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

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

attrAccessibility^Required

public readonly attrAccessibility: string | IResolvable;

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

Attribute Accessibility: Resource attribute fields representing visibility.

attrCreateTime^Required

public readonly attrCreateTime: string | IResolvable;

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

Attribute CreateTime: The creation time of the Run.

attrExperimentId^Required

public readonly attrExperimentId: string | IResolvable;

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

Attribute ExperimentId: Resource attribute field of the experiment ID to which Run belongs.

attrGmtModifiedTime^Required

public readonly attrGmtModifiedTime: string | IResolvable;

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

Attribute GmtModifiedTime: Resource attribute fields representing edit time.

attrLabels^Required

public readonly attrLabels: string | IResolvable;

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

Attribute Labels: Run attribute field representing the run tag.

attrMetrics^Required

public readonly attrMetrics: string | IResolvable;

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

Attribute Metrics: Resource attribute field representing the run metric.

attrOwnerId^Required

public readonly attrOwnerId: string | IResolvable;

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

Attribute OwnerId: Resource attribute field representing owner.

attrParams^Required

public readonly attrParams: string | IResolvable;

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

Attribute Params: Resource attribute field representing the run parameter.

attrRunId^Required

public readonly attrRunId: string | IResolvable;

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

Attribute RunId: The ID of the Run.

attrRunName^Required

public readonly attrRunName: string | IResolvable;

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

Attribute RunName: The name of the Run.

attrSourceId^Required

public readonly attrSourceId: string | IResolvable;

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

Attribute SourceId: Attribute Resource field representing the source task ID.

attrSourceType^Required

public readonly attrSourceType: string | IResolvable;

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

Attribute SourceType: Run attribute fields representing the source type.

attrUserId^Required

public readonly attrUserId: string | IResolvable;

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

Attribute UserId: Run attribute field representing creator ID.

attrWorkspaceId^Required

public readonly attrWorkspaceId: string | IResolvable;

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

Attribute WorkspaceId: Resource attribute field of the workspace ID to which Run belongs.

props^Required

public readonly props: RunProps;

• Type: RunProps