| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="run_v1alpha1.html">Cloud Run Admin API</a> . <a href="run_v1alpha1.namespaces.html">namespaces</a> . <a href="run_v1alpha1.namespaces.jobs.html">jobs</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Create a job.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, apiVersion=None, kind=None, propagationPolicy=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Delete a job.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Get information about a job.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list">list(parent, continue=None, fieldSelector=None, includeUninitialized=None, labelSelector=None, limit=None, resourceVersion=None, watch=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">List jobs.</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| 94 | <code class="details" id="close">close()</code> |
| 95 | <pre>Close httplib2 connections.</pre> |
| 96 | </div> |
| 97 | |
| 98 | <div class="method"> |
| 99 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 100 | <pre>Create a job. |
| 101 | |
| 102 | Args: |
| 103 | parent: string, Required. The namespace in which the job should be created. Replace {namespace_id} with the project ID or number. (required) |
| 104 | body: object, The request body. |
| 105 | The object takes the form of: |
| 106 | |
| 107 | { # Job represents the configuration of a single job. A job an immutable resource that references a container image which is run to completion. |
| 108 | "apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional |
| 109 | "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 110 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional |
| 111 | "annotations": { # (Optional) 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 |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 112 | "a_key": "A String", |
| 113 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 114 | "clusterName": "A String", # (Optional) Not supported by Cloud Run 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. |
| 115 | "creationTimestamp": "A String", # (Optional) CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 116 | "deletionGracePeriodSeconds": 42, # (Optional) Not supported by Cloud Run 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. |
| 117 | "deletionTimestamp": "A String", # (Optional) Not supported by Cloud Run DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 118 | "finalizers": [ # (Optional) Not supported by Cloud Run 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. +patchStrategy=merge |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 119 | "A String", |
| 120 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 121 | "generateName": "A String", # (Optional) Not supported by Cloud Run 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. If 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). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency string generateName = 2; |
| 122 | "generation": 42, # (Optional) A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
| 123 | "labels": { # (Optional) 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 routes. More info: http://kubernetes.io/docs/user-guide/labels |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 124 | "a_key": "A String", |
| 125 | }, |
| 126 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. 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 +optional |
| 127 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 128 | "ownerReferences": [ # (Optional) Not supported by Cloud Run List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 129 | { # OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field. |
| 130 | "apiVersion": "A String", # API version of the referent. |
| 131 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional |
| 132 | "controller": True or False, # If true, this reference points to the managing controller. +optional |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 133 | "kind": "A String", # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 134 | "name": "A String", # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 135 | "uid": "A String", # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 136 | }, |
| 137 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 138 | "resourceVersion": "A String", # Optional. 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 or omit the value to disable conflict-detection. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients or omitted. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
| 139 | "selfLink": "A String", # (Optional) SelfLink is a URL representing this object. Populated by the system. Read-only. string selfLink = 4; |
| 140 | "uid": "A String", # (Optional) 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. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 141 | }, |
| 142 | "spec": { # JobSpec describes how the job execution will look like. # Optional. Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 143 | "activeDeadlineSeconds": "A String", # Optional. Not supported. Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it. If set to zero, the system will never attempt to terminate the job based on time. Otherwise, the value must be positive integer. +optional |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 144 | "backoffLimit": 42, # Optional. Specifies the number of retries per instance, before marking this job failed. If set to zero, instances will never retry on failure. +optional |
| 145 | "completions": 42, # Optional. Specifies the desired number of successfully finished instances the job should be run with. Setting to 1 means that parallelism is limited to 1 and the success of that instance signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional |
| 146 | "parallelism": 42, # Optional. Specifies the maximum desired number of instances the job should run at any given time. Must be <= completions. The actual number of instances running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional |
| 147 | "template": { # InstanceTemplateSpec describes the data an instance should have when created from a template. # Optional. Describes the instance that will be created when executing a job. |
| 148 | "spec": { # InstanceSpec is a description of an instance. # Optional. Specification of the desired behavior of the instance. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional |
| 149 | "activeDeadlineSeconds": "A String", # Optional. Optional duration in seconds the instance may be active relative to StartTime before the system will actively try to mark it failed and kill associated containers. If set to zero, the system will never attempt to kill an instance based on time. Otherwise, value must be a positive integer. +optional |
| 150 | "containers": [ # Optional. List of containers belonging to the instance. We disallow a number of fields on this Container. Only a single container may be provided. |
| 151 | { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 152 | "args": [ # (Optional) 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 |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 153 | "A String", |
| 154 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 155 | "command": [ |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 156 | "A String", |
| 157 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 158 | "env": [ # (Optional) List of environment variables to set in the container. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 159 | { # EnvVar represents an environment variable present in a Container. |
| 160 | "name": "A String", # Name of the environment variable. Must be a C_IDENTIFIER. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 161 | "value": "A String", # (Optional) Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. 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. Defaults to "". |
| 162 | "valueFrom": { # EnvVarSource represents a source for the value of an EnvVar. # (Optional) Source for the environment variable's value. Only supports secret_key_ref. Source for the environment variable's value. Cannot be used if value is not empty. |
| 163 | "configMapKeyRef": { # Not supported by Cloud Run Selects a key from a ConfigMap. # (Optional) Not supported by Cloud Run Selects a key of a ConfigMap. |
| 164 | "key": "A String", # The key to select. |
| 165 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 166 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 167 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 168 | "name": "A String", # The ConfigMap to select from. |
| 169 | "optional": True or False, # (Optional) Specify whether the ConfigMap or its key must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 170 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 171 | "secretKeyRef": { # SecretKeySelector selects a key of a Secret. # (Optional) Selects a key (version) of a secret in Secret Manager. |
| 172 | "key": "A String", # A Cloud Secret Manager secret version. Must be 'latest' for the latest version or an integer for a specific version. The key of the secret to select from. Must be a valid secret key. |
| 173 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 174 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 175 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 176 | "name": "A String", # The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. The name of the secret in the pod's namespace to select from. |
| 177 | "optional": True or False, # (Optional) Specify whether the Secret or its key must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 178 | }, |
| 179 | }, |
| 180 | }, |
| 181 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 182 | "envFrom": [ # (Optional) List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. |
| 183 | { # Not supported by Cloud Run EnvFromSource represents the source of a set of ConfigMaps |
| 184 | "configMapRef": { # Not supported by Cloud Run ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. # (Optional) The ConfigMap to select from |
| 185 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 186 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 187 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 188 | "name": "A String", # The ConfigMap to select from. |
| 189 | "optional": True or False, # (Optional) Specify whether the ConfigMap must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 190 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 191 | "prefix": "A String", # (Optional) An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. |
| 192 | "secretRef": { # Not supported by Cloud Run SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables. # (Optional) The Secret to select from |
| 193 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 194 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 195 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 196 | "name": "A String", # The Secret to select from. |
| 197 | "optional": True or False, # (Optional) Specify whether the Secret must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 198 | }, |
| 199 | }, |
| 200 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 201 | "image": "A String", # Only supports containers from Google Container Registry or Artifact Registry URL of the Container image. More info: https://kubernetes.io/docs/concepts/containers/images |
| 202 | "imagePullPolicy": "A String", # (Optional) Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
| 203 | "livenessProbe": { # Not supported by Cloud Run Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # (Optional) 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 |
| 204 | "exec": { # Not supported by Cloud Run ExecAction describes a "run in container" action. # (Optional) One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message. |
| 205 | "command": [ # (Optional) Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
| 206 | "A String", |
| 207 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 208 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 209 | "failureThreshold": 42, # (Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
| 210 | "httpGet": { # Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests. # (Optional) HTTPGet specifies the http request to perform. A field inlined from the Handler message. |
| 211 | "host": "A String", # (Optional) Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
| 212 | "httpHeaders": [ # (Optional) Custom headers to set in the request. HTTP allows repeated headers. |
| 213 | { # Not supported by Cloud Run HTTPHeader describes a custom header to be used in HTTP probes |
| 214 | "name": "A String", # The header field name |
| 215 | "value": "A String", # The header field value |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 216 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 217 | ], |
| 218 | "path": "A String", # (Optional) Path to access on the HTTP server. |
| 219 | "scheme": "A String", # (Optional) Scheme to use for connecting to the host. Defaults to HTTP. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 220 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 221 | "initialDelaySeconds": 42, # (Optional) Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 222 | "periodSeconds": 42, # (Optional) How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
| 223 | "successThreshold": 42, # (Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
| 224 | "tcpSocket": { # Not supported by Cloud Run TCPSocketAction describes an action based on opening a socket # (Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message. |
| 225 | "host": "A String", # (Optional) Optional: Host name to connect to, defaults to the pod IP. |
| 226 | "port": 42, # Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. This field is currently limited to integer types only because of proto's inability to properly support the IntOrString golang type. |
| 227 | }, |
| 228 | "timeoutSeconds": 42, # (Optional) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 229 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 230 | "name": "A String", # (Optional) Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names |
| 231 | "ports": [ # (Optional) 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 232 | { # ContainerPort represents a network port in a single container. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 233 | "containerPort": 42, # (Optional) Port number the container listens on. This must be a valid port number, 0 < x < 65536. |
| 234 | "name": "A String", # (Optional) If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c". |
| 235 | "protocol": "A String", # (Optional) Protocol for port. Must be "TCP". Defaults to "TCP". |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 236 | }, |
| 237 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 238 | "readinessProbe": { # Not supported by Cloud Run Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # (Optional) Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 239 | "exec": { # Not supported by Cloud Run ExecAction describes a "run in container" action. # (Optional) One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message. |
| 240 | "command": [ # (Optional) Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 241 | "A String", |
| 242 | ], |
| 243 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 244 | "failureThreshold": 42, # (Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
| 245 | "httpGet": { # Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests. # (Optional) HTTPGet specifies the http request to perform. A field inlined from the Handler message. |
| 246 | "host": "A String", # (Optional) Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
| 247 | "httpHeaders": [ # (Optional) Custom headers to set in the request. HTTP allows repeated headers. |
| 248 | { # Not supported by Cloud Run HTTPHeader describes a custom header to be used in HTTP probes |
| 249 | "name": "A String", # The header field name |
| 250 | "value": "A String", # The header field value |
| 251 | }, |
| 252 | ], |
| 253 | "path": "A String", # (Optional) Path to access on the HTTP server. |
| 254 | "scheme": "A String", # (Optional) Scheme to use for connecting to the host. Defaults to HTTP. |
| 255 | }, |
| 256 | "initialDelaySeconds": 42, # (Optional) Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 257 | "periodSeconds": 42, # (Optional) How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
| 258 | "successThreshold": 42, # (Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
| 259 | "tcpSocket": { # Not supported by Cloud Run TCPSocketAction describes an action based on opening a socket # (Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message. |
| 260 | "host": "A String", # (Optional) Optional: Host name to connect to, defaults to the pod IP. |
| 261 | "port": 42, # Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. This field is currently limited to integer types only because of proto's inability to properly support the IntOrString golang type. |
| 262 | }, |
| 263 | "timeoutSeconds": 42, # (Optional) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 264 | }, |
| 265 | "resources": { # ResourceRequirements describes the compute resource requirements. # (Optional) Compute Resources required by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
| 266 | "limits": { # (Optional) Only memory and CPU are supported. Note: The only supported values for CPU are '1', '2', and '4'. Setting 4 CPU requires at least 2Gi of memory. Limits describes the maximum amount of compute resources allowed. 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 |
| 267 | "a_key": "A String", |
| 268 | }, |
| 269 | "requests": { # (Optional) Only memory and CPU are supported. Note: The only supported values for CPU are '1' and '2'. Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. 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 |
| 270 | "a_key": "A String", |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 271 | }, |
| 272 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 273 | "securityContext": { # Not supported by Cloud Run SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. # (Optional) Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
| 274 | "runAsUser": 42, # (Optional) The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
| 275 | }, |
| 276 | "startupProbe": { # Not supported by Cloud Run Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # (Optional) 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 |
| 277 | "exec": { # Not supported by Cloud Run ExecAction describes a "run in container" action. # (Optional) One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message. |
| 278 | "command": [ # (Optional) Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
| 279 | "A String", |
| 280 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 281 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 282 | "failureThreshold": 42, # (Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
| 283 | "httpGet": { # Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests. # (Optional) HTTPGet specifies the http request to perform. A field inlined from the Handler message. |
| 284 | "host": "A String", # (Optional) Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
| 285 | "httpHeaders": [ # (Optional) Custom headers to set in the request. HTTP allows repeated headers. |
| 286 | { # Not supported by Cloud Run HTTPHeader describes a custom header to be used in HTTP probes |
| 287 | "name": "A String", # The header field name |
| 288 | "value": "A String", # The header field value |
| 289 | }, |
| 290 | ], |
| 291 | "path": "A String", # (Optional) Path to access on the HTTP server. |
| 292 | "scheme": "A String", # (Optional) Scheme to use for connecting to the host. Defaults to HTTP. |
| 293 | }, |
| 294 | "initialDelaySeconds": 42, # (Optional) Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 295 | "periodSeconds": 42, # (Optional) How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
| 296 | "successThreshold": 42, # (Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
| 297 | "tcpSocket": { # Not supported by Cloud Run TCPSocketAction describes an action based on opening a socket # (Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message. |
| 298 | "host": "A String", # (Optional) Optional: Host name to connect to, defaults to the pod IP. |
| 299 | "port": 42, # Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. This field is currently limited to integer types only because of proto's inability to properly support the IntOrString golang type. |
| 300 | }, |
| 301 | "timeoutSeconds": 42, # (Optional) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 302 | }, |
| 303 | "terminationMessagePath": "A String", # (Optional) Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. |
| 304 | "terminationMessagePolicy": "A String", # (Optional) Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
| 305 | "volumeMounts": [ # (Optional) Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem. |
| 306 | { # Not supported by Cloud Run VolumeMount describes a mounting of a Volume within a container. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 307 | "mountPath": "A String", # Path within the container at which the volume should be mounted. Must not contain ':'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 308 | "name": "A String", # This must match the Name of a Volume. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 309 | "readOnly": True or False, # (Optional) Only true is accepted. Defaults to true. |
| 310 | "subPath": "A String", # (Optional) Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 311 | }, |
| 312 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 313 | "workingDir": "A String", # (Optional) Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 314 | }, |
| 315 | ], |
| 316 | "restartPolicy": "A String", # Optional. Restart policy for all containers within the instance. Allowed values are: - OnFailure: Instances will always be restarted on failure if the backoffLimit has not been reached. - Never: Instances are never restarted and all failures are permanent. Cannot be used if backoffLimit is set. +optional |
| 317 | "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the instance of a Job. The service account represents the identity of the running instance, and determines what permissions the instance has. If not provided, the instance will use the project's default service account. +optional |
| 318 | "terminationGracePeriodSeconds": "A String", # Optional. Optional duration in seconds the instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates delete immediately. The grace period is the duration in seconds after the processes running in the instance are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. +optional |
| 319 | "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the instance. More info: https://kubernetes.io/docs/concepts/storage/volumes +optional |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 320 | { # Not supported by Cloud Run Volume represents a named volume in a container. |
| 321 | "configMap": { # Not supported by Cloud Run Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. |
| 322 | "defaultMode": 42, # (Optional) Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
| 323 | "items": [ # (Optional) If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 324 | { # Maps a string key to a path within a volume. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 325 | "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. |
| 326 | "mode": 42, # (Optional) Mode bits to use on this file, must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
| 327 | "path": "A String", # The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 328 | }, |
| 329 | ], |
| 330 | "name": "A String", # Name of the config. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 331 | "optional": True or False, # (Optional) Specify whether the Secret or its keys must be defined. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 332 | }, |
| 333 | "name": "A String", # Volume's name. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 334 | "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. |
| 335 | "defaultMode": 42, # (Optional) Mode bits to use on created files by default. Must be a value between 0000 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. NOTE: This is an integer representation of the mode bits. So, the integer value should look exactly as the chmod numeric notation, i.e. Unix chmod "777" (a=rwx) should have the integer value 777. |
| 336 | "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. 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 key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 337 | { # Maps a string key to a path within a volume. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 338 | "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. |
| 339 | "mode": 42, # (Optional) Mode bits to use on this file, must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
| 340 | "path": "A String", # The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 341 | }, |
| 342 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 343 | "optional": True or False, # (Optional) Specify whether the Secret or its keys must be defined. |
| 344 | "secretName": "A String", # The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. Name of the secret in the container's namespace to use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 345 | }, |
| 346 | }, |
| 347 | ], |
| 348 | }, |
| 349 | }, |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 350 | "ttlSecondsAfterFinished": 42, # Optional. Not supported. ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is set to zero, the Job won't be automatically deleted. +optional |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 351 | }, |
| 352 | "status": { # JobStatus represents the current state of a Job. # Optional. Current status of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional |
| 353 | "active": 42, # Optional. The number of actively running instances. +optional |
| 354 | "completionTime": "A String", # Optional. Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 355 | "conditions": [ # Optional. The latest available observations of a job's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional |
| 356 | { # JobCondition defines a readiness condition for a Revision. |
| 357 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 358 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 359 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 360 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 361 | "status": "A String", # Required. Status of the condition, one of True, False, Unknown. |
| 362 | "type": "A String", # Required. Type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include: * "Completed": True when the Job has successfully completed. * "Started": True when the Job has successfully started running. * "ResourcesAvailable": True when underlying resources have been provisioned. |
| 363 | }, |
| 364 | ], |
| 365 | "failed": 42, # Optional. The number of instances which reached phase Failed. +optional |
| 366 | "imageDigest": "A String", # Optional. ImageDigest holds the resolved digest for the image specified within .Spec.Template.Spec.Container.Image. The digest is resolved during the creation of the Job. This field holds the digest value regardless of whether a tag or digest was originally specified in the Container object. |
| 367 | "instances": [ # Optional. Status of completed, failed, and running instances. +optional |
| 368 | { # Instance represents the status of an instance of a Job. |
| 369 | "completionTime": "A String", # Optional. Represents time when the instance was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 370 | "failed": 42, # Optional. The number of times this instance exited with code > 0; +optional |
| 371 | "index": 42, # Required. Index of the instance, unique per Job, and beginning at 0. |
| 372 | "lastExitCode": 42, # Optional. Last exit code seen for this instance. +optional |
| 373 | "restarted": 42, # Optional. The number of times this instance was restarted. Instances are restarted according the restartPolicy configured in the Job template. +optional |
| 374 | "startTime": "A String", # Optional. Represents time when the instance was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 375 | "succeeded": 42, # Optional. The number of times this instance exited with code == 0. +optional |
| 376 | }, |
| 377 | ], |
| 378 | "observedGeneration": 42, # Optional. The 'generation' of the job that was last processed by the controller. |
| 379 | "startTime": "A String", # Optional. Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 380 | "succeeded": 42, # Optional. The number of instances which reached phase Succeeded. +optional |
| 381 | }, |
| 382 | } |
| 383 | |
| 384 | x__xgafv: string, V1 error format. |
| 385 | Allowed values |
| 386 | 1 - v1 error format |
| 387 | 2 - v2 error format |
| 388 | |
| 389 | Returns: |
| 390 | An object of the form: |
| 391 | |
| 392 | { # Job represents the configuration of a single job. A job an immutable resource that references a container image which is run to completion. |
| 393 | "apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional |
| 394 | "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 395 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional |
| 396 | "annotations": { # (Optional) 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 |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 397 | "a_key": "A String", |
| 398 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 399 | "clusterName": "A String", # (Optional) Not supported by Cloud Run 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. |
| 400 | "creationTimestamp": "A String", # (Optional) CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 401 | "deletionGracePeriodSeconds": 42, # (Optional) Not supported by Cloud Run 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. |
| 402 | "deletionTimestamp": "A String", # (Optional) Not supported by Cloud Run DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 403 | "finalizers": [ # (Optional) Not supported by Cloud Run 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. +patchStrategy=merge |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 404 | "A String", |
| 405 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 406 | "generateName": "A String", # (Optional) Not supported by Cloud Run 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. If 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). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency string generateName = 2; |
| 407 | "generation": 42, # (Optional) A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
| 408 | "labels": { # (Optional) 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 routes. More info: http://kubernetes.io/docs/user-guide/labels |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 409 | "a_key": "A String", |
| 410 | }, |
| 411 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. 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 +optional |
| 412 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 413 | "ownerReferences": [ # (Optional) Not supported by Cloud Run List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 414 | { # OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field. |
| 415 | "apiVersion": "A String", # API version of the referent. |
| 416 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional |
| 417 | "controller": True or False, # If true, this reference points to the managing controller. +optional |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 418 | "kind": "A String", # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 419 | "name": "A String", # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 420 | "uid": "A String", # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 421 | }, |
| 422 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 423 | "resourceVersion": "A String", # Optional. 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 or omit the value to disable conflict-detection. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients or omitted. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
| 424 | "selfLink": "A String", # (Optional) SelfLink is a URL representing this object. Populated by the system. Read-only. string selfLink = 4; |
| 425 | "uid": "A String", # (Optional) 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. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 426 | }, |
| 427 | "spec": { # JobSpec describes how the job execution will look like. # Optional. Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 428 | "activeDeadlineSeconds": "A String", # Optional. Not supported. Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it. If set to zero, the system will never attempt to terminate the job based on time. Otherwise, the value must be positive integer. +optional |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 429 | "backoffLimit": 42, # Optional. Specifies the number of retries per instance, before marking this job failed. If set to zero, instances will never retry on failure. +optional |
| 430 | "completions": 42, # Optional. Specifies the desired number of successfully finished instances the job should be run with. Setting to 1 means that parallelism is limited to 1 and the success of that instance signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional |
| 431 | "parallelism": 42, # Optional. Specifies the maximum desired number of instances the job should run at any given time. Must be <= completions. The actual number of instances running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional |
| 432 | "template": { # InstanceTemplateSpec describes the data an instance should have when created from a template. # Optional. Describes the instance that will be created when executing a job. |
| 433 | "spec": { # InstanceSpec is a description of an instance. # Optional. Specification of the desired behavior of the instance. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional |
| 434 | "activeDeadlineSeconds": "A String", # Optional. Optional duration in seconds the instance may be active relative to StartTime before the system will actively try to mark it failed and kill associated containers. If set to zero, the system will never attempt to kill an instance based on time. Otherwise, value must be a positive integer. +optional |
| 435 | "containers": [ # Optional. List of containers belonging to the instance. We disallow a number of fields on this Container. Only a single container may be provided. |
| 436 | { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 437 | "args": [ # (Optional) 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 |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 438 | "A String", |
| 439 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 440 | "command": [ |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 441 | "A String", |
| 442 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 443 | "env": [ # (Optional) List of environment variables to set in the container. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 444 | { # EnvVar represents an environment variable present in a Container. |
| 445 | "name": "A String", # Name of the environment variable. Must be a C_IDENTIFIER. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 446 | "value": "A String", # (Optional) Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. 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. Defaults to "". |
| 447 | "valueFrom": { # EnvVarSource represents a source for the value of an EnvVar. # (Optional) Source for the environment variable's value. Only supports secret_key_ref. Source for the environment variable's value. Cannot be used if value is not empty. |
| 448 | "configMapKeyRef": { # Not supported by Cloud Run Selects a key from a ConfigMap. # (Optional) Not supported by Cloud Run Selects a key of a ConfigMap. |
| 449 | "key": "A String", # The key to select. |
| 450 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 451 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 452 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 453 | "name": "A String", # The ConfigMap to select from. |
| 454 | "optional": True or False, # (Optional) Specify whether the ConfigMap or its key must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 455 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 456 | "secretKeyRef": { # SecretKeySelector selects a key of a Secret. # (Optional) Selects a key (version) of a secret in Secret Manager. |
| 457 | "key": "A String", # A Cloud Secret Manager secret version. Must be 'latest' for the latest version or an integer for a specific version. The key of the secret to select from. Must be a valid secret key. |
| 458 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 459 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 460 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 461 | "name": "A String", # The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. The name of the secret in the pod's namespace to select from. |
| 462 | "optional": True or False, # (Optional) Specify whether the Secret or its key must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 463 | }, |
| 464 | }, |
| 465 | }, |
| 466 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 467 | "envFrom": [ # (Optional) List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. |
| 468 | { # Not supported by Cloud Run EnvFromSource represents the source of a set of ConfigMaps |
| 469 | "configMapRef": { # Not supported by Cloud Run ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. # (Optional) The ConfigMap to select from |
| 470 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 471 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 472 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 473 | "name": "A String", # The ConfigMap to select from. |
| 474 | "optional": True or False, # (Optional) Specify whether the ConfigMap must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 475 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 476 | "prefix": "A String", # (Optional) An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. |
| 477 | "secretRef": { # Not supported by Cloud Run SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables. # (Optional) The Secret to select from |
| 478 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 479 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 480 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 481 | "name": "A String", # The Secret to select from. |
| 482 | "optional": True or False, # (Optional) Specify whether the Secret must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 483 | }, |
| 484 | }, |
| 485 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 486 | "image": "A String", # Only supports containers from Google Container Registry or Artifact Registry URL of the Container image. More info: https://kubernetes.io/docs/concepts/containers/images |
| 487 | "imagePullPolicy": "A String", # (Optional) Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
| 488 | "livenessProbe": { # Not supported by Cloud Run Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # (Optional) 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 |
| 489 | "exec": { # Not supported by Cloud Run ExecAction describes a "run in container" action. # (Optional) One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message. |
| 490 | "command": [ # (Optional) Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
| 491 | "A String", |
| 492 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 493 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 494 | "failureThreshold": 42, # (Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
| 495 | "httpGet": { # Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests. # (Optional) HTTPGet specifies the http request to perform. A field inlined from the Handler message. |
| 496 | "host": "A String", # (Optional) Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
| 497 | "httpHeaders": [ # (Optional) Custom headers to set in the request. HTTP allows repeated headers. |
| 498 | { # Not supported by Cloud Run HTTPHeader describes a custom header to be used in HTTP probes |
| 499 | "name": "A String", # The header field name |
| 500 | "value": "A String", # The header field value |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 501 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 502 | ], |
| 503 | "path": "A String", # (Optional) Path to access on the HTTP server. |
| 504 | "scheme": "A String", # (Optional) Scheme to use for connecting to the host. Defaults to HTTP. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 505 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 506 | "initialDelaySeconds": 42, # (Optional) Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 507 | "periodSeconds": 42, # (Optional) How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
| 508 | "successThreshold": 42, # (Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
| 509 | "tcpSocket": { # Not supported by Cloud Run TCPSocketAction describes an action based on opening a socket # (Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message. |
| 510 | "host": "A String", # (Optional) Optional: Host name to connect to, defaults to the pod IP. |
| 511 | "port": 42, # Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. This field is currently limited to integer types only because of proto's inability to properly support the IntOrString golang type. |
| 512 | }, |
| 513 | "timeoutSeconds": 42, # (Optional) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 514 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 515 | "name": "A String", # (Optional) Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names |
| 516 | "ports": [ # (Optional) 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 517 | { # ContainerPort represents a network port in a single container. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 518 | "containerPort": 42, # (Optional) Port number the container listens on. This must be a valid port number, 0 < x < 65536. |
| 519 | "name": "A String", # (Optional) If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c". |
| 520 | "protocol": "A String", # (Optional) Protocol for port. Must be "TCP". Defaults to "TCP". |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 521 | }, |
| 522 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 523 | "readinessProbe": { # Not supported by Cloud Run Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # (Optional) Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 524 | "exec": { # Not supported by Cloud Run ExecAction describes a "run in container" action. # (Optional) One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message. |
| 525 | "command": [ # (Optional) Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 526 | "A String", |
| 527 | ], |
| 528 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 529 | "failureThreshold": 42, # (Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
| 530 | "httpGet": { # Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests. # (Optional) HTTPGet specifies the http request to perform. A field inlined from the Handler message. |
| 531 | "host": "A String", # (Optional) Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
| 532 | "httpHeaders": [ # (Optional) Custom headers to set in the request. HTTP allows repeated headers. |
| 533 | { # Not supported by Cloud Run HTTPHeader describes a custom header to be used in HTTP probes |
| 534 | "name": "A String", # The header field name |
| 535 | "value": "A String", # The header field value |
| 536 | }, |
| 537 | ], |
| 538 | "path": "A String", # (Optional) Path to access on the HTTP server. |
| 539 | "scheme": "A String", # (Optional) Scheme to use for connecting to the host. Defaults to HTTP. |
| 540 | }, |
| 541 | "initialDelaySeconds": 42, # (Optional) Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 542 | "periodSeconds": 42, # (Optional) How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
| 543 | "successThreshold": 42, # (Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
| 544 | "tcpSocket": { # Not supported by Cloud Run TCPSocketAction describes an action based on opening a socket # (Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message. |
| 545 | "host": "A String", # (Optional) Optional: Host name to connect to, defaults to the pod IP. |
| 546 | "port": 42, # Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. This field is currently limited to integer types only because of proto's inability to properly support the IntOrString golang type. |
| 547 | }, |
| 548 | "timeoutSeconds": 42, # (Optional) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 549 | }, |
| 550 | "resources": { # ResourceRequirements describes the compute resource requirements. # (Optional) Compute Resources required by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
| 551 | "limits": { # (Optional) Only memory and CPU are supported. Note: The only supported values for CPU are '1', '2', and '4'. Setting 4 CPU requires at least 2Gi of memory. Limits describes the maximum amount of compute resources allowed. 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 |
| 552 | "a_key": "A String", |
| 553 | }, |
| 554 | "requests": { # (Optional) Only memory and CPU are supported. Note: The only supported values for CPU are '1' and '2'. Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. 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 |
| 555 | "a_key": "A String", |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 556 | }, |
| 557 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 558 | "securityContext": { # Not supported by Cloud Run SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. # (Optional) Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
| 559 | "runAsUser": 42, # (Optional) The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
| 560 | }, |
| 561 | "startupProbe": { # Not supported by Cloud Run Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # (Optional) 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 |
| 562 | "exec": { # Not supported by Cloud Run ExecAction describes a "run in container" action. # (Optional) One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message. |
| 563 | "command": [ # (Optional) Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
| 564 | "A String", |
| 565 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 566 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 567 | "failureThreshold": 42, # (Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
| 568 | "httpGet": { # Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests. # (Optional) HTTPGet specifies the http request to perform. A field inlined from the Handler message. |
| 569 | "host": "A String", # (Optional) Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
| 570 | "httpHeaders": [ # (Optional) Custom headers to set in the request. HTTP allows repeated headers. |
| 571 | { # Not supported by Cloud Run HTTPHeader describes a custom header to be used in HTTP probes |
| 572 | "name": "A String", # The header field name |
| 573 | "value": "A String", # The header field value |
| 574 | }, |
| 575 | ], |
| 576 | "path": "A String", # (Optional) Path to access on the HTTP server. |
| 577 | "scheme": "A String", # (Optional) Scheme to use for connecting to the host. Defaults to HTTP. |
| 578 | }, |
| 579 | "initialDelaySeconds": 42, # (Optional) Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 580 | "periodSeconds": 42, # (Optional) How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
| 581 | "successThreshold": 42, # (Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
| 582 | "tcpSocket": { # Not supported by Cloud Run TCPSocketAction describes an action based on opening a socket # (Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message. |
| 583 | "host": "A String", # (Optional) Optional: Host name to connect to, defaults to the pod IP. |
| 584 | "port": 42, # Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. This field is currently limited to integer types only because of proto's inability to properly support the IntOrString golang type. |
| 585 | }, |
| 586 | "timeoutSeconds": 42, # (Optional) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 587 | }, |
| 588 | "terminationMessagePath": "A String", # (Optional) Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. |
| 589 | "terminationMessagePolicy": "A String", # (Optional) Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
| 590 | "volumeMounts": [ # (Optional) Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem. |
| 591 | { # Not supported by Cloud Run VolumeMount describes a mounting of a Volume within a container. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 592 | "mountPath": "A String", # Path within the container at which the volume should be mounted. Must not contain ':'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 593 | "name": "A String", # This must match the Name of a Volume. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 594 | "readOnly": True or False, # (Optional) Only true is accepted. Defaults to true. |
| 595 | "subPath": "A String", # (Optional) Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 596 | }, |
| 597 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 598 | "workingDir": "A String", # (Optional) Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 599 | }, |
| 600 | ], |
| 601 | "restartPolicy": "A String", # Optional. Restart policy for all containers within the instance. Allowed values are: - OnFailure: Instances will always be restarted on failure if the backoffLimit has not been reached. - Never: Instances are never restarted and all failures are permanent. Cannot be used if backoffLimit is set. +optional |
| 602 | "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the instance of a Job. The service account represents the identity of the running instance, and determines what permissions the instance has. If not provided, the instance will use the project's default service account. +optional |
| 603 | "terminationGracePeriodSeconds": "A String", # Optional. Optional duration in seconds the instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates delete immediately. The grace period is the duration in seconds after the processes running in the instance are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. +optional |
| 604 | "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the instance. More info: https://kubernetes.io/docs/concepts/storage/volumes +optional |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 605 | { # Not supported by Cloud Run Volume represents a named volume in a container. |
| 606 | "configMap": { # Not supported by Cloud Run Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. |
| 607 | "defaultMode": 42, # (Optional) Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
| 608 | "items": [ # (Optional) If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 609 | { # Maps a string key to a path within a volume. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 610 | "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. |
| 611 | "mode": 42, # (Optional) Mode bits to use on this file, must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
| 612 | "path": "A String", # The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 613 | }, |
| 614 | ], |
| 615 | "name": "A String", # Name of the config. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 616 | "optional": True or False, # (Optional) Specify whether the Secret or its keys must be defined. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 617 | }, |
| 618 | "name": "A String", # Volume's name. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 619 | "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. |
| 620 | "defaultMode": 42, # (Optional) Mode bits to use on created files by default. Must be a value between 0000 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. NOTE: This is an integer representation of the mode bits. So, the integer value should look exactly as the chmod numeric notation, i.e. Unix chmod "777" (a=rwx) should have the integer value 777. |
| 621 | "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. 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 key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 622 | { # Maps a string key to a path within a volume. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 623 | "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. |
| 624 | "mode": 42, # (Optional) Mode bits to use on this file, must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
| 625 | "path": "A String", # The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 626 | }, |
| 627 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 628 | "optional": True or False, # (Optional) Specify whether the Secret or its keys must be defined. |
| 629 | "secretName": "A String", # The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. Name of the secret in the container's namespace to use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 630 | }, |
| 631 | }, |
| 632 | ], |
| 633 | }, |
| 634 | }, |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 635 | "ttlSecondsAfterFinished": 42, # Optional. Not supported. ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is set to zero, the Job won't be automatically deleted. +optional |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 636 | }, |
| 637 | "status": { # JobStatus represents the current state of a Job. # Optional. Current status of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional |
| 638 | "active": 42, # Optional. The number of actively running instances. +optional |
| 639 | "completionTime": "A String", # Optional. Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 640 | "conditions": [ # Optional. The latest available observations of a job's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional |
| 641 | { # JobCondition defines a readiness condition for a Revision. |
| 642 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 643 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 644 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 645 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 646 | "status": "A String", # Required. Status of the condition, one of True, False, Unknown. |
| 647 | "type": "A String", # Required. Type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include: * "Completed": True when the Job has successfully completed. * "Started": True when the Job has successfully started running. * "ResourcesAvailable": True when underlying resources have been provisioned. |
| 648 | }, |
| 649 | ], |
| 650 | "failed": 42, # Optional. The number of instances which reached phase Failed. +optional |
| 651 | "imageDigest": "A String", # Optional. ImageDigest holds the resolved digest for the image specified within .Spec.Template.Spec.Container.Image. The digest is resolved during the creation of the Job. This field holds the digest value regardless of whether a tag or digest was originally specified in the Container object. |
| 652 | "instances": [ # Optional. Status of completed, failed, and running instances. +optional |
| 653 | { # Instance represents the status of an instance of a Job. |
| 654 | "completionTime": "A String", # Optional. Represents time when the instance was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 655 | "failed": 42, # Optional. The number of times this instance exited with code > 0; +optional |
| 656 | "index": 42, # Required. Index of the instance, unique per Job, and beginning at 0. |
| 657 | "lastExitCode": 42, # Optional. Last exit code seen for this instance. +optional |
| 658 | "restarted": 42, # Optional. The number of times this instance was restarted. Instances are restarted according the restartPolicy configured in the Job template. +optional |
| 659 | "startTime": "A String", # Optional. Represents time when the instance was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 660 | "succeeded": 42, # Optional. The number of times this instance exited with code == 0. +optional |
| 661 | }, |
| 662 | ], |
| 663 | "observedGeneration": 42, # Optional. The 'generation' of the job that was last processed by the controller. |
| 664 | "startTime": "A String", # Optional. Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 665 | "succeeded": 42, # Optional. The number of instances which reached phase Succeeded. +optional |
| 666 | }, |
| 667 | }</pre> |
| 668 | </div> |
| 669 | |
| 670 | <div class="method"> |
| 671 | <code class="details" id="delete">delete(name, apiVersion=None, kind=None, propagationPolicy=None, x__xgafv=None)</code> |
| 672 | <pre>Delete a job. |
| 673 | |
| 674 | Args: |
| 675 | name: string, Required. The name of the job to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. (required) |
| 676 | apiVersion: string, Optional. Cloud Run currently ignores this parameter. |
| 677 | kind: string, Optional. Cloud Run currently ignores this parameter. |
| 678 | propagationPolicy: string, Optional. Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. |
| 679 | x__xgafv: string, V1 error format. |
| 680 | Allowed values |
| 681 | 1 - v1 error format |
| 682 | 2 - v2 error format |
| 683 | |
| 684 | Returns: |
| 685 | An object of the form: |
| 686 | |
| 687 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| 688 | }</pre> |
| 689 | </div> |
| 690 | |
| 691 | <div class="method"> |
| 692 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 693 | <pre>Get information about a job. |
| 694 | |
| 695 | Args: |
| 696 | name: string, Required. The name of the job to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. (required) |
| 697 | x__xgafv: string, V1 error format. |
| 698 | Allowed values |
| 699 | 1 - v1 error format |
| 700 | 2 - v2 error format |
| 701 | |
| 702 | Returns: |
| 703 | An object of the form: |
| 704 | |
| 705 | { # Job represents the configuration of a single job. A job an immutable resource that references a container image which is run to completion. |
| 706 | "apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional |
| 707 | "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 708 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional |
| 709 | "annotations": { # (Optional) 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 |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 710 | "a_key": "A String", |
| 711 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 712 | "clusterName": "A String", # (Optional) Not supported by Cloud Run 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. |
| 713 | "creationTimestamp": "A String", # (Optional) CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 714 | "deletionGracePeriodSeconds": 42, # (Optional) Not supported by Cloud Run 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. |
| 715 | "deletionTimestamp": "A String", # (Optional) Not supported by Cloud Run DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 716 | "finalizers": [ # (Optional) Not supported by Cloud Run 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. +patchStrategy=merge |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 717 | "A String", |
| 718 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 719 | "generateName": "A String", # (Optional) Not supported by Cloud Run 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. If 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). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency string generateName = 2; |
| 720 | "generation": 42, # (Optional) A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
| 721 | "labels": { # (Optional) 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 routes. More info: http://kubernetes.io/docs/user-guide/labels |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 722 | "a_key": "A String", |
| 723 | }, |
| 724 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. 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 +optional |
| 725 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 726 | "ownerReferences": [ # (Optional) Not supported by Cloud Run List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 727 | { # OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field. |
| 728 | "apiVersion": "A String", # API version of the referent. |
| 729 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional |
| 730 | "controller": True or False, # If true, this reference points to the managing controller. +optional |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 731 | "kind": "A String", # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 732 | "name": "A String", # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 733 | "uid": "A String", # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 734 | }, |
| 735 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 736 | "resourceVersion": "A String", # Optional. 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 or omit the value to disable conflict-detection. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients or omitted. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
| 737 | "selfLink": "A String", # (Optional) SelfLink is a URL representing this object. Populated by the system. Read-only. string selfLink = 4; |
| 738 | "uid": "A String", # (Optional) 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. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 739 | }, |
| 740 | "spec": { # JobSpec describes how the job execution will look like. # Optional. Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 741 | "activeDeadlineSeconds": "A String", # Optional. Not supported. Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it. If set to zero, the system will never attempt to terminate the job based on time. Otherwise, the value must be positive integer. +optional |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 742 | "backoffLimit": 42, # Optional. Specifies the number of retries per instance, before marking this job failed. If set to zero, instances will never retry on failure. +optional |
| 743 | "completions": 42, # Optional. Specifies the desired number of successfully finished instances the job should be run with. Setting to 1 means that parallelism is limited to 1 and the success of that instance signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional |
| 744 | "parallelism": 42, # Optional. Specifies the maximum desired number of instances the job should run at any given time. Must be <= completions. The actual number of instances running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional |
| 745 | "template": { # InstanceTemplateSpec describes the data an instance should have when created from a template. # Optional. Describes the instance that will be created when executing a job. |
| 746 | "spec": { # InstanceSpec is a description of an instance. # Optional. Specification of the desired behavior of the instance. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional |
| 747 | "activeDeadlineSeconds": "A String", # Optional. Optional duration in seconds the instance may be active relative to StartTime before the system will actively try to mark it failed and kill associated containers. If set to zero, the system will never attempt to kill an instance based on time. Otherwise, value must be a positive integer. +optional |
| 748 | "containers": [ # Optional. List of containers belonging to the instance. We disallow a number of fields on this Container. Only a single container may be provided. |
| 749 | { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 750 | "args": [ # (Optional) 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 |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 751 | "A String", |
| 752 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 753 | "command": [ |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 754 | "A String", |
| 755 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 756 | "env": [ # (Optional) List of environment variables to set in the container. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 757 | { # EnvVar represents an environment variable present in a Container. |
| 758 | "name": "A String", # Name of the environment variable. Must be a C_IDENTIFIER. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 759 | "value": "A String", # (Optional) Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. 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. Defaults to "". |
| 760 | "valueFrom": { # EnvVarSource represents a source for the value of an EnvVar. # (Optional) Source for the environment variable's value. Only supports secret_key_ref. Source for the environment variable's value. Cannot be used if value is not empty. |
| 761 | "configMapKeyRef": { # Not supported by Cloud Run Selects a key from a ConfigMap. # (Optional) Not supported by Cloud Run Selects a key of a ConfigMap. |
| 762 | "key": "A String", # The key to select. |
| 763 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 764 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 765 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 766 | "name": "A String", # The ConfigMap to select from. |
| 767 | "optional": True or False, # (Optional) Specify whether the ConfigMap or its key must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 768 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 769 | "secretKeyRef": { # SecretKeySelector selects a key of a Secret. # (Optional) Selects a key (version) of a secret in Secret Manager. |
| 770 | "key": "A String", # A Cloud Secret Manager secret version. Must be 'latest' for the latest version or an integer for a specific version. The key of the secret to select from. Must be a valid secret key. |
| 771 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 772 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 773 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 774 | "name": "A String", # The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. The name of the secret in the pod's namespace to select from. |
| 775 | "optional": True or False, # (Optional) Specify whether the Secret or its key must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 776 | }, |
| 777 | }, |
| 778 | }, |
| 779 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 780 | "envFrom": [ # (Optional) List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. |
| 781 | { # Not supported by Cloud Run EnvFromSource represents the source of a set of ConfigMaps |
| 782 | "configMapRef": { # Not supported by Cloud Run ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. # (Optional) The ConfigMap to select from |
| 783 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 784 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 785 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 786 | "name": "A String", # The ConfigMap to select from. |
| 787 | "optional": True or False, # (Optional) Specify whether the ConfigMap must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 788 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 789 | "prefix": "A String", # (Optional) An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. |
| 790 | "secretRef": { # Not supported by Cloud Run SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables. # (Optional) The Secret to select from |
| 791 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 792 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 793 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 794 | "name": "A String", # The Secret to select from. |
| 795 | "optional": True or False, # (Optional) Specify whether the Secret must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 796 | }, |
| 797 | }, |
| 798 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 799 | "image": "A String", # Only supports containers from Google Container Registry or Artifact Registry URL of the Container image. More info: https://kubernetes.io/docs/concepts/containers/images |
| 800 | "imagePullPolicy": "A String", # (Optional) Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
| 801 | "livenessProbe": { # Not supported by Cloud Run Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # (Optional) 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 |
| 802 | "exec": { # Not supported by Cloud Run ExecAction describes a "run in container" action. # (Optional) One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message. |
| 803 | "command": [ # (Optional) Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
| 804 | "A String", |
| 805 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 806 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 807 | "failureThreshold": 42, # (Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
| 808 | "httpGet": { # Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests. # (Optional) HTTPGet specifies the http request to perform. A field inlined from the Handler message. |
| 809 | "host": "A String", # (Optional) Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
| 810 | "httpHeaders": [ # (Optional) Custom headers to set in the request. HTTP allows repeated headers. |
| 811 | { # Not supported by Cloud Run HTTPHeader describes a custom header to be used in HTTP probes |
| 812 | "name": "A String", # The header field name |
| 813 | "value": "A String", # The header field value |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 814 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 815 | ], |
| 816 | "path": "A String", # (Optional) Path to access on the HTTP server. |
| 817 | "scheme": "A String", # (Optional) Scheme to use for connecting to the host. Defaults to HTTP. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 818 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 819 | "initialDelaySeconds": 42, # (Optional) Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 820 | "periodSeconds": 42, # (Optional) How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
| 821 | "successThreshold": 42, # (Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
| 822 | "tcpSocket": { # Not supported by Cloud Run TCPSocketAction describes an action based on opening a socket # (Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message. |
| 823 | "host": "A String", # (Optional) Optional: Host name to connect to, defaults to the pod IP. |
| 824 | "port": 42, # Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. This field is currently limited to integer types only because of proto's inability to properly support the IntOrString golang type. |
| 825 | }, |
| 826 | "timeoutSeconds": 42, # (Optional) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 827 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 828 | "name": "A String", # (Optional) Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names |
| 829 | "ports": [ # (Optional) 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 830 | { # ContainerPort represents a network port in a single container. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 831 | "containerPort": 42, # (Optional) Port number the container listens on. This must be a valid port number, 0 < x < 65536. |
| 832 | "name": "A String", # (Optional) If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c". |
| 833 | "protocol": "A String", # (Optional) Protocol for port. Must be "TCP". Defaults to "TCP". |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 834 | }, |
| 835 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 836 | "readinessProbe": { # Not supported by Cloud Run Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # (Optional) Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 837 | "exec": { # Not supported by Cloud Run ExecAction describes a "run in container" action. # (Optional) One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message. |
| 838 | "command": [ # (Optional) Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 839 | "A String", |
| 840 | ], |
| 841 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 842 | "failureThreshold": 42, # (Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
| 843 | "httpGet": { # Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests. # (Optional) HTTPGet specifies the http request to perform. A field inlined from the Handler message. |
| 844 | "host": "A String", # (Optional) Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
| 845 | "httpHeaders": [ # (Optional) Custom headers to set in the request. HTTP allows repeated headers. |
| 846 | { # Not supported by Cloud Run HTTPHeader describes a custom header to be used in HTTP probes |
| 847 | "name": "A String", # The header field name |
| 848 | "value": "A String", # The header field value |
| 849 | }, |
| 850 | ], |
| 851 | "path": "A String", # (Optional) Path to access on the HTTP server. |
| 852 | "scheme": "A String", # (Optional) Scheme to use for connecting to the host. Defaults to HTTP. |
| 853 | }, |
| 854 | "initialDelaySeconds": 42, # (Optional) Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 855 | "periodSeconds": 42, # (Optional) How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
| 856 | "successThreshold": 42, # (Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
| 857 | "tcpSocket": { # Not supported by Cloud Run TCPSocketAction describes an action based on opening a socket # (Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message. |
| 858 | "host": "A String", # (Optional) Optional: Host name to connect to, defaults to the pod IP. |
| 859 | "port": 42, # Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. This field is currently limited to integer types only because of proto's inability to properly support the IntOrString golang type. |
| 860 | }, |
| 861 | "timeoutSeconds": 42, # (Optional) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 862 | }, |
| 863 | "resources": { # ResourceRequirements describes the compute resource requirements. # (Optional) Compute Resources required by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
| 864 | "limits": { # (Optional) Only memory and CPU are supported. Note: The only supported values for CPU are '1', '2', and '4'. Setting 4 CPU requires at least 2Gi of memory. Limits describes the maximum amount of compute resources allowed. 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 |
| 865 | "a_key": "A String", |
| 866 | }, |
| 867 | "requests": { # (Optional) Only memory and CPU are supported. Note: The only supported values for CPU are '1' and '2'. Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. 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 |
| 868 | "a_key": "A String", |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 869 | }, |
| 870 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 871 | "securityContext": { # Not supported by Cloud Run SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. # (Optional) Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
| 872 | "runAsUser": 42, # (Optional) The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
| 873 | }, |
| 874 | "startupProbe": { # Not supported by Cloud Run Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # (Optional) 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 |
| 875 | "exec": { # Not supported by Cloud Run ExecAction describes a "run in container" action. # (Optional) One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message. |
| 876 | "command": [ # (Optional) Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
| 877 | "A String", |
| 878 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 879 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 880 | "failureThreshold": 42, # (Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
| 881 | "httpGet": { # Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests. # (Optional) HTTPGet specifies the http request to perform. A field inlined from the Handler message. |
| 882 | "host": "A String", # (Optional) Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
| 883 | "httpHeaders": [ # (Optional) Custom headers to set in the request. HTTP allows repeated headers. |
| 884 | { # Not supported by Cloud Run HTTPHeader describes a custom header to be used in HTTP probes |
| 885 | "name": "A String", # The header field name |
| 886 | "value": "A String", # The header field value |
| 887 | }, |
| 888 | ], |
| 889 | "path": "A String", # (Optional) Path to access on the HTTP server. |
| 890 | "scheme": "A String", # (Optional) Scheme to use for connecting to the host. Defaults to HTTP. |
| 891 | }, |
| 892 | "initialDelaySeconds": 42, # (Optional) Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 893 | "periodSeconds": 42, # (Optional) How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
| 894 | "successThreshold": 42, # (Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
| 895 | "tcpSocket": { # Not supported by Cloud Run TCPSocketAction describes an action based on opening a socket # (Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message. |
| 896 | "host": "A String", # (Optional) Optional: Host name to connect to, defaults to the pod IP. |
| 897 | "port": 42, # Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. This field is currently limited to integer types only because of proto's inability to properly support the IntOrString golang type. |
| 898 | }, |
| 899 | "timeoutSeconds": 42, # (Optional) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 900 | }, |
| 901 | "terminationMessagePath": "A String", # (Optional) Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. |
| 902 | "terminationMessagePolicy": "A String", # (Optional) Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
| 903 | "volumeMounts": [ # (Optional) Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem. |
| 904 | { # Not supported by Cloud Run VolumeMount describes a mounting of a Volume within a container. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 905 | "mountPath": "A String", # Path within the container at which the volume should be mounted. Must not contain ':'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 906 | "name": "A String", # This must match the Name of a Volume. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 907 | "readOnly": True or False, # (Optional) Only true is accepted. Defaults to true. |
| 908 | "subPath": "A String", # (Optional) Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 909 | }, |
| 910 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 911 | "workingDir": "A String", # (Optional) Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 912 | }, |
| 913 | ], |
| 914 | "restartPolicy": "A String", # Optional. Restart policy for all containers within the instance. Allowed values are: - OnFailure: Instances will always be restarted on failure if the backoffLimit has not been reached. - Never: Instances are never restarted and all failures are permanent. Cannot be used if backoffLimit is set. +optional |
| 915 | "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the instance of a Job. The service account represents the identity of the running instance, and determines what permissions the instance has. If not provided, the instance will use the project's default service account. +optional |
| 916 | "terminationGracePeriodSeconds": "A String", # Optional. Optional duration in seconds the instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates delete immediately. The grace period is the duration in seconds after the processes running in the instance are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. +optional |
| 917 | "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the instance. More info: https://kubernetes.io/docs/concepts/storage/volumes +optional |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 918 | { # Not supported by Cloud Run Volume represents a named volume in a container. |
| 919 | "configMap": { # Not supported by Cloud Run Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. |
| 920 | "defaultMode": 42, # (Optional) Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
| 921 | "items": [ # (Optional) If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 922 | { # Maps a string key to a path within a volume. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 923 | "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. |
| 924 | "mode": 42, # (Optional) Mode bits to use on this file, must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
| 925 | "path": "A String", # The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 926 | }, |
| 927 | ], |
| 928 | "name": "A String", # Name of the config. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 929 | "optional": True or False, # (Optional) Specify whether the Secret or its keys must be defined. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 930 | }, |
| 931 | "name": "A String", # Volume's name. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 932 | "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. |
| 933 | "defaultMode": 42, # (Optional) Mode bits to use on created files by default. Must be a value between 0000 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. NOTE: This is an integer representation of the mode bits. So, the integer value should look exactly as the chmod numeric notation, i.e. Unix chmod "777" (a=rwx) should have the integer value 777. |
| 934 | "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. 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 key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 935 | { # Maps a string key to a path within a volume. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 936 | "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. |
| 937 | "mode": 42, # (Optional) Mode bits to use on this file, must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
| 938 | "path": "A String", # The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 939 | }, |
| 940 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 941 | "optional": True or False, # (Optional) Specify whether the Secret or its keys must be defined. |
| 942 | "secretName": "A String", # The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. Name of the secret in the container's namespace to use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 943 | }, |
| 944 | }, |
| 945 | ], |
| 946 | }, |
| 947 | }, |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 948 | "ttlSecondsAfterFinished": 42, # Optional. Not supported. ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is set to zero, the Job won't be automatically deleted. +optional |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 949 | }, |
| 950 | "status": { # JobStatus represents the current state of a Job. # Optional. Current status of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional |
| 951 | "active": 42, # Optional. The number of actively running instances. +optional |
| 952 | "completionTime": "A String", # Optional. Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 953 | "conditions": [ # Optional. The latest available observations of a job's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional |
| 954 | { # JobCondition defines a readiness condition for a Revision. |
| 955 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 956 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 957 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 958 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 959 | "status": "A String", # Required. Status of the condition, one of True, False, Unknown. |
| 960 | "type": "A String", # Required. Type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include: * "Completed": True when the Job has successfully completed. * "Started": True when the Job has successfully started running. * "ResourcesAvailable": True when underlying resources have been provisioned. |
| 961 | }, |
| 962 | ], |
| 963 | "failed": 42, # Optional. The number of instances which reached phase Failed. +optional |
| 964 | "imageDigest": "A String", # Optional. ImageDigest holds the resolved digest for the image specified within .Spec.Template.Spec.Container.Image. The digest is resolved during the creation of the Job. This field holds the digest value regardless of whether a tag or digest was originally specified in the Container object. |
| 965 | "instances": [ # Optional. Status of completed, failed, and running instances. +optional |
| 966 | { # Instance represents the status of an instance of a Job. |
| 967 | "completionTime": "A String", # Optional. Represents time when the instance was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 968 | "failed": 42, # Optional. The number of times this instance exited with code > 0; +optional |
| 969 | "index": 42, # Required. Index of the instance, unique per Job, and beginning at 0. |
| 970 | "lastExitCode": 42, # Optional. Last exit code seen for this instance. +optional |
| 971 | "restarted": 42, # Optional. The number of times this instance was restarted. Instances are restarted according the restartPolicy configured in the Job template. +optional |
| 972 | "startTime": "A String", # Optional. Represents time when the instance was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 973 | "succeeded": 42, # Optional. The number of times this instance exited with code == 0. +optional |
| 974 | }, |
| 975 | ], |
| 976 | "observedGeneration": 42, # Optional. The 'generation' of the job that was last processed by the controller. |
| 977 | "startTime": "A String", # Optional. Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 978 | "succeeded": 42, # Optional. The number of instances which reached phase Succeeded. +optional |
| 979 | }, |
| 980 | }</pre> |
| 981 | </div> |
| 982 | |
| 983 | <div class="method"> |
| 984 | <code class="details" id="list">list(parent, continue=None, fieldSelector=None, includeUninitialized=None, labelSelector=None, limit=None, resourceVersion=None, watch=None, x__xgafv=None)</code> |
| 985 | <pre>List jobs. |
| 986 | |
| 987 | Args: |
| 988 | parent: string, Required. The namespace from which the jobs should be listed. Replace {namespace_id} with the project ID or number. (required) |
| 989 | continue: string, Optional. Optional encoded string to continue paging. |
| 990 | fieldSelector: string, Optional. Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. |
| 991 | includeUninitialized: boolean, Optional. Not currently used by Cloud Run. |
| 992 | labelSelector: string, Optional. Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. |
| 993 | limit: integer, Optional. The maximum number of records that should be returned. |
| 994 | resourceVersion: string, Optional. The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. |
| 995 | watch: boolean, Optional. Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. |
| 996 | x__xgafv: string, V1 error format. |
| 997 | Allowed values |
| 998 | 1 - v1 error format |
| 999 | 2 - v2 error format |
| 1000 | |
| 1001 | Returns: |
| 1002 | An object of the form: |
| 1003 | |
| 1004 | { # ListJobsResponse is a list of Jobs resources. |
| 1005 | "apiVersion": "A String", # The API version for this call such as "run.googleapis.com/v1alpha1". |
| 1006 | "items": [ # List of Jobs. |
| 1007 | { # Job represents the configuration of a single job. A job an immutable resource that references a container image which is run to completion. |
| 1008 | "apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional |
| 1009 | "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1010 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional |
| 1011 | "annotations": { # (Optional) 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 |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1012 | "a_key": "A String", |
| 1013 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1014 | "clusterName": "A String", # (Optional) Not supported by Cloud Run 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. |
| 1015 | "creationTimestamp": "A String", # (Optional) CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1016 | "deletionGracePeriodSeconds": 42, # (Optional) Not supported by Cloud Run 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. |
| 1017 | "deletionTimestamp": "A String", # (Optional) Not supported by Cloud Run DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1018 | "finalizers": [ # (Optional) Not supported by Cloud Run 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. +patchStrategy=merge |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1019 | "A String", |
| 1020 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1021 | "generateName": "A String", # (Optional) Not supported by Cloud Run 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. If 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). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency string generateName = 2; |
| 1022 | "generation": 42, # (Optional) A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
| 1023 | "labels": { # (Optional) 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 routes. More info: http://kubernetes.io/docs/user-guide/labels |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1024 | "a_key": "A String", |
| 1025 | }, |
| 1026 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. 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 +optional |
| 1027 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1028 | "ownerReferences": [ # (Optional) Not supported by Cloud Run List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1029 | { # OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field. |
| 1030 | "apiVersion": "A String", # API version of the referent. |
| 1031 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional |
| 1032 | "controller": True or False, # If true, this reference points to the managing controller. +optional |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1033 | "kind": "A String", # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1034 | "name": "A String", # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1035 | "uid": "A String", # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1036 | }, |
| 1037 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1038 | "resourceVersion": "A String", # Optional. 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 or omit the value to disable conflict-detection. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients or omitted. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
| 1039 | "selfLink": "A String", # (Optional) SelfLink is a URL representing this object. Populated by the system. Read-only. string selfLink = 4; |
| 1040 | "uid": "A String", # (Optional) 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. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1041 | }, |
| 1042 | "spec": { # JobSpec describes how the job execution will look like. # Optional. Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 1043 | "activeDeadlineSeconds": "A String", # Optional. Not supported. Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it. If set to zero, the system will never attempt to terminate the job based on time. Otherwise, the value must be positive integer. +optional |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1044 | "backoffLimit": 42, # Optional. Specifies the number of retries per instance, before marking this job failed. If set to zero, instances will never retry on failure. +optional |
| 1045 | "completions": 42, # Optional. Specifies the desired number of successfully finished instances the job should be run with. Setting to 1 means that parallelism is limited to 1 and the success of that instance signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional |
| 1046 | "parallelism": 42, # Optional. Specifies the maximum desired number of instances the job should run at any given time. Must be <= completions. The actual number of instances running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional |
| 1047 | "template": { # InstanceTemplateSpec describes the data an instance should have when created from a template. # Optional. Describes the instance that will be created when executing a job. |
| 1048 | "spec": { # InstanceSpec is a description of an instance. # Optional. Specification of the desired behavior of the instance. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional |
| 1049 | "activeDeadlineSeconds": "A String", # Optional. Optional duration in seconds the instance may be active relative to StartTime before the system will actively try to mark it failed and kill associated containers. If set to zero, the system will never attempt to kill an instance based on time. Otherwise, value must be a positive integer. +optional |
| 1050 | "containers": [ # Optional. List of containers belonging to the instance. We disallow a number of fields on this Container. Only a single container may be provided. |
| 1051 | { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1052 | "args": [ # (Optional) 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 |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1053 | "A String", |
| 1054 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1055 | "command": [ |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1056 | "A String", |
| 1057 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1058 | "env": [ # (Optional) List of environment variables to set in the container. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1059 | { # EnvVar represents an environment variable present in a Container. |
| 1060 | "name": "A String", # Name of the environment variable. Must be a C_IDENTIFIER. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1061 | "value": "A String", # (Optional) Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. 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. Defaults to "". |
| 1062 | "valueFrom": { # EnvVarSource represents a source for the value of an EnvVar. # (Optional) Source for the environment variable's value. Only supports secret_key_ref. Source for the environment variable's value. Cannot be used if value is not empty. |
| 1063 | "configMapKeyRef": { # Not supported by Cloud Run Selects a key from a ConfigMap. # (Optional) Not supported by Cloud Run Selects a key of a ConfigMap. |
| 1064 | "key": "A String", # The key to select. |
| 1065 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 1066 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1067 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1068 | "name": "A String", # The ConfigMap to select from. |
| 1069 | "optional": True or False, # (Optional) Specify whether the ConfigMap or its key must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1070 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1071 | "secretKeyRef": { # SecretKeySelector selects a key of a Secret. # (Optional) Selects a key (version) of a secret in Secret Manager. |
| 1072 | "key": "A String", # A Cloud Secret Manager secret version. Must be 'latest' for the latest version or an integer for a specific version. The key of the secret to select from. Must be a valid secret key. |
| 1073 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 1074 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1075 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1076 | "name": "A String", # The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. The name of the secret in the pod's namespace to select from. |
| 1077 | "optional": True or False, # (Optional) Specify whether the Secret or its key must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1078 | }, |
| 1079 | }, |
| 1080 | }, |
| 1081 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1082 | "envFrom": [ # (Optional) List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. |
| 1083 | { # Not supported by Cloud Run EnvFromSource represents the source of a set of ConfigMaps |
| 1084 | "configMapRef": { # Not supported by Cloud Run ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. # (Optional) The ConfigMap to select from |
| 1085 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 1086 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1087 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1088 | "name": "A String", # The ConfigMap to select from. |
| 1089 | "optional": True or False, # (Optional) Specify whether the ConfigMap must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1090 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1091 | "prefix": "A String", # (Optional) An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. |
| 1092 | "secretRef": { # Not supported by Cloud Run SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables. # (Optional) The Secret to select from |
| 1093 | "localObjectReference": { # Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
| 1094 | "name": "A String", # (Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1095 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1096 | "name": "A String", # The Secret to select from. |
| 1097 | "optional": True or False, # (Optional) Specify whether the Secret must be defined |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1098 | }, |
| 1099 | }, |
| 1100 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1101 | "image": "A String", # Only supports containers from Google Container Registry or Artifact Registry URL of the Container image. More info: https://kubernetes.io/docs/concepts/containers/images |
| 1102 | "imagePullPolicy": "A String", # (Optional) Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
| 1103 | "livenessProbe": { # Not supported by Cloud Run Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # (Optional) 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 |
| 1104 | "exec": { # Not supported by Cloud Run ExecAction describes a "run in container" action. # (Optional) One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message. |
| 1105 | "command": [ # (Optional) Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
| 1106 | "A String", |
| 1107 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1108 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1109 | "failureThreshold": 42, # (Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
| 1110 | "httpGet": { # Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests. # (Optional) HTTPGet specifies the http request to perform. A field inlined from the Handler message. |
| 1111 | "host": "A String", # (Optional) Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
| 1112 | "httpHeaders": [ # (Optional) Custom headers to set in the request. HTTP allows repeated headers. |
| 1113 | { # Not supported by Cloud Run HTTPHeader describes a custom header to be used in HTTP probes |
| 1114 | "name": "A String", # The header field name |
| 1115 | "value": "A String", # The header field value |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1116 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1117 | ], |
| 1118 | "path": "A String", # (Optional) Path to access on the HTTP server. |
| 1119 | "scheme": "A String", # (Optional) Scheme to use for connecting to the host. Defaults to HTTP. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1120 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1121 | "initialDelaySeconds": 42, # (Optional) Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 1122 | "periodSeconds": 42, # (Optional) How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
| 1123 | "successThreshold": 42, # (Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
| 1124 | "tcpSocket": { # Not supported by Cloud Run TCPSocketAction describes an action based on opening a socket # (Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message. |
| 1125 | "host": "A String", # (Optional) Optional: Host name to connect to, defaults to the pod IP. |
| 1126 | "port": 42, # Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. This field is currently limited to integer types only because of proto's inability to properly support the IntOrString golang type. |
| 1127 | }, |
| 1128 | "timeoutSeconds": 42, # (Optional) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1129 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1130 | "name": "A String", # (Optional) Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names |
| 1131 | "ports": [ # (Optional) 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1132 | { # ContainerPort represents a network port in a single container. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1133 | "containerPort": 42, # (Optional) Port number the container listens on. This must be a valid port number, 0 < x < 65536. |
| 1134 | "name": "A String", # (Optional) If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c". |
| 1135 | "protocol": "A String", # (Optional) Protocol for port. Must be "TCP". Defaults to "TCP". |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1136 | }, |
| 1137 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1138 | "readinessProbe": { # Not supported by Cloud Run Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # (Optional) Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 1139 | "exec": { # Not supported by Cloud Run ExecAction describes a "run in container" action. # (Optional) One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message. |
| 1140 | "command": [ # (Optional) Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1141 | "A String", |
| 1142 | ], |
| 1143 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1144 | "failureThreshold": 42, # (Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
| 1145 | "httpGet": { # Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests. # (Optional) HTTPGet specifies the http request to perform. A field inlined from the Handler message. |
| 1146 | "host": "A String", # (Optional) Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
| 1147 | "httpHeaders": [ # (Optional) Custom headers to set in the request. HTTP allows repeated headers. |
| 1148 | { # Not supported by Cloud Run HTTPHeader describes a custom header to be used in HTTP probes |
| 1149 | "name": "A String", # The header field name |
| 1150 | "value": "A String", # The header field value |
| 1151 | }, |
| 1152 | ], |
| 1153 | "path": "A String", # (Optional) Path to access on the HTTP server. |
| 1154 | "scheme": "A String", # (Optional) Scheme to use for connecting to the host. Defaults to HTTP. |
| 1155 | }, |
| 1156 | "initialDelaySeconds": 42, # (Optional) Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 1157 | "periodSeconds": 42, # (Optional) How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
| 1158 | "successThreshold": 42, # (Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
| 1159 | "tcpSocket": { # Not supported by Cloud Run TCPSocketAction describes an action based on opening a socket # (Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message. |
| 1160 | "host": "A String", # (Optional) Optional: Host name to connect to, defaults to the pod IP. |
| 1161 | "port": 42, # Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. This field is currently limited to integer types only because of proto's inability to properly support the IntOrString golang type. |
| 1162 | }, |
| 1163 | "timeoutSeconds": 42, # (Optional) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 1164 | }, |
| 1165 | "resources": { # ResourceRequirements describes the compute resource requirements. # (Optional) Compute Resources required by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
| 1166 | "limits": { # (Optional) Only memory and CPU are supported. Note: The only supported values for CPU are '1', '2', and '4'. Setting 4 CPU requires at least 2Gi of memory. Limits describes the maximum amount of compute resources allowed. 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 |
| 1167 | "a_key": "A String", |
| 1168 | }, |
| 1169 | "requests": { # (Optional) Only memory and CPU are supported. Note: The only supported values for CPU are '1' and '2'. Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. 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 |
| 1170 | "a_key": "A String", |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1171 | }, |
| 1172 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1173 | "securityContext": { # Not supported by Cloud Run SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. # (Optional) Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
| 1174 | "runAsUser": 42, # (Optional) The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
| 1175 | }, |
| 1176 | "startupProbe": { # Not supported by Cloud Run Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # (Optional) 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 |
| 1177 | "exec": { # Not supported by Cloud Run ExecAction describes a "run in container" action. # (Optional) One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message. |
| 1178 | "command": [ # (Optional) Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
| 1179 | "A String", |
| 1180 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1181 | }, |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1182 | "failureThreshold": 42, # (Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
| 1183 | "httpGet": { # Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests. # (Optional) HTTPGet specifies the http request to perform. A field inlined from the Handler message. |
| 1184 | "host": "A String", # (Optional) Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
| 1185 | "httpHeaders": [ # (Optional) Custom headers to set in the request. HTTP allows repeated headers. |
| 1186 | { # Not supported by Cloud Run HTTPHeader describes a custom header to be used in HTTP probes |
| 1187 | "name": "A String", # The header field name |
| 1188 | "value": "A String", # The header field value |
| 1189 | }, |
| 1190 | ], |
| 1191 | "path": "A String", # (Optional) Path to access on the HTTP server. |
| 1192 | "scheme": "A String", # (Optional) Scheme to use for connecting to the host. Defaults to HTTP. |
| 1193 | }, |
| 1194 | "initialDelaySeconds": 42, # (Optional) Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 1195 | "periodSeconds": 42, # (Optional) How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
| 1196 | "successThreshold": 42, # (Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
| 1197 | "tcpSocket": { # Not supported by Cloud Run TCPSocketAction describes an action based on opening a socket # (Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message. |
| 1198 | "host": "A String", # (Optional) Optional: Host name to connect to, defaults to the pod IP. |
| 1199 | "port": 42, # Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. This field is currently limited to integer types only because of proto's inability to properly support the IntOrString golang type. |
| 1200 | }, |
| 1201 | "timeoutSeconds": 42, # (Optional) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 1202 | }, |
| 1203 | "terminationMessagePath": "A String", # (Optional) Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. |
| 1204 | "terminationMessagePolicy": "A String", # (Optional) Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
| 1205 | "volumeMounts": [ # (Optional) Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem. |
| 1206 | { # Not supported by Cloud Run VolumeMount describes a mounting of a Volume within a container. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1207 | "mountPath": "A String", # Path within the container at which the volume should be mounted. Must not contain ':'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1208 | "name": "A String", # This must match the Name of a Volume. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1209 | "readOnly": True or False, # (Optional) Only true is accepted. Defaults to true. |
| 1210 | "subPath": "A String", # (Optional) Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1211 | }, |
| 1212 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1213 | "workingDir": "A String", # (Optional) Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1214 | }, |
| 1215 | ], |
| 1216 | "restartPolicy": "A String", # Optional. Restart policy for all containers within the instance. Allowed values are: - OnFailure: Instances will always be restarted on failure if the backoffLimit has not been reached. - Never: Instances are never restarted and all failures are permanent. Cannot be used if backoffLimit is set. +optional |
| 1217 | "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the instance of a Job. The service account represents the identity of the running instance, and determines what permissions the instance has. If not provided, the instance will use the project's default service account. +optional |
| 1218 | "terminationGracePeriodSeconds": "A String", # Optional. Optional duration in seconds the instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates delete immediately. The grace period is the duration in seconds after the processes running in the instance are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. +optional |
| 1219 | "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the instance. More info: https://kubernetes.io/docs/concepts/storage/volumes +optional |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1220 | { # Not supported by Cloud Run Volume represents a named volume in a container. |
| 1221 | "configMap": { # Not supported by Cloud Run Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. |
| 1222 | "defaultMode": 42, # (Optional) Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
| 1223 | "items": [ # (Optional) If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1224 | { # Maps a string key to a path within a volume. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1225 | "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. |
| 1226 | "mode": 42, # (Optional) Mode bits to use on this file, must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
| 1227 | "path": "A String", # The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1228 | }, |
| 1229 | ], |
| 1230 | "name": "A String", # Name of the config. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1231 | "optional": True or False, # (Optional) Specify whether the Secret or its keys must be defined. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1232 | }, |
| 1233 | "name": "A String", # Volume's name. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1234 | "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. |
| 1235 | "defaultMode": 42, # (Optional) Mode bits to use on created files by default. Must be a value between 0000 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. NOTE: This is an integer representation of the mode bits. So, the integer value should look exactly as the chmod numeric notation, i.e. Unix chmod "777" (a=rwx) should have the integer value 777. |
| 1236 | "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. 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 key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1237 | { # Maps a string key to a path within a volume. |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1238 | "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. |
| 1239 | "mode": 42, # (Optional) Mode bits to use on this file, must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
| 1240 | "path": "A String", # The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1241 | }, |
| 1242 | ], |
| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame] | 1243 | "optional": True or False, # (Optional) Specify whether the Secret or its keys must be defined. |
| 1244 | "secretName": "A String", # The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. Name of the secret in the container's namespace to use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1245 | }, |
| 1246 | }, |
| 1247 | ], |
| 1248 | }, |
| 1249 | }, |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 1250 | "ttlSecondsAfterFinished": 42, # Optional. Not supported. ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is set to zero, the Job won't be automatically deleted. +optional |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1251 | }, |
| 1252 | "status": { # JobStatus represents the current state of a Job. # Optional. Current status of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional |
| 1253 | "active": 42, # Optional. The number of actively running instances. +optional |
| 1254 | "completionTime": "A String", # Optional. Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 1255 | "conditions": [ # Optional. The latest available observations of a job's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional |
| 1256 | { # JobCondition defines a readiness condition for a Revision. |
| 1257 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 1258 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 1259 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 1260 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 1261 | "status": "A String", # Required. Status of the condition, one of True, False, Unknown. |
| 1262 | "type": "A String", # Required. Type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include: * "Completed": True when the Job has successfully completed. * "Started": True when the Job has successfully started running. * "ResourcesAvailable": True when underlying resources have been provisioned. |
| 1263 | }, |
| 1264 | ], |
| 1265 | "failed": 42, # Optional. The number of instances which reached phase Failed. +optional |
| 1266 | "imageDigest": "A String", # Optional. ImageDigest holds the resolved digest for the image specified within .Spec.Template.Spec.Container.Image. The digest is resolved during the creation of the Job. This field holds the digest value regardless of whether a tag or digest was originally specified in the Container object. |
| 1267 | "instances": [ # Optional. Status of completed, failed, and running instances. +optional |
| 1268 | { # Instance represents the status of an instance of a Job. |
| 1269 | "completionTime": "A String", # Optional. Represents time when the instance was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 1270 | "failed": 42, # Optional. The number of times this instance exited with code > 0; +optional |
| 1271 | "index": 42, # Required. Index of the instance, unique per Job, and beginning at 0. |
| 1272 | "lastExitCode": 42, # Optional. Last exit code seen for this instance. +optional |
| 1273 | "restarted": 42, # Optional. The number of times this instance was restarted. Instances are restarted according the restartPolicy configured in the Job template. +optional |
| 1274 | "startTime": "A String", # Optional. Represents time when the instance was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 1275 | "succeeded": 42, # Optional. The number of times this instance exited with code == 0. +optional |
| 1276 | }, |
| 1277 | ], |
| 1278 | "observedGeneration": 42, # Optional. The 'generation' of the job that was last processed by the controller. |
| 1279 | "startTime": "A String", # Optional. Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional |
| 1280 | "succeeded": 42, # Optional. The number of instances which reached phase Succeeded. +optional |
| 1281 | }, |
| 1282 | }, |
| 1283 | ], |
| 1284 | "kind": "A String", # The kind of this resource, in this case "JobsList". |
| 1285 | "metadata": { # ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. # Metadata associated with this jobs list. |
| 1286 | "continue": "A String", # continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response. |
| 1287 | "resourceVersion": "A String", # String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional |
| 1288 | "selfLink": "A String", # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional |
| 1289 | }, |
| 1290 | "nextPageToken": "A String", # This field is equivalent to the metadata.continue field and is provided as a convenience for compatibility with https://google.aip.dev/158. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The metadata.resourceVersion field returned when using this field will be identical to the value in the first response. |
| 1291 | "unreachable": [ # Locations that could not be reached. |
| 1292 | "A String", |
| 1293 | ], |
| 1294 | }</pre> |
| 1295 | </div> |
| 1296 | |
| 1297 | </body></html> |