Skip to content

Run

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

Initializers

import com.aliyun.ros.cdk.pai.Run;
Run.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .experimentId(java.lang.String)
    .experimentId(IResolvable)
//  .runName(java.lang.String)
//  .runName(IResolvable)
//  .sourceId(java.lang.String)
//  .sourceId(IResolvable)
//  .sourceType(java.lang.String)
//  .sourceType(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.
experimentId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property experimentId: Resource attribute field of the experiment ID to which Run belongs.
runName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property runName: The name of the Run.
sourceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceId: Attribute Resource field representing the source task ID.
sourceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceType: Resource attribute fields representing the source type.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

experimentIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property experimentId: Resource attribute field of the experiment ID to which Run belongs.


runNameOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property runName: The name of the Run.


sourceIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property sourceId: Attribute Resource field representing the source task ID.


sourceTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property sourceType: Resource attribute fields representing the source type.


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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.pai.Run;
Run.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • 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: Resource attribute fields representing visibility.
attrCreateTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The creation time of the Run.
attrExperimentId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ExperimentId: Resource attribute field of the experiment ID to which Run belongs.
attrGmtModifiedTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute GmtModifiedTime: Resource attribute fields representing edit time.
attrLabels java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Labels: Run attribute field representing the run tag.
attrMetrics java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Metrics: Resource attribute field representing the run metric.
attrOwnerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute OwnerId: Resource attribute field representing owner.
attrParams java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Params: Resource attribute field representing the run parameter.
attrRunId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RunId: The ID of the Run.
attrRunName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RunName: The name of the Run.
attrSourceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SourceId: Attribute Resource field representing the source task ID.
attrSourceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SourceType: Run attribute fields representing the source type.
attrUserId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute UserId: Run attribute field representing creator ID.
attrWorkspaceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute WorkspaceId: Resource attribute field of the workspace ID to which Run belongs.
props RunProps 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: Resource attribute fields representing 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 Run.


attrExperimentIdRequired

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

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


attrGmtModifiedTimeRequired

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

Attribute GmtModifiedTime: Resource attribute fields representing edit time.


attrLabelsRequired

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

Attribute Labels: Run attribute field representing the run tag.


attrMetricsRequired

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

Attribute Metrics: Resource attribute field representing the run metric.


attrOwnerIdRequired

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

Attribute OwnerId: Resource attribute field representing owner.


attrParamsRequired

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

Attribute Params: Resource attribute field representing the run parameter.


attrRunIdRequired

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

Attribute RunId: The ID of the Run.


attrRunNameRequired

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

Attribute RunName: The name of the Run.


attrSourceIdRequired

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

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


attrSourceTypeRequired

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

Attribute SourceType: Run attribute fields representing the source type.


attrUserIdRequired

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

Attribute UserId: Run attribute field representing creator ID.


attrWorkspaceIdRequired

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

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


propsRequired

public RunProps getProps();