Workspace

This class encapsulates and extends the ROS resource type DATASOURCE::PAI::Workspace, which is used to query the information about a Platform for AI (PAI) workspace.

Initializers

import com.aliyun.ros.cdk.pai.datasource.Workspace;
Workspace.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .workspaceId(java.lang.String)
    .workspaceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
workspaceId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property workspaceId: The ID of the workspace.
refreshOptions	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

workspaceId^Required

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

Property workspaceId: The ID of the workspace.

---

refreshOptions^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

---

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.datasource.Workspace;
Workspace.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.
attrAdminNames	com.aliyun.ros.cdk.core.IResolvable	Attribute AdminNames: List of administrator account names.
attrCreator	com.aliyun.ros.cdk.core.IResolvable	Attribute Creator: The user ID of the creator.
attrDescription	com.aliyun.ros.cdk.core.IResolvable	Attribute Description: The description of the workspace.
attrDisplayName	com.aliyun.ros.cdk.core.IResolvable	Attribute DisplayName: The display name of the workspace.
attrEnvTypes	com.aliyun.ros.cdk.core.IResolvable	Attribute EnvTypes: The environments of the workspace.
attrExtraInfos	com.aliyun.ros.cdk.core.IResolvable	Attribute ExtraInfos: Additional information, currently including TenantId (tenant ID).
attrIsDefault	com.aliyun.ros.cdk.core.IResolvable	Attribute IsDefault: Default Workspace.
attrUsers	com.aliyun.ros.cdk.core.IResolvable	Attribute Users: List of users.
attrWorkspaceId	com.aliyun.ros.cdk.core.IResolvable	Attribute WorkspaceId: The first ID of the resource.
attrWorkspaceName	com.aliyun.ros.cdk.core.IResolvable	Attribute WorkspaceName: The name of the workspace.

---

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

---

attrAdminNames^Required

public IResolvable getAttrAdminNames();

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

Attribute AdminNames: List of administrator account names.

---

attrCreator^Required

public IResolvable getAttrCreator();

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

Attribute Creator: The user ID of the creator.

---

attrDescription^Required

public IResolvable getAttrDescription();

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

Attribute Description: The description of the workspace.

---

attrDisplayName^Required

public IResolvable getAttrDisplayName();

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

Attribute DisplayName: The display name of the workspace.

---

attrEnvTypes^Required

public IResolvable getAttrEnvTypes();

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

Attribute EnvTypes: The environments of the workspace.

---

attrExtraInfos^Required

public IResolvable getAttrExtraInfos();

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

Attribute ExtraInfos: Additional information, currently including TenantId (tenant ID).

---

attrIsDefault^Required

public IResolvable getAttrIsDefault();

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

Attribute IsDefault: Default Workspace.

---

attrUsers^Required

public IResolvable getAttrUsers();

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

Attribute Users: List of users.

---

attrWorkspaceId^Required

public IResolvable getAttrWorkspaceId();

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

Attribute WorkspaceId: The first ID of the resource.

---

attrWorkspaceName^Required

public IResolvable getAttrWorkspaceName();

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

Attribute WorkspaceName: The name of the workspace.

---