TreeCloudArtifact

Initializers

import ros_cdk_cxapi
ros_cdk_cxapi.TreeCloudArtifact(
  assembly: CloudAssembly,
  name: str,
  type: ArtifactType,
  dependencies: typing.List[str] = None,
  metadata: typing.Mapping[typing.List[MetadataEntry]] = None,
  properties: typing.Union[AliyunRosStackProperties, TreeArtifactProperties, NestedCloudAssemblyProperties] = None
)

Name	Type	Description
assembly	CloudAssembly	No description.
name	str	No description.
type	ros_cdk_assembly_schema.ArtifactType	The type of artifact.
dependencies	typing.List[str]	IDs of artifacts that must be deployed before this artifact.
metadata	typing.Mapping[typing.List[ros_cdk_assembly_schema.MetadataEntry]]	Associated metadata.
properties	typing.Union[ros_cdk_assembly_schema.AliyunRosStackProperties, ros_cdk_assembly_schema.TreeArtifactProperties, ros_cdk_assembly_schema.NestedCloudAssemblyProperties]	The set of properties for this artifact (depends on type).

---

assembly^Required

• Type: CloudAssembly

---

name^Required

• Type: str

---

type^Required

• Type: ros_cdk_assembly_schema.ArtifactType

The type of artifact.

---

dependencies^Optional

• Type: typing.List[str]
• Default: no dependencies.

IDs of artifacts that must be deployed before this artifact.

---

metadata^Optional

• Type: typing.Mapping[typing.List[ros_cdk_assembly_schema.MetadataEntry]]
• Default: no metadata.

Associated metadata.

---

properties^Optional

• Type: typing.Union[ros_cdk_assembly_schema.AliyunRosStackProperties, ros_cdk_assembly_schema.TreeArtifactProperties, ros_cdk_assembly_schema.NestedCloudAssemblyProperties]
• Default: no properties.

The set of properties for this artifact (depends on type).

---

Methods

Name	Description
find_metadata_by_type	No description.

---

find_metadata_by_type

def find_metadata_by_type(
  type: str
) -> typing.List[MetadataEntryResult]

type^Required

• Type: str

---

Static Functions

Name	Description
from_manifest	Returns a subclass of CloudArtifact based on the artifact type defined in the artifact manifest.

---

from_manifest

import ros_cdk_cxapi
ros_cdk_cxapi.TreeCloudArtifact.from_manifest(
  assembly: CloudAssembly,
  id: str,
  type: ArtifactType,
  dependencies: typing.List[str] = None,
  metadata: typing.Mapping[typing.List[MetadataEntry]] = None,
  properties: typing.Union[AliyunRosStackProperties, TreeArtifactProperties, NestedCloudAssemblyProperties] = None
)

Returns a subclass of CloudArtifact based on the artifact type defined in the artifact manifest.

assembly^Required

• Type: CloudAssembly

The cloud assembly from which to load the artifact.

---

id^Required

• Type: str

The artifact ID.

---

type^Required

• Type: ros_cdk_assembly_schema.ArtifactType

The type of artifact.

---

dependencies^Optional

• Type: typing.List[str]
• Default: no dependencies.

IDs of artifacts that must be deployed before this artifact.

---

metadata^Optional

• Type: typing.Mapping[typing.List[ros_cdk_assembly_schema.MetadataEntry]]
• Default: no metadata.

Associated metadata.

---

properties^Optional

• Type: typing.Union[ros_cdk_assembly_schema.AliyunRosStackProperties, ros_cdk_assembly_schema.TreeArtifactProperties, ros_cdk_assembly_schema.NestedCloudAssemblyProperties]
• Default: no properties.

The set of properties for this artifact (depends on type).

---

Properties

Name	Type	Description
assembly	CloudAssembly	No description.
id	str	No description.
manifest	ros_cdk_assembly_schema.ArtifactManifest	The artifact's manifest.
messages	typing.List[SynthesisMessage]	The set of messages extracted from the artifact's metadata.
dependencies	typing.List[CloudArtifact]	Returns all the artifacts that this artifact depends on.
file	str	No description.

---

assembly^Required

assembly: CloudAssembly

• Type: CloudAssembly

---

id^Required

id: str

• Type: str

---

manifest^Required

manifest: ArtifactManifest

• Type: ros_cdk_assembly_schema.ArtifactManifest

The artifact's manifest.

---

messages^Required

messages: typing.List[SynthesisMessage]

• Type: typing.List[SynthesisMessage]

The set of messages extracted from the artifact's metadata.

---

dependencies^Optional

dependencies: typing.List[CloudArtifact]

• Type: typing.List[CloudArtifact]

Returns all the artifacts that this artifact depends on.

---

file^Required

file: str

• Type: str

---

Protocols