googleapis
Version:
Google APIs Client Library for Node.js
1,044 lines • 230 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 clouddeploy_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;
}
/**
* Google Cloud Deploy API
*
*
*
* @example
* ```js
* const {google} = require('googleapis');
* const clouddeploy = google.clouddeploy('v1');
* ```
*/
export class Clouddeploy {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* The request object used by `AbandonRelease`.
*/
export interface Schema$AbandonReleaseRequest {
}
/**
* The response object for `AbandonRelease`.
*/
export interface Schema$AbandonReleaseResponse {
}
/**
* Information specifying an Anthos Cluster.
*/
export interface Schema$AnthosCluster {
/**
* Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project\}/locations/{location\}/memberships/{membership_name\}`.
*/
membership?: string | null;
}
/**
* The request object used by `ApproveRollout`.
*/
export interface Schema$ApproveRolloutRequest {
/**
* Required. True = approve; false = reject
*/
approved?: boolean | null;
}
/**
* The response object from `ApproveRollout`.
*/
export interface Schema$ApproveRolloutResponse {
}
/**
* 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;
}
/**
* 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`. * `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. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
*/
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;
}
/**
* Description of an a image to use during Skaffold rendering.
*/
export interface Schema$BuildArtifact {
/**
* Image name in Skaffold configuration.
*/
image?: string | null;
/**
* Image tag to use. This will generally be the full path to an image, such as "gcr.io/my-project/busybox:1.2.3" or "gcr.io/my-project/busybox@sha256:abc123".
*/
tag?: string | null;
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* Information specifying where to deploy a Cloud Run Service.
*/
export interface Schema$CloudRunLocation {
/**
* Required. The location for the Cloud Run Service. Format must be `projects/{project\}/locations/{location\}`.
*/
location?: string | null;
}
/**
* CloudRunMetadata contains information from a Cloud Run deployment.
*/
export interface Schema$CloudRunMetadata {
/**
* Output only. The Cloud Run Revision id associated with a `Rollout`.
*/
revision?: string | null;
/**
* Output only. The name of the Cloud Run Service that is associated with a `Rollout`. Format is projects/{project\}/locations/{location\}/services/{service\}.
*/
service?: string | null;
/**
* Output only. The Cloud Run Service urls that are associated with a `Rollout`.
*/
serviceUrls?: string[] | null;
}
/**
* Service-wide configuration.
*/
export interface Schema$Config {
/**
* Output only. Default Skaffold version that is assigned when a Release is created without specifying a Skaffold version.
*/
defaultSkaffoldVersion?: string | null;
/**
* Name of the configuration.
*/
name?: string | null;
/**
* Output only. All supported versions of Skaffold.
*/
supportedVersions?: Schema$SkaffoldVersion[];
}
/**
* Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
*/
export interface Schema$Date {
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
day?: number | null;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
month?: number | null;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
year?: number | null;
}
/**
* Execution using the default Cloud Build pool.
*/
export interface Schema$DefaultPool {
/**
* Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.
*/
artifactStorage?: string | null;
/**
* Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) will be used.
*/
serviceAccount?: string | null;
}
/**
* A `DeliveryPipeline` resource in the Google Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress.
*/
export interface Schema$DeliveryPipeline {
/**
* User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy.
*/
annotations?: {
[key: string]: string;
} | null;
/**
* Output only. Information around the state of the Delivery Pipeline.
*/
condition?: Schema$PipelineCondition;
/**
* Output only. Time at which the pipeline was created.
*/
createTime?: string | null;
/**
* Description of the `DeliveryPipeline`. Max length is 255 characters.
*/
description?: string | null;
/**
* This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
*/
etag?: string | null;
/**
* Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Optional. Name of the `DeliveryPipeline`. Format is projects/{project\}/ locations/{location\}/deliveryPipelines/a-z{0,62\}.
*/
name?: string | null;
/**
* SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.
*/
serialPipeline?: Schema$SerialPipeline;
/**
* When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
*/
suspended?: boolean | null;
/**
* Output only. Unique identifier of the `DeliveryPipeline`.
*/
uid?: string | null;
/**
* Output only. Most recent time at which the pipeline was updated.
*/
updateTime?: string | null;
}
/**
* Payload proto for "clouddeploy.googleapis.com/deliverypipeline_notification" Platform Log event that describes the failure to send delivery pipeline status change Pub/Sub notification.
*/
export interface Schema$DeliveryPipelineNotificationEvent {
/**
* The name of the `Delivery Pipeline`.
*/
deliveryPipeline?: string | null;
/**
* Debug message for when a notification fails to send.
*/
message?: string | null;
/**
* Type of this notification, e.g. for a Pub/Sub failure.
*/
type?: string | null;
}
/**
* A deploy Job.
*/
export interface Schema$DeployJob {
}
/**
* DeployJobRun contains information specific to a deploy `JobRun`.
*/
export interface Schema$DeployJobRun {
/**
* Output only. The resource name of the Cloud Build `Build` object that is used to deploy. Format is projects/{project\}/locations/{location\}/builds/{build\}.
*/
build?: string | null;
/**
* Output only. The reason the deploy failed. This will always be unspecified while the deploy is in progress or if it succeeded.
*/
failureCause?: string | null;
/**
* Output only. Additional information about the deploy failure, if available.
*/
failureMessage?: string | null;
/**
* Output only. Metadata containing information about the deploy job run.
*/
metadata?: Schema$DeployJobRunMetadata;
}
/**
* DeployJobRunMetadata surfaces information associated with a `DeployJobRun` to the user.
*/
export interface Schema$DeployJobRunMetadata {
/**
* Output only. The name of the Cloud Run Service that is associated with a `DeployJobRun`.
*/
cloudRun?: Schema$CloudRunMetadata;
}
/**
* Deployment job composition.
*/
export interface Schema$DeploymentJobs {
/**
* Output only. The deploy Job. This is the first job run in the phase.
*/
deployJob?: Schema$Job;
/**
* Output only. The verify Job. Runs after a deploy if the deploy succeeds.
*/
verifyJob?: Schema$Job;
}
/**
* 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); \}
*/
export interface Schema$Empty {
}
/**
* Configuration of the environment to use when calling Skaffold.
*/
export interface Schema$ExecutionConfig {
/**
* Optional. Cloud Storage location in which to store execution outputs. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.
*/
artifactStorage?: string | null;
/**
* Optional. Use default Cloud Build pool.
*/
defaultPool?: Schema$DefaultPool;
/**
* Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and 24h in seconds format. If unspecified, a default timeout of 1h is used.
*/
executionTimeout?: string | null;
/**
* Optional. Use private Cloud Build pool.
*/
privatePool?: Schema$PrivatePool;
/**
* Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) is used.
*/
serviceAccount?: string | null;
/**
* Required. Usages when this configuration should be applied.
*/
usages?: string[] | null;
/**
* Optional. The resource name of the `WorkerPool`, with the format `projects/{project\}/locations/{location\}/workerPools/{worker_pool\}`. If this optional field is unspecified, the default Cloud Build pool will be used.
*/
workerPool?: string | null;
}
/**
* 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;
}
/**
* Information specifying a GKE Cluster.
*/
export interface Schema$GkeCluster {
/**
* Information specifying a GKE Cluster. Format is `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}.
*/
cluster?: string | null;
/**
* Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept).
*/
internalIp?: boolean | null;
}
/**
* Job represents an operation for a `Rollout`.
*/
export interface Schema$Job {
/**
* Output only. A deploy Job.
*/
deployJob?: Schema$DeployJob;
/**
* Output only. The ID of the Job.
*/
id?: string | null;
/**
* Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
*/
jobRun?: string | null;
/**
* Output only. The current state of the Job.
*/
state?: string | null;
/**
* Output only. A verify Job.
*/
verifyJob?: Schema$VerifyJob;
}
/**
* A `JobRun` resource in the Google Cloud Deploy API. A `JobRun` contains information of a single `Rollout` job evaluation.
*/
export interface Schema$JobRun {
/**
* Output only. Time at which the `JobRun` was created.
*/
createTime?: string | null;
/**
* Output only. Information specific to a deploy `JobRun`.
*/
deployJobRun?: Schema$DeployJobRun;
/**
* Output only. Time at which the `JobRun` ended.
*/
endTime?: string | null;
/**
* Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
*/
etag?: string | null;
/**
* Output only. ID of the `Rollout` job this `JobRun` corresponds to.
*/
jobId?: string | null;
/**
* Optional. Name of the `JobRun`. Format is projects/{project\}/locations/{location\}/ deliveryPipelines/{deliveryPipeline\}/releases/{releases\}/rollouts/ {rollouts\}/jobRuns/{uuid\}.
*/
name?: string | null;
/**
* Output only. ID of the `Rollout` phase this `JobRun` belongs in.
*/
phaseId?: string | null;
/**
* Output only. Time at which the `JobRun` was started.
*/
startTime?: string | null;
/**
* Output only. The current state of the `JobRun`.
*/
state?: string | null;
/**
* Output only. Unique identifier of the `JobRun`.
*/
uid?: string | null;
/**
* Output only. Information specific to a verify `JobRun`.
*/
verifyJobRun?: Schema$VerifyJobRun;
}
/**
* Payload proto for "clouddeploy.googleapis.com/jobrun_notification" Platform Log event that describes the failure to send JobRun resource update Pub/Sub notification.
*/
export interface Schema$JobRunNotificationEvent {
/**
* The name of the `JobRun`.
*/
jobRun?: string | null;
/**
* Debug message for when a notification fails to send.
*/
message?: string | null;
/**
* Unique identifier of the `DeliveryPipeline`.
*/
pipelineUid?: string | null;
/**
* Unique identifier of the `Release`.
*/
releaseUid?: string | null;
/**
* Unique identifier of the `Rollout`.
*/
rolloutUid?: string | null;
/**
* ID of the `Target`.
*/
targetId?: string | null;
/**
* Type of this notification, e.g. for a Pub/Sub failure.
*/
type?: string | null;
}
/**
* The response object from `ListDeliveryPipelines`.
*/
export interface Schema$ListDeliveryPipelinesResponse {
/**
* The `DeliveryPipeline` objects.
*/
deliveryPipelines?: Schema$DeliveryPipeline[];
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* ListJobRunsResponse is the response object returned by `ListJobRuns`.
*/
export interface Schema$ListJobRunsResponse {
/**
* The `JobRun` objects.
*/
jobRuns?: Schema$JobRun[];
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* 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;
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* The response object from `ListReleases`.
*/
export interface Schema$ListReleasesResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* The `Release` objects.
*/
releases?: Schema$Release[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* ListRolloutsResponse is the response object reutrned by `ListRollouts`.
*/
export interface Schema$ListRolloutsResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* The `Rollout` objects.
*/
rollouts?: Schema$Rollout[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* The response object from `ListTargets`.
*/
export interface Schema$ListTargetsResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* The `Target` objects.
*/
targets?: Schema$Target[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* A resource that represents Google Cloud Platform location.
*/
export interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string | null;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\}
*/
labels?: {
[key: string]: string;
} | null;
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string | null;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
*/
name?: string | null;
}
/**
* Metadata includes information associated with a `Rollout`.
*/
export interface Schema$Metadata {
/**
* Output only. The name of the Cloud Run Service that is associated with a `Rollout`.
*/
cloudRun?: Schema$CloudRunMetadata;
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`.
*/
name?: string | null;
/**
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$OperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* Phase represents a collection of jobs that are logically grouped together for a `Rollout`.
*/
export interface Schema$Phase {
/**
* Output only. Deployment job composition.
*/
deploymentJobs?: Schema$DeploymentJobs;
/**
* Output only. The ID of the Phase.
*/
id?: string | null;
/**
* Output only. Current state of the Phase.
*/
state?: string | null;
}
/**
* PipelineCondition contains all conditions relevant to a Delivery Pipeline.
*/
export interface Schema$PipelineCondition {
/**
* Details around the Pipeline's overall status.
*/
pipelineReadyCondition?: Schema$PipelineReadyCondition;
/**
* Detalis around targets enumerated in the pipeline.
*/
targetsPresentCondition?: Schema$TargetsPresentCondition;
}
/**
* PipelineReadyCondition contains information around the status of the Pipeline.
*/
export interface Schema$PipelineReadyCondition {
/**
* True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
*/
status?: boolean | null;
/**
* Last time the condition was updated.
*/
updateTime?: string | null;
}
/**
* An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
*/
export interface Schema$Policy {
/**
* Specifies cloud audit logging configuration for this policy.
*/
auditConfigs?: Schema$AuditConfig[];
/**
* Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
*/
bindings?: Schema$Binding[];
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
*/
etag?: string | null;
/**
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
version?: number | null;
}
/**
* Execution using a private Cloud Build pool.
*/
export interface Schema$PrivatePool {
/**
* Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.
*/
artifactStorage?: string | null;
/**
* Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) will be used.
*/
serviceAccount?: string | null;
/**
* Required. Resource name of the Cloud Build worker pool to use. The format is `projects/{project\}/locations/{location\}/workerPools/{pool\}`.
*/
workerPool?: string | null;
}
/**
* A `Release` resource in the Google Cloud Deploy API. A `Release` defines a specific Skaffold configuration instance that can be deployed.
*/
export interface Schema$Release {
/**
* Output only. Indicates whether this is an abandoned release.
*/
abandoned?: boolean | null;
/**
* User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
*/
annotations?: {
[key: string]: string;
} | null;
/**
* List of artifacts to pass through to Skaffold command.
*/
buildArtifacts?: Schema$BuildArtifact[];
/**
* Output only. Time at which the `Release` was created.
*/
createTime?: string | null;
/**
* Output only. Snapshot of the parent pipeline taken at release creation time.
*/
deliveryPipelineSnapshot?: Schema$DeliveryPipeline;
/**
* Description of the `Release`. Max length is 255 characters.
*/
description?: string | null;
/**
* This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
*/
etag?: string | null;
/**
* Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Optional. Name of the `Release`. Format is projects/{project\}/ locations/{location\}/deliveryPipelines/{deliveryPipeline\}/ releases/a-z{0,62\}.
*/
name?: string | null;
/**
* Output only. Time at which the render completed.
*/
renderEndTime?: string | null;
/**
* Output only. Time at which the render began.
*/
renderStartTime?: string | null;
/**
* Output only. Current state of the render operation.
*/
renderState?: string | null;
/**
* Filepath of the Skaffold config inside of the config URI.
*/
skaffoldConfigPath?: string | null;
/**
* Cloud Storage URI of tar.gz archive containing Skaffold configuration.
*/
skaffoldConfigUri?: string | null;
/**
* The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Google Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used.
*/
skaffoldVersion?: string | null;
/**
* Output only. Map from target ID to the target artifacts created during the render operation.
*/
targetArtifacts?: {
[key: string]: Schema$TargetArtifact;
} | null;
/**
* Output only. Map from target ID to details of the render operation for that target.
*/
targetRenders?: {
[key: string]: Schema$TargetRender;
} | null;
/**
* Output only. Snapshot of the targets taken at release creation time.
*/
targetSnapshots?: Schema$Target[];
/**
* Output only. Unique identifier of the `Release`.
*/
uid?: string | null;
}
/**
* Payload proto for "clouddeploy.googleapis.com/release_notification" Platform Log event that describes the failure to send release status change Pub/Sub notification.
*/
export interface Schema$ReleaseNotificationEvent {
/**
* Debug message for when a notification fails to send.
*/
message?: string | null;
/**
* The name of the `Release`.
*/
release?: string | null;
/**
* Type of this notification, e.g. for a Pub/Sub failure.
*/
type?: string | null;
}
/**
* Payload proto for "clouddeploy.googleapis.com/release_render" Platform Log event that describes the render status change.
*/
export interface Schema$ReleaseRenderEvent {
/**
* Debug message for when a render transition occurs. Provides further details as rendering progresses through render states.
*/
message?: string | null;
/**
* The name of the `Release`.
*/
release?: string | null;
}
/**
* RetryJobRequest is the request object used by `RetryJob`.
*/
export interface Schema$RetryJobRequest {
/**
* Required. The job ID for the Job to retry.
*/
jobId?: string | null;
/**
* Required. The phase ID the Job to retry belongs to.
*/
phaseId?: string | null;
}
/**
* The response object from 'RetryJob'.
*/
export interface Schema$RetryJobResponse {
}
/**
* A `Rollout` resource in the Google Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`.
*/
export interface Schema$Rollout {
/**
* User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
*/
annotations?: {
[key: string]: string;
} | null;
/**
* Output only. Approval state of the `Rollout`.
*/
approvalState?: string | null;
/**
* Output only. Time at which the `Rollout` was approved.
*/
approveTime?: string | null;
/**
* Output only. Time at which the `Rollout` was created.
*/
createTime?: string | null;
/**
* Output only. Time at which the `Rollout` finished deploying.
*/
deployEndTime?: string | null;
/**
* Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
*/
deployFailureCause?: string | null;
/**
* Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project\}/locations/{location\}/builds/{build\}`.
*/
deployingBuild?: string | null;
/**
* Output only. Time at which the `Rollout` started deploying.
*/
deployStartTime?: string | null;
/**
* Description of the `Rollout` for user purposes. Max length is 255 characters.
*/
description?: string | null;
/**
* Output only. Time at which the `Rollout` was enqueued.
*/
enqueueTime?: string | null;
/**
* This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
*/
etag?: string | null;
/**
* Output only. Additional information about the rollout failure, if available.
*/
failureReason?: string | null;
/**
* Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. Metadata contains information about the rollout.
*/
metadata?: Schema$Metadata;
/**
* Optional. Name of the `Rollout`. Format is projects/{project\}/ locations/{location\}/deliveryPipelines/{deliveryPipeline\}/ releases/{release\}/rollouts/a-z{0,62\}.
*/
name?: string | null;
/**
* Output only. The phases that represent the workflows of this `Rollout`.
*/
phases?: Schema$Phase[];
/**
* Output only. Current state of the `Rollout`.
*/
state?: string | null;
/**
* Required. The ID of Target to which this `Rollout` is