workflow.v1alpha1.artifactLocation

"ArtifactLocation describes a location for a single or multiple artifacts. It is used as single artifact in the context of inputs/outputs (e.g. outputs.artifacts.artname). It is also used to describe the location of multiple artifacts such as the archive location of a single workflow step, which the executor will use as a default location to store its files."

Fields

fn withArchiveLogs

withArchiveLogs(archiveLogs)

"ArchiveLogs indicates if the container logs should be archived"

obj artifactory

"ArtifactoryArtifact is the location of an artifactory artifact"

fn artifactory.withUrl

withUrl(url)

"URL of the artifact"

obj artifactory.passwordSecret

"SecretKeySelector selects a key of a Secret."

fn artifactory.passwordSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn artifactory.passwordSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn artifactory.passwordSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj artifactory.usernameSecret

"SecretKeySelector selects a key of a Secret."

fn artifactory.usernameSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn artifactory.usernameSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn artifactory.usernameSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj gcs

"GCSArtifact is the location of a GCS artifact"

fn gcs.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn gcs.withKey

withKey(key)

"Key is the path in the bucket where the artifact resides"

obj gcs.serviceAccountKeySecret

"SecretKeySelector selects a key of a Secret."

fn gcs.serviceAccountKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn gcs.serviceAccountKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn gcs.serviceAccountKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj git

"GitArtifact is the location of an git artifact"

fn git.withDepth

withDepth(depth)

"Depth specifies clones/fetches should be shallow and include the given number of commits from the branch tip"

fn git.withDisableSubmodules

withDisableSubmodules(disableSubmodules)

"DisableSubmodules disables submodules during git clone"

fn git.withFetch

withFetch(fetch)

"Fetch specifies a number of refs that should be fetched before checkout"

fn git.withFetchMixin

withFetchMixin(fetch)

"Fetch specifies a number of refs that should be fetched before checkout"

Note: This function appends passed data to existing values

fn git.withInsecureIgnoreHostKey

withInsecureIgnoreHostKey(insecureIgnoreHostKey)

"InsecureIgnoreHostKey disables SSH strict host key checking during git clone"

fn git.withRepo

withRepo(repo)

"Repo is the git repository"

fn git.withRevision

withRevision(revision)

"Revision is the git commit, tag, branch to checkout"

obj git.passwordSecret

"SecretKeySelector selects a key of a Secret."

fn git.passwordSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn git.passwordSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn git.passwordSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj git.sshPrivateKeySecret

"SecretKeySelector selects a key of a Secret."

fn git.sshPrivateKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn git.sshPrivateKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn git.sshPrivateKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj git.usernameSecret

"SecretKeySelector selects a key of a Secret."

fn git.usernameSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn git.usernameSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn git.usernameSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj hdfs

"HDFSArtifact is the location of an HDFS artifact"

fn hdfs.withAddresses

withAddresses(addresses)

"Addresses is accessible addresses of HDFS name nodes"

fn hdfs.withAddressesMixin

withAddressesMixin(addresses)

"Addresses is accessible addresses of HDFS name nodes"

Note: This function appends passed data to existing values

fn hdfs.withForce

withForce(force)

"Force copies a file forcibly even if it exists (default: false)"

fn hdfs.withHdfsUser

withHdfsUser(hdfsUser)

"HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used."

fn hdfs.withKrbRealm

withKrbRealm(krbRealm)

"KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used."

fn hdfs.withKrbServicePrincipalName

withKrbServicePrincipalName(krbServicePrincipalName)

"KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used."

fn hdfs.withKrbUsername

withKrbUsername(krbUsername)

"KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used."

fn hdfs.withPath

withPath(path)

"Path is a file path in HDFS"

obj hdfs.krbCCacheSecret

"SecretKeySelector selects a key of a Secret."

fn hdfs.krbCCacheSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn hdfs.krbCCacheSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn hdfs.krbCCacheSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj hdfs.krbConfigConfigMap

"Selects a key from a ConfigMap."

fn hdfs.krbConfigConfigMap.withKey

withKey(key)

"The key to select."

fn hdfs.krbConfigConfigMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn hdfs.krbConfigConfigMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj hdfs.krbKeytabSecret

"SecretKeySelector selects a key of a Secret."

fn hdfs.krbKeytabSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn hdfs.krbKeytabSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn hdfs.krbKeytabSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj http

"HTTPArtifact allows an file served on HTTP to be placed as an input artifact in a container"

fn http.withHeaders

withHeaders(headers)

"Headers are an optional list of headers to send with HTTP requests for artifacts"

fn http.withHeadersMixin

withHeadersMixin(headers)

"Headers are an optional list of headers to send with HTTP requests for artifacts"

Note: This function appends passed data to existing values

fn http.withUrl

withUrl(url)

"URL of the artifact"

obj oss

"OSSArtifact is the location of an Alibaba Cloud OSS artifact"

fn oss.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn oss.withCreateBucketIfNotPresent

withCreateBucketIfNotPresent(createBucketIfNotPresent)

"CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist"

fn oss.withEndpoint

withEndpoint(endpoint)

"Endpoint is the hostname of the bucket endpoint"

fn oss.withKey

withKey(key)

"Key is the path in the bucket where the artifact resides"

fn oss.withSecurityToken

withSecurityToken(securityToken)

"SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm"

obj oss.accessKeySecret

"SecretKeySelector selects a key of a Secret."

fn oss.accessKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn oss.accessKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn oss.accessKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj oss.lifecycleRule

"OSSLifecycleRule specifies how to manage bucket's lifecycle"

fn oss.lifecycleRule.withMarkDeletionAfterDays

withMarkDeletionAfterDays(markDeletionAfterDays)

"MarkDeletionAfterDays is the number of days before we delete objects in the bucket"

fn oss.lifecycleRule.withMarkInfrequentAccessAfterDays

withMarkInfrequentAccessAfterDays(markInfrequentAccessAfterDays)

"MarkInfrequentAccessAfterDays is the number of days before we convert the objects in the bucket to Infrequent Access (IA) storage type"

obj oss.secretKeySecret

"SecretKeySelector selects a key of a Secret."

fn oss.secretKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn oss.secretKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn oss.secretKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj raw

"RawArtifact allows raw string content to be placed as an artifact in a container"

fn raw.withData

withData(data)

"Data is the string contents of the artifact"

obj s3

"S3Artifact is the location of an S3 artifact"

fn s3.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn s3.withEndpoint

withEndpoint(endpoint)

"Endpoint is the hostname of the bucket endpoint"

fn s3.withInsecure

withInsecure(insecure)

"Insecure will connect to the service with TLS"

fn s3.withKey

withKey(key)

"Key is the key in the bucket where the artifact resides"

fn s3.withRegion

withRegion(region)

"Region contains the optional bucket region"

fn s3.withRoleARN

withRoleARN(roleARN)

"RoleARN is the Amazon Resource Name (ARN) of the role to assume."

fn s3.withUseSDKCreds

withUseSDKCreds(useSDKCreds)

"UseSDKCreds tells the driver to figure out credentials based on sdk defaults."

obj s3.accessKeySecret

"SecretKeySelector selects a key of a Secret."

fn s3.accessKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn s3.accessKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn s3.accessKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj s3.createBucketIfNotPresent

"CreateS3BucketOptions options used to determine automatic automatic bucket-creation process"

fn s3.createBucketIfNotPresent.withObjectLocking

withObjectLocking(objectLocking)

"ObjectLocking Enable object locking"

obj s3.secretKeySecret

"SecretKeySelector selects a key of a Secret."

fn s3.secretKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn s3.secretKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn s3.secretKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"