Experiment

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

Initializers

import com.aliyun.ros.cdk.pai.Experiment;
Experiment.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .artifactUri(java.lang.String)
    .artifactUri(IResolvable)
    .experimentName(java.lang.String)
    .experimentName(IResolvable)
    .workspaceId(java.lang.String)
    .workspaceId(IResolvable)
//  .accessibility(java.lang.String)
//  .accessibility(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.
artifactUri	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property artifactUri: ArtifactUri is default OSS storage path of the output of trials in the experiment.
experimentName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property experimentName: Name is the name of the experiment, unique in a namespace.
workspaceId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property workspaceId: WorkspaceId is the workspace id which contains the experiment.
accessibility	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property accessibility: Experimental Visibility.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

artifactUri^Required

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

Property artifactUri: ArtifactUri is default OSS storage path of the output of trials in the experiment.

---

experimentName^Required

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

Property experimentName: Name is the name of the experiment, unique in a namespace.

---

workspaceId^Required

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

Property workspaceId: WorkspaceId is the workspace id which contains the experiment.

---

accessibility^Optional

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

Property accessibility: Experimental Visibility.

---

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

session^Required

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

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

---

addCount

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

count^Required

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

---

addDependency

public void addDependency(Resource resource)

resource^Required

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

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

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

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

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

---

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
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	com.aliyun.ros.cdk.core.IResolvable	Attribute Accessibility: Experimental Visibility.
attrArtifactUri	com.aliyun.ros.cdk.core.IResolvable	Attribute ArtifactUri: ArtifactUri is default OSS storage path of the output of trials in the experiment.
attrCreateTime	com.aliyun.ros.cdk.core.IResolvable	Attribute CreateTime: GmtCreateTime is time when this entity is created.
attrExperimentId	com.aliyun.ros.cdk.core.IResolvable	Attribute ExperimentId: ExperimentId is globally unique identifier of the experiment.
attrExperimentName	com.aliyun.ros.cdk.core.IResolvable	Attribute ExperimentName: Name is the name of the experiment, unique in a namespace.
attrGmtModifiedTime	com.aliyun.ros.cdk.core.IResolvable	Attribute GmtModifiedTime: GmtModifiedTime is time when this entity is modified.
attrLabels	com.aliyun.ros.cdk.core.IResolvable	Attribute Labels: Labels are tags of the experiment.
attrOwnerId	com.aliyun.ros.cdk.core.IResolvable	Attribute OwnerId: OwnerId is the user account id which this entity belongs to.
attrTensorboardLogUri	com.aliyun.ros.cdk.core.IResolvable	Attribute TensorboardLogUri: TensorboardLogUri is the default OSS storage path of tensorboard log of trials in the experiment.
attrUserId	com.aliyun.ros.cdk.core.IResolvable	Attribute UserId: UserId is the user account id which created this entity.
attrWorkspaceId	com.aliyun.ros.cdk.core.IResolvable	Attribute WorkspaceId: WorkspaceId is the workspace id which contains the experiment.

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

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

---

attrAccessibility^Required

public IResolvable getAttrAccessibility();

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

Attribute Accessibility: Experimental Visibility.

---

attrArtifactUri^Required

public IResolvable getAttrArtifactUri();

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

Attribute ArtifactUri: ArtifactUri is default OSS storage path of the output of trials in the experiment.

---

attrCreateTime^Required

public IResolvable getAttrCreateTime();

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

Attribute CreateTime: GmtCreateTime is time when this entity is created.

---

attrExperimentId^Required

public IResolvable getAttrExperimentId();

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

Attribute ExperimentId: ExperimentId is globally unique identifier of the experiment.

---

attrExperimentName^Required

public IResolvable getAttrExperimentName();

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

Attribute ExperimentName: Name is the name of the experiment, unique in a namespace.

---

attrGmtModifiedTime^Required

public IResolvable getAttrGmtModifiedTime();

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

Attribute GmtModifiedTime: GmtModifiedTime is time when this entity is modified.

---

attrLabels^Required

public IResolvable getAttrLabels();

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

Attribute Labels: Labels are tags of the experiment.

---

attrOwnerId^Required

public IResolvable getAttrOwnerId();

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

Attribute OwnerId: OwnerId is the user account id which this entity belongs to.

---

attrTensorboardLogUri^Required

public IResolvable getAttrTensorboardLogUri();

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

Attribute TensorboardLogUri: TensorboardLogUri is the default OSS storage path of tensorboard log of trials in the experiment.

---

attrUserId^Required

public IResolvable getAttrUserId();

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

Attribute UserId: UserId is the user account id which created this entity.

---

attrWorkspaceId^Required

public IResolvable getAttrWorkspaceId();

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

Attribute WorkspaceId: WorkspaceId is the workspace id which contains the experiment.

---