RosStackArtifact
Initializers
import com.aliyun.ros.cdk.cxapi.RosStackArtifact;
RosStackArtifact.Builder.create(CloudAssembly assembly, java.lang.String artifactId)
.type(ArtifactType)
// .dependencies(java.util.List<java.lang.String>)
// .metadata(java.util.Map<java.lang.String, java.util.List<MetadataEntry>>)
// .properties(AliyunRosStackProperties)
// .properties(TreeArtifactProperties)
// .properties(NestedCloudAssemblyProperties)
.build();
| Name | Type | Description |
|---|---|---|
assembly |
CloudAssembly |
No description. |
artifactId |
java.lang.String |
No description. |
type |
com.aliyun.ros.cdk.assembly.schema.ArtifactType |
The type of artifact. |
dependencies |
java.util.List |
IDs of artifacts that must be deployed before this artifact. |
metadata |
java.util.Map |
Associated metadata. |
properties |
com.aliyun.ros.cdk.assembly.schema.AliyunRosStackProperties OR com.aliyun.ros.cdk.assembly.schema.TreeArtifactProperties OR com.aliyun.ros.cdk.assembly.schema.NestedCloudAssemblyProperties |
The set of properties for this artifact (depends on type). |
assemblyRequired
- Type: CloudAssembly
artifactIdRequired
- Type: java.lang.String
typeRequired
- Type: com.aliyun.ros.cdk.assembly.schema.ArtifactType
The type of artifact.
dependenciesOptional
- Type: java.util.List
- Default: no dependencies.
IDs of artifacts that must be deployed before this artifact.
metadataOptional
- Type: java.util.Map
> - Default: no metadata.
Associated metadata.
propertiesOptional
- Type: com.aliyun.ros.cdk.assembly.schema.AliyunRosStackProperties OR com.aliyun.ros.cdk.assembly.schema.TreeArtifactProperties OR com.aliyun.ros.cdk.assembly.schema.NestedCloudAssemblyProperties
- Default: no properties.
The set of properties for this artifact (depends on type).
Methods
| Name | Description |
|---|---|
findMetadataByType |
No description. |
findMetadataByType
public java.util.List<MetadataEntryResult> findMetadataByType(java.lang.String type)
- Type: java.lang.String
Static Functions
| Name | Description |
|---|---|
fromManifest |
Returns a subclass of CloudArtifact based on the artifact type defined in the artifact manifest. |
fromManifest
import com.aliyun.ros.cdk.cxapi.RosStackArtifact;
RosStackArtifact.fromManifest(CloudAssembly assembly, java.lang.String id, ArtifactManifest artifact)
Returns a subclass of CloudArtifact based on the artifact type defined in the artifact manifest.
- Type: CloudAssembly
The cloud assembly from which to load the artifact.
- Type: java.lang.String
The artifact ID.
- Type: com.aliyun.ros.cdk.assembly.schema.ArtifactManifest
The artifact manifest.
Properties
| Name | Type | Description |
|---|---|---|
assembly |
CloudAssembly |
No description. |
id |
java.lang.String |
No description. |
manifest |
com.aliyun.ros.cdk.assembly.schema.ArtifactManifest |
The artifact's manifest. |
messages |
java.util.List<SynthesisMessage> |
The set of messages extracted from the artifact's metadata. |
dependencies |
java.util.List<CloudArtifact> |
Returns all the artifacts that this artifact depends on. |
displayName |
java.lang.String |
A string that represents this stack. |
name |
java.lang.String |
The physical name of this stack. |
originalName |
java.lang.String |
The original name as defined in the CDK app. |
parameters |
java.util.Map |
ROS parameters to pass to the stack. |
stackName |
java.lang.String |
The physical name of this stack. |
tags |
java.lang.Object |
No description. |
template |
java.lang.Object |
The ROS template for this stack. |
templateFile |
java.lang.String |
The file name of the template. |
assemblyRequired
public CloudAssembly getAssembly();
- Type: CloudAssembly
idRequired
public java.lang.String getId();
- Type: java.lang.String
manifestRequired
public ArtifactManifest getManifest();
- Type: com.aliyun.ros.cdk.assembly.schema.ArtifactManifest
The artifact's manifest.
messagesRequired
public java.util.List<SynthesisMessage> getMessages();
- Type: java.util.List<SynthesisMessage>
The set of messages extracted from the artifact's metadata.
dependenciesOptional
public java.util.List<CloudArtifact> getDependencies();
- Type: java.util.List<CloudArtifact>
Returns all the artifacts that this artifact depends on.
displayNameRequired
public java.lang.String getDisplayName();
- Type: java.lang.String
A string that represents this stack.
Should only be used in user interfaces.
If the stackName and artifactId are the same, it will just return that. Otherwise,
it will return something like "
~~name~~Required
- Deprecated: renamed to
stackName
public java.lang.String getName();
- Type: java.lang.String
The physical name of this stack.
originalNameRequired
public java.lang.String getOriginalName();
- Type: java.lang.String
The original name as defined in the CDK app.
parametersRequired
public java.util.Map<java.lang.String, java.lang.String> getParameters();
- Type: java.util.Map
ROS parameters to pass to the stack.
stackNameRequired
public java.lang.String getStackName();
- Type: java.lang.String
The physical name of this stack.
tagsRequired
public java.lang.Object getTags();
- Type: java.lang.Object
templateRequired
public java.lang.Object getTemplate();
- Type: java.lang.Object
The ROS template for this stack.
templateFileRequired
public java.lang.String getTemplateFile();
- Type: java.lang.String
The file name of the template.