Skip to content

AssetStagingProps

Initialization properties for AssetStaging.

Initializer

import com.aliyun.ros.cdk.core.AssetStagingProps;
AssetStagingProps.builder()
//  .exclude(java.util.List<java.lang.String>)
//  .follow(SymlinkFollowMode)
//  .ignoreMode(IgnoreMode)
//  .extraHash(java.lang.String)
//  .assetHash(java.lang.String)
//  .assetHashType(AssetHashType)
//  .bundling(BundlingOptions)
    .sourcePath(java.lang.String)
    .build();

Properties

Name Type Description
exclude java.util.List File paths matching the patterns will be excluded.
follow SymlinkFollowMode A strategy for how to handle symlinks.
ignoreMode IgnoreMode The ignore behavior to use for exclude patterns.
extraHash java.lang.String Extra information to encode into the fingerprint (e.g. build instructions and other inputs).
assetHash java.lang.String Specify a custom hash for this asset.
assetHashType AssetHashType Specifies the type of hash to calculate for this asset.
bundling BundlingOptions Bundle the asset by executing a command in a Docker container or a custom bundling provider.
sourcePath java.lang.String The source file or directory to copy from.

excludeOptional

public java.util.List<java.lang.String> getExclude();
  • Type: java.util.List
  • Default: nothing is excluded

File paths matching the patterns will be excluded.

See ignoreMode to set the matching behavior. Has no effect on Assets bundled using the bundling property.


followOptional

public SymlinkFollowMode getFollow();

A strategy for how to handle symlinks.


ignoreModeOptional

public IgnoreMode getIgnoreMode();

The ignore behavior to use for exclude patterns.


extraHashOptional

public java.lang.String getExtraHash();
  • Type: java.lang.String
  • Default: hash is only based on source content

Extra information to encode into the fingerprint (e.g. build instructions and other inputs).


assetHashOptional

public java.lang.String getAssetHash();
  • Type: java.lang.String
  • Default: based on assetHashType

Specify a custom hash for this asset.

If assetHashType is set it must be set to AssetHashType.CUSTOM. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash.

NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to OSS bucket, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated.


assetHashTypeOptional

public AssetHashType getAssetHashType();
  • Type: AssetHashType
  • Default: the default is AssetHashType.SOURCE, but if assetHash is explicitly specified this value defaults to AssetHashType.CUSTOM.

Specifies the type of hash to calculate for this asset.

If assetHash is configured, this option must be undefined or AssetHashType.CUSTOM.


bundlingOptional

public BundlingOptions getBundling();
  • Type: BundlingOptions
  • Default: uploaded as-is to OSS bucket if the asset is a regular file or a .zip file, archived into a .zip file and uploaded to OSS bucket otherwise.

Bundle the asset by executing a command in a Docker container or a custom bundling provider.

The asset path will be mounted at /asset-input. The Docker container is responsible for putting content at /asset-output. The content at /asset-output will be zipped and used as the final asset.


sourcePathRequired

public java.lang.String getSourcePath();
  • Type: java.lang.String

The source file or directory to copy from.