CloudAssembly

Represents a deployable cloud application.

Initializers

import com.aliyun.ros.cdk.cxapi.CloudAssembly;
new CloudAssembly(java.lang.String directory);

Name	Type	Description
directory	java.lang.String	The root directory of the assembly.

---

directory^Required

• Type: java.lang.String

The root directory of the assembly.

---

Methods

Name	Description
getNestedAssembly	Returns a nested assembly.
getNestedAssemblyArtifact	Returns a nested assembly artifact.
getStack	Returns a ROS stack artifact by name from this assembly.
getStackArtifact	Returns a ROS stack artifact from this assembly.
getStackByName	Returns a ROS stack artifact from this assembly.
tree	Returns the tree metadata artifact from this assembly.
tryGetArtifact	Attempts to find an artifact with a specific identity.

---

getNestedAssembly

public CloudAssembly getNestedAssembly(java.lang.String artifactId)

Returns a nested assembly.

artifactId^Required

• Type: java.lang.String

The artifact ID of the nested assembly.

---

getNestedAssemblyArtifact

public NestedCloudAssemblyArtifact getNestedAssemblyArtifact(java.lang.String artifactId)

Returns a nested assembly artifact.

artifactId^Required

• Type: java.lang.String

The artifact ID of the nested assembly.

---

getStack

public RosStackArtifact getStack(java.lang.String stackName)

Returns a ROS stack artifact by name from this assembly.

Deprecated renamed to 'getStackByName' (or 'getStackArtifact(id)')

stackName^Required

• Type: java.lang.String

---

getStackArtifact

public RosStackArtifact getStackArtifact(java.lang.String artifactId)

Returns a ROS stack artifact from this assembly.

Param artifactId the artifact id of the stack (can be obtained through 'stack.artifactId'). Throws if there is no stack artifact with that id Returns a 'RosStackArtifact' object.

artifactId^Required

• Type: java.lang.String

---

getStackByName

public RosStackArtifact getStackByName(java.lang.String stackName)

Returns a ROS stack artifact from this assembly.

Will only search the current assembly.

Param stackName the name of the ROS stack. Throws if there is no stack artifact by that name Throws if there is more than one stack with the same stack name. You can use 'getStackArtifact - stack.artifactId' instead. Returns a 'RosStackArtifact' object.

stackName^Required

• Type: java.lang.String

---

tree

public TreeCloudArtifact tree()

Returns the tree metadata artifact from this assembly.

Throws if there is no metadata artifact by that name Returns a 'TreeCloudArtifact' object if there is one defined in the manifest, 'undefined' otherwise.

tryGetArtifact

public CloudArtifact tryGetArtifact(java.lang.String id)

Attempts to find an artifact with a specific identity.

Returns A 'CloudArtifact' object or 'undefined' if the artifact does not exist in this assembly. Param id The artifact ID

id^Required

• Type: java.lang.String

---

Properties

Name	Type	Description
artifacts	java.util.List<CloudArtifact>	All artifacts included in this assembly.
directory	java.lang.String	The root directory of the cloud assembly.
manifest	com.aliyun.ros.cdk.assembly.schema.AssemblyManifest	The raw assembly manifest.
runtime	com.aliyun.ros.cdk.assembly.schema.RuntimeInfo	Runtime information such as module versions used to synthesize this assembly.
stacks	java.util.List<RosStackArtifact>	No description.
version	java.lang.String	The schema version of the assembly manifest.

---

artifacts^Required

public java.util.List<CloudArtifact> getArtifacts();

• Type: java.util.List<CloudArtifact>

All artifacts included in this assembly.

---

directory^Required

public java.lang.String getDirectory();

• Type: java.lang.String

The root directory of the cloud assembly.

---

manifest^Required

public AssemblyManifest getManifest();

• Type: com.aliyun.ros.cdk.assembly.schema.AssemblyManifest

The raw assembly manifest.

---

runtime^Required

public RuntimeInfo getRuntime();

• Type: com.aliyun.ros.cdk.assembly.schema.RuntimeInfo

Runtime information such as module versions used to synthesize this assembly.

---

stacks^Required

public java.util.List<RosStackArtifact> getStacks();

• Type: java.util.List<RosStackArtifact>

---

version^Required

public java.lang.String getVersion();

• Type: java.lang.String

The schema version of the assembly manifest.

---