googleapis
Version:
Google APIs Client Library for Node.js
1,080 lines • 406 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace run_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Run Admin API
*
* Deploy and manage user provided container images that scale automatically based on incoming requests. The Cloud Run Admin API v1 follows the Knative Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/.
*
* @example
* ```js
* const {google} = require('googleapis');
* const run = google.run('v2');
* ```
*/
export class Run {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Settings for Binary Authorization feature.
*/
export interface Schema$GoogleCloudRunV2BinaryAuthorization {
/**
* Optional. If present, indicates to use Breakglass using this justification. If use_default is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass
*/
breakglassJustification?: string | null;
/**
* Optional. The path to a binary authorization policy. Format: `projects/{project\}/platforms/cloudRun/{policy-name\}`
*/
policy?: string | null;
/**
* Optional. If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled.
*/
useDefault?: boolean | null;
}
/**
* Describes the Build step of the function that builds a container from the given source.
*/
export interface Schema$GoogleCloudRunV2BuildConfig {
/**
* Optional. The base image used to build the function.
*/
baseImage?: string | null;
/**
* Optional. Sets whether the function will receive automatic base image updates.
*/
enableAutomaticUpdates?: boolean | null;
/**
* Optional. User-provided build-time environment variables for the function
*/
environmentVariables?: {
[key: string]: string;
} | null;
/**
* Optional. The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function".
*/
functionTarget?: string | null;
/**
* Optional. Artifact Registry URI to store the built image.
*/
imageUri?: string | null;
/**
* Output only. The Cloud Build name of the latest successful deployment of the function.
*/
name?: string | null;
/**
* Optional. Service account to be used for building the container. The format of this field is `projects/{projectId\}/serviceAccounts/{serviceAccountEmail\}`.
*/
serviceAccount?: string | null;
/**
* The Cloud Storage bucket URI where the function source code is located.
*/
sourceLocation?: string | null;
/**
* Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the Cloud Run function. The format of this field is `projects/{project\}/locations/{region\}/workerPools/{workerPool\}` where `{project\}` and `{region\}` are the project id and region respectively where the worker pool is defined and `{workerPool\}` is the short name of the worker pool.
*/
workerPool?: string | null;
}
/**
* Build information of the image.
*/
export interface Schema$GoogleCloudRunV2BuildInfo {
/**
* Output only. Entry point of the function when the image is a Cloud Run function.
*/
functionTarget?: string | null;
/**
* Output only. Source code location of the image.
*/
sourceLocation?: string | null;
}
/**
* Build the source using Buildpacks.
*/
export interface Schema$GoogleCloudRunV2BuildpacksBuild {
/**
* Optional. The base image to use for the build.
*/
baseImage?: string | null;
/**
* Optional. cache_image_uri is the GCR/AR URL where the cache image will be stored. cache_image_uri is optional and omitting it will disable caching. This URL must be stable across builds. It is used to derive a build-specific temporary URL by substituting the tag with the build ID. The build will clean up the temporary image on a best-effort basis.
*/
cacheImageUri?: string | null;
/**
* Optional. Whether or not the application container will be enrolled in automatic base image updates. When true, the application will be built on a scratch base image, so the base layers can be appended at run time.
*/
enableAutomaticUpdates?: boolean | null;
/**
* Optional. User-provided build-time environment variables.
*/
environmentVariables?: {
[key: string]: string;
} | null;
/**
* Optional. Name of the function target if the source is a function source. Required for function builds.
*/
functionTarget?: string | null;
/**
* Optional. project_descriptor stores the path to the project descriptor file. When empty, it means that there is no project descriptor file in the source.
*/
projectDescriptor?: string | null;
/**
* The runtime name, e.g. 'go113'. Leave blank for generic builds.
*/
runtime?: string | null;
}
/**
* Request message for deleting an Execution.
*/
export interface Schema$GoogleCloudRunV2CancelExecutionRequest {
/**
* A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates.
*/
etag?: string | null;
/**
* Indicates that the request should be validated without actually cancelling any resources.
*/
validateOnly?: boolean | null;
}
/**
* 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.
*/
export interface Schema$GoogleCloudRunV2CloudSqlInstance {
/**
* 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\}
*/
instances?: string[] | null;
}
/**
* Defines a status condition for a resource.
*/
export interface Schema$GoogleCloudRunV2Condition {
/**
* Output only. A reason for the execution condition.
*/
executionReason?: string | null;
/**
* Last time the condition transitioned from one status to another.
*/
lastTransitionTime?: string | null;
/**
* Human readable message indicating details about the current status.
*/
message?: string | null;
/**
* Output only. A common (service-level) reason for this condition.
*/
reason?: string | null;
/**
* Output only. A reason for the revision condition.
*/
revisionReason?: string | null;
/**
* How to interpret failures of this condition, one of Error, Warning, Info
*/
severity?: string | null;
/**
* State of the condition.
*/
state?: string | null;
/**
* 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.
*/
type?: string | null;
}
/**
* 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.
*/
export interface Schema$GoogleCloudRunV2Container {
/**
* Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
*/
args?: string[] | null;
/**
* Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update.
*/
baseImageUri?: string | null;
/**
* Output only. The build info of the container image.
*/
buildInfo?: Schema$GoogleCloudRunV2BuildInfo;
/**
* Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
*/
command?: string[] | null;
/**
* Names of the containers that must start before this container.
*/
dependsOn?: string[] | null;
/**
* List of environment variables to set in the container.
*/
env?: Schema$GoogleCloudRunV2EnvVar[];
/**
* Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
*/
image?: string | null;
/**
* Periodic probe of container liveness. Container will be restarted if the probe fails.
*/
livenessProbe?: Schema$GoogleCloudRunV2Probe;
/**
* Name of the container specified as a DNS_LABEL (RFC 1123).
*/
name?: string | null;
/**
* 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.
*/
ports?: Schema$GoogleCloudRunV2ContainerPort[];
/**
* Compute Resource requirements by this container.
*/
resources?: Schema$GoogleCloudRunV2ResourceRequirements;
/**
* 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.
*/
startupProbe?: Schema$GoogleCloudRunV2Probe;
/**
* Volume to mount into the container's filesystem.
*/
volumeMounts?: Schema$GoogleCloudRunV2VolumeMount[];
/**
* Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
*/
workingDir?: string | null;
}
/**
* Per-container override specification.
*/
export interface Schema$GoogleCloudRunV2ContainerOverride {
/**
* Optional. Arguments to the entrypoint. Will replace existing args for override.
*/
args?: string[] | null;
/**
* Optional. True if the intention is to clear out existing args list.
*/
clearArgs?: boolean | null;
/**
* List of environment variables to set in the container. Will be merged with existing env for override.
*/
env?: Schema$GoogleCloudRunV2EnvVar[];
/**
* The name of the container specified as a DNS_LABEL.
*/
name?: string | null;
}
/**
* ContainerPort represents a network port in a single container.
*/
export interface Schema$GoogleCloudRunV2ContainerPort {
/**
* Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
*/
containerPort?: number | null;
/**
* If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
*/
name?: string | null;
}
/**
* Build the source using Docker. This means the source has a Dockerfile.
*/
export interface Schema$GoogleCloudRunV2DockerBuild {
}
/**
* 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).
*/
export interface Schema$GoogleCloudRunV2EmptyDirVolumeSource {
/**
* 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
*/
medium?: string | null;
/**
* 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
*/
sizeLimit?: string | null;
}
/**
* EnvVar represents an environment variable present in a Container.
*/
export interface Schema$GoogleCloudRunV2EnvVar {
/**
* Required. Name of the environment variable. Must not exceed 32768 characters.
*/
name?: string | null;
/**
* Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run.
*/
value?: string | null;
/**
* Source for the environment variable's value.
*/
valueSource?: Schema$GoogleCloudRunV2EnvVarSource;
}
/**
* EnvVarSource represents a source for the value of an EnvVar.
*/
export interface Schema$GoogleCloudRunV2EnvVarSource {
/**
* Selects a secret and a specific version from Cloud Secret Manager.
*/
secretKeyRef?: Schema$GoogleCloudRunV2SecretKeySelector;
}
/**
* Execution represents the configuration of a single execution. A execution an immutable resource that references a container image which is run to completion.
*/
export interface Schema$GoogleCloudRunV2Execution {
/**
* 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.
*/
annotations?: {
[key: string]: string;
} | null;
/**
* Output only. The number of tasks which reached phase Cancelled.
*/
cancelledCount?: number | null;
/**
* Output only. Represents time when the execution was completed. It is not guaranteed to be set in happens-before order across separate operations.
*/
completionTime?: string | null;
/**
* Output only. The Condition of this Execution, containing its readiness status, and detailed error information in case it did not reach the desired state.
*/
conditions?: Schema$GoogleCloudRunV2Condition[];
/**
* 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.
*/
createTime?: string | null;
/**
* Output only. Email address of the authenticated creator.
*/
creator?: string | null;
/**
* Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.
*/
deleteTime?: string | null;
/**
* Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
*/
etag?: string | null;
/**
* 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.
*/
expireTime?: string | null;
/**
* Output only. The number of tasks which reached phase Failed.
*/
failedCount?: number | null;
/**
* Output only. A number that monotonically increases every time the user modifies the desired state.
*/
generation?: string | null;
/**
* Output only. The name of the parent Job.
*/
job?: string | null;
/**
* 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
*/
labels?: {
[key: string]: string;
} | null;
/**
* 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.
*/
launchStage?: string | null;
/**
* Output only. URI where logs for this execution can be found in Cloud Console.
*/
logUri?: string | null;
/**
* Output only. The unique name of this Execution.
*/
name?: string | null;
/**
* Output only. The generation of this Execution. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
*/
observedGeneration?: string | null;
/**
* 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.
*/
parallelism?: number | null;
/**
* 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.
*/
reconciling?: boolean | null;
/**
* Output only. The number of tasks which have retried at least once.
*/
retriedCount?: number | null;
/**
* Output only. The number of actively running tasks.
*/
runningCount?: number | null;
/**
* Output only. Reserved for future use.
*/
satisfiesPzs?: boolean | null;
/**
* Output only. Represents time when the execution started to run. It is not guaranteed to be set in happens-before order across separate operations.
*/
startTime?: string | null;
/**
* Output only. The number of tasks which reached phase Succeeded.
*/
succeededCount?: number | null;
/**
* 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.
*/
taskCount?: number | null;
/**
* Output only. The template used to create tasks for this execution.
*/
template?: Schema$GoogleCloudRunV2TaskTemplate;
/**
* 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.
*/
uid?: string | null;
/**
* Output only. The last-modified time.
*/
updateTime?: string | null;
}
/**
* Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status.
*/
export interface Schema$GoogleCloudRunV2ExecutionReference {
/**
* Status for the execution completion.
*/
completionStatus?: string | null;
/**
* Creation timestamp of the execution.
*/
completionTime?: string | null;
/**
* Creation timestamp of the execution.
*/
createTime?: string | null;
/**
* The deletion time of the execution. It is only populated as a response to a Delete request.
*/
deleteTime?: string | null;
/**
* Name of the execution.
*/
name?: string | null;
}
/**
* ExecutionTemplate describes the data an execution should have when created from a template.
*/
export interface Schema$GoogleCloudRunV2ExecutionTemplate {
/**
* 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. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.
*/
annotations?: {
[key: string]: string;
} | null;
/**
* 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. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Optional. Specifies the maximum desired number of tasks the execution should run at given time. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism.
*/
parallelism?: number | null;
/**
* 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. Defaults to 1.
*/
taskCount?: number | null;
/**
* Required. Describes the task(s) that will be created when executing an execution.
*/
template?: Schema$GoogleCloudRunV2TaskTemplate;
}
/**
* Request message for exporting Cloud Run image.
*/
export interface Schema$GoogleCloudRunV2ExportImageRequest {
/**
* Required. The export destination url (the Artifact Registry repo).
*/
destinationRepo?: string | null;
}
/**
* ExportImageResponse contains an operation Id to track the image export operation.
*/
export interface Schema$GoogleCloudRunV2ExportImageResponse {
/**
* An operation ID used to track the status of image exports tied to the original pod ID in the request.
*/
operationId?: string | null;
}
/**
* ExportStatusResponse contains the status of image export operation, with the status of each image export job.
*/
export interface Schema$GoogleCloudRunV2ExportStatusResponse {
/**
* The status of each image export job.
*/
imageExportStatuses?: Schema$GoogleCloudRunV2ImageExportStatus[];
/**
* The operation id.
*/
operationId?: string | null;
/**
* Output only. The state of the overall export operation.
*/
operationState?: string | null;
}
/**
* Represents a volume backed by a Cloud Storage bucket using Cloud Storage FUSE.
*/
export interface Schema$GoogleCloudRunV2GCSVolumeSource {
/**
* Cloud Storage Bucket name.
*/
bucket?: string | null;
/**
* A list of additional flags to pass to the gcsfuse CLI. Options should be specified without the leading "--".
*/
mountOptions?: string[] | null;
/**
* If true, the volume will be mounted as read only for all mounts.
*/
readOnly?: boolean | null;
}
/**
* GRPCAction describes an action involving a GRPC port.
*/
export interface Schema$GoogleCloudRunV2GRPCAction {
/**
* 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.
*/
port?: number | null;
/**
* 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.
*/
service?: string | null;
}
/**
* HTTPGetAction describes an action based on HTTP Get requests.
*/
export interface Schema$GoogleCloudRunV2HTTPGetAction {
/**
* Optional. Custom headers to set in the request. HTTP allows repeated headers.
*/
httpHeaders?: Schema$GoogleCloudRunV2HTTPHeader[];
/**
* Optional. Path to access on the HTTP server. Defaults to '/'.
*/
path?: string | null;
/**
* 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.
*/
port?: number | null;
}
/**
* HTTPHeader describes a custom header to be used in HTTP probes
*/
export interface Schema$GoogleCloudRunV2HTTPHeader {
/**
* Required. The header field name
*/
name?: string | null;
/**
* Optional. The header field value
*/
value?: string | null;
}
/**
* The status of an image export job.
*/
export interface Schema$GoogleCloudRunV2ImageExportStatus {
/**
* The exported image ID as it will appear in Artifact Registry.
*/
exportedImageDigest?: string | null;
/**
* Output only. Has the image export job finished (regardless of successful or failure).
*/
exportJobState?: string | null;
/**
* The status of the export task if done.
*/
status?: Schema$UtilStatusProto;
/**
* The image tag as it will appear in Artifact Registry.
*/
tag?: string | null;
}
/**
* Holds a single instance split entry for the Worker. Allocations can be done to a specific Revision name, or pointing to the latest Ready Revision.
*/
export interface Schema$GoogleCloudRunV2InstanceSplit {
/**
* Specifies percent of the instance split to this Revision. This defaults to zero if unspecified.
*/
percent?: number | null;
/**
* Revision to which to assign this portion of instances, if split allocation is by revision.
*/
revision?: string | null;
/**
* The allocation type for this instance split.
*/
type?: string | null;
}
/**
* Represents the observed state of a single `InstanceSplit` entry.
*/
export interface Schema$GoogleCloudRunV2InstanceSplitStatus {
/**
* Specifies percent of the instance split to this Revision.
*/
percent?: number | null;
/**
* Revision to which this instance split is assigned.
*/
revision?: string | null;
/**
* The allocation type for this instance split.
*/
type?: string | null;
}
/**
* Job represents the configuration of a single job, which references a container image that is run to completion.
*/
export interface Schema$GoogleCloudRunV2Job {
/**
* 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. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job. This field follows Kubernetes annotations' namespacing, limits, and rules.
*/
annotations?: {
[key: string]: string;
} | null;
/**
* Settings for the Binary Authorization feature.
*/
binaryAuthorization?: Schema$GoogleCloudRunV2BinaryAuthorization;
/**
* Arbitrary identifier for the API client.
*/
client?: string | null;
/**
* Arbitrary version identifier for the API client.
*/
clientVersion?: string | null;
/**
* Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
*/
conditions?: Schema$GoogleCloudRunV2Condition[];
/**
* Output only. The creation time.
*/
createTime?: string | null;
/**
* Output only. Email address of the authenticated creator.
*/
creator?: string | null;
/**
* Output only. The deletion time. It is only populated as a response to a Delete request.
*/
deleteTime?: string | null;
/**
* Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
*/
etag?: string | null;
/**
* Output only. Number of executions created for this job.
*/
executionCount?: number | null;
/**
* Output only. For a deleted resource, the time after which it will be permamently deleted.
*/
expireTime?: string | null;
/**
* Output only. A number that monotonically increases every time the user modifies the desired state.
*/
generation?: string | null;
/**
* 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. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. Email address of the last authenticated modifier.
*/
lastModifier?: string | null;
/**
* Output only. Name of the last created execution.
*/
latestCreatedExecution?: Schema$GoogleCloudRunV2ExecutionReference;
/**
* The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.
*/
launchStage?: string | null;
/**
* The fully qualified name of this Job. Format: projects/{project\}/locations/{location\}/jobs/{job\}
*/
name?: string | null;
/**
* Output only. The generation of this Job. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
*/
observedGeneration?: string | null;
/**
* Output only. Returns true if the Job is currently being acted upon by the system to bring it into the desired state. When a new Job is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Job to the desired state. This process is called reconciliation. While reconciliation is in process, `observed_generation` and `latest_succeeded_execution`, will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the state matches the Job, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `observed_generation` and `generation`, `latest_succeeded_execution` and `latest_created_execution`. If reconciliation failed, `observed_generation` and `latest_succeeded_execution` will have the state of the last succeeded execution or empty for newly created Job. Additional information on the failure can be found in `terminal_condition` and `conditions`.
*/
reconciling?: boolean | null;
/**
* A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully completed. The sum of job name and token length must be fewer than 63 characters.
*/
runExecutionToken?: string | null;
/**
* Output only. Reserved for future use.
*/
satisfiesPzs?: boolean | null;
/**
* A unique string used as a suffix creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters.
*/
startExecutionToken?: string | null;
/**
* Required. The template used to create executions for this Job.
*/
template?: Schema$GoogleCloudRunV2ExecutionTemplate;
/**
* Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state.
*/
terminalCondition?: Schema$GoogleCloudRunV2Condition;
/**
* 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.
*/
uid?: string | null;
/**
* Output only. The last-modified time.
*/
updateTime?: string | null;
}
/**
* Response message containing a list of Executions.
*/
export interface Schema$GoogleCloudRunV2ListExecutionsResponse {
/**
* The resulting list of Executions.
*/
executions?: Schema$GoogleCloudRunV2Execution[];
/**
* A token indicating there are more items than page_size. Use it in the next ListExecutions request to continue.
*/
nextPageToken?: string | null;
}
/**
* Response message containing a list of Jobs.
*/
export interface Schema$GoogleCloudRunV2ListJobsResponse {
/**
* The resulting list of Jobs.
*/
jobs?: Schema$GoogleCloudRunV2Job[];
/**
* A token indicating there are more items than page_size. Use it in the next ListJobs request to continue.
*/
nextPageToken?: string | null;
}
/**
* Response message containing a list of Revisions.
*/
export interface Schema$GoogleCloudRunV2ListRevisionsResponse {
/**
* A token indicating there are more items than page_size. Use it in the next ListRevisions request to continue.
*/
nextPageToken?: string | null;
/**
* The resulting list of Revisions.
*/
revisions?: Schema$GoogleCloudRunV2Revision[];
}
/**
* Response message containing a list of Services.
*/
export interface Schema$GoogleCloudRunV2ListServicesResponse {
/**
* A token indicating there are more items than page_size. Use it in the next ListServices request to continue.
*/
nextPageToken?: string | null;
/**
* The resulting list of Services.
*/
services?: Schema$GoogleCloudRunV2Service[];
}
/**
* Response message containing a list of Tasks.
*/
export interface Schema$GoogleCloudRunV2ListTasksResponse {
/**
* A token indicating there are more items than page_size. Use it in the next ListTasks request to continue.
*/
nextPageToken?: string | null;
/**
* The resulting list of Tasks.
*/
tasks?: Schema$GoogleCloudRunV2Task[];
}
/**
* Response message containing a list of WorkerPools.
*/
export interface Schema$GoogleCloudRunV2ListWorkerPoolsResponse {
/**
* A token indicating there are more items than page_size. Use it in the next ListWorkerPools request to continue.
*/
nextPageToken?: string | null;
/**
* The resulting list of WorkerPools.
*/
workerPools?: Schema$GoogleCloudRunV2WorkerPool[];
}
/**
* Metadata represents the JSON encoded generated customer metadata.
*/
export interface Schema$GoogleCloudRunV2Metadata {
/**
* JSON encoded Google-generated Customer Metadata for a given resource/project.
*/
metadata?: string | null;
}
/**
* Settings for multi-region deployment.
*/
export interface Schema$GoogleCloudRunV2MultiRegionSettings {
/**
* Optional. System-generated unique id for the multi-region Service.
*/
multiRegionId?: string | null;
/**
* Required. List of regions to deploy to, including primary region.
*/
regions?: string[] | null;
}
/**
* Direct VPC egress settings.
*/
export interface Schema$GoogleCloudRunV2NetworkInterface {
/**
* 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.
*/
network?: string | null;
/**
* 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.
*/
subnetwork?: string | null;
/**
* Optional. Network tags applied to this Cloud Run resource.
*/
tags?: string[] | null;
}
/**
* Represents an NFS mount.
*/
export interface Schema$GoogleCloudRunV2NFSVolumeSource {
/**
* Path that is exported by the NFS server.
*/
path?: string | null;
/**
* If true, the volume will be mounted as read only for all mounts.
*/
readOnly?: boolean | null;
/**
* Hostname or IP address of the NFS server
*/
server?: string | null;
}
/**
* Hardware constraints configuration.
*/
export interface Schema$GoogleCloudRunV2NodeSelector {
/**
* Required. GPU accelerator type to attach to an instance.
*/
accelerator?: string | null;
}
/**
* RunJob Overrides that contains Execution fields to be overridden.
*/
export interface Schema$GoogleCloudRunV2Overrides {
/**
* Per container override specification.
*/
containerOverrides?: Schema$GoogleCloudRunV2ContainerOverride[];
/**
* Optional. The desired number of tasks the execution should run. Will replace existing task_count value.
*/
taskCount?: number | null;
/**
* Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. Will replace existing timeout_seconds value.
*/
timeout?: string | null;
}
/**
* Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
*/
export interface Schema$GoogleCloudRunV2Probe {
/**
* Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
*/
failureThreshold?: number | null;
/**
* Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
*/
grpc?: Schema$GoogleCloudRunV2GRPCAction;
/**
* Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
*/
httpGet?: Schema$GoogleCloudRunV2HTTPGetAction;
/**
* 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.
*/
initialDelaySeconds?: number | null;
/**
* 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.
*/
periodSeconds?: number | null;
/**
* Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
*/
tcpSocket?: Schema$GoogleCloudRunV2TCPSocketAction;
/**
* 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.
*/
timeoutSeconds?: number | null;
}
/**
* ResourceRequirements describes the compute resource requirements.
*/
export interface Schema$GoogleCloudRunV2ResourceRequirements {
/**
* 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.
*/
cpuIdle?: boolean | null;
/**
* 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
*/
limits?: {
[key: string]: string;
} | null;
/**
* 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.
*/
startupCpuBoost?: boolean | null;
}
/**
* A Revision is an immutable snapshot of code and configuration. A Revision references a container image. Revisions are only created by updates to its parent Service.
*/
export interface Schema$GoogleCloudRunV2Revision {
/**
* 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.
*/
annotations?: {
[key: string]: string;
} | null;
/**
* Output only. The Condition of this Revision, containing its readiness status, and detailed error information in case it did not reach a serving state.
*/
conditions?: Schema$GoogleCloudRunV2Condition[];
/**
* Holds the single container that defines the unit of execution for this Revision.
*/
containers?: Schema$GoogleCloudRunV2Container[];
/**
* Output only. The creation time.
*/
createTime?: string | null;
/**
* Output only. Email address of the authenticated creator.
*/
creator?: string | null;
/**
* Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.
*/
deleteTime?: string | null;
/**
* 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
*/
encryptionKey?: string | null;
/**
* The action to take if the encryption key is revoked.
*/
encryptionKeyRevocationAction?: string | null;
/**
* If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
*/
encryptionKeyShutdownDuration?: string | null;
/**
* Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
*/
etag?: string | null;
/**
* The execution environment being used to host this Revision.
*/
executionEnvironment?: string | null;
/**
* Output only. For a deleted resource, the time after which it