Package io.github.cdklabs.projen.github

Interface UploadArtifactWith

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UploadArtifactWith.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.092Z")
@Stability(Experimental)
public interface UploadArtifactWith
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	UploadArtifactWith.Builder	A builder for UploadArtifactWith
static class	UploadArtifactWith.Jsii$Proxy	An implementation for UploadArtifactWith

Method Summary

Modifier and Type	Method	Description
static UploadArtifactWith.Builder	builder()
default Number	getCompressionLevel()	(experimental) The level of compression for Zlib to be applied to the artifact archive.
default String	getIfNoFilesFound()	(experimental) The desired behavior if no files are found using the provided path.
default String	getName()	(experimental) Name of the artifact to upload.
default Boolean	getOverwrite()	(experimental) Whether action should overwrite an existing artifact with the same name (should one exist).
String	getPath()	(experimental) A file, directory or wildcard pattern that describes what to upload.
default Number	getRetentionDays()	(experimental) Duration after which artifact will expire in days.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPath

@Stability(Experimental)
@NotNull
String getPath()

(experimental) A file, directory or wildcard pattern that describes what to upload.

getCompressionLevel

@Stability(Experimental)
@Nullable
default Number getCompressionLevel()

(experimental) The level of compression for Zlib to be applied to the artifact archive.

The value can range from 0 to 9. For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.

Default: 6

getIfNoFilesFound

@Stability(Experimental)
@Nullable
default String getIfNoFilesFound()

(experimental) The desired behavior if no files are found using the provided path.

Available Options: warn: Output a warning but do not fail the action error: Fail the action with an error message ignore: Do not output any warnings or errors, the action does not fail

Default: "warn"

getName

@Stability(Experimental)
@Nullable
default String getName()

(experimental) Name of the artifact to upload.

Default: "artifact"

getOverwrite

@Stability(Experimental)
@Nullable
default Boolean getOverwrite()

(experimental) Whether action should overwrite an existing artifact with the same name (should one exist).

Introduced in v4 and represents a breaking change from the behavior of the v3 action. To maintain backwards compatibility with existing, this should be set the true (the default).

Default: true

getRetentionDays

@Stability(Experimental)
@Nullable
default Number getRetentionDays()

(experimental) Duration after which artifact will expire in days. 0 means using default repository retention.

Minimum 1 day. Maximum 90 days unless changed from the repository settings page.

Default: - The default repository retention

builder

@Stability(Experimental)
static UploadArtifactWith.Builder builder()

Returns:

a UploadArtifactWith.Builder of UploadArtifactWith