cloudrun.v1beta1.v2Job
"V2Job is the Schema for the V2Jobs API. A Cloud Run Job resource that references a container image which is run to completion."
Index
fn new(name)obj metadatafn withAnnotations(annotations)fn withAnnotationsMixin(annotations)fn withClusterName(clusterName)fn withCreationTimestamp(creationTimestamp)fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)fn withDeletionTimestamp(deletionTimestamp)fn withFinalizers(finalizers)fn withFinalizersMixin(finalizers)fn withGenerateName(generateName)fn withGeneration(generation)fn withLabels(labels)fn withLabelsMixin(labels)fn withName(name)fn withNamespace(namespace)fn withOwnerReferences(ownerReferences)fn withOwnerReferencesMixin(ownerReferences)fn withResourceVersion(resourceVersion)fn withSelfLink(selfLink)fn withUid(uid)
obj specfn withDeletionPolicy(deletionPolicy)fn withManagementPolicies(managementPolicies)fn withManagementPoliciesMixin(managementPolicies)obj spec.forProviderfn withBinaryAuthorization(binaryAuthorization)fn withBinaryAuthorizationMixin(binaryAuthorization)fn withClient(client)fn withClientVersion(clientVersion)fn withLabels(labels)fn withLabelsMixin(labels)fn withLaunchStage(launchStage)fn withLocation(location)fn withProject(project)fn withTemplate(template)fn withTemplateMixin(template)obj spec.forProvider.binaryAuthorizationobj spec.forProvider.templatefn withLabels(labels)fn withLabelsMixin(labels)fn withParallelism(parallelism)fn withTaskCount(taskCount)fn withTemplate(template)fn withTemplateMixin(template)obj spec.forProvider.template.templatefn withContainers(containers)fn withContainersMixin(containers)fn withEncryptionKey(encryptionKey)fn withExecutionEnvironment(executionEnvironment)fn withMaxRetries(maxRetries)fn withServiceAccount(serviceAccount)fn withTimeout(timeout)fn withVolumes(volumes)fn withVolumesMixin(volumes)fn withVpcAccess(vpcAccess)fn withVpcAccessMixin(vpcAccess)obj spec.forProvider.template.template.containersfn withArgs(args)fn withArgsMixin(args)fn withCommand(command)fn withCommandMixin(command)fn withEnv(env)fn withEnvMixin(env)fn withImage(image)fn withLivenessProbe(livenessProbe)fn withLivenessProbeMixin(livenessProbe)fn withName(name)fn withPorts(ports)fn withPortsMixin(ports)fn withResources(resources)fn withResourcesMixin(resources)fn withStartupProbe(startupProbe)fn withStartupProbeMixin(startupProbe)fn withVolumeMounts(volumeMounts)fn withVolumeMountsMixin(volumeMounts)fn withWorkingDir(workingDir)obj spec.forProvider.template.template.containers.envfn withName(name)fn withValue(value)fn withValueSource(valueSource)fn withValueSourceMixin(valueSource)obj spec.forProvider.template.template.containers.env.valueSourcefn withSecretKeyRef(secretKeyRef)fn withSecretKeyRefMixin(secretKeyRef)obj spec.forProvider.template.template.containers.env.valueSource.secretKeyRef
obj spec.forProvider.template.template.containers.livenessProbefn withFailureThreshold(failureThreshold)fn withHttpGet(httpGet)fn withHttpGetMixin(httpGet)fn withInitialDelaySeconds(initialDelaySeconds)fn withPeriodSeconds(periodSeconds)fn withTcpSocket(tcpSocket)fn withTcpSocketMixin(tcpSocket)fn withTimeoutSeconds(timeoutSeconds)obj spec.forProvider.template.template.containers.livenessProbe.httpGetobj spec.forProvider.template.template.containers.livenessProbe.tcpSocket
obj spec.forProvider.template.template.containers.portsobj spec.forProvider.template.template.containers.resourcesobj spec.forProvider.template.template.containers.startupProbefn withFailureThreshold(failureThreshold)fn withHttpGet(httpGet)fn withHttpGetMixin(httpGet)fn withInitialDelaySeconds(initialDelaySeconds)fn withPeriodSeconds(periodSeconds)fn withTcpSocket(tcpSocket)fn withTcpSocketMixin(tcpSocket)fn withTimeoutSeconds(timeoutSeconds)obj spec.forProvider.template.template.containers.startupProbe.httpGetobj spec.forProvider.template.template.containers.startupProbe.tcpSocket
obj spec.forProvider.template.template.containers.volumeMounts
obj spec.forProvider.template.template.volumesfn withCloudSqlInstance(cloudSqlInstance)fn withCloudSqlInstanceMixin(cloudSqlInstance)fn withName(name)fn withSecret(secret)fn withSecretMixin(secret)obj spec.forProvider.template.template.volumes.cloudSqlInstanceobj spec.forProvider.template.template.volumes.secret
obj spec.forProvider.template.template.vpcAccess
obj spec.initProviderfn withBinaryAuthorization(binaryAuthorization)fn withBinaryAuthorizationMixin(binaryAuthorization)fn withClient(client)fn withClientVersion(clientVersion)fn withLabels(labels)fn withLabelsMixin(labels)fn withLaunchStage(launchStage)fn withProject(project)fn withTemplate(template)fn withTemplateMixin(template)obj spec.initProvider.binaryAuthorizationobj spec.initProvider.templatefn withLabels(labels)fn withLabelsMixin(labels)fn withParallelism(parallelism)fn withTaskCount(taskCount)fn withTemplate(template)fn withTemplateMixin(template)obj spec.initProvider.template.templatefn withContainers(containers)fn withContainersMixin(containers)fn withEncryptionKey(encryptionKey)fn withExecutionEnvironment(executionEnvironment)fn withMaxRetries(maxRetries)fn withServiceAccount(serviceAccount)fn withTimeout(timeout)fn withVolumes(volumes)fn withVolumesMixin(volumes)fn withVpcAccess(vpcAccess)fn withVpcAccessMixin(vpcAccess)obj spec.initProvider.template.template.containersfn withArgs(args)fn withArgsMixin(args)fn withCommand(command)fn withCommandMixin(command)fn withEnv(env)fn withEnvMixin(env)fn withImage(image)fn withLivenessProbe(livenessProbe)fn withLivenessProbeMixin(livenessProbe)fn withName(name)fn withPorts(ports)fn withPortsMixin(ports)fn withResources(resources)fn withResourcesMixin(resources)fn withStartupProbe(startupProbe)fn withStartupProbeMixin(startupProbe)fn withVolumeMounts(volumeMounts)fn withVolumeMountsMixin(volumeMounts)fn withWorkingDir(workingDir)obj spec.initProvider.template.template.containers.envobj spec.initProvider.template.template.containers.livenessProbefn withFailureThreshold(failureThreshold)fn withHttpGet(httpGet)fn withHttpGetMixin(httpGet)fn withInitialDelaySeconds(initialDelaySeconds)fn withPeriodSeconds(periodSeconds)fn withTcpSocket(tcpSocket)fn withTcpSocketMixin(tcpSocket)fn withTimeoutSeconds(timeoutSeconds)obj spec.initProvider.template.template.containers.livenessProbe.httpGetobj spec.initProvider.template.template.containers.livenessProbe.tcpSocket
obj spec.initProvider.template.template.containers.portsobj spec.initProvider.template.template.containers.resourcesobj spec.initProvider.template.template.containers.startupProbefn withFailureThreshold(failureThreshold)fn withHttpGet(httpGet)fn withHttpGetMixin(httpGet)fn withInitialDelaySeconds(initialDelaySeconds)fn withPeriodSeconds(periodSeconds)fn withTcpSocket(tcpSocket)fn withTcpSocketMixin(tcpSocket)fn withTimeoutSeconds(timeoutSeconds)obj spec.initProvider.template.template.containers.startupProbe.httpGetobj spec.initProvider.template.template.containers.startupProbe.tcpSocket
obj spec.initProvider.template.template.containers.volumeMounts
obj spec.initProvider.template.template.volumesobj spec.initProvider.template.template.vpcAccess
obj spec.providerConfigRefobj spec.providerRefobj spec.publishConnectionDetailsToobj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of V2Job
obj metadata
"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
fn metadata.withAnnotations
withAnnotations(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
fn metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
Note: This function appends passed data to existing values
fn metadata.withClusterName
withClusterName(clusterName)
"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
fn metadata.withCreationTimestamp
withCreationTimestamp(creationTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withDeletionGracePeriodSeconds
withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."
fn metadata.withDeletionTimestamp
withDeletionTimestamp(deletionTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withFinalizers
withFinalizers(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
fn metadata.withFinalizersMixin
withFinalizersMixin(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
Note: This function appends passed data to existing values
fn metadata.withGenerateName
withGenerateName(generateName)
"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"
fn metadata.withGeneration
withGeneration(generation)
"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."
fn metadata.withLabels
withLabels(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
fn metadata.withLabelsMixin
withLabelsMixin(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
Note: This function appends passed data to existing values
fn metadata.withName
withName(name)
"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
fn metadata.withNamespace
withNamespace(namespace)
"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"
fn metadata.withOwnerReferences
withOwnerReferences(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
fn metadata.withOwnerReferencesMixin
withOwnerReferencesMixin(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
Note: This function appends passed data to existing values
fn metadata.withResourceVersion
withResourceVersion(resourceVersion)
"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"
fn metadata.withSelfLink
withSelfLink(selfLink)
"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."
fn metadata.withUid
withUid(uid)
"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
obj spec
"V2JobSpec defines the desired state of V2Job"
fn spec.withDeletionPolicy
withDeletionPolicy(deletionPolicy)
"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223"
fn spec.withManagementPolicies
withManagementPolicies(managementPolicies)
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"
fn spec.withManagementPoliciesMixin
withManagementPoliciesMixin(managementPolicies)
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"
Note: This function appends passed data to existing values
obj spec.forProvider
fn spec.forProvider.withBinaryAuthorization
withBinaryAuthorization(binaryAuthorization)
"Settings for the Binary Authorization feature. Structure is documented below."
fn spec.forProvider.withBinaryAuthorizationMixin
withBinaryAuthorizationMixin(binaryAuthorization)
"Settings for the Binary Authorization feature. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withClient
withClient(client)
"Arbitrary identifier for the API client."
fn spec.forProvider.withClientVersion
withClientVersion(clientVersion)
"Arbitrary version identifier for the API client."
fn spec.forProvider.withLabels
withLabels(labels)
"KRM-style labels for the resource. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved."
fn spec.forProvider.withLabelsMixin
withLabelsMixin(labels)
"KRM-style labels for the resource. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved."
Note: This function appends passed data to existing values
fn spec.forProvider.withLaunchStage
withLaunchStage(launchStage)
"The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values are: UNIMPLEMENTED, PRELAUNCH, EARLY_ACCESS, ALPHA, BETA, GA, DEPRECATED."
fn spec.forProvider.withLocation
withLocation(location)
"The location of the cloud run job"
fn spec.forProvider.withProject
withProject(project)
"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."
fn spec.forProvider.withTemplate
withTemplate(template)
"The template used to create executions for this Job. Structure is documented below."
fn spec.forProvider.withTemplateMixin
withTemplateMixin(template)
"The template used to create executions for this Job. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.binaryAuthorization
"Settings for the Binary Authorization feature. Structure is documented below."
fn spec.forProvider.binaryAuthorization.withBreakglassJustification
withBreakglassJustification(breakglassJustification)
"If present, indicates to use Breakglass using this justification. If useDefault is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass"
fn spec.forProvider.binaryAuthorization.withUseDefault
withUseDefault(useDefault)
"If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled."
obj spec.forProvider.template
"The template used to create executions for this Job. Structure is documented below."
fn spec.forProvider.template.withLabels
withLabels(labels)
"KRM-style labels for the resource."
fn spec.forProvider.template.withLabelsMixin
withLabelsMixin(labels)
"KRM-style labels for the resource."
Note: This function appends passed data to existing values
fn spec.forProvider.template.withParallelism
withParallelism(parallelism)
"Specifies the maximum desired number of tasks the execution should run at given time. Must be <= taskCount. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism."
fn spec.forProvider.template.withTaskCount
withTaskCount(taskCount)
"Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/"
fn spec.forProvider.template.withTemplate
withTemplate(template)
"Describes the task(s) that will be created when executing an execution Structure is documented below."
fn spec.forProvider.template.withTemplateMixin
withTemplateMixin(template)
"Describes the task(s) that will be created when executing an execution Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.template.template
"Describes the task(s) that will be created when executing an execution Structure is documented below."
fn spec.forProvider.template.template.withContainers
withContainers(containers)
"Holds the single container that defines the unit of execution for this task. Structure is documented below."
fn spec.forProvider.template.template.withContainersMixin
withContainersMixin(containers)
"Holds the single container that defines the unit of execution for this task. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.withEncryptionKey
withEncryptionKey(encryptionKey)
"A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek"
fn spec.forProvider.template.template.withExecutionEnvironment
withExecutionEnvironment(executionEnvironment)
"The execution environment being used to host this Task. Possible values are: EXECUTION_ENVIRONMENT_GEN1, EXECUTION_ENVIRONMENT_GEN2."
fn spec.forProvider.template.template.withMaxRetries
withMaxRetries(maxRetries)
"Number of retries allowed per Task, before marking this Task failed."
fn spec.forProvider.template.template.withServiceAccount
withServiceAccount(serviceAccount)
"Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account."
fn spec.forProvider.template.template.withTimeout
withTimeout(timeout)
"Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. A duration in seconds with up to nine fractional digits, ending with 's'. Example: \"3.5s\"."
fn spec.forProvider.template.template.withVolumes
withVolumes(volumes)
"A list of Volumes to make available to containers. Structure is documented below."
fn spec.forProvider.template.template.withVolumesMixin
withVolumesMixin(volumes)
"A list of Volumes to make available to containers. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.withVpcAccess
withVpcAccess(vpcAccess)
"VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. Structure is documented below."
fn spec.forProvider.template.template.withVpcAccessMixin
withVpcAccessMixin(vpcAccess)
"VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.template.template.containers
"Holds the single container that defines the unit of execution for this task. Structure is documented below."
fn spec.forProvider.template.template.containers.withArgs
withArgs(args)
"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
fn spec.forProvider.template.template.containers.withArgsMixin
withArgsMixin(args)
"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.containers.withCommand
withCommand(command)
"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
fn spec.forProvider.template.template.containers.withCommandMixin
withCommandMixin(command)
"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.containers.withEnv
withEnv(env)
"List of environment variables to set in the container. Structure is documented below."
fn spec.forProvider.template.template.containers.withEnvMixin
withEnvMixin(env)
"List of environment variables to set in the container. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.containers.withImage
withImage(image)
"URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images"
fn spec.forProvider.template.template.containers.withLivenessProbe
withLivenessProbe(livenessProbe)
"Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. Structure is documented below."
fn spec.forProvider.template.template.containers.withLivenessProbeMixin
withLivenessProbeMixin(livenessProbe)
"Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.containers.withName
withName(name)
"Volume's name."
fn spec.forProvider.template.template.containers.withPorts
withPorts(ports)
"List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on Structure is documented below."
fn spec.forProvider.template.template.containers.withPortsMixin
withPortsMixin(ports)
"List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.containers.withResources
withResources(resources)
"Compute Resource requirements by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources Structure is documented below."
fn spec.forProvider.template.template.containers.withResourcesMixin
withResourcesMixin(resources)
"Compute Resource requirements by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.containers.withStartupProbe
withStartupProbe(startupProbe)
"Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. Structure is documented below."
fn spec.forProvider.template.template.containers.withStartupProbeMixin
withStartupProbeMixin(startupProbe)
"Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.containers.withVolumeMounts
withVolumeMounts(volumeMounts)
"Volume to mount into the container's filesystem. Structure is documented below."
fn spec.forProvider.template.template.containers.withVolumeMountsMixin
withVolumeMountsMixin(volumeMounts)
"Volume to mount into the container's filesystem. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.containers.withWorkingDir
withWorkingDir(workingDir)
"Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image."
obj spec.forProvider.template.template.containers.env
"List of environment variables to set in the container. Structure is documented below."
fn spec.forProvider.template.template.containers.env.withName
withName(name)
"Volume's name."
fn spec.forProvider.template.template.containers.env.withValue
withValue(value)
"The header field value"
fn spec.forProvider.template.template.containers.env.withValueSource
withValueSource(valueSource)
"Source for the environment variable's value. Structure is documented below."
fn spec.forProvider.template.template.containers.env.withValueSourceMixin
withValueSourceMixin(valueSource)
"Source for the environment variable's value. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.template.template.containers.env.valueSource
"Source for the environment variable's value. Structure is documented below."
fn spec.forProvider.template.template.containers.env.valueSource.withSecretKeyRef
withSecretKeyRef(secretKeyRef)
"Selects a secret and a specific version from Cloud Secret Manager. Structure is documented below."
fn spec.forProvider.template.template.containers.env.valueSource.withSecretKeyRefMixin
withSecretKeyRefMixin(secretKeyRef)
"Selects a secret and a specific version from Cloud Secret Manager. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.template.template.containers.env.valueSource.secretKeyRef
"Selects a secret and a specific version from Cloud Secret Manager. Structure is documented below."
fn spec.forProvider.template.template.containers.env.valueSource.secretKeyRef.withSecret
withSecret(secret)
"Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret Structure is documented below."
fn spec.forProvider.template.template.containers.env.valueSource.secretKeyRef.withVersion
withVersion(version)
"The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version."
obj spec.forProvider.template.template.containers.env.valueSource.secretKeyRef.secretRef
"Reference to a Secret in secretmanager to populate secret."
fn spec.forProvider.template.template.containers.env.valueSource.secretKeyRef.secretRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.template.template.containers.env.valueSource.secretKeyRef.secretRef.policy
"Policies for referencing."
fn spec.forProvider.template.template.containers.env.valueSource.secretKeyRef.secretRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.template.template.containers.env.valueSource.secretKeyRef.secretRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.template.template.containers.env.valueSource.secretKeyRef.secretSelector
"Selector for a Secret in secretmanager to populate secret."
fn spec.forProvider.template.template.containers.env.valueSource.secretKeyRef.secretSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.template.template.containers.env.valueSource.secretKeyRef.secretSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.template.template.containers.env.valueSource.secretKeyRef.secretSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.template.template.containers.env.valueSource.secretKeyRef.secretSelector.policy
"Policies for selection."
fn spec.forProvider.template.template.containers.env.valueSource.secretKeyRef.secretSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.template.template.containers.env.valueSource.secretKeyRef.secretSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.template.template.containers.livenessProbe
"Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. Structure is documented below."
fn spec.forProvider.template.template.containers.livenessProbe.withFailureThreshold
withFailureThreshold(failureThreshold)
"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."
fn spec.forProvider.template.template.containers.livenessProbe.withHttpGet
withHttpGet(httpGet)
"HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.forProvider.template.template.containers.livenessProbe.withHttpGetMixin
withHttpGetMixin(httpGet)
"HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.containers.livenessProbe.withInitialDelaySeconds
withInitialDelaySeconds(initialDelaySeconds)
"Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
fn spec.forProvider.template.template.containers.livenessProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds"
fn spec.forProvider.template.template.containers.livenessProbe.withTcpSocket
withTcpSocket(tcpSocket)
"TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.forProvider.template.template.containers.livenessProbe.withTcpSocketMixin
withTcpSocketMixin(tcpSocket)
"TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.containers.livenessProbe.withTimeoutSeconds
withTimeoutSeconds(timeoutSeconds)
"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
obj spec.forProvider.template.template.containers.livenessProbe.httpGet
"HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.forProvider.template.template.containers.livenessProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers. Structure is documented below."
fn spec.forProvider.template.template.containers.livenessProbe.httpGet.withHttpHeadersMixin
withHttpHeadersMixin(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.containers.livenessProbe.httpGet.withPath
withPath(path)
"The relative path of the secret in the container."
obj spec.forProvider.template.template.containers.livenessProbe.httpGet.httpHeaders
"Custom headers to set in the request. HTTP allows repeated headers. Structure is documented below."
fn spec.forProvider.template.template.containers.livenessProbe.httpGet.httpHeaders.withName
withName(name)
"Volume's name."
fn spec.forProvider.template.template.containers.livenessProbe.httpGet.httpHeaders.withValue
withValue(value)
"The header field value"
obj spec.forProvider.template.template.containers.livenessProbe.tcpSocket
"TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.forProvider.template.template.containers.livenessProbe.tcpSocket.withPort
withPort(port)
"Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to 8080."
obj spec.forProvider.template.template.containers.ports
"List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on Structure is documented below."
fn spec.forProvider.template.template.containers.ports.withContainerPort
withContainerPort(containerPort)
"Port number the container listens on. This must be a valid TCP port number, 0 < containerPort < 65536."
fn spec.forProvider.template.template.containers.ports.withName
withName(name)
"Volume's name."
obj spec.forProvider.template.template.containers.resources
"Compute Resource requirements by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources Structure is documented below."
fn spec.forProvider.template.template.containers.resources.withLimits
withLimits(limits)
"Only memory and CPU are supported. Note: The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go"
fn spec.forProvider.template.template.containers.resources.withLimitsMixin
withLimitsMixin(limits)
"Only memory and CPU are supported. Note: The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go"
Note: This function appends passed data to existing values
obj spec.forProvider.template.template.containers.startupProbe
"Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. Structure is documented below."
fn spec.forProvider.template.template.containers.startupProbe.withFailureThreshold
withFailureThreshold(failureThreshold)
"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."
fn spec.forProvider.template.template.containers.startupProbe.withHttpGet
withHttpGet(httpGet)
"HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.forProvider.template.template.containers.startupProbe.withHttpGetMixin
withHttpGetMixin(httpGet)
"HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.containers.startupProbe.withInitialDelaySeconds
withInitialDelaySeconds(initialDelaySeconds)
"Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
fn spec.forProvider.template.template.containers.startupProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds"
fn spec.forProvider.template.template.containers.startupProbe.withTcpSocket
withTcpSocket(tcpSocket)
"TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.forProvider.template.template.containers.startupProbe.withTcpSocketMixin
withTcpSocketMixin(tcpSocket)
"TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.containers.startupProbe.withTimeoutSeconds
withTimeoutSeconds(timeoutSeconds)
"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
obj spec.forProvider.template.template.containers.startupProbe.httpGet
"HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.forProvider.template.template.containers.startupProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers. Structure is documented below."
fn spec.forProvider.template.template.containers.startupProbe.httpGet.withHttpHeadersMixin
withHttpHeadersMixin(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.containers.startupProbe.httpGet.withPath
withPath(path)
"The relative path of the secret in the container."
obj spec.forProvider.template.template.containers.startupProbe.httpGet.httpHeaders
"Custom headers to set in the request. HTTP allows repeated headers. Structure is documented below."
fn spec.forProvider.template.template.containers.startupProbe.httpGet.httpHeaders.withName
withName(name)
"Volume's name."
fn spec.forProvider.template.template.containers.startupProbe.httpGet.httpHeaders.withValue
withValue(value)
"The header field value"
obj spec.forProvider.template.template.containers.startupProbe.tcpSocket
"TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.forProvider.template.template.containers.startupProbe.tcpSocket.withPort
withPort(port)
"Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to 8080."
obj spec.forProvider.template.template.containers.volumeMounts
"Volume to mount into the container's filesystem. Structure is documented below."
fn spec.forProvider.template.template.containers.volumeMounts.withMountPath
withMountPath(mountPath)
"Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be /cloudsql. All instances defined in the Volume will be available as /cloudsql/[instance]. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run"
fn spec.forProvider.template.template.containers.volumeMounts.withName
withName(name)
"Volume's name."
obj spec.forProvider.template.template.volumes
"A list of Volumes to make available to containers. Structure is documented below."
fn spec.forProvider.template.template.volumes.withCloudSqlInstance
withCloudSqlInstance(cloudSqlInstance)
"For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Structure is documented below."
fn spec.forProvider.template.template.volumes.withCloudSqlInstanceMixin
withCloudSqlInstanceMixin(cloudSqlInstance)
"For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.volumes.withName
withName(name)
"Volume's name."
fn spec.forProvider.template.template.volumes.withSecret
withSecret(secret)
"Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret Structure is documented below."
fn spec.forProvider.template.template.volumes.withSecretMixin
withSecretMixin(secret)
"Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.template.template.volumes.cloudSqlInstance
"For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Structure is documented below."
fn spec.forProvider.template.template.volumes.cloudSqlInstance.withInstances
withInstances(instances)
"The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}"
fn spec.forProvider.template.template.volumes.cloudSqlInstance.withInstancesMixin
withInstancesMixin(instances)
"The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}"
Note: This function appends passed data to existing values
obj spec.forProvider.template.template.volumes.secret
"Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret Structure is documented below."
fn spec.forProvider.template.template.volumes.secret.withDefaultMode
withDefaultMode(defaultMode)
"Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting."
fn spec.forProvider.template.template.volumes.secret.withItems
withItems(items)
"If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. Structure is documented below."
fn spec.forProvider.template.template.volumes.secret.withItemsMixin
withItemsMixin(items)
"If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.template.template.volumes.secret.withSecret
withSecret(secret)
"Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret Structure is documented below."
obj spec.forProvider.template.template.volumes.secret.items
"If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. Structure is documented below."
fn spec.forProvider.template.template.volumes.secret.items.withMode
withMode(mode)
"Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used."
fn spec.forProvider.template.template.volumes.secret.items.withPath
withPath(path)
"The relative path of the secret in the container."
fn spec.forProvider.template.template.volumes.secret.items.withVersion
withVersion(version)
"The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version."
obj spec.forProvider.template.template.volumes.secret.secretRef
"Reference to a Secret in secretmanager to populate secret."
fn spec.forProvider.template.template.volumes.secret.secretRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.template.template.volumes.secret.secretRef.policy
"Policies for referencing."
fn spec.forProvider.template.template.volumes.secret.secretRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.template.template.volumes.secret.secretRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.template.template.volumes.secret.secretSelector
"Selector for a Secret in secretmanager to populate secret."
fn spec.forProvider.template.template.volumes.secret.secretSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.template.template.volumes.secret.secretSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.template.template.volumes.secret.secretSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.template.template.volumes.secret.secretSelector.policy
"Policies for selection."
fn spec.forProvider.template.template.volumes.secret.secretSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.template.template.volumes.secret.secretSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.template.template.vpcAccess
"VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. Structure is documented below."
fn spec.forProvider.template.template.vpcAccess.withConnector
withConnector(connector)
"VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number."
fn spec.forProvider.template.template.vpcAccess.withEgress
withEgress(egress)
"Traffic VPC egress settings. Possible values are: ALL_TRAFFIC, PRIVATE_RANGES_ONLY."
obj spec.initProvider
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler."
fn spec.initProvider.withBinaryAuthorization
withBinaryAuthorization(binaryAuthorization)
"Settings for the Binary Authorization feature. Structure is documented below."
fn spec.initProvider.withBinaryAuthorizationMixin
withBinaryAuthorizationMixin(binaryAuthorization)
"Settings for the Binary Authorization feature. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withClient
withClient(client)
"Arbitrary identifier for the API client."
fn spec.initProvider.withClientVersion
withClientVersion(clientVersion)
"Arbitrary version identifier for the API client."
fn spec.initProvider.withLabels
withLabels(labels)
"KRM-style labels for the resource. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved."
fn spec.initProvider.withLabelsMixin
withLabelsMixin(labels)
"KRM-style labels for the resource. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved."
Note: This function appends passed data to existing values
fn spec.initProvider.withLaunchStage
withLaunchStage(launchStage)
"The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values are: UNIMPLEMENTED, PRELAUNCH, EARLY_ACCESS, ALPHA, BETA, GA, DEPRECATED."
fn spec.initProvider.withProject
withProject(project)
"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."
fn spec.initProvider.withTemplate
withTemplate(template)
"The template used to create executions for this Job. Structure is documented below."
fn spec.initProvider.withTemplateMixin
withTemplateMixin(template)
"The template used to create executions for this Job. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.binaryAuthorization
"Settings for the Binary Authorization feature. Structure is documented below."
fn spec.initProvider.binaryAuthorization.withBreakglassJustification
withBreakglassJustification(breakglassJustification)
"If present, indicates to use Breakglass using this justification. If useDefault is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass"
fn spec.initProvider.binaryAuthorization.withUseDefault
withUseDefault(useDefault)
"If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled."
obj spec.initProvider.template
"The template used to create executions for this Job. Structure is documented below."
fn spec.initProvider.template.withLabels
withLabels(labels)
"KRM-style labels for the resource."
fn spec.initProvider.template.withLabelsMixin
withLabelsMixin(labels)
"KRM-style labels for the resource."
Note: This function appends passed data to existing values
fn spec.initProvider.template.withParallelism
withParallelism(parallelism)
"Specifies the maximum desired number of tasks the execution should run at given time. Must be <= taskCount. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism."
fn spec.initProvider.template.withTaskCount
withTaskCount(taskCount)
"Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/"
fn spec.initProvider.template.withTemplate
withTemplate(template)
"Describes the task(s) that will be created when executing an execution Structure is documented below."
fn spec.initProvider.template.withTemplateMixin
withTemplateMixin(template)
"Describes the task(s) that will be created when executing an execution Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.template.template
"Describes the task(s) that will be created when executing an execution Structure is documented below."
fn spec.initProvider.template.template.withContainers
withContainers(containers)
"Holds the single container that defines the unit of execution for this task. Structure is documented below."
fn spec.initProvider.template.template.withContainersMixin
withContainersMixin(containers)
"Holds the single container that defines the unit of execution for this task. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.withEncryptionKey
withEncryptionKey(encryptionKey)
"A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek"
fn spec.initProvider.template.template.withExecutionEnvironment
withExecutionEnvironment(executionEnvironment)
"The execution environment being used to host this Task. Possible values are: EXECUTION_ENVIRONMENT_GEN1, EXECUTION_ENVIRONMENT_GEN2."
fn spec.initProvider.template.template.withMaxRetries
withMaxRetries(maxRetries)
"Number of retries allowed per Task, before marking this Task failed."
fn spec.initProvider.template.template.withServiceAccount
withServiceAccount(serviceAccount)
"Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account."
fn spec.initProvider.template.template.withTimeout
withTimeout(timeout)
"Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. A duration in seconds with up to nine fractional digits, ending with 's'. Example: \"3.5s\"."
fn spec.initProvider.template.template.withVolumes
withVolumes(volumes)
"A list of Volumes to make available to containers. Structure is documented below."
fn spec.initProvider.template.template.withVolumesMixin
withVolumesMixin(volumes)
"A list of Volumes to make available to containers. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.withVpcAccess
withVpcAccess(vpcAccess)
"VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. Structure is documented below."
fn spec.initProvider.template.template.withVpcAccessMixin
withVpcAccessMixin(vpcAccess)
"VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.template.template.containers
"Holds the single container that defines the unit of execution for this task. Structure is documented below."
fn spec.initProvider.template.template.containers.withArgs
withArgs(args)
"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
fn spec.initProvider.template.template.containers.withArgsMixin
withArgsMixin(args)
"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.containers.withCommand
withCommand(command)
"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
fn spec.initProvider.template.template.containers.withCommandMixin
withCommandMixin(command)
"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.containers.withEnv
withEnv(env)
"List of environment variables to set in the container. Structure is documented below."
fn spec.initProvider.template.template.containers.withEnvMixin
withEnvMixin(env)
"List of environment variables to set in the container. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.containers.withImage
withImage(image)
"URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images"
fn spec.initProvider.template.template.containers.withLivenessProbe
withLivenessProbe(livenessProbe)
"Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. Structure is documented below."
fn spec.initProvider.template.template.containers.withLivenessProbeMixin
withLivenessProbeMixin(livenessProbe)
"Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.containers.withName
withName(name)
"Volume's name."
fn spec.initProvider.template.template.containers.withPorts
withPorts(ports)
"List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on Structure is documented below."
fn spec.initProvider.template.template.containers.withPortsMixin
withPortsMixin(ports)
"List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.containers.withResources
withResources(resources)
"Compute Resource requirements by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources Structure is documented below."
fn spec.initProvider.template.template.containers.withResourcesMixin
withResourcesMixin(resources)
"Compute Resource requirements by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.containers.withStartupProbe
withStartupProbe(startupProbe)
"Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. Structure is documented below."
fn spec.initProvider.template.template.containers.withStartupProbeMixin
withStartupProbeMixin(startupProbe)
"Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.containers.withVolumeMounts
withVolumeMounts(volumeMounts)
"Volume to mount into the container's filesystem. Structure is documented below."
fn spec.initProvider.template.template.containers.withVolumeMountsMixin
withVolumeMountsMixin(volumeMounts)
"Volume to mount into the container's filesystem. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.containers.withWorkingDir
withWorkingDir(workingDir)
"Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image."
obj spec.initProvider.template.template.containers.env
"List of environment variables to set in the container. Structure is documented below."
fn spec.initProvider.template.template.containers.env.withName
withName(name)
"Volume's name."
fn spec.initProvider.template.template.containers.env.withValue
withValue(value)
"The header field value"
fn spec.initProvider.template.template.containers.env.withValueSource
withValueSource(valueSource)
"Source for the environment variable's value. Structure is documented below."
fn spec.initProvider.template.template.containers.env.withValueSourceMixin
withValueSourceMixin(valueSource)
"Source for the environment variable's value. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.template.template.containers.env.valueSource
"Source for the environment variable's value. Structure is documented below."
fn spec.initProvider.template.template.containers.env.valueSource.withSecretKeyRef
withSecretKeyRef(secretKeyRef)
"Selects a secret and a specific version from Cloud Secret Manager. Structure is documented below."
fn spec.initProvider.template.template.containers.env.valueSource.withSecretKeyRefMixin
withSecretKeyRefMixin(secretKeyRef)
"Selects a secret and a specific version from Cloud Secret Manager. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.template.template.containers.env.valueSource.secretKeyRef
"Selects a secret and a specific version from Cloud Secret Manager. Structure is documented below."
fn spec.initProvider.template.template.containers.env.valueSource.secretKeyRef.withVersion
withVersion(version)
"The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version."
obj spec.initProvider.template.template.containers.livenessProbe
"Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. Structure is documented below."
fn spec.initProvider.template.template.containers.livenessProbe.withFailureThreshold
withFailureThreshold(failureThreshold)
"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."
fn spec.initProvider.template.template.containers.livenessProbe.withHttpGet
withHttpGet(httpGet)
"HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.initProvider.template.template.containers.livenessProbe.withHttpGetMixin
withHttpGetMixin(httpGet)
"HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.containers.livenessProbe.withInitialDelaySeconds
withInitialDelaySeconds(initialDelaySeconds)
"Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
fn spec.initProvider.template.template.containers.livenessProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds"
fn spec.initProvider.template.template.containers.livenessProbe.withTcpSocket
withTcpSocket(tcpSocket)
"TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.initProvider.template.template.containers.livenessProbe.withTcpSocketMixin
withTcpSocketMixin(tcpSocket)
"TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.containers.livenessProbe.withTimeoutSeconds
withTimeoutSeconds(timeoutSeconds)
"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
obj spec.initProvider.template.template.containers.livenessProbe.httpGet
"HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.initProvider.template.template.containers.livenessProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers. Structure is documented below."
fn spec.initProvider.template.template.containers.livenessProbe.httpGet.withHttpHeadersMixin
withHttpHeadersMixin(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.containers.livenessProbe.httpGet.withPath
withPath(path)
"The relative path of the secret in the container."
obj spec.initProvider.template.template.containers.livenessProbe.httpGet.httpHeaders
"Custom headers to set in the request. HTTP allows repeated headers. Structure is documented below."
fn spec.initProvider.template.template.containers.livenessProbe.httpGet.httpHeaders.withName
withName(name)
"Volume's name."
fn spec.initProvider.template.template.containers.livenessProbe.httpGet.httpHeaders.withValue
withValue(value)
"The header field value"
obj spec.initProvider.template.template.containers.livenessProbe.tcpSocket
"TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.initProvider.template.template.containers.livenessProbe.tcpSocket.withPort
withPort(port)
"Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to 8080."
obj spec.initProvider.template.template.containers.ports
"List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on Structure is documented below."
fn spec.initProvider.template.template.containers.ports.withContainerPort
withContainerPort(containerPort)
"Port number the container listens on. This must be a valid TCP port number, 0 < containerPort < 65536."
fn spec.initProvider.template.template.containers.ports.withName
withName(name)
"Volume's name."
obj spec.initProvider.template.template.containers.resources
"Compute Resource requirements by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources Structure is documented below."
fn spec.initProvider.template.template.containers.resources.withLimits
withLimits(limits)
"Only memory and CPU are supported. Note: The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go"
fn spec.initProvider.template.template.containers.resources.withLimitsMixin
withLimitsMixin(limits)
"Only memory and CPU are supported. Note: The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go"
Note: This function appends passed data to existing values
obj spec.initProvider.template.template.containers.startupProbe
"Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. Structure is documented below."
fn spec.initProvider.template.template.containers.startupProbe.withFailureThreshold
withFailureThreshold(failureThreshold)
"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."
fn spec.initProvider.template.template.containers.startupProbe.withHttpGet
withHttpGet(httpGet)
"HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.initProvider.template.template.containers.startupProbe.withHttpGetMixin
withHttpGetMixin(httpGet)
"HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.containers.startupProbe.withInitialDelaySeconds
withInitialDelaySeconds(initialDelaySeconds)
"Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
fn spec.initProvider.template.template.containers.startupProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds"
fn spec.initProvider.template.template.containers.startupProbe.withTcpSocket
withTcpSocket(tcpSocket)
"TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.initProvider.template.template.containers.startupProbe.withTcpSocketMixin
withTcpSocketMixin(tcpSocket)
"TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.containers.startupProbe.withTimeoutSeconds
withTimeoutSeconds(timeoutSeconds)
"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
obj spec.initProvider.template.template.containers.startupProbe.httpGet
"HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.initProvider.template.template.containers.startupProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers. Structure is documented below."
fn spec.initProvider.template.template.containers.startupProbe.httpGet.withHttpHeadersMixin
withHttpHeadersMixin(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.containers.startupProbe.httpGet.withPath
withPath(path)
"The relative path of the secret in the container."
obj spec.initProvider.template.template.containers.startupProbe.httpGet.httpHeaders
"Custom headers to set in the request. HTTP allows repeated headers. Structure is documented below."
fn spec.initProvider.template.template.containers.startupProbe.httpGet.httpHeaders.withName
withName(name)
"Volume's name."
fn spec.initProvider.template.template.containers.startupProbe.httpGet.httpHeaders.withValue
withValue(value)
"The header field value"
obj spec.initProvider.template.template.containers.startupProbe.tcpSocket
"TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. Structure is documented below."
fn spec.initProvider.template.template.containers.startupProbe.tcpSocket.withPort
withPort(port)
"Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to 8080."
obj spec.initProvider.template.template.containers.volumeMounts
"Volume to mount into the container's filesystem. Structure is documented below."
fn spec.initProvider.template.template.containers.volumeMounts.withMountPath
withMountPath(mountPath)
"Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be /cloudsql. All instances defined in the Volume will be available as /cloudsql/[instance]. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run"
fn spec.initProvider.template.template.containers.volumeMounts.withName
withName(name)
"Volume's name."
obj spec.initProvider.template.template.volumes
"A list of Volumes to make available to containers. Structure is documented below."
fn spec.initProvider.template.template.volumes.withCloudSqlInstance
withCloudSqlInstance(cloudSqlInstance)
"For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Structure is documented below."
fn spec.initProvider.template.template.volumes.withCloudSqlInstanceMixin
withCloudSqlInstanceMixin(cloudSqlInstance)
"For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.template.template.volumes.withName
withName(name)
"Volume's name."
fn spec.initProvider.template.template.volumes.withSecret
withSecret(secret)
"Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret Structure is documented below."
fn spec.initProvider.template.template.volumes.withSecretMixin
withSecretMixin(secret)
"Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.template.template.volumes.cloudSqlInstance
"For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Structure is documented below."
fn spec.initProvider.template.template.volumes.cloudSqlInstance.withInstances
withInstances(instances)
"The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}"
fn spec.initProvider.template.template.volumes.cloudSqlInstance.withInstancesMixin
withInstancesMixin(instances)
"The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}"
Note: This function appends passed data to existing values
obj spec.initProvider.template.template.volumes.secret
"Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret Structure is documented below."
fn spec.initProvider.template.template.volumes.secret.withDefaultMode
withDefaultMode(defaultMode)
"Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting."
fn spec.initProvider.template.template.volumes.secret.withItems
withItems(items)
"If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. Structure is documented below."
fn spec.initProvider.template.template.volumes.secret.withItemsMixin
withItemsMixin(items)
"If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.template.template.volumes.secret.items
"If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. Structure is documented below."
fn spec.initProvider.template.template.volumes.secret.items.withMode
withMode(mode)
"Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used."
fn spec.initProvider.template.template.volumes.secret.items.withPath
withPath(path)
"The relative path of the secret in the container."
fn spec.initProvider.template.template.volumes.secret.items.withVersion
withVersion(version)
"The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version."
obj spec.initProvider.template.template.vpcAccess
"VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. Structure is documented below."
fn spec.initProvider.template.template.vpcAccess.withConnector
withConnector(connector)
"VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number."
fn spec.initProvider.template.template.vpcAccess.withEgress
withEgress(egress)
"Traffic VPC egress settings. Possible values are: ALL_TRAFFIC, PRIVATE_RANGES_ONLY."
obj spec.providerConfigRef
"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."
fn spec.providerConfigRef.withName
withName(name)
"Name of the referenced object."
obj spec.providerConfigRef.policy
"Policies for referencing."
fn spec.providerConfigRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.providerConfigRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.providerRef
"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"
fn spec.providerRef.withName
withName(name)
"Name of the referenced object."
obj spec.providerRef.policy
"Policies for referencing."
fn spec.providerRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.providerRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.publishConnectionDetailsTo
"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."
fn spec.publishConnectionDetailsTo.withName
withName(name)
"Name is the name of the connection secret."
obj spec.publishConnectionDetailsTo.configRef
"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."
fn spec.publishConnectionDetailsTo.configRef.withName
withName(name)
"Name of the referenced object."
obj spec.publishConnectionDetailsTo.configRef.policy
"Policies for referencing."
fn spec.publishConnectionDetailsTo.configRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.publishConnectionDetailsTo.configRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.publishConnectionDetailsTo.metadata
"Metadata is the metadata for connection secret."
fn spec.publishConnectionDetailsTo.metadata.withAnnotations
withAnnotations(annotations)
"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."
fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."
Note: This function appends passed data to existing values
fn spec.publishConnectionDetailsTo.metadata.withLabels
withLabels(labels)
"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."
fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin
withLabelsMixin(labels)
"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."
Note: This function appends passed data to existing values
fn spec.publishConnectionDetailsTo.metadata.withType
withType(type)
"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."
obj spec.writeConnectionSecretToRef
"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."
fn spec.writeConnectionSecretToRef.withName
withName(name)
"Name of the secret."
fn spec.writeConnectionSecretToRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."