googleapis

/** * Copyright 2019 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library'; import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common'; import { GaxiosPromise } from 'gaxios'; export declare namespace run_v1alpha1 { interface Options extends GlobalOptions { version: 'v1alpha1'; } interface StandardParameters { /** * 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 API * * Deploy and manage user provided container images that scale automatically based on HTTP traffic. * * @example * const {google} = require('googleapis'); * const run = google.run('v1alpha1'); * * @namespace run * @type {Function} * @version v1alpha1 * @variation v1alpha1 * @param {object=} options Options for Run */ class Run { context: APIRequestContext; namespaces: Resource$Namespaces; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable); } /** * Information for connecting over HTTP(s). */ interface Schema$Addressable { /** * Deprecated - use url instead. */ hostname?: string; url?: string; } /** * 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:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ 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; } /** * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ 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[]; /** * The log type that this config enables. */ logType?: string; } /** * A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via [Webmaster Central](https://www.google.com/webmasters/verification/home). */ interface Schema$AuthorizedDomain { /** * Relative name of the domain authorized for use. Example: `example.com`. */ id?: string; /** * Read only. Full path to the `AuthorizedDomain` resource in the API. Example: `apps/myapp/authorizedDomains/example.com`. */ name?: string; } /** * Associates `members` with a `role`. */ interface Schema$Binding { /** * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** * Specifies the identities requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `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`. */ members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** * Adds and removes POSIX capabilities from running containers. */ interface Schema$Capabilities { /** * Added capabilities +optional */ add?: string[]; /** * Removed capabilities +optional */ drop?: string[]; } /** * 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. */ interface Schema$ConfigMapEnvSource { /** * The ConfigMap to select from. */ localObjectReference?: Schema$LocalObjectReference; /** * Specify whether the ConfigMap must be defined +optional */ optional?: boolean; } /** * 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. */ interface Schema$ConfigMapVolumeSource { /** * Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. */ defaultMode?: number; /** * 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 which 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; /** * Specify whether the Secret or its keys must be defined. */ optional?: boolean; } /** * 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. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration */ interface Schema$Configuration { /** * The API version for this call such as "serving.knative.dev/v1alpha1". */ apiVersion?: string; /** * The kind of resource, in this case always "Configuration". */ kind?: string; /** * 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; } /** * ConfigurationCondition defines a readiness condition for a Configuration. */ interface Schema$ConfigurationCondition { /** * Last time the condition transitioned from one status to another. +optional */ lastTransitionTime?: string; /** * Human-readable message indicating details about last transition. +optional */ message?: string; /** * One-word CamelCase reason for the condition's last transition. +optional */ reason?: string; /** * How to interpret failures of this condition, one of Error, Warning, Info +optional */ severity?: string; /** * Status of the condition, one of True, False, Unknown. */ status?: string; /** * ConfigurationConditionType is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include:"Ready" */ type?: string; } /** * ConfigurationSpec holds the desired state of the Configuration (from the client). */ interface Schema$ConfigurationSpec { /** * Deprecated and not currently populated by Cloud Run. See metadata.generation instead, which is the sequence number containing the latest generation of the desired state. Read-only. */ generation?: number; /** * RevisionTemplate holds the latest specification for the Revision to be stamped out. The template references the container image, and may also include labels and annotations that should be attached to the Revision. To correlate a Revision, and/or to force a Revision to be created when the spec doesn't otherwise change, a nonce label may be provided in the template metadata. For more details, see: https://github.com/knative/serving/blob/master/docs/client-conventions.md#associate-modifications-with-revisions Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source. */ revisionTemplate?: Schema$RevisionTemplate; /** * 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). */ interface Schema$ConfigurationStatus { /** * Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. */ conditions?: Schema$ConfigurationCondition[]; /** * LatestCreatedRevisionName is the last revision that was created from this Configuration. It might not be ready yet, for that use LatestReadyRevisionName. */ latestCreatedRevisionName?: string; /** * LatestReadyRevisionName holds the name of the latest Revision stamped out from this Configuration that has had its "Ready" condition become "True". */ latestReadyRevisionName?: string; /** * 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; } /** * 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. */ interface Schema$Container { /** * Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional */ args?: string[]; /** * Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional */ command?: string[]; /** * List of environment variables to set in the container. Cannot be updated. +optional */ env?: Schema$EnvVar[]; /** * List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +optional */ envFrom?: Schema$EnvFromSource[]; /** * Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images */ image?: string; /** * Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images +optional */ imagePullPolicy?: string; /** * Actions that the management system should take in response to container lifecycle events. Cannot be updated. +optional */ lifecycle?: Schema$Lifecycle; /** * Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional */ livenessProbe?: Schema$Probe; /** * Name of the container specified as a DNS_LABEL. Each container must have a unique name (DNS_LABEL). Cannot be updated. */ name?: string; /** * List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. +optional */ ports?: Schema$ContainerPort[]; /** * Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional */ readinessProbe?: Schema$Probe; /** * Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources +optional */ resources?: Schema$ResourceRequirements; /** * Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ +optional */ securityContext?: Schema$SecurityContext; /** * Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. +optional */ stdin?: boolean; /** * Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false +optional */ stdinOnce?: boolean; /** * Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. +optional */ terminationMessagePath?: string; /** * 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. +optional */ terminationMessagePolicy?: string; /** * Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. +optional */ tty?: boolean; /** * volumeDevices is the list of block devices to be used by the container. This is an alpha feature and may change in the future. +optional */ volumeDevices?: Schema$VolumeDevice[]; /** * Pod volumes to mount into the container's filesystem. Cannot be updated. +optional */ 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. Cannot be updated. +optional */ workingDir?: string; } /** * ContainerPort represents a network port in a single container. */ interface Schema$ContainerPort { /** * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. */ containerPort?: number; /** * What host IP to bind the external port to. +optional */ hostIP?: string; /** * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. +optional */ hostPort?: number; /** * If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. +optional */ name?: string; /** * Protocol for port. Must be UDP or TCP. Defaults to "TCP". +optional */ protocol?: string; } /** * Resource to hold the state and status of a user's domain mapping. */ interface Schema$DomainMapping { /** * The API version for this call such as "domains.cloudrun.com/v1alpha1". */ apiVersion?: string; /** * The kind of resource, in this case "DomainMapping". */ kind?: string; /** * 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; } /** * DomainMappingCondition contains state information for a DomainMapping. */ interface Schema$DomainMappingCondition { /** * Last time the condition transitioned from one status to another. +optional */ lastTransitionTime?: string; /** * Human readable message indicating details about the current status. +optional */ message?: string; /** * One-word CamelCase reason for the condition's current status. +optional */ reason?: string; /** * How to interpret failures of this condition, one of Error, Warning, Info +optional */ severity?: string; /** * Status of the condition, one of True, False, Unknown. */ status?: string; /** * Type of domain mapping condition. */ type?: string; } /** * The desired state of the Domain Mapping. */ interface Schema$DomainMappingSpec { /** * The mode of the certificate. */ certificateMode?: string; /** * 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; /** * The name of the Knative Route that this DomainMapping applies to. The route must exist. */ routeName?: string; } /** * The current state of the Domain Mapping. */ interface Schema$DomainMappingStatus { /** * Array of observed DomainMappingConditions, indicating the current state of the DomainMapping. */ conditions?: Schema$DomainMappingCondition[]; /** * The name of the route that the mapping currently points to. */ mappedRouteName?: string; /** * 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; /** * 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[]; } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ interface Schema$Empty { } /** * EnvFromSource represents the source of a set of ConfigMaps */ interface Schema$EnvFromSource { /** * The ConfigMap to select from +optional */ configMapRef?: Schema$ConfigMapEnvSource; /** * An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. +optional */ prefix?: string; /** * The Secret to select from +optional */ secretRef?: Schema$SecretEnvSource; } /** * EnvVar represents an environment variable present in a Container. */ interface Schema$EnvVar { /** * Name of the environment variable. Must be a C_IDENTIFIER. */ name?: string; /** * Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +optional */ value?: string; } interface Schema$EventType { /** * The API version for this call such as "eventing.knative.dev/v1alpha1". */ apiVersion?: string; /** * The kind of resource, in this case "EventType". */ kind?: string; /** * Metadata associated with this EventType. */ metadata?: Schema$ObjectMeta; /** * Spec defines the desired state of the EventType. */ spec?: Schema$EventTypeSpec; } interface Schema$EventTypeSpec { /** * Refers to the Broker that can provide the EventType. */ broker?: string; /** * Description is a string describing what the EventType is about. +optional */ description?: string; /** * Schema is a URI with the EventType schema. It may be a JSON schema, a protobuf schema, etc. +optional */ schema?: string; /** * Source is a valid URI. Refers to the CloudEvent source as it enters into the eventing mesh. */ source?: string; /** * Type is authoritative. This refers to the CloudEvent type as it enters into the eventing mesh. */ type?: string; } /** * ExecAction describes a "run in container" action. */ 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. +optional */ command?: string; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ interface Schema$Expr { /** * An 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; /** * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** * An 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; } /** * Handler defines a specific action that should be taken */ interface Schema$Handler { /** * One and only one of the following should be specified. Exec specifies the action to take. +optional */ exec?: Schema$ExecAction; /** * HTTPGet specifies the http request to perform. +optional */ httpGet?: Schema$HTTPGetAction; /** * TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported */ tcpSocket?: Schema$TCPSocketAction; } /** * HTTPGetAction describes an action based on HTTP Get requests. */ interface Schema$HTTPGetAction { /** * Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional */ host?: string; /** * Custom headers to set in the request. HTTP allows repeated headers. +optional */ httpHeaders?: Schema$HTTPHeader[]; /** * Path to access on the HTTP server. +optional */ path?: string; /** * Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port?: Schema$IntOrString; /** * Scheme to use for connecting to the host. Defaults to HTTP. +optional */ scheme?: string; } /** * HTTPHeader describes a custom header to be used in HTTP probes */ interface Schema$HTTPHeader { /** * The header field name */ name?: string; /** * The header field value */ value?: string; } /** * Initializer is information about an initializer that has not yet completed. */ interface Schema$Initializer { /** * name of the process that is responsible for initializing this object. */ name?: string; } /** * Initializers tracks the progress of initialization. */ interface Schema$Initializers { /** * Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients. +patchMergeKey=name +patchStrategy=merge */ pending?: Schema$Initializer[]; } /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. */ interface Schema$IntOrString { /** * The int value. */ intVal?: number; /** * The string value. */ strVal?: string; /** * The type of the value. */ type?: string; } /** * Maps a string key to a path within a volume. */ interface Schema$KeyToPath { /** * The key to project. */ key?: string; /** * Mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional */ mode?: number; /** * 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; } /** * Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ interface Schema$Lifecycle { /** * PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks +optional */ postStart?: Schema$Handler; /** * PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks +optional */ preStop?: Schema$Handler; } /** * A list of Authorized Domains. */ interface Schema$ListAuthorizedDomainsResponse { /** * The authorized domains belonging to the user. */ domains?: Schema$AuthorizedDomain[]; /** * Continuation token for fetching the next page of results. */ nextPageToken?: string; } /** * ListConfigurationsResponse is a list of Configuration resources. */ interface Schema$ListConfigurationsResponse { /** * The API version for this call such as "serving.knative.dev/v1alpha1". */ apiVersion?: string; /** * List of Configurations. */ items?: Schema$Configuration[]; /** * The kind of this resource, in this case "ConfigurationList". */ kind?: string; /** * Metadata associated with this Configuration list. */ metadata?: Schema$ListMeta; /** * Locations that could not be reached. */ unreachable?: string[]; } /** * ListDomainMappingsResponse is a list of DomainMapping resources. */ interface Schema$ListDomainMappingsResponse { /** * The API version for this call such as "domains.cloudrun.com/v1alpha1". */ apiVersion?: string; /** * List of DomainMappings. */ items?: Schema$DomainMapping[]; /** * The kind of this resource, in this case "DomainMappingList". */ kind?: string; /** * Metadata associated with this DomainMapping list. */ metadata?: Schema$ListMeta; } /** * ListEventTypesResponse is a list of EventType resources. */ interface Schema$ListEventTypesResponse { /** * The API version for this call such as "eventing.knative.dev/v1alpha1". */ apiVersion?: string; /** * List of EventTypes. */ items?: Schema$EventType[]; /** * The kind of this resource, in this case "EventTypeList". */ kind?: string; /** * Metadata associated with this EventType list. */ metadata?: Schema$ListMeta; /** * Locations that could not be reached. */ unreachable?: string[]; } /** * The response message for Locations.ListLocations. */ 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; } /** * ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. */ interface Schema$ListMeta { /** * continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response. */ continue?: string; /** * String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional */ resourceVersion?: string; /** * SelfLink is a URL representing this object. Populated by the system. Read-only. +optional */ selfLink?: string; } /** * ListRevisionsResponse is a list of Revision resources. */ interface Schema$ListRevisionsResponse { /** * The API version for this call such as "serving.knative.dev/v1alpha1". */ apiVersion?: string; /** * List of Revisions. */ items?: Schema$Revision[]; /** * The kind of this resource, in this case "RevisionList". */ kind?: string; /** * Metadata associated with this revision list. */ metadata?: Schema$ListMeta; /** * Locations that could not be reached. */ unreachable?: string[]; } /** * ListRoutesResponse is a list of Route resources. */ interface Schema$ListRoutesResponse { /** * The API version for this call such as "serving.knative.dev/v1alpha1". */ apiVersion?: string; /** * List of Routes. */ items?: Schema$Route[]; /** * The kind of this resource, in this case always "RouteList". */ kind?: string; /** * Metadata associated with this Route list. */ metadata?: Schema$ListMeta; /** * Locations that could not be reached. */ unreachable?: string[]; } /** * A list of Service resources. */ interface Schema$ListServicesResponse { /** * The API version for this call such as "serving.knative.dev/v1alpha1". */ apiVersion?: string; /** * List of Services. */ items?: Schema$Service[]; /** * The kind of this resource, in this case "ServiceList". */ kind?: string; /** * Metadata associated with this Service list. */ metadata?: Schema$ListMeta; /** * Locations that could not be reached. */ unreachable?: string[]; } /** * ListTriggersResponse is a list of Trigger resources. */ interface Schema$ListTriggersResponse { /** * The API version for this call such as "eventing.knative.dev/v1alpha1". */ apiVersion?: string; /** * List of Triggers. */ items?: Schema$Trigger[]; /** * The kind of this resource, in this case "TriggerList". */ kind?: string; /** * Metadata associated with this Trigger list. */ metadata?: Schema$ListMeta; /** * Locations that could not be reached. */ unreachable?: string[]; } /** * LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. */ interface Schema$LocalObjectReference { /** * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; } /** * A resource that represents Google Cloud Platform location. */ interface Schema$Location { /** * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: { [key: string]: string; }; /** * The canonical id for this location. For example: `"us-east1"`. */ locationId?: string; /** * Service-specific metadata. For example the available capacity at the given location. */ metadata?: { [key: string]: any; }; /** * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } /** * ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. */ interface Schema$ObjectMeta { /** * Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional */ annotations?: { [key: string]: string; }; /** * Not currently supported by Cloud Run. The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. +optional */ clusterName?: string; /** * CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional */ creationTimestamp?: string; /** * Not currently supported by Cloud Run. Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional */ deletionGracePeriodSeconds?: number; /** * DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional */ deletionTimestamp?: string; /** * Not currently supported by Cloud Run. Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. +optional +patchStrategy=merge */ finalizers?: string[]; /** * Not currently supported by Cloud Run. GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors