googleapis
Version:
Google APIs Client Library for Node.js
1,050 lines • 489 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace 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;
}
/**
* 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 {
}
/**
* An advanceChildRollout Job.
*/
export interface Schema$AdvanceChildRolloutJob {
}
/**
* AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout `JobRun`.
*/
export interface Schema$AdvanceChildRolloutJobRun {
/**
* Output only. Name of the `ChildRollout`. Format is `projects/{project\}/locations/{location\}/deliveryPipelines/{deliveryPipeline\}/releases/{release\}/rollouts/{rollout\}`.
*/
rollout?: string | null;
/**
* Output only. the ID of the ChildRollout's Phase.
*/
rolloutPhaseId?: string | null;
}
/**
* Contains the information of an automated advance-rollout operation.
*/
export interface Schema$AdvanceRolloutOperation {
/**
* Output only. The phase the rollout will be advanced to.
*/
destinationPhase?: string | null;
/**
* Output only. The name of the rollout that initiates the `AutomationRun`.
*/
rollout?: string | null;
/**
* Output only. The phase of a deployment that initiated the operation.
*/
sourcePhase?: string | null;
/**
* Output only. How long the operation will be paused.
*/
wait?: string | null;
}
/**
* The request object used by `AdvanceRollout`.
*/
export interface Schema$AdvanceRolloutRequest {
/**
* Optional. Deploy policies to override. Format is `projects/{project\}/locations/{location\}/deployPolicies/{deployPolicy\}`.
*/
overrideDeployPolicy?: string[] | null;
/**
* Required. The phase ID to advance the `Rollout` to.
*/
phaseId?: string | null;
}
/**
* The response object from `AdvanceRollout`.
*/
export interface Schema$AdvanceRolloutResponse {
}
/**
* The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase.
*/
export interface Schema$AdvanceRolloutRule {
/**
* Output only. Information around the state of the Automation rule.
*/
condition?: Schema$AutomationRuleCondition;
/**
* Required. ID of the rule. This id must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z]([a-z0-9-]{0,61\}[a-z0-9])?`.
*/
id?: string | null;
/**
* Optional. Proceeds only after phase name matched any one in the list. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$`.
*/
sourcePhases?: string[] | null;
/**
* Optional. How long to wait after a rollout is finished.
*/
wait?: string | null;
}
/**
* AlertPolicyCheck configures a set of Cloud Monitoring alerting policies that will be periodically polled for alerts. If any of the listed policies have an active alert, the analysis check will fail.
*/
export interface Schema$AlertPolicyCheck {
/**
* Required. The Cloud Monitoring Alert Policies to check for active alerts. Format is `projects/{project\}/alertPolicies/{alert_policy\}`.
*/
alertPolicies?: string[] | null;
/**
* Required. The ID of the analysis check.
*/
id?: string | null;
/**
* Optional. A set of labels to filter active alerts. If set, only alerts having all of the specified labels will be considered. Otherwise, all active alerts will be considered.
*/
labels?: {
[key: string]: string;
} | null;
}
/**
* AlertPolicyCheckStatus contains information specific to a single run of an alert policy check.
*/
export interface Schema$AlertPolicyCheckStatus {
/**
* Output only. The alert policies that this analysis monitors. Format is `projects/{project\}/locations/{location\}/alertPolicies/{alertPolicy\}`.
*/
alertPolicies?: string[] | null;
/**
* Output only. The alert policies that were found to be firing during this check. This will be empty if no incidents were found.
*/
failedAlertPolicies?: Schema$FailedAlertPolicy[];
/**
* Output only. Additional information about the alert policy check failure, if available. This will be empty if the alert policy check succeeded.
*/
failureMessage?: string | null;
/**
* Output only. The ID of this analysis.
*/
id?: string | null;
/**
* Output only. The resolved labels used to filter for specific incidents.
*/
labels?: {
[key: string]: string;
} | null;
}
/**
* Analysis contains the configuration for the set of analyses to be performed on the target.
*/
export interface Schema$Analysis {
/**
* Optional. Custom analysis checks from 3P metric providers.
*/
customChecks?: Schema$CustomCheck[];
/**
* Required. The amount of time in minutes the analysis on the target will last. If all analysis checks have successfully completed before the specified duration, the analysis is successful. If a check is still running while the specified duration passes, it will wait for that check to complete to determine if the analysis is successful. The maximum duration is 48 hours.
*/
duration?: string | null;
/**
* Optional. Google Cloud - based analysis checks.
*/
googleCloud?: Schema$GoogleCloudAnalysis;
}
/**
* An analysis Job.
*/
export interface Schema$AnalysisJob {
/**
* Output only. Custom analysis checks from 3P metric providers that are run as part of the analysis Job.
*/
customChecks?: Schema$CustomCheck[];
/**
* Output only. The amount of time in minutes the analysis Job will run, up to a maximum of 48 hours. If any check in this Job is still running when the duration ends, the Job keeps running until that check completes.
*/
duration?: string | null;
/**
* Output only. Google Cloud - based analysis checks that are run as part of the analysis Job.
*/
googleCloud?: Schema$GoogleCloudAnalysis;
}
/**
* AnalysisJobRun contains information specific to an analysis `JobRun`.
*/
export interface Schema$AnalysisJobRun {
/**
* Output only. The status of the running alert policy checks configured for this analysis.
*/
alertPolicyAnalyses?: Schema$AlertPolicyCheckStatus[];
/**
* Output only. The status of the running custom checks configured for this analysis.
*/
customCheckAnalyses?: Schema$CustomCheckStatus[];
/**
* Output only. The ID of the configured check that failed. This will always be blank while the analysis is in progress or if it succeeded.
*/
failedCheckId?: string | null;
}
/**
* Information specifying an Anthos Cluster.
*/
export interface Schema$AnthosCluster {
/**
* Optional. 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;
/**
* Optional. Deploy policies to override. Format is `projects/{project\}/locations/{location\}/deployPolicies/{deployPolicy\}`.
*/
overrideDeployPolicy?: string[] | null;
}
/**
* The response object from `ApproveRollout`.
*/
export interface Schema$ApproveRolloutResponse {
}
/**
* Information about entities associated with a `Target`.
*/
export interface Schema$AssociatedEntities {
/**
* Optional. Information specifying Anthos clusters as associated entities.
*/
anthosClusters?: Schema$AnthosCluster[];
/**
* Optional. Information specifying GKE clusters as associated entities.
*/
gkeClusters?: Schema$GkeCluster[];
}
/**
* 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;
}
/**
* An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.
*/
export interface Schema$Automation {
/**
* Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
*/
annotations?: {
[key: string]: string;
} | null;
/**
* Output only. Time at which the automation was created.
*/
createTime?: string | null;
/**
* Optional. Description of the `Automation`. Max length is 255 characters.
*/
description?: string | null;
/**
* Optional. The weak etag of the `Automation` resource. 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;
/**
* Optional. Labels are attributes that can be set and used by both the user and by 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 <= 63 characters.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. Name of the `Automation`. Format is `projects/{project\}/locations/{location\}/deliveryPipelines/{delivery_pipeline\}/automations/{automation\}`.
*/
name?: string | null;
/**
* Required. List of Automation rules associated with the Automation resource. Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution.
*/
rules?: Schema$AutomationRule[];
/**
* Required. Selected resources to which the automation will be applied.
*/
selector?: Schema$AutomationResourceSelector;
/**
* Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
*/
serviceAccount?: string | null;
/**
* Optional. When Suspended, automation is deactivated from execution.
*/
suspended?: boolean | null;
/**
* Output only. Unique identifier of the `Automation`.
*/
uid?: string | null;
/**
* Output only. Time at which the automation was updated.
*/
updateTime?: string | null;
}
/**
* Payload proto for "clouddeploy.googleapis.com/automation" Platform Log event that describes the Automation related events.
*/
export interface Schema$AutomationEvent {
/**
* The name of the `AutomationRun`.
*/
automation?: string | null;
/**
* Debug message for when there is an update on the AutomationRun. Provides further details about the resource creation or state change.
*/
message?: string | null;
/**
* Unique identifier of the `DeliveryPipeline`.
*/
pipelineUid?: string | null;
/**
* Type of this notification, e.g. for a Pub/Sub failure.
*/
type?: string | null;
}
/**
* AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied.
*/
export interface Schema$AutomationResourceSelector {
/**
* Optional. Contains attributes about a target.
*/
targets?: Schema$TargetAttribute[];
}
/**
* AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout.
*/
export interface Schema$AutomationRolloutMetadata {
/**
* Output only. The names of the AutomationRuns initiated by an advance rollout rule.
*/
advanceAutomationRuns?: string[] | null;
/**
* Output only. The name of the AutomationRun initiated by a promote release rule.
*/
promoteAutomationRun?: string | null;
/**
* Output only. The names of the AutomationRuns initiated by a repair rollout rule.
*/
repairAutomationRuns?: string[] | null;
}
/**
* `AutomationRule` defines the automation activities.
*/
export interface Schema$AutomationRule {
/**
* Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
*/
advanceRolloutRule?: Schema$AdvanceRolloutRule;
/**
* Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
*/
promoteReleaseRule?: Schema$PromoteReleaseRule;
/**
* Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
*/
repairRolloutRule?: Schema$RepairRolloutRule;
/**
* Optional. The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule.
*/
timedPromoteReleaseRule?: Schema$TimedPromoteReleaseRule;
}
/**
* `AutomationRuleCondition` contains conditions relevant to an `Automation` rule.
*/
export interface Schema$AutomationRuleCondition {
/**
* Optional. Details around targets enumerated in the rule.
*/
targetsPresentCondition?: Schema$TargetsPresentCondition;
/**
* Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
*/
timedPromoteReleaseCondition?: Schema$TimedPromoteReleaseCondition;
}
/**
* An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun` represents an execution instance of an automation rule.
*/
export interface Schema$AutomationRun {
/**
* Output only. Advances a rollout to the next phase.
*/
advanceRolloutOperation?: Schema$AdvanceRolloutOperation;
/**
* Output only. The ID of the automation that initiated the operation.
*/
automationId?: string | null;
/**
* Output only. Snapshot of the Automation taken at AutomationRun creation time.
*/
automationSnapshot?: Schema$Automation;
/**
* Output only. Time at which the `AutomationRun` was created.
*/
createTime?: string | null;
/**
* Output only. The weak etag of the `AutomationRun` resource. 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. Time the `AutomationRun` expires. An `AutomationRun` expires after 14 days from its creation date.
*/
expireTime?: string | null;
/**
* Output only. Name of the `AutomationRun`. Format is `projects/{project\}/locations/{location\}/deliveryPipelines/{delivery_pipeline\}/automationRuns/{automation_run\}`.
*/
name?: string | null;
/**
* Output only. Contains information about what policies prevented the `AutomationRun` from proceeding.
*/
policyViolation?: Schema$PolicyViolation;
/**
* Output only. Promotes a release to a specified 'Target'.
*/
promoteReleaseOperation?: Schema$PromoteReleaseOperation;
/**
* Output only. Repairs a failed 'Rollout'.
*/
repairRolloutOperation?: Schema$RepairRolloutOperation;
/**
* Output only. The ID of the automation rule that initiated the operation.
*/
ruleId?: string | null;
/**
* Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.
*/
serviceAccount?: string | null;
/**
* Output only. Current state of the `AutomationRun`.
*/
state?: string | null;
/**
* Output only. Explains the current state of the `AutomationRun`. Present only when an explanation is needed.
*/
stateDescription?: string | null;
/**
* Output only. The ID of the source target that initiates the `AutomationRun`. The value of this field is the last segment of a target name.
*/
targetId?: string | null;
/**
* Output only. Promotes a release to a specified 'Target' as defined in a Timed Promote Release rule.
*/
timedPromoteReleaseOperation?: Schema$TimedPromoteReleaseOperation;
/**
* Output only. Unique identifier of the `AutomationRun`.
*/
uid?: string | null;
/**
* Output only. Time at which the automationRun was updated.
*/
updateTime?: string | null;
/**
* Output only. Earliest time the `AutomationRun` will attempt to resume. Wait-time is configured by `wait` in automation rule.
*/
waitUntilTime?: string | null;
}
/**
* Payload proto for "clouddeploy.googleapis.com/automation_run" Platform Log event that describes the AutomationRun related events.
*/
export interface Schema$AutomationRunEvent {
/**
* Identifier of the `Automation`.
*/
automationId?: string | null;
/**
* The name of the `AutomationRun`.
*/
automationRun?: string | null;
/**
* ID of the `Target` to which the `AutomationRun` is created.
*/
destinationTargetId?: string | null;
/**
* Debug message for when there is an update on the AutomationRun. Provides further details about the resource creation or state change.
*/
message?: string | null;
/**
* Unique identifier of the `DeliveryPipeline`.
*/
pipelineUid?: string | null;
/**
* Identifier of the `Automation` rule.
*/
ruleId?: string | null;
/**
* Type of this notification, e.g. for a Pub/Sub failure.
*/
type?: 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`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
*/
role?: string | null;
}
/**
* Description of an a image to use during Skaffold rendering.
*/
export interface Schema$BuildArtifact {
/**
* Optional. Image name in Skaffold configuration.
*/
image?: string | null;
/**
* Optional. 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;
}
/**
* Canary represents the canary deployment strategy.
*/
export interface Schema$Canary {
/**
* Optional. Configures the progressive based deployment for a Target.
*/
canaryDeployment?: Schema$CanaryDeployment;
/**
* Optional. Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.
*/
customCanaryDeployment?: Schema$CustomCanaryDeployment;
/**
* Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
*/
runtimeConfig?: Schema$RuntimeConfig;
}
/**
* CanaryDeployment represents the canary deployment configuration
*/
export interface Schema$CanaryDeployment {
/**
* Optional. Configuration for the analysis job. If configured, the analysis will run after each percentage deployment.
*/
analysis?: Schema$Analysis;
/**
* Required. The percentage based deployments that will occur as a part of a `Rollout`. List is expected in ascending order and each integer n is 0 <= n < 100. If the GatewayServiceMesh is configured for Kubernetes, then the range for n is 0 <= n <= 100.
*/
percentages?: number[] | null;
/**
* Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase.
*/
postdeploy?: Schema$Postdeploy;
/**
* Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase.
*/
predeploy?: Schema$Predeploy;
/**
* Optional. Whether to run verify tests after each percentage deployment via `skaffold verify`.
*/
verify?: boolean | null;
/**
* Optional. Configuration for the verify job. Cannot be set if `verify` is set to true.
*/
verifyConfig?: Schema$Verify;
}
/**
* The request object used by `CancelAutomationRun`.
*/
export interface Schema$CancelAutomationRunRequest {
}
/**
* The response object from `CancelAutomationRun`.
*/
export interface Schema$CancelAutomationRunResponse {
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* The request object used by `CancelRollout`.
*/
export interface Schema$CancelRolloutRequest {
/**
* Optional. Deploy policies to override. Format is `projects/{project\}/locations/{location\}/deployPolicies/{deployPolicy\}`.
*/
overrideDeployPolicy?: string[] | null;
}
/**
* The response object from `CancelRollout`.
*/
export interface Schema$CancelRolloutResponse {
}
/**
* ChildRollouts job composition
*/
export interface Schema$ChildRolloutJobs {
/**
* Output only. List of AdvanceChildRolloutJobs
*/
advanceRolloutJobs?: Schema$Job[];
/**
* Output only. List of CreateChildRolloutJobs
*/
createRolloutJobs?: Schema$Job[];
}
/**
* CloudRunConfig contains the Cloud Run runtime configuration.
*/
export interface Schema$CloudRunConfig {
/**
* Optional. Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
*/
automaticTrafficControl?: boolean | null;
/**
* Optional. A list of tags that are added to the canary revision while the canary phase is in progress.
*/
canaryRevisionTags?: string[] | null;
/**
* Optional. A list of tags that are added to the prior revision while the canary phase is in progress.
*/
priorRevisionTags?: string[] | null;
/**
* Optional. A list of tags that are added to the final stable revision when the stable phase is applied.
*/
stableRevisionTags?: string[] | null;
}
/**
* 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 name of the Cloud Run job that is associated with a `Rollout`. Format is `projects/{project\}/locations/{location\}/jobs/{job_name\}`.
*/
job?: string | null;
/**
* Output only. The previous Cloud Run Revision name associated with a `Rollout`. Only set when a canary deployment strategy is configured. Format for service is projects/{project\}/locations/{location\}/services/{service\}/revisions/{revision\}. Format for worker pool is projects/{project\}/locations/{location\}/workerPools/{workerpool\}/revisions/{revision\}.
*/
previousRevision?: string | null;
/**
* 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;
/**
* Output only. The Cloud Run worker pool associated with a `Rollout`. Format is `projects/{project\}/locations/{location\}/workerPools/{worker_pool\}`.
*/
workerPool?: string | null;
}
/**
* CloudRunRenderMetadata contains Cloud Run information associated with a `Release` render.
*/
export interface Schema$CloudRunRenderMetadata {
/**
* Output only. The name of the Cloud Run Job in the rendered manifest. Format is `projects/{project\}/locations/{location\}/jobs/{job\}`.
*/
job?: string | null;
/**
* Output only. The name of the Cloud Run Revision in the rendered manifest. Format is `projects/{project\}/locations/{location\}/services/{service\}/revisions/{revision\}`.
*/
revision?: string | null;
/**
* Output only. The name of the Cloud Run Service in the rendered manifest. Format is `projects/{project\}/locations/{location\}/services/{service\}`.
*/
service?: string | null;
/**
* Output only. The name of the Cloud Run Worker Pool in the rendered manifest. Format is `projects/{project\}/locations/{location\}/workerPools/{worker_pool\}`.
*/
workerPool?: string | null;
}
/**
* Service-wide configuration.
*/
export interface Schema$Config {
/**
* Default Skaffold version that is assigned when a Release is created without specifying a Skaffold version.
*/
defaultSkaffoldVersion?: string | null;
/**
* Output only. Default tool versions. These tool versions are assigned when a Release is created without specifying tool versions.
*/
defaultToolVersions?: Schema$ToolVersions;
/**
* Name of the configuration.
*/
name?: string | null;
/**
* All supported versions of Skaffold.
*/
supportedVersions?: Schema$SkaffoldVersion[];
}
/**
* This task is represented by a container that is executed in the Cloud Build execution environment.
*/
export interface Schema$ContainerTask {
/**
* Optional. Args is the container arguments to use. This overrides the default arguments defined in the container image.
*/
args?: string[] | null;
/**
* Optional. Command is the container entrypoint to use. This overrides the default entrypoint defined in the container image.
*/
command?: string[] | null;
/**
* Optional. Environment variables that are set in the container.
*/
env?: {
[key: string]: string;
} | null;
/**
* Required. Image is the container image to use.
*/
image?: string | null;
}
/**
* A createChildRollout Job.
*/
export interface Schema$CreateChildRolloutJob {
}
/**
* CreateChildRolloutJobRun contains information specific to a createChildRollout `JobRun`.
*/
export interface Schema$CreateChildRolloutJobRun {
/**
* Output only. Name of the `ChildRollout`. Format is `projects/{project\}/locations/{location\}/deliveryPipelines/{deliveryPipeline\}/releases/{release\}/rollouts/{rollout\}`.
*/
rollout?: string | null;
/**
* Output only. The ID of the childRollout Phase initiated by this JobRun.
*/
rolloutPhaseId?: string | null;
}
/**
* CustomCanaryDeployment represents the custom canary deployment configuration.
*/
export interface Schema$CustomCanaryDeployment {
/**
* Required. Configuration for each phase in the canary deployment in the order executed.
*/
phaseConfigs?: Schema$PhaseConfig[];
}
/**
* CustomCheck configures a third-party metric provider to run the analysis, via a Task that runs at a specified frequency.
*/
export interface Schema$CustomCheck {
/**
* Optional. The frequency at which the custom check will be run, with a minimum and default of 5 minutes.
*/
frequency?: string | null;
/**
* Required. The ID of the custom Analysis check.
*/
id?: string | null;
/**
* Required. The Task to be run for this custom check.
*/
task?: Schema$Task;
}
/**
* CustomCheckStatus contains information specific to a single iteration of a custom analysis job.
*/
export interface Schema$CustomCheckStatus {
/**
* Output only. The reason the analysis failed. This will always be unspecified while the analysis is in progress or if it succeeded.
*/
failureCause?: string | null;
/**
* Output only. Additional information about the analysis failure, if available.
*/
failureMessage?: string | null;
/**
* Output only. The frequency in minutes at which the custom check is run.
*/
frequency?: string | null;
/**
* Output only. The ID of the custom check.
*/
id?: string | null;
/**
* Output only. The resource name of the Cloud Build `Build` object that was used to execute the latest run of this custom action check. Format is `projects/{project\}/locations/{location\}/builds/{build\}`.
*/
latestBuild?: string | null;
/**
* Output only. Custom metadata provided by the user-defined custom check operation. result.
*/
metadata?: Schema$CustomMetadata;
/**
* Output only. The task that ran for this custom check.
*/
task?: Schema$Task;
}
/**
* CustomMetadata contains information from a user-defined operation.
*/
export interface Schema$CustomMetadata {
/**
* Output only. Key-value pairs provided by the user-defined operation.
*/
values?: {
[key: string]: string;
} | null;
}
/**
* Information specifying a Custom Target.
*/
export interface Schema$CustomTarget {
/**
* Required. The name of the CustomTargetType. Format must be `projects/{project\}/locations/{location\}/customTargetTypes/{custom_target_type\}`.
*/
customTargetType?: string | null;
}
/**
* CustomTargetDeployMetadata contains information from a Custom Target deploy operation.
*/
export interface Schema$CustomTargetDeployMetadata {
/**
* Output only. Skip message provided in the results of a custom deploy operation.
*/
skipMessage?: string | null;
}
/**
* CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions.
*/
export interface Schema$CustomTargetSkaffoldActions {
/**
* Required. The Skaffold custom action responsible for deploy operations.
*/
deployAction?: string | null;
/**
* Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
*/
includeSkaffoldModules?: Schema$SkaffoldModules[];
/**
* Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
*/
renderAction?: string | null;
}
/**
* CustomTargetTasks represents the `CustomTargetType` configuration using tasks.
*/
export interface Schema$CustomTargetTasks {
/**
* Required. The task responsible for deploy operations.
*/
deploy?: Schema$Task;
/**
* Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation.
*/
render?: Schema$Task;
}
/**
* A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` defines a type of custom target that can be referenced in a `Target` in order to facilitate deploying to other systems besides the supported runtimes.
*/
export interface Schema$CustomTargetType {
/**
* Optional. User annotations. These attributes can only be set and used by the user, and not by 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. Time at which the `CustomTargetType` was created.
*/
createTime?: string | null;
/**
* Optional. Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
*/
customActions?: Schema$CustomTargetSkaffoldActions;
/**
* Output only. Resource id of the `CustomTargetType`.
*/
customTargetTypeId?: string | null;
/**
* Optional. Description of the `CustomTargetType`. Max length is 255 characters.
*/
description?: string | null;
/**
* Optional. 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;
/**
* Optional. Labels are attributes that can be set and used by both the user and by 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;
/**
* Identifier. Name of the `CustomTargetType`. Format is `projects/{project\}/locations/{location\}/customTargetTypes/{customTargetType\}`. The `customTargetType` component must match `[a-z]([a-z0-9-]{0,61\}[a-z0-9])?`
*/
name?: string | null;
/**
* Optional. Configures render and deploy for the `CustomTargetType` using tasks.
*/
tasks?: Schema$CustomTargetTasks;
/**
* Output only. Unique identifier of the `CustomTargetType`.
*/
uid?: string | null;
/**
* Output only. Most recent time at which the `CustomTargetType` was updated.
*/
updateTime?: string | null;
}
/**
* Payload proto for "clouddeploy.googleapis.com/customtargettype_notification" Platform Log event that describes the failure to send a custom target type status change Pub/Sub notification.
*/
export interface Schema$CustomTargetTypeNotificationEvent {
/**
* The name of the `CustomTargetType`.
*/
customTargetType?: string | null;
/**
* Unique identifier of the `CustomTargetType`.
*/
customTargetTypeUid?: 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;
}
/**
* 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 buc