Returns the tasks Resource.
cancel(name, body=None, x__xgafv=None)
Cancels an Execution.
Close httplib2 connections.
delete(name, etag=None, validateOnly=None, x__xgafv=None)
Deletes an Execution.
exportStatus(name, operationId, x__xgafv=None)
Read the status of an image export operation.
Gets information about an Execution.
list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)
Lists Executions from a Job. Results are sorted by creation time, descending.
Retrieves the next page of results.
cancel(name, body=None, x__xgafv=None)
Cancels an Execution.
Args:
name: string, Required. The name of the Execution to cancel. Format: `projects/{project}/locations/{location}/jobs/{job}/executions/{execution}`, where `{project}` can be project id or number. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for deleting an Execution.
"etag": "A String", # A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates.
"validateOnly": True or False, # Indicates that the request should be validated without actually cancelling any resources.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
close()
Close httplib2 connections.
delete(name, etag=None, validateOnly=None, x__xgafv=None)
Deletes an Execution.
Args:
name: string, Required. The name of the Execution to delete. Format: `projects/{project}/locations/{location}/jobs/{job}/executions/{execution}`, where `{project}` can be project id or number. (required)
etag: string, A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates.
validateOnly: boolean, Indicates that the request should be validated without actually deleting any resources.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
exportStatus(name, operationId, x__xgafv=None)
Read the status of an image export operation.
Args:
name: string, Required. The name of the resource of which image export operation status has to be fetched. Format: `projects/{project_id_or_number}/locations/{location}/services/{service}/revisions/{revision}` for Revision `projects/{project_id_or_number}/locations/{location}/jobs/{job}/executions/{execution}` for Execution (required)
operationId: string, Required. The operation id returned from ExportImage. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ExportStatusResponse contains the status of image export operation, with the status of each image export job.
"imageExportStatuses": [ # The status of each image export job.
{ # The status of an image export job.
"exportJobState": "A String", # Output only. Has the image export job finished (regardless of successful or failure).
"exportedImageDigest": "A String", # The exported image ID as it will appear in Artifact Registry.
"status": { # Wire-format for a Status object # The status of the export task if done.
"canonicalCode": 42, # The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be.
"code": 42, # Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto
"message": "A String", # Detail message
"messageSet": { # This is proto2's version of MessageSet. # message_set associates an arbitrary proto message with the status.
},
"space": "A String", # The following are usually only present when code != 0 Space to which this status belongs
},
"tag": "A String", # The image tag as it will appear in Artifact Registry.
},
],
"operationId": "A String", # The operation id.
"operationState": "A String", # Output only. The state of the overall export operation.
}
get(name, x__xgafv=None)
Gets information about an Execution.
Args:
name: string, Required. The full name of the Execution. Format: `projects/{project}/locations/{location}/jobs/{job}/executions/{execution}`, where `{project}` can be project id or number. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Execution represents the configuration of a single execution. A execution an immutable resource that references a container image which is run to completion.
"annotations": { # Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
"a_key": "A String",
},
"cancelledCount": 42, # Output only. The number of tasks which reached phase Cancelled.
"completionTime": "A String", # Output only. Represents time when the execution was completed. It is not guaranteed to be set in happens-before order across separate operations.
"conditions": [ # Output only. The Condition of this Execution, containing its readiness status, and detailed error information in case it did not reach the desired state.
{ # Defines a status condition for a resource.
"executionReason": "A String", # Output only. A reason for the execution condition.
"lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
"message": "A String", # Human readable message indicating details about the current status.
"reason": "A String", # Output only. A common (service-level) reason for this condition.
"revisionReason": "A String", # Output only. A reason for the revision condition.
"severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
"state": "A String", # State of the condition.
"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
},
],
"createTime": "A String", # Output only. Represents time when the execution was acknowledged by the execution controller. It is not guaranteed to be set in happens-before order across separate operations.
"deleteTime": "A String", # Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.
"etag": "A String", # Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
"expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.
"failedCount": 42, # Output only. The number of tasks which reached phase Failed.
"generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state.
"job": "A String", # Output only. The name of the parent Job.
"labels": { # Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels
"a_key": "A String",
},
"launchStage": "A String", # The least stable launch stage needed to create this resource, as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA.
"logUri": "A String", # Output only. URI where logs for this execution can be found in Cloud Console.
"name": "A String", # Output only. The unique name of this Execution.
"observedGeneration": "A String", # Output only. The generation of this Execution. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
"parallelism": 42, # Output only. Specifies the maximum desired number of tasks the execution should run at any given time. Must be <= task_count. The actual number of tasks running in steady state will be less than this number when ((.spec.task_count - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism.
"reconciling": True or False, # Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run.
"retriedCount": 42, # Output only. The number of tasks which have retried at least once.
"runningCount": 42, # Output only. The number of actively running tasks.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"startTime": "A String", # Output only. Represents time when the execution started to run. It is not guaranteed to be set in happens-before order across separate operations.
"succeededCount": 42, # Output only. The number of tasks which reached phase Succeeded.
"taskCount": 42, # Output only. Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution.
"template": { # TaskTemplate describes the data a task should have when created from a template. # Output only. The template used to create tasks for this execution.
"containers": [ # Holds the single container that defines the unit of execution for this task.
{ # 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 can be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
"A String",
],
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
"A String",
],
"dependsOn": [ # Names of the containers that must start before this container.
"A String",
],
"env": [ # List of environment variables to set in the container.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters.
"value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run.
"valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value.
"secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager.
"secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project.
"version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.
},
},
},
],
"image": "A String", # Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
"livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Periodic probe of container liveness. Container will be restarted if the probe fails.
"failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
"grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
"service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
},
"httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
{ # HTTPHeader describes a custom header to be used in HTTP probes
"name": "A String", # Required. The header field name
"value": "A String", # Optional. The header field value
},
],
"path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
"port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
"periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
"tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
},
"name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
"name": "A String", # If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
},
],
"resources": { # ResourceRequirements describes the compute resource requirements. # Compute Resource requirements by this container.
"cpuIdle": True or False, # Determines whether CPU is only allocated during requests (true by default). However, if ResourceRequirements is set, the caller must explicitly set this field to true to preserve the default behavior.
"limits": { # Only `memory` and `cpu` keys in the map are supported. Notes: * The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
"a_key": "A String",
},
"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency.
},
"startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # 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.
"failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
"grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
"service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
},
"httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
{ # HTTPHeader describes a custom header to be used in HTTP probes
"name": "A String", # Required. The header field name
"value": "A String", # Optional. The header field value
},
],
"path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
"port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
"periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
"tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
},
"volumeMounts": [ # Volume to mount into the container's filesystem.
{ # VolumeMount describes a mounting of a Volume within a container.
"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
"name": "A String", # Required. This must match the Name of a Volume.
},
],
"workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
},
],
"encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
"executionEnvironment": "A String", # Optional. The execution environment being used to host this Task.
"maxRetries": 42, # Number of retries allowed per Task, before marking this Task failed. Defaults to 3.
"serviceAccount": "A String", # Optional. Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.
"timeout": "A String", # Optional. Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds.
"volumes": [ # Optional. A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
"cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
},
"emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume.
"medium": "A String", # The medium on which the data is stored. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional
"sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
},
"gcs": { # Represents a volume backed by a Cloud Storage bucket using Cloud Storage FUSE. # Persistent storage backed by a Google Cloud Storage bucket.
"bucket": "A String", # Cloud Storage Bucket name.
"mountOptions": [ # A list of additional flags to pass to the gcsfuse CLI. Options should be specified without the leading "--".
"A String",
],
"readOnly": True or False, # If true, the volume will be mounted as read only for all mounts.
},
"name": "A String", # Required. Volume's name.
"nfs": { # Represents an NFS mount. # For NFS Voumes, contains the path to the nfs Volume
"path": "A String", # Path that is exported by the NFS server.
"readOnly": True or False, # If true, the volume will be mounted as read only for all mounts.
"server": "A String", # Hostname or IP address of the NFS server
},
"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. # Secret represents a secret that should populate this volume.
"defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.
"items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
{ # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path.
"mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
"path": "A String", # Required. The relative path of the secret in the container.
"version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version.
},
],
"secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
},
},
],
"vpcAccess": { # VPC Access settings. For more information on sending traffic to a VPC network, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. # Optional. VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
"connector": "A String", # VPC Access connector name. Format: `projects/{project}/locations/{location}/connectors/{connector}`, where `{project}` can be project id or number. For more information on sending traffic to a VPC network via a connector, visit https://cloud.google.com/run/docs/configuring/vpc-connectors.
"egress": "A String", # Optional. Traffic VPC egress settings. If not provided, it defaults to PRIVATE_RANGES_ONLY.
"networkInterfaces": [ # Optional. Direct VPC egress settings. Currently only single network interface is supported.
{ # Direct VPC egress settings.
"network": "A String", # Optional. The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork.
"subnetwork": "A String", # Optional. The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
"tags": [ # Optional. Network tags applied to this Cloud Run resource.
"A String",
],
},
],
},
},
"uid": "A String", # Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
"updateTime": "A String", # Output only. The last-modified time.
}
list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)
Lists Executions from a Job. Results are sorted by creation time, descending.
Args:
parent: string, Required. The Execution from which the Executions should be listed. To list all Executions across Jobs, use "-" instead of Job name. Format: `projects/{project}/locations/{location}/jobs/{job}`, where `{project}` can be project id or number. (required)
pageSize: integer, Maximum number of Executions to return in this call.
pageToken: string, A page token received from a previous call to ListExecutions. All other parameters must match.
showDeleted: boolean, If true, returns deleted (but unexpired) resources along with active ones.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message containing a list of Executions.
"executions": [ # The resulting list of Executions.
{ # Execution represents the configuration of a single execution. A execution an immutable resource that references a container image which is run to completion.
"annotations": { # Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
"a_key": "A String",
},
"cancelledCount": 42, # Output only. The number of tasks which reached phase Cancelled.
"completionTime": "A String", # Output only. Represents time when the execution was completed. It is not guaranteed to be set in happens-before order across separate operations.
"conditions": [ # Output only. The Condition of this Execution, containing its readiness status, and detailed error information in case it did not reach the desired state.
{ # Defines a status condition for a resource.
"executionReason": "A String", # Output only. A reason for the execution condition.
"lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
"message": "A String", # Human readable message indicating details about the current status.
"reason": "A String", # Output only. A common (service-level) reason for this condition.
"revisionReason": "A String", # Output only. A reason for the revision condition.
"severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
"state": "A String", # State of the condition.
"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
},
],
"createTime": "A String", # Output only. Represents time when the execution was acknowledged by the execution controller. It is not guaranteed to be set in happens-before order across separate operations.
"deleteTime": "A String", # Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.
"etag": "A String", # Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
"expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.
"failedCount": 42, # Output only. The number of tasks which reached phase Failed.
"generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state.
"job": "A String", # Output only. The name of the parent Job.
"labels": { # Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels
"a_key": "A String",
},
"launchStage": "A String", # The least stable launch stage needed to create this resource, as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA.
"logUri": "A String", # Output only. URI where logs for this execution can be found in Cloud Console.
"name": "A String", # Output only. The unique name of this Execution.
"observedGeneration": "A String", # Output only. The generation of this Execution. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
"parallelism": 42, # Output only. Specifies the maximum desired number of tasks the execution should run at any given time. Must be <= task_count. The actual number of tasks running in steady state will be less than this number when ((.spec.task_count - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism.
"reconciling": True or False, # Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run.
"retriedCount": 42, # Output only. The number of tasks which have retried at least once.
"runningCount": 42, # Output only. The number of actively running tasks.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"startTime": "A String", # Output only. Represents time when the execution started to run. It is not guaranteed to be set in happens-before order across separate operations.
"succeededCount": 42, # Output only. The number of tasks which reached phase Succeeded.
"taskCount": 42, # Output only. Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution.
"template": { # TaskTemplate describes the data a task should have when created from a template. # Output only. The template used to create tasks for this execution.
"containers": [ # Holds the single container that defines the unit of execution for this task.
{ # 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 can be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
"A String",
],
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
"A String",
],
"dependsOn": [ # Names of the containers that must start before this container.
"A String",
],
"env": [ # List of environment variables to set in the container.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters.
"value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run.
"valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value.
"secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager.
"secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project.
"version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.
},
},
},
],
"image": "A String", # Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
"livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Periodic probe of container liveness. Container will be restarted if the probe fails.
"failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
"grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
"service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
},
"httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
{ # HTTPHeader describes a custom header to be used in HTTP probes
"name": "A String", # Required. The header field name
"value": "A String", # Optional. The header field value
},
],
"path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
"port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
"periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
"tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
},
"name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
"name": "A String", # If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
},
],
"resources": { # ResourceRequirements describes the compute resource requirements. # Compute Resource requirements by this container.
"cpuIdle": True or False, # Determines whether CPU is only allocated during requests (true by default). However, if ResourceRequirements is set, the caller must explicitly set this field to true to preserve the default behavior.
"limits": { # Only `memory` and `cpu` keys in the map are supported. Notes: * The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
"a_key": "A String",
},
"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency.
},
"startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # 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.
"failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
"grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
"service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
},
"httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
{ # HTTPHeader describes a custom header to be used in HTTP probes
"name": "A String", # Required. The header field name
"value": "A String", # Optional. The header field value
},
],
"path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
"port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
"periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
"tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
},
"volumeMounts": [ # Volume to mount into the container's filesystem.
{ # VolumeMount describes a mounting of a Volume within a container.
"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
"name": "A String", # Required. This must match the Name of a Volume.
},
],
"workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
},
],
"encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
"executionEnvironment": "A String", # Optional. The execution environment being used to host this Task.
"maxRetries": 42, # Number of retries allowed per Task, before marking this Task failed. Defaults to 3.
"serviceAccount": "A String", # Optional. Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.
"timeout": "A String", # Optional. Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds.
"volumes": [ # Optional. A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
"cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
},
"emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume.
"medium": "A String", # The medium on which the data is stored. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional
"sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
},
"gcs": { # Represents a volume backed by a Cloud Storage bucket using Cloud Storage FUSE. # Persistent storage backed by a Google Cloud Storage bucket.
"bucket": "A String", # Cloud Storage Bucket name.
"mountOptions": [ # A list of additional flags to pass to the gcsfuse CLI. Options should be specified without the leading "--".
"A String",
],
"readOnly": True or False, # If true, the volume will be mounted as read only for all mounts.
},
"name": "A String", # Required. Volume's name.
"nfs": { # Represents an NFS mount. # For NFS Voumes, contains the path to the nfs Volume
"path": "A String", # Path that is exported by the NFS server.
"readOnly": True or False, # If true, the volume will be mounted as read only for all mounts.
"server": "A String", # Hostname or IP address of the NFS server
},
"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. # Secret represents a secret that should populate this volume.
"defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.
"items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
{ # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path.
"mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
"path": "A String", # Required. The relative path of the secret in the container.
"version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version.
},
],
"secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
},
},
],
"vpcAccess": { # VPC Access settings. For more information on sending traffic to a VPC network, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. # Optional. VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
"connector": "A String", # VPC Access connector name. Format: `projects/{project}/locations/{location}/connectors/{connector}`, where `{project}` can be project id or number. For more information on sending traffic to a VPC network via a connector, visit https://cloud.google.com/run/docs/configuring/vpc-connectors.
"egress": "A String", # Optional. Traffic VPC egress settings. If not provided, it defaults to PRIVATE_RANGES_ONLY.
"networkInterfaces": [ # Optional. Direct VPC egress settings. Currently only single network interface is supported.
{ # Direct VPC egress settings.
"network": "A String", # Optional. The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork.
"subnetwork": "A String", # Optional. The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
"tags": [ # Optional. Network tags applied to this Cloud Run resource.
"A String",
],
},
],
},
},
"uid": "A String", # Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
"updateTime": "A String", # Output only. The last-modified time.
},
],
"nextPageToken": "A String", # A token indicating there are more items than page_size. Use it in the next ListExecutions request to continue.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.