AssetOptions
Initializer
using AlibabaCloud.SDK.ROS.CDK.Ossassets;
new AssetOptions {
string[] Exclude = null,
SymlinkFollowMode FollowSymlinks = null,
IgnoreMode IgnoreMode = null,
string AssetHash = null,
AssetHashType AssetHashType = null,
BundlingOptions Bundling = null,
bool DeployTime = null
};
Properties
Name | Type | Description |
---|---|---|
Exclude |
string[] |
File paths matching the patterns will be excluded. |
FollowSymlinks |
AlibabaCloud.SDK.ROS.CDK.Core.SymlinkFollowMode |
A strategy for how to handle symlinks. |
IgnoreMode |
AlibabaCloud.SDK.ROS.CDK.Core.IgnoreMode |
The ignore behavior to use for exclude patterns. |
AssetHash |
string |
Specify a custom hash for this asset. |
AssetHashType |
AlibabaCloud.SDK.ROS.CDK.Core.AssetHashType |
Specifies the type of hash to calculate for this asset. |
Bundling |
AlibabaCloud.SDK.ROS.CDK.Core.BundlingOptions |
Bundle the asset by executing a command in a Docker container or a custom bundling provider. |
DeployTime |
bool |
Whether or not the asset needs to exist beyond deployment time; |
Exclude
Optional
public string[] Exclude { get; set; }
- Type: string[]
- 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.
FollowSymlinks
Optional
public SymlinkFollowMode FollowSymlinks { get; set; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.SymlinkFollowMode
- Default: SymlinkFollowMode.NEVER
A strategy for how to handle symlinks.
IgnoreMode
Optional
public IgnoreMode IgnoreMode { get; set; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IgnoreMode
- Default: IgnoreMode.GLOB
The ignore behavior to use for exclude
patterns.
AssetHash
Optional
public string AssetHash { get; set; }
- Type: 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.
AssetHashType
Optional
public AssetHashType AssetHashType { get; set; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.AssetHashType
- Default: the default is
AssetHashType.SOURCE
, but ifassetHash
is explicitly specified this value defaults toAssetHashType.CUSTOM
.
Specifies the type of hash to calculate for this asset.
If assetHash
is configured, this option must be undefined
or
AssetHashType.CUSTOM
.
Bundling
Optional
public BundlingOptions Bundling { get; set; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.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.
DeployTime
Optional
public bool DeployTime { get; set; }
- 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 Function during deployment. Therefore, it is not necessary to store the asset in OSS bucket, so we consider those deployTime assets.