workflow.v1alpha1.artifactNodeSpec

"ArtifactNodeSpec specifies the Artifacts that need to be deleted for a given Node"

Index

fn withArtifacts(artifacts)
fn withArtifactsMixin(artifacts)
obj archiveLocation

Fields

fn withArtifacts

withArtifacts(artifacts)

"Artifacts maps artifact name to Artifact description"

fn withArtifactsMixin

withArtifactsMixin(artifacts)

"Artifacts maps artifact name to Artifact description"

Note: This function appends passed data to existing values

obj archiveLocation

"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."

fn archiveLocation.withArchiveLogs

withArchiveLogs(archiveLogs)

"ArchiveLogs indicates if the container logs should be archived"

obj archiveLocation.artifactory

"ArtifactoryArtifact is the location of an artifactory artifact"

fn archiveLocation.artifactory.withUrl

withUrl(url)

"URL of the artifact"

obj archiveLocation.artifactory.passwordSecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.artifactory.passwordSecret.withKey

withKey(key)

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

fn archiveLocation.artifactory.passwordSecret.withName

withName(name)

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

fn archiveLocation.artifactory.passwordSecret.withOptional

withOptional(optional)

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

obj archiveLocation.artifactory.usernameSecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.artifactory.usernameSecret.withKey

withKey(key)

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

fn archiveLocation.artifactory.usernameSecret.withName

withName(name)

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

fn archiveLocation.artifactory.usernameSecret.withOptional

withOptional(optional)

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

obj archiveLocation.azure

"AzureArtifact is the location of a an Azure Storage artifact"

fn archiveLocation.azure.withBlob

withBlob(blob)

"Blob is the blob name (i.e., path) in the container where the artifact resides"

fn archiveLocation.azure.withContainer

withContainer(container)

"Container is the container where resources will be stored"

fn archiveLocation.azure.withEndpoint

withEndpoint(endpoint)

"Endpoint is the service url associated with an account. It is most likely \"https://.blob.core.windows.net\

fn archiveLocation.azure.withUseSDKCreds

withUseSDKCreds(useSDKCreds)

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

obj archiveLocation.azure.accountKeySecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.azure.accountKeySecret.withKey

withKey(key)

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

fn archiveLocation.azure.accountKeySecret.withName

withName(name)

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

fn archiveLocation.azure.accountKeySecret.withOptional

withOptional(optional)

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

obj archiveLocation.gcs

"GCSArtifact is the location of a GCS artifact"

fn archiveLocation.gcs.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn archiveLocation.gcs.withKey

withKey(key)

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

obj archiveLocation.gcs.serviceAccountKeySecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.gcs.serviceAccountKeySecret.withKey

withKey(key)

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

fn archiveLocation.gcs.serviceAccountKeySecret.withName

withName(name)

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

fn archiveLocation.gcs.serviceAccountKeySecret.withOptional

withOptional(optional)

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

obj archiveLocation.git

"GitArtifact is the location of an git artifact"

fn archiveLocation.git.withBranch

withBranch(branch)

"Branch is the branch to fetch when SingleBranch is enabled"

fn archiveLocation.git.withDepth

withDepth(depth)

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

fn archiveLocation.git.withDisableSubmodules

withDisableSubmodules(disableSubmodules)

"DisableSubmodules disables submodules during git clone"

fn archiveLocation.git.withFetch

withFetch(fetch)

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

fn archiveLocation.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 archiveLocation.git.withInsecureIgnoreHostKey

withInsecureIgnoreHostKey(insecureIgnoreHostKey)

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

fn archiveLocation.git.withRepo

withRepo(repo)

"Repo is the git repository"

fn archiveLocation.git.withRevision

withRevision(revision)

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

fn archiveLocation.git.withSingleBranch

withSingleBranch(singleBranch)

"SingleBranch enables single branch clone, using the branch parameter"

obj archiveLocation.git.passwordSecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.git.passwordSecret.withKey

withKey(key)

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

fn archiveLocation.git.passwordSecret.withName

withName(name)

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

fn archiveLocation.git.passwordSecret.withOptional

withOptional(optional)

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

obj archiveLocation.git.sshPrivateKeySecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.git.sshPrivateKeySecret.withKey

withKey(key)

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

fn archiveLocation.git.sshPrivateKeySecret.withName

withName(name)

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

fn archiveLocation.git.sshPrivateKeySecret.withOptional

withOptional(optional)

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

obj archiveLocation.git.usernameSecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.git.usernameSecret.withKey

withKey(key)

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

fn archiveLocation.git.usernameSecret.withName

withName(name)

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

fn archiveLocation.git.usernameSecret.withOptional

withOptional(optional)

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

obj archiveLocation.hdfs

"HDFSArtifact is the location of an HDFS artifact"

fn archiveLocation.hdfs.withAddresses

withAddresses(addresses)

"Addresses is accessible addresses of HDFS name nodes"

fn archiveLocation.hdfs.withAddressesMixin

withAddressesMixin(addresses)

"Addresses is accessible addresses of HDFS name nodes"

Note: This function appends passed data to existing values

fn archiveLocation.hdfs.withForce

withForce(force)

"Force copies a file forcibly even if it exists"

fn archiveLocation.hdfs.withHdfsUser

withHdfsUser(hdfsUser)

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

fn archiveLocation.hdfs.withKrbRealm

withKrbRealm(krbRealm)

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

fn archiveLocation.hdfs.withKrbServicePrincipalName

withKrbServicePrincipalName(krbServicePrincipalName)

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

fn archiveLocation.hdfs.withKrbUsername

withKrbUsername(krbUsername)

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

fn archiveLocation.hdfs.withPath

withPath(path)

"Path is a file path in HDFS"

obj archiveLocation.hdfs.krbCCacheSecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.hdfs.krbCCacheSecret.withKey

withKey(key)

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

fn archiveLocation.hdfs.krbCCacheSecret.withName

withName(name)

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

fn archiveLocation.hdfs.krbCCacheSecret.withOptional

withOptional(optional)

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

obj archiveLocation.hdfs.krbConfigConfigMap

"Selects a key from a ConfigMap."

fn archiveLocation.hdfs.krbConfigConfigMap.withKey

withKey(key)

"The key to select."

fn archiveLocation.hdfs.krbConfigConfigMap.withName

withName(name)

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

fn archiveLocation.hdfs.krbConfigConfigMap.withOptional

withOptional(optional)

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

obj archiveLocation.hdfs.krbKeytabSecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.hdfs.krbKeytabSecret.withKey

withKey(key)

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

fn archiveLocation.hdfs.krbKeytabSecret.withName

withName(name)

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

fn archiveLocation.hdfs.krbKeytabSecret.withOptional

withOptional(optional)

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

obj archiveLocation.http

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

fn archiveLocation.http.withHeaders

withHeaders(headers)

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

fn archiveLocation.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 archiveLocation.http.withUrl

withUrl(url)

"URL of the artifact"

obj archiveLocation.http.auth

obj archiveLocation.http.auth.basicAuth

"BasicAuth describes the secret selectors required for basic authentication"

obj archiveLocation.http.auth.basicAuth.passwordSecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.http.auth.basicAuth.passwordSecret.withKey

withKey(key)

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

fn archiveLocation.http.auth.basicAuth.passwordSecret.withName

withName(name)

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

fn archiveLocation.http.auth.basicAuth.passwordSecret.withOptional

withOptional(optional)

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

obj archiveLocation.http.auth.basicAuth.usernameSecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.http.auth.basicAuth.usernameSecret.withKey

withKey(key)

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

fn archiveLocation.http.auth.basicAuth.usernameSecret.withName

withName(name)

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

fn archiveLocation.http.auth.basicAuth.usernameSecret.withOptional

withOptional(optional)

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

obj archiveLocation.http.auth.clientCert

"ClientCertAuth holds necessary information for client authentication via certificates"

obj archiveLocation.http.auth.clientCert.clientCertSecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.http.auth.clientCert.clientCertSecret.withKey

withKey(key)

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

fn archiveLocation.http.auth.clientCert.clientCertSecret.withName

withName(name)

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

fn archiveLocation.http.auth.clientCert.clientCertSecret.withOptional

withOptional(optional)

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

obj archiveLocation.http.auth.clientCert.clientKeySecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.http.auth.clientCert.clientKeySecret.withKey

withKey(key)

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

fn archiveLocation.http.auth.clientCert.clientKeySecret.withName

withName(name)

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

fn archiveLocation.http.auth.clientCert.clientKeySecret.withOptional

withOptional(optional)

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

obj archiveLocation.http.auth.oauth2

"OAuth2Auth holds all information for client authentication via OAuth2 tokens"

fn archiveLocation.http.auth.oauth2.withEndpointParams

withEndpointParams(endpointParams)

fn archiveLocation.http.auth.oauth2.withEndpointParamsMixin

withEndpointParamsMixin(endpointParams)

Note: This function appends passed data to existing values

fn archiveLocation.http.auth.oauth2.withScopes

withScopes(scopes)

fn archiveLocation.http.auth.oauth2.withScopesMixin

withScopesMixin(scopes)

Note: This function appends passed data to existing values

obj archiveLocation.http.auth.oauth2.clientIDSecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.http.auth.oauth2.clientIDSecret.withKey

withKey(key)

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

fn archiveLocation.http.auth.oauth2.clientIDSecret.withName

withName(name)

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

fn archiveLocation.http.auth.oauth2.clientIDSecret.withOptional

withOptional(optional)

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

obj archiveLocation.http.auth.oauth2.clientSecretSecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.http.auth.oauth2.clientSecretSecret.withKey

withKey(key)

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

fn archiveLocation.http.auth.oauth2.clientSecretSecret.withName

withName(name)

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

fn archiveLocation.http.auth.oauth2.clientSecretSecret.withOptional

withOptional(optional)

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

obj archiveLocation.http.auth.oauth2.tokenURLSecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.http.auth.oauth2.tokenURLSecret.withKey

withKey(key)

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

fn archiveLocation.http.auth.oauth2.tokenURLSecret.withName

withName(name)

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

fn archiveLocation.http.auth.oauth2.tokenURLSecret.withOptional

withOptional(optional)

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

obj archiveLocation.oss

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

fn archiveLocation.oss.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn archiveLocation.oss.withCreateBucketIfNotPresent

withCreateBucketIfNotPresent(createBucketIfNotPresent)

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

fn archiveLocation.oss.withEndpoint

withEndpoint(endpoint)

"Endpoint is the hostname of the bucket endpoint"

fn archiveLocation.oss.withKey

withKey(key)

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

fn archiveLocation.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"

fn archiveLocation.oss.withUseSDKCreds

withUseSDKCreds(useSDKCreds)

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

obj archiveLocation.oss.accessKeySecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.oss.accessKeySecret.withKey

withKey(key)

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

fn archiveLocation.oss.accessKeySecret.withName

withName(name)

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

fn archiveLocation.oss.accessKeySecret.withOptional

withOptional(optional)

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

obj archiveLocation.oss.lifecycleRule

"OSSLifecycleRule specifies how to manage bucket's lifecycle"

fn archiveLocation.oss.lifecycleRule.withMarkDeletionAfterDays

withMarkDeletionAfterDays(markDeletionAfterDays)

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

fn archiveLocation.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 archiveLocation.oss.secretKeySecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.oss.secretKeySecret.withKey

withKey(key)

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

fn archiveLocation.oss.secretKeySecret.withName

withName(name)

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

fn archiveLocation.oss.secretKeySecret.withOptional

withOptional(optional)

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

obj archiveLocation.raw

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

fn archiveLocation.raw.withData

withData(data)

"Data is the string contents of the artifact"

obj archiveLocation.s3

"S3Artifact is the location of an S3 artifact"

fn archiveLocation.s3.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn archiveLocation.s3.withEndpoint

withEndpoint(endpoint)

"Endpoint is the hostname of the bucket endpoint"

fn archiveLocation.s3.withInsecure

withInsecure(insecure)

"Insecure will connect to the service with TLS"

fn archiveLocation.s3.withKey

withKey(key)

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

fn archiveLocation.s3.withRegion

withRegion(region)

"Region contains the optional bucket region"

fn archiveLocation.s3.withRoleARN

withRoleARN(roleARN)

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

fn archiveLocation.s3.withUseSDKCreds

withUseSDKCreds(useSDKCreds)

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

obj archiveLocation.s3.accessKeySecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.s3.accessKeySecret.withKey

withKey(key)

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

fn archiveLocation.s3.accessKeySecret.withName

withName(name)

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

fn archiveLocation.s3.accessKeySecret.withOptional

withOptional(optional)

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

obj archiveLocation.s3.caSecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.s3.caSecret.withKey

withKey(key)

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

fn archiveLocation.s3.caSecret.withName

withName(name)

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

fn archiveLocation.s3.caSecret.withOptional

withOptional(optional)

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

obj archiveLocation.s3.createBucketIfNotPresent

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

fn archiveLocation.s3.createBucketIfNotPresent.withObjectLocking

withObjectLocking(objectLocking)

"ObjectLocking Enable object locking"

obj archiveLocation.s3.encryptionOptions

"S3EncryptionOptions used to determine encryption options during s3 operations"

fn archiveLocation.s3.encryptionOptions.withEnableEncryption

withEnableEncryption(enableEncryption)

"EnableEncryption tells the driver to encrypt objects if set to true. If kmsKeyId and serverSideCustomerKeySecret are not set, SSE-S3 will be used"

fn archiveLocation.s3.encryptionOptions.withKmsEncryptionContext

withKmsEncryptionContext(kmsEncryptionContext)

"KmsEncryptionContext is a json blob that contains an encryption context. See https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context for more information"

fn archiveLocation.s3.encryptionOptions.withKmsKeyId

withKmsKeyId(kmsKeyId)

"KMSKeyId tells the driver to encrypt the object using the specified KMS Key."

obj archiveLocation.s3.encryptionOptions.serverSideCustomerKeySecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.s3.encryptionOptions.serverSideCustomerKeySecret.withKey

withKey(key)

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

fn archiveLocation.s3.encryptionOptions.serverSideCustomerKeySecret.withName

withName(name)

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

fn archiveLocation.s3.encryptionOptions.serverSideCustomerKeySecret.withOptional

withOptional(optional)

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

obj archiveLocation.s3.secretKeySecret

"SecretKeySelector selects a key of a Secret."

fn archiveLocation.s3.secretKeySecret.withKey

withKey(key)

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

fn archiveLocation.s3.secretKeySecret.withName

withName(name)

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

fn archiveLocation.s3.secretKeySecret.withOptional

withOptional(optional)

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