Skip to content

FileAssetSource

Represents the source for a file asset.

Initializer 

import ros_cdk_core
ros_cdk_core.FileAssetSource(
  source_hash: str,
  deploy_time: bool = None,
  executable: typing.List[str] = None,
  file_name: str = None,
  packaging: FileAssetPackaging = None
)

Properties

Name Type Description
source_hash str A hash on the content source.
deploy_time bool Whether or not the asset needs to exist beyond deployment time;
executable typing.List[str] An external command that will produce the packaged asset.
file_name str The path, relative to the root of the cloud assembly, in which this asset source resides.
packaging FileAssetPackaging Which type of packaging to perform.

source_hashRequired 

source_hash: str
  • Type: str

A hash on the content source.

This hash is used to uniquely identify this asset throughout the system. If this value doesn't change, the asset will not be rebuilt or republished.

deploy_timeOptional 

deploy_time: bool
  • Type: bool
  • Default: false

Whether or not the asset needs to exist beyond deployment time;

i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the ROS deployment succeeds.

For example, FC Function assets are copied over to FC during deployment. Therefore, it is not necessary to store the asset in OSS bucket, so we consider those deployTime assets.

executableOptional 

executable: typing.List[str]
  • Type: typing.List[str]
  • Default: Exactly one of fileName and executable is required

An external command that will produce the packaged asset.

The command should produce the location of a ZIP file on stdout.

file_nameOptional 

file_name: str
  • Type: str
  • Default: Exactly one of fileName and executable is required

The path, relative to the root of the cloud assembly, in which this asset source resides.

This can be a path to a file or a directory, depending on the packaging type.

packagingOptional 

packaging: FileAssetPackaging

Which type of packaging to perform.