googleapis
Version:
Google APIs Client Library for Node.js
1,052 lines (1,051 loc) • 215 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace run_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
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('v1');
* ```
*/
export class Run {
context: APIRequestContext;
namespaces: Resource$Namespaces;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Information for connecting over HTTP(s).
*/
export interface Schema$Addressable {
url?: string | null;
}
/**
* Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
*/
export interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
*/
service?: string | null;
}
/**
* Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
*/
export interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[] | null;
/**
* The log type that this config enables.
*/
logType?: string | null;
}
/**
* A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via [Search Console](https://search.google.com/search-console/welcome).
*/
export interface Schema$AuthorizedDomain {
/**
* Relative name of the domain authorized for use. Example: `example.com`.
*/
id?: string | null;
/**
* Deprecated Read only. Full path to the `AuthorizedDomain` resource in the API. Example: `projects/myproject/authorizedDomains/example.com`.
*/
name?: string | null;
}
/**
* Associates `members`, or principals, with a `role`.
*/
export interface Schema$Binding {
/**
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
condition?: Schema$Expr;
/**
* Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
role?: string | null;
}
/**
* Request message for cancelling an execution.
*/
export interface Schema$CancelExecutionRequest {
}
/**
* Not supported by Cloud Run. ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
*/
export interface Schema$ConfigMapEnvSource {
/**
* This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead.
*/
localObjectReference?: Schema$LocalObjectReference;
/**
* The ConfigMap to select from.
*/
name?: string | null;
/**
* Specify whether the ConfigMap must be defined.
*/
optional?: boolean | null;
}
/**
* Not supported by Cloud Run.
*/
export interface Schema$ConfigMapKeySelector {
/**
* Required. Not supported by Cloud Run.
*/
key?: string | null;
/**
* Not supported by Cloud Run.
*/
localObjectReference?: Schema$LocalObjectReference;
/**
* Required. Not supported by Cloud Run.
*/
name?: string | null;
/**
* Not supported by Cloud Run.
*/
optional?: boolean | null;
}
/**
* Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths.
*/
export interface Schema$ConfigMapVolumeSource {
/**
* (Optional) Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. 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.
*/
defaultMode?: number | null;
/**
* (Optional) If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional.
*/
items?: Schema$KeyToPath[];
/**
* Name of the config.
*/
name?: string | null;
/**
* (Optional) Specify whether the Secret or its keys must be defined.
*/
optional?: boolean | null;
}
/**
* Configuration represents the "floating HEAD" of a linear history of Revisions, and optionally how the containers those revisions reference are built. Users create new Revisions by updating the Configuration's spec. The "latest created" revision's name is available under status, as is the "latest ready" revision's name.
*/
export interface Schema$Configuration {
/**
* The API version for this call such as "serving.knative.dev/v1".
*/
apiVersion?: string | null;
/**
* The kind of resource, in this case always "Configuration".
*/
kind?: string | null;
/**
* Metadata associated with this Configuration, including name, namespace, labels, and annotations.
*/
metadata?: Schema$ObjectMeta;
/**
* Spec holds the desired state of the Configuration (from the client).
*/
spec?: Schema$ConfigurationSpec;
/**
* Status communicates the observed state of the Configuration (from the controller).
*/
status?: Schema$ConfigurationStatus;
}
/**
* ConfigurationSpec holds the desired state of the Configuration (from the client).
*/
export interface Schema$ConfigurationSpec {
/**
* Template holds the latest specification for the Revision to be stamped out.
*/
template?: Schema$RevisionTemplate;
}
/**
* ConfigurationStatus communicates the observed state of the Configuration (from the controller).
*/
export interface Schema$ConfigurationStatus {
/**
* Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world.
*/
conditions?: Schema$GoogleCloudRunV1Condition[];
/**
* LatestCreatedRevisionName is the last revision that was created from this Configuration. It might not be ready yet, so for the latest ready revision, use LatestReadyRevisionName.
*/
latestCreatedRevisionName?: string | null;
/**
* LatestReadyRevisionName holds the name of the latest Revision stamped out from this Configuration that has had its "Ready" condition become "True".
*/
latestReadyRevisionName?: string | null;
/**
* ObservedGeneration is the 'Generation' of the Configuration that was last processed by the controller. The observed generation is updated even if the controller failed to process the spec and create the Revision. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation, and the Ready condition's status is True or False.
*/
observedGeneration?: number | 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 may be supplied by the system to the container at runtime.
*/
export interface Schema$Container {
/**
* Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
*/
args?: string[] | null;
/**
* Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
*/
command?: string[] | null;
/**
* List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
*/
env?: Schema$EnvVar[];
/**
* Not supported by Cloud Run.
*/
envFrom?: Schema$EnvFromSource[];
/**
* 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;
/**
* Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
*/
imagePullPolicy?: string | null;
/**
* Periodic probe of container liveness. Container will be restarted if the probe fails.
*/
livenessProbe?: Schema$Probe;
/**
* 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$ContainerPort[];
/**
* Not supported by Cloud Run.
*/
readinessProbe?: Schema$Probe;
/**
* Compute Resources required by this container.
*/
resources?: Schema$ResourceRequirements;
/**
* Not supported by Cloud Run.
*/
securityContext?: Schema$SecurityContext;
/**
* Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not receive traffic if the probe fails. If not provided, a default startup probe with TCP socket action is used.
*/
startupProbe?: Schema$Probe;
/**
* Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log.
*/
terminationMessagePath?: string | null;
/**
* Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
*/
terminationMessagePolicy?: string | null;
/**
* Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem.
*/
volumeMounts?: Schema$VolumeMount[];
/**
* 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$ContainerOverride {
/**
* Arguments to the entrypoint. The specified arguments replace and override any existing entrypoint arguments. Must be empty if `clear_args` is set to true.
*/
args?: string[] | null;
/**
* Optional. Set to True to clear all existing arguments.
*/
clearArgs?: boolean | null;
/**
* List of environment variables to set in the container. All specified environment variables are merged with existing environment variables. When the specified environment variables exist, these values override any existing values.
*/
env?: Schema$EnvVar[];
/**
* 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$ContainerPort {
/**
* Port number the container listens on. If present, this must be a valid port number, 0 < x < 65536. If not present, it will default to port 8080. For more information, see https://cloud.google.com/run/docs/container-contract#port
*/
containerPort?: number | null;
/**
* If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
*/
name?: string | null;
/**
* Protocol for port. Must be "TCP". Defaults to "TCP".
*/
protocol?: string | null;
}
/**
* Resource to hold the state and status of a user's domain mapping. NOTE: This resource is currently in Beta.
*/
export interface Schema$DomainMapping {
/**
* The API version for this call such as "domains.cloudrun.com/v1".
*/
apiVersion?: string | null;
/**
* The kind of resource, in this case "DomainMapping".
*/
kind?: string | null;
/**
* Metadata associated with this BuildTemplate.
*/
metadata?: Schema$ObjectMeta;
/**
* The spec for this DomainMapping.
*/
spec?: Schema$DomainMappingSpec;
/**
* The current status of the DomainMapping.
*/
status?: Schema$DomainMappingStatus;
}
/**
* The desired state of the Domain Mapping.
*/
export interface Schema$DomainMappingSpec {
/**
* The mode of the certificate.
*/
certificateMode?: string | null;
/**
* If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
*/
forceOverride?: boolean | null;
/**
* The name of the Knative Route that this DomainMapping applies to. The route must exist.
*/
routeName?: string | null;
}
/**
* The current state of the Domain Mapping.
*/
export interface Schema$DomainMappingStatus {
/**
* Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.
*/
conditions?: Schema$GoogleCloudRunV1Condition[];
/**
* The name of the route that the mapping currently points to.
*/
mappedRouteName?: string | null;
/**
* ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.
*/
observedGeneration?: number | null;
/**
* The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.
*/
resourceRecords?: Schema$ResourceRecord[];
/**
* Optional. Not supported by Cloud Run.
*/
url?: string | null;
}
/**
* 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$EmptyDirVolumeSource {
/**
* The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
*/
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;
}
/**
* Not supported by Cloud Run. EnvFromSource represents the source of a set of ConfigMaps
*/
export interface Schema$EnvFromSource {
/**
* The ConfigMap to select from
*/
configMapRef?: Schema$ConfigMapEnvSource;
/**
* An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
*/
prefix?: string | null;
/**
* The Secret to select from
*/
secretRef?: Schema$SecretEnvSource;
}
/**
* EnvVar represents an environment variable present in a Container.
*/
export interface Schema$EnvVar {
/**
* Required. Name of the environment variable. Must be a C_IDENTIFIER.
*/
name?: string | null;
/**
* Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
*/
value?: string | null;
/**
* Source for the environment variable's value. Only supports secret_key_ref. Cannot be used if value is not empty.
*/
valueFrom?: Schema$EnvVarSource;
}
/**
* EnvVarSource represents a source for the value of an EnvVar.
*/
export interface Schema$EnvVarSource {
/**
* Not supported by Cloud Run. Not supported in Cloud Run.
*/
configMapKeyRef?: Schema$ConfigMapKeySelector;
/**
* Selects a key (version) of a secret in Secret Manager.
*/
secretKeyRef?: Schema$SecretKeySelector;
}
/**
* Not supported by Cloud Run. ExecAction describes a "run in container" action.
*/
export interface Schema$ExecAction {
/**
* Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
*/
command?: string[] | null;
}
/**
* Execution represents the configuration of a single execution. An execution is an immutable resource that references a container image which is run to completion.
*/
export interface Schema$Execution {
/**
* Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.
*/
apiVersion?: string | null;
/**
* Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase.
*/
kind?: string | null;
/**
* Optional. Standard object's metadata.
*/
metadata?: Schema$ObjectMeta;
/**
* Optional. Specification of the desired behavior of an execution.
*/
spec?: Schema$ExecutionSpec;
/**
* Output only. Current status of an execution.
*/
status?: Schema$ExecutionStatus;
}
/**
* Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status.
*/
export interface Schema$ExecutionReference {
/**
* Optional. Completion timestamp of the execution.
*/
completionTimestamp?: string | null;
/**
* Optional. Creation timestamp of the execution.
*/
creationTimestamp?: string | null;
/**
* Optional. Name of the execution.
*/
name?: string | null;
}
/**
* ExecutionSpec describes how the execution will look.
*/
export interface Schema$ExecutionSpec {
/**
* Optional. Specifies the maximum desired number of tasks the execution should run at given time. Must be <= task_count. 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, i.e. when the work left to do is less than max parallelism.
*/
parallelism?: number | null;
/**
* Optional. 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;
/**
* Optional. The template used to create tasks for this execution.
*/
template?: Schema$TaskTemplateSpec;
}
/**
* ExecutionStatus represents the current state of an Execution.
*/
export interface Schema$ExecutionStatus {
/**
* Optional. The number of tasks which reached phase Cancelled.
*/
cancelledCount?: number | null;
/**
* Optional. Represents the time that the execution was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional
*/
completionTime?: string | null;
/**
* Optional. Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. Execution-specific conditions include: * `ResourcesAvailable`: `True` when underlying resources have been provisioned. * `Started`: `True` when the execution has started to execute. * `Completed`: `True` when the execution has succeeded. `False` when the execution has failed.
*/
conditions?: Schema$GoogleCloudRunV1Condition[];
/**
* Optional. The number of tasks which reached phase Failed.
*/
failedCount?: number | null;
/**
* Optional. URI where logs for this execution can be found in Cloud Console.
*/
logUri?: string | null;
/**
* Optional. The 'generation' of the execution that was last processed by the controller.
*/
observedGeneration?: number | null;
/**
* Optional. The number of tasks which have retried at least once.
*/
retriedCount?: number | null;
/**
* Optional. The number of actively running tasks.
*/
runningCount?: number | null;
/**
* Optional. Represents the time that the execution started to run. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
*/
startTime?: string | null;
/**
* Optional. The number of tasks which reached phase Succeeded.
*/
succeededCount?: number | null;
}
/**
* ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job.
*/
export interface Schema$ExecutionTemplateSpec {
/**
* Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`.
*/
metadata?: Schema$ObjectMeta;
/**
* Required. ExecutionSpec holds the desired configuration for executions of this job.
*/
spec?: Schema$ExecutionSpec;
}
/**
* Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string | null;
}
/**
* Conditions show the status of reconciliation progress on a given resource. Most resource use a top-level condition type "Ready" or "Completed" to show overall status with other conditions to checkpoint each stage of reconciliation. Note that if metadata.Generation does not equal status.ObservedGeneration, the conditions shown may not be relevant for the current spec.
*/
export interface Schema$GoogleCloudRunV1Condition {
/**
* Optional. Last time the condition transitioned from one status to another.
*/
lastTransitionTime?: string | null;
/**
* Optional. Human readable message indicating details about the current status.
*/
message?: string | null;
/**
* Optional. One-word CamelCase reason for the condition's last transition. These are intended to be stable, unique values which the client may use to trigger error handling logic, whereas messages which may be changed later by the server.
*/
reason?: string | null;
/**
* Optional. How to interpret this condition. One of Error, Warning, or Info. Conditions of severity Info do not contribute to resource readiness.
*/
severity?: string | null;
/**
* Status of the condition, one of True, False, Unknown.
*/
status?: string | null;
/**
* type is used to communicate the status of the reconciliation process. Types common to all resources include: * "Ready" or "Completed": True when the Resource is ready.
*/
type?: string | null;
}
/**
* 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).
*/
export interface Schema$GoogleRpcStatus {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* 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.
*/
message?: string | null;
}
/**
* GRPCAction describes an action involving a GRPC port.
*/
export interface Schema$GRPCAction {
/**
* Port number of the gRPC service. Number must be in the range 1 to 65535.
*/
port?: number | null;
/**
* Service is the name of the service to place in the gRPC HealthCheckRequest. 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$HTTPGetAction {
/**
* Not supported by Cloud Run.
*/
host?: string | null;
/**
* Custom headers to set in the request. HTTP allows repeated headers.
*/
httpHeaders?: Schema$HTTPHeader[];
/**
* Path to access on the HTTP server.
*/
path?: string | null;
/**
* Port number to access on the container. Number must be in the range 1 to 65535.
*/
port?: number | null;
/**
* Not supported by Cloud Run.
*/
scheme?: string | null;
}
/**
* HTTPHeader describes a custom header to be used in HTTP probes
*/
export interface Schema$HTTPHeader {
/**
* Required. The header field name
*/
name?: string | null;
/**
* The header field value
*/
value?: string | null;
}
/**
* Job represents the configuration of a single job, which references a container image which is run to completion.
*/
export interface Schema$Job {
/**
* Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.
*/
apiVersion?: string | null;
/**
* Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase.
*/
kind?: string | null;
/**
* Optional. Standard object's metadata.
*/
metadata?: Schema$ObjectMeta;
/**
* Optional. Specification of the desired behavior of a job.
*/
spec?: Schema$JobSpec;
/**
* Output only. Current status of a job.
*/
status?: Schema$JobStatus;
}
/**
* JobSpec describes how the job will look.
*/
export interface Schema$JobSpec {
/**
* Optional. Describes the execution that will be created when running a job.
*/
template?: Schema$ExecutionTemplateSpec;
}
/**
* JobStatus represents the current state of a Job.
*/
export interface Schema$JobStatus {
/**
* Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. Job-specific conditions include: * `Ready`: `True` when the job is ready to be executed.
*/
conditions?: Schema$GoogleCloudRunV1Condition[];
/**
* Number of executions created for this job.
*/
executionCount?: number | null;
/**
* A pointer to the most recently created execution for this job. This is set regardless of the eventual state of the execution.
*/
latestCreatedExecution?: Schema$ExecutionReference;
/**
* The 'generation' of the job that was last processed by the controller.
*/
observedGeneration?: number | null;
}
/**
* Maps a string key to a path within a volume.
*/
export interface Schema$KeyToPath {
/**
* The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version. The key to project.
*/
key?: string | null;
/**
* (Optional) 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.
*/
mode?: number | null;
/**
* The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
*/
path?: string | null;
}
/**
* A list of Authorized Domains.
*/
export interface Schema$ListAuthorizedDomainsResponse {
/**
* The authorized domains belonging to the user.
*/
domains?: Schema$AuthorizedDomain[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
}
/**
* ListConfigurationsResponse is a list of Configuration resources.
*/
export interface Schema$ListConfigurationsResponse {
/**
* The API version for this call such as "serving.knative.dev/v1".
*/
apiVersion?: string | null;
/**
* List of Configurations.
*/
items?: Schema$Configuration[];
/**
* The kind of this resource, in this case "ConfigurationList".
*/
kind?: string | null;
/**
* Metadata associated with this Configuration list.
*/
metadata?: Schema$ListMeta;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* ListDomainMappingsResponse is a list of DomainMapping resources.
*/
export interface Schema$ListDomainMappingsResponse {
/**
* The API version for this call such as "domains.cloudrun.com/v1".
*/
apiVersion?: string | null;
/**
* List of DomainMappings.
*/
items?: Schema$DomainMapping[];
/**
* The kind of this resource, in this case "DomainMappingList".
*/
kind?: string | null;
/**
* Metadata associated with this DomainMapping list.
*/
metadata?: Schema$ListMeta;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* ListExecutionsResponse is a list of Executions resources.
*/
export interface Schema$ListExecutionsResponse {
/**
* The API version for this call such as "run.googleapis.com/v1".
*/
apiVersion?: string | null;
/**
* List of Executions.
*/
items?: Schema$Execution[];
/**
* The kind of this resource, in this case "ExecutionsList".
*/
kind?: string | null;
/**
* Metadata associated with this executions list.
*/
metadata?: Schema$ListMeta;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* ListJobsResponse is a list of Jobs resources.
*/
export interface Schema$ListJobsResponse {
/**
* The API version for this call such as "run.googleapis.com/v1".
*/
apiVersion?: string | null;
/**
* List of Jobs.
*/
items?: Schema$Job[];
/**
* The kind of this resource, in this case "JobsList".
*/
kind?: string | null;
/**
* Metadata associated with this jobs list.
*/
metadata?: Schema$ListMeta;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* Metadata for synthetic resources like List. In Cloud Run, all List Resources Responses will have a ListMeta instead of ObjectMeta.
*/
export interface Schema$ListMeta {
/**
* Continuation token is a value emitted when the count of items is larger than the user/system limit. To retrieve the next page of items, pass the value of `continue` as the next request's `page_token`.
*/
continue?: string | null;
/**
* Opaque string that identifies the server's internal version of this object. It can be used by clients to determine when objects have changed. If the message is passed back to the server, it must be left unmodified.
*/
resourceVersion?: string | null;
/**
* URL representing this object.
*/
selfLink?: string | null;
}
/**
* ListRevisionsResponse is a list of Revision resources.
*/
export interface Schema$ListRevisionsResponse {
/**
* The API version for this call such as "serving.knative.dev/v1".
*/
apiVersion?: string | null;
/**
* List of Revisions.
*/
items?: Schema$Revision[];
/**
* The kind of this resource, in this case "RevisionList".
*/
kind?: string | null;
/**
* Metadata associated with this revision list.
*/
metadata?: Schema$ListMeta;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* ListRoutesResponse is a list of Route resources.
*/
export interface Schema$ListRoutesResponse {
/**
* The API version for this call such as "serving.knative.dev/v1".
*/
apiVersion?: string | null;
/**
* List of Routes.
*/
items?: Schema$Route[];
/**
* The kind of this resource, in this case always "RouteList".
*/
kind?: string | null;
/**
* Metadata associated with this Route list.
*/
metadata?: Schema$ListMeta;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* A list of Service resources.
*/
export interface Schema$ListServicesResponse {
/**
* The API version for this call; returns "serving.knative.dev/v1".
*/
apiVersion?: string | null;
/**
* List of Services.
*/
items?: Schema$Service[];
/**
* The kind of this resource; returns "ServiceList".
*/
kind?: string | null;
/**
* Metadata associated with this Service list.
*/
metadata?: Schema$ListMeta;
/**
* For calls against the global endpoint, returns the list of Cloud locations that could not be reached. For regional calls, this field is not used.
*/
unreachable?: string[] | null;
}
/**
* ListTasksResponse is a list of Tasks resources.
*/
export interface Schema$ListTasksResponse {
/**
* The API version for this call such as "run.googleapis.com/v1".
*/
apiVersion?: string | null;
/**
* List of Tasks.
*/
items?: Schema$Task[];
/**
* The kind of this resource, in this case "TasksList".
*/
kind?: string | null;
/**
* Metadata associated with this tasks list.
*/
metadata?: Schema$ListMeta;
/**
* Locations that could not be reached.