Skip to content

Manifest

Protocol utility class.

Static Functions

Name Description
load Deprecated.
load_assembly_manifest Load and validates the cloud assembly manifest from file.
save Deprecated.
save_assembly_manifest Validates and saves the cloud assembly manifest to file.
version Fetch the current schema version number.

~~load~~

import ros_cdk_assembly_schema
ros_cdk_assembly_schema.Manifest.load(
  file_path: str
)

Deprecated.

file_pathRequired

  • Type: str

load_assembly_manifest

import ros_cdk_assembly_schema
ros_cdk_assembly_schema.Manifest.load_assembly_manifest(
  file_path: str
)

Load and validates the cloud assembly manifest from file.

file_pathRequired

  • Type: str

path to the manifest file.


~~save~~

import ros_cdk_assembly_schema
ros_cdk_assembly_schema.Manifest.save(
  version: str,
  artifacts: typing.Mapping[ArtifactManifest] = None,
  missing: typing.List[MissingContext] = None,
  runtime: RuntimeInfo = None,
  file_path: str
)

Deprecated.

versionRequired

  • Type: str

Protocol version.


artifactsOptional

The set of artifacts in this assembly.


missingOptional

Missing context information.

If this field has values, it means that the cloud assembly is not complete and should not be deployed.


runtimeOptional

Runtime information.


file_pathRequired

  • Type: str

save_assembly_manifest

import ros_cdk_assembly_schema
ros_cdk_assembly_schema.Manifest.save_assembly_manifest(
  version: str,
  artifacts: typing.Mapping[ArtifactManifest] = None,
  missing: typing.List[MissingContext] = None,
  runtime: RuntimeInfo = None,
  file_path: str
)

Validates and saves the cloud assembly manifest to file.

versionRequired

  • Type: str

Protocol version.


artifactsOptional

The set of artifacts in this assembly.


missingOptional

Missing context information.

If this field has values, it means that the cloud assembly is not complete and should not be deployed.


runtimeOptional

Runtime information.


file_pathRequired

  • Type: str

output file path.


version

import ros_cdk_assembly_schema
ros_cdk_assembly_schema.Manifest.version()

Fetch the current schema version number.

Enums