Skip to content

CloudAssembly

Represents a deployable cloud application.

Initializers 

import ros_cdk_cxapi
ros_cdk_cxapi.CloudAssembly(
  directory: str
)
Name Type Description
directory str The root directory of the assembly.

directoryRequired

  • Type: str

The root directory of the assembly.

Methods

Name Description
get_nested_assembly Returns a nested assembly.
get_nested_assembly_artifact Returns a nested assembly artifact.
get_stack Returns a ROS stack artifact by name from this assembly.
get_stack_artifact Returns a ROS stack artifact from this assembly.
get_stack_by_name Returns a ROS stack artifact from this assembly.
tree Returns the tree metadata artifact from this assembly.
try_get_artifact Attempts to find an artifact with a specific identity.

get_nested_assembly 

def get_nested_assembly(
  artifact_id: str
) -> CloudAssembly

Returns a nested assembly.

artifact_idRequired

  • Type: str

The artifact ID of the nested assembly.

get_nested_assembly_artifact 

def get_nested_assembly_artifact(
  artifact_id: str
) -> NestedCloudAssemblyArtifact

Returns a nested assembly artifact.

artifact_idRequired

  • Type: str

The artifact ID of the nested assembly.

get_stack 

def get_stack(
  stack_name: str
) -> RosStackArtifact

Returns a ROS stack artifact by name from this assembly.

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

stack_nameRequired

  • Type: str

get_stack_artifact 

def get_stack_artifact(
  artifact_id: str
) -> RosStackArtifact

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.

artifact_idRequired

  • Type: str

get_stack_by_name 

def get_stack_by_name(
  stack_name: str
) -> RosStackArtifact

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.

stack_nameRequired

  • Type: str

tree 

def tree() -> TreeCloudArtifact

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.

try_get_artifact 

def try_get_artifact(
  id: str
) -> CloudArtifact

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

idRequired

  • Type: str

Properties

Name Type Description
artifacts typing.List[CloudArtifact] All artifacts included in this assembly.
directory str The root directory of the cloud assembly.
manifest ros_cdk_assembly_schema.AssemblyManifest The raw assembly manifest.
runtime ros_cdk_assembly_schema.RuntimeInfo Runtime information such as module versions used to synthesize this assembly.
stacks typing.List[RosStackArtifact] No description.
version str The schema version of the assembly manifest.

artifactsRequired 

artifacts: typing.List[CloudArtifact]

All artifacts included in this assembly.

directoryRequired 

directory: str
  • Type: str

The root directory of the cloud assembly.

manifestRequired 

manifest: AssemblyManifest
  • Type: ros_cdk_assembly_schema.AssemblyManifest

The raw assembly manifest.

runtimeRequired 

runtime: RuntimeInfo
  • Type: ros_cdk_assembly_schema.RuntimeInfo

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

stacksRequired 

stacks: typing.List[RosStackArtifact]

versionRequired 

version: str
  • Type: str

The schema version of the assembly manifest.