, S r SSKJr SSKJr SSKJr SSKJr Sr " S S\R 5 r " S S
\R 5 r " S S \R 5 r
" S
S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S \R 5 r " S S \R 5 r " S S \R 5 r " S! S"\R 5 r " S# S$\R 5 r " S% S&\R 5 r " S' S(\R 5 r " S) S*\R 5 r " S+ S,\R 5 r " S- S.\R 5 r " S/ S0\R 5 r " S1 S2\R 5 r " S3 S4\R 5 r! " S5 S6\R 5 r" " S7 S8\R 5 r# " S9 S:\R 5 r$ " S; S<\R 5 r% " S= S>\R 5 r& " S? S@\R 5 r' " SA SB\R 5 r( " SC SD\R 5 r) " SE SF\R 5 r* " SG SH\R 5 r+ " SI SJ\R 5 r, " SK SL\R 5 r- " SM SN\R 5 r. " SO SP\R 5 r/ " SQ SR\R 5 r0 " SS ST\R 5 r1 " SU SV\R 5 r2 " SW SX\R 5 r3 " SY SZ\R 5 r4 " S[ S\\R 5 r5 " S] S^\R 5 r6 " S_ S`\R 5 r7 " Sa Sb\R 5 r8 " Sc Sd\R 5 r9 " Se Sf\R 5 r: " Sg Sh\R 5 r; " Si Sj\R 5 r< " Sk Sl\R 5 r= " Sm Sn\R 5 r> " So Sp\R 5 r? " Sq Sr\R 5 r@ " Ss St\R 5 rA " Su Sv\R 5 rB " Sw Sx\R 5 rC " Sy Sz\R 5 rD " S{ S|\R 5 rE " S} S~\R 5 rF " S S\R 5 rG " S S\R 5 rH " S S\R 5 rI " S S\R 5 rJ " S S\R 5 rK " S S\R 5 rL " S S\R 5 rM " S S\R 5 rN " S S\R 5 rO " S S\R 5 rP " S S\R 5 rQ " S S\R 5 rR " S S\R 5 rS " S S\R 5 rT " S S\R 5 rU " S S\R 5 rV " S S\R 5 rW " S S\R 5 rX " S S\R 5 rY " S S\R 5 rZ " S S\R 5 r[ " S S\R 5 r\ " S S\R 5 r] " S S\R 5 r^ " S S\R 5 r_ " S S\R 5 r` " S S\R 5 ra " S S\R 5 rb " S S\R 5 rc " S S\R 5 rd " S S\R 5 re " S S\R 5 rf " S S\R 5 rg " S S\R 5 rh " S S\R 5 ri " S S\R 5 rj " S S\R 5 rk " S S\R 5 rl " S S\R 5 rm " S S\R 5 rn " S S\R 5 ro " S S\R 5 rp " S S\R 5 rq " S S\R 5 rr " S S\R 5 rs " S S\R 5 rt " S S\R 5 ru " S S\R 5 rv " S S\R 5 rw " S S\R 5 rx " S S\R 5 ry " S S\R 5 rz " S S\R 5 r{ " S S\R 5 r| " S S\R 5 r} " S S\R 5 r~ " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S GS \R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS
\R 5 r " GS GS \R 5 r " GS
GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS \R 5 r " GS GS \R 5 r " GS GS \R 5 r " GS! GS"\R 5 r " GS# GS$\R 5 r " GS% GS&\R 5 r " GS' GS(\R 5 r " GS) GS*\R 5 r " GS+ GS,\R 5 r " GS- GS.\R 5 r " GS/ GS0\R 5 r " GS1 GS2\R 5 r " GS3 GS4\R 5 r " GS5 GS6\R 5 r " GS7 GS8\R 5 r " GS9 GS:\R 5 r " GS; GS<\R 5 r " GS= GS>\R 5 r " GS? GS@\R 5 r " GSA GSB\R 5 r " GSC GSD\R 5 r " GSE GSF\R 5 r " GSG GSH\R 5 r " GSI GSJ\R 5 r " GSK GSL\R 5 r " GSM GSN\R 5 r " GSO GSP\R 5 r " GSQ GSR\R 5 r " GSS GST\R 5 r " GSU GSV\R 5 r " GSW GSX\R 5 r " GSY GSZ\R 5 r " GS[ GS\\R 5 r " GS] GS^\R 5 r " GS_ GS`\R 5 r " GSa GSb\R 5 r " GSc GSd\R 5 r " GSe GSf\R 5 r " GSg GSh\R 5 r " GSi GSj\R 5 r " GSk GSl\R 5 r " GSm GSn\R 5 r " GSo GSp\R 5 r " GSq GSr\R 5 r " GSs GSt\R 5 r " GSu GSv\R 5 r " GSw GSx\R 5 r " GSy GSz\R 5 r " GS{ GS|\R 5 r " GS} GS~\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr\GR " \GSGS5 \GR
" \GR GSGS5 \GR
" \GR GSGS5 \GR " \7GSGS 5 \GR " \FGSGS 5 \GR " \^GSGS 5 \GR " \lGSGS 5 Gg( z7Generated message classes for clouddeploy version v1.
)absolute_import)messages)encoding) extra_types clouddeployc \ rS rSrSrSrg)AbandonReleaseRequest z,The request object used by `AbandonRelease`. N__name__
__module__ __qualname____firstlineno____doc____static_attributes__r Slib/googlecloudsdk/generated_clients/apis/clouddeploy/v1/clouddeploy_v1_messages.pyr r s 5r r c \ rS rSrSrSrg)AbandonReleaseResponse z)The response object for `AbandonRelease`.r Nr r r r r r 2r r c \ rS rSrSrSrg)AdvanceChildRolloutJob zAn advanceChildRollout Job.r Nr r r r r r s $r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)AdvanceChildRolloutJobRun ae AdvanceChildRolloutJobRun contains information specific to a
advanceChildRollout `JobRun`.
Fields:
rollout: Output only. Name of the `ChildRollout`. Format is `projects/{pro
ject}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases
/{release}/rollouts/{rollout}`.
rolloutPhaseId: Output only. the ID of the ChildRollout's Phase.
r N
r
r r r r _messages StringFieldrolloutrolloutPhaseIdr r r r r r s)
! !! $' ((+.r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
Sr g) AdvanceRolloutOperation+ a Contains the information of an automated advance-rollout operation.
Fields:
destinationPhase: Output only. The phase the rollout will be advanced to.
rollout: Output only. The name of the rollout that initiates the
`AutomationRun`.
sourcePhase: Output only. The phase of a deployment that initiated the
operation.
wait: Output only. How long the operation will be paused.
r r r N) r
r r r r r" r# destinationPhaser$ sourcePhasewaitr r r r r' r' + sJ **1- ! !! $'%%a(+ q !$r r' c ^ \ rS rSrSr\R " SSS9r\R " S5 rSr g) AdvanceRolloutRequest= a The request object used by `AdvanceRollout`.
Fields:
overrideDeployPolicy: Optional. Deploy policies to override. Format is
`projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
phaseId: Required. The phase ID to advance the `Rollout` to.
r Trepeatedr r N)
r
r r r r r" r# overrideDeployPolicyphaseIdr r r r r/ r/ = s, #..q4@ ! !! $'r r/ c \ rS rSrSrSrg)AdvanceRolloutResponseJ z*The response object from `AdvanceRollout`.r Nr r r r r6 r6 J 3r r6 c \ rS rSrSr\R " SS5 r\R " S5 r \R " SSS9r
\R " S 5 r S
r g ) AdvanceRolloutRuleN a The `AdvanceRollout` automation rule will automatically advance a
successful Rollout to the next phase.
Fields:
condition: Output only. Information around the state of the Automation
rule.
id: 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])?`.
sourcePhases: 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])?$`.
wait: Optional. How long to wait after a rollout is finished.
AutomationRuleConditionr r r) Tr1 r* r N)
r
r r r r r" MessageField conditionr# id sourcePhasesr- r r r r r: r: N sN " $$%>B) Q "&&q48, q !$r r: c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SSS9r \R " S 5 r \R " SS
5 rS rg )
AlertPolicyCheckf a 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.
Messages:
LabelsValue: Optional. A set of labels to filter active alerts. If set,
only alerts having all of the specified labels will be considered.
Fields:
alertPolicies: Required. The Cloud Monitoring Alert Policies to check for
active alerts. Format is
`projects/{project}/alertPolicies/{alert_policy}`.
id: Required. The ID of the analysis check.
labels: Optional. A set of labels to filter active alerts. If set, only
alerts having all of the specified labels will be considered.
additionalPropertiesc f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
AlertPolicyCheck.LabelsValuex a Optional. A set of labels to filter active alerts. If set, only alerts
having all of the specified labels will be considered.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)/AlertPolicyCheck.LabelsValue.AdditionalProperty An additional property for a LabelsValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r N
r
r r r r r" r# keyvaluer r r r AdditionalPropertyrI )
! !! $c##A&er rO r Tr1 r N r
r r r r r" MessagerO r= rD r r r r LabelsValuerF x 2 'Y . . ' %112FTXYr rS r Tr1 r r) r N)r
r r r r r MapUnrecognizedFieldsr" rR rS r#
alertPoliciesr? r= labelsr r r r rB rB f sm " !!"89ZI%% Z :Z0 ''D9- Q " ! !- 3&r rB c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SSS9r \R " S S
SS9r
\R " S 5 r\R " S 5 r\R " SS
5 rSrg)AlertPolicyCheckStatus a; AlertPolicyCheckStatus contains information specific to a single run of
an alert policy check.
Messages:
LabelsValue: Output only. The resolved labels used to filter for specific
incidents.
Fields:
alertPolicies: Output only. The alert policies that this analysis
monitors. Format is
`projects/{project}/locations/{location}/alertPolicies/{alertPolicy}`.
failedAlertPolicies: Output only. The alert policies that were found to be
firing during this check. This will be empty if no incidents were found.
failureMessage: Output only. Additional information about the alert policy
check failure, if available. This will be empty if the alert policy
check succeeded.
id: Output only. The ID of this analysis.
labels: Output only. The resolved labels used to filter for specific
incidents.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
"AlertPolicyCheckStatus.LabelsValue zOutput only. The resolved labels used to filter for specific
incidents.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)5AlertPolicyCheckStatus.LabelsValue.AdditionalProperty rK r r r NrL r r r rO r_ rP r rO r Tr1 r NrQ r r r rS r\ rT r rS r Tr1 FailedAlertPolicyr r) r* r N)r
r r r r r rU r" rR rS r# rV r= failedAlertPoliciesfailureMessager? rW r r r r rY rY s * !!"89ZI%% Z :Z0 ''D9-!../BAPTU ((+. Q " ! !- 3&r rY c \ rS rSrSr\R " SSSS9r\R " S5 r \R " SS 5 r
S
r g ) Analysis a Analysis contains the configuration for the set of analyses to be
performed on the target.
Fields:
customChecks: Optional. Custom analysis checks from 3P metric providers.
duration: 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.
googleCloud: Optional. Google Cloud - based analysis checks.
CustomCheckr Tr1 r GoogleCloudAnalysisr) r N r
r r r r r" r= customChecksr# duration googleCloudr r r r rf rf s@ ''
q4H,
"
"1
%(&&'
y~~ ))!d;/ 8! <'r r c v \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " SS5 r \R " S 5 r\R " S
5 r\R " S 5 r\R " SS 5 r\R " S
5 r\R " SSSS9r\R " SS5 r\R " S5 r\R, " S5 r\R " S5 r\R " S5 rSrg)
Automationio a 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.
Messages:
AnnotationsValue: 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.
LabelsValue: 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.
Fields:
annotations: 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.
createTime: Output only. Time at which the automation was created.
description: Optional. Description of the `Automation`. Max length is 255
characters.
etag: 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.
labels: 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.
name: Output only. Name of the `Automation`. Format is `projects/{project}
/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/
{automation}`.
rules: 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.
selector: Required. Selected resources to which the automation will be
applied.
serviceAccount: Required. Email address of the user-managed IAM service
account that creates Cloud Deploy release and rollout resources.
suspended: Optional. When Suspended, automation is deactivated from
execution.
uid: Output only. Unique identifier of the `Automation`.
updateTime: Output only. Time at which the automation was updated.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Automation.AnnotationsValuei 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.
Messages:
AdditionalProperty: An additional property for a AnnotationsValue
object.
Fields:
additionalProperties: Additional properties of type AnnotationsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g).Automation.AnnotationsValue.AdditionalPropertyi An additional property for a AnnotationsValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r NrL r r r rO r rP r rO r Tr1 r NrQ r r r AnnotationsValuer 2 * 'Y . . ' %112FTXYr r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Automation.LabelsValuei a 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.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g))Automation.LabelsValue.AdditionalPropertyi rK r r r NrL r r r rO r rP r rO r Tr1 r NrQ r r r rS r 2 'Y . . ' %112FTXYr rS r r r) r* rb AutomationRule Tr1 AutomationResourceSelector
r N)r
r r r r r rU r" rR r rS r= annotationsr#
createTime descriptionetagrW namerulesselectorserviceAccountr} suspendeduid
updateTimer r r r r r o s9 IV !!"89!Z** !Z :!ZF !!"89 ZI%% Z : Z< &&'91=+$$Q'*%%a(+ q !$ ! !- 3& q !$
!11t
D%
#
#$@!
D( ((+.$$R() b!#$$R(*r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " S5 r \R " SS5 r
S rg
) AutomationEventi a Payload proto for "clouddeploy.googleapis.com/automation" Platform Log
event that describes the Automation related events.
Enums:
TypeValueValuesEnum: Type of this notification, e.g. for a Pub/Sub
failure.
Fields:
automation: The name of the `AutomationRun`.
message: Debug message for when there is an update on the AutomationRun.
Provides further details about the resource creation or state change.
pipelineUid: Unique identifier of the `DeliveryPipeline`.
type: Type of this notification, e.g. for a Pub/Sub failure.
c < \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rg
)#AutomationEvent.TypeValueValuesEnumi N Type of this notification, e.g. for a Pub/Sub failure.
Values:
TYPE_UNSPECIFIED: Type is unspecified.
TYPE_PUBSUB_NOTIFICATION_FAILURE: A Pub/Sub notification failed to be
sent.
TYPE_RESOURCE_STATE_CHANGE: Resource state changed.
TYPE_PROCESS_ABORTED: A process aborted.
TYPE_RESTRICTION_VIOLATED: Restriction check failed.
TYPE_RESOURCE_DELETED: Resource deleted.
TYPE_ROLLOUT_UPDATE: Rollout updated.
TYPE_DEPLOY_POLICY_EVALUATION: Deploy Policy evaluation.
TYPE_RENDER_STATUES_CHANGE: Deprecated: This field is never used. Use
release_render log type instead.
r r r r) r* rb r r r r Nr
r r r r TYPE_UNSPECIFIED TYPE_PUBSUB_NOTIFICATION_FAILURETYPE_RESOURCE_STATE_CHANGETYPE_PROCESS_ABORTEDTYPE_RESTRICTION_VIOLATEDTYPE_RESOURCE_DELETEDTYPE_ROLLOUT_UPDATE TYPE_DEPLOY_POLICY_EVALUATIONTYPE_RENDER_STATUES_CHANGEr r r r TypeValueValuesEnumr ? '($!" ! $%!!" r r r r r) r* r N)r
r r r r r" r r r#
automationmessage pipelineUidr typer r r r r r s\
#INN #4 $$Q'* ! !! $'%%a(+ 2A 6$r r c < \ rS rSrSr\R " SSSS9rSrg) r i< zAutomationResourceSelector contains the information to select the
resources to which an Automation is going to be applied.
Fields:
targets: Optional. Contains attributes about a target.
TargetAttributer Tr1 r N) r
r r r r r" r= targetsr r r r r r < s
" "#4a$ G'r r c \ rS rSrSr\R " SSS9r\R " S5 r\R " SSS9r Sr
g )
AutomationRolloutMetadataiG a AutomationRolloutMetadata contains Automation-related actions that were
performed on a rollout.
Fields:
advanceAutomationRuns: Output only. The names of the AutomationRuns
initiated by an advance rollout rule.
promoteAutomationRun: Output only. The name of the AutomationRun initiated
by a promote release rule.
repairAutomationRuns: Output only. The names of the AutomationRuns
initiated by a repair rollout rule.
r Tr1 r r) r N) r
r r r r r" r# advanceAutomationRunspromoteAutomationRunrepairAutomationRunsr r r r r r G s@
$//DA"..q1"..q4@r r c \ rS rSrSr\R " SS5 r\R " SS5 r\R " SS5 r \R " S S
5 r
S r g )
r iY a_ `AutomationRule` defines the automation activities.
Fields:
advanceRolloutRule: Optional. The `AdvanceRolloutRule` will automatically
advance a successful Rollout.
promoteReleaseRule: Optional. `PromoteReleaseRule` will automatically
promote a release from the current target to a specified target.
repairRolloutRule: Optional. The `RepairRolloutRule` will automatically
repair a failed rollout.
timedPromoteReleaseRule: Optional. The `TimedPromoteReleaseRule` will
automatically promote a release from the current target(s) to the
specified target(s) on a configured schedule.
r: r PromoteReleaseRuler RepairRolloutRuler) TimedPromoteReleaseRuler* r N) r
r r r r r" r= advanceRolloutRulepromoteReleaseRulerepairRolloutRuletimedPromoteReleaseRuler r r r r r Y sY !--.BAF --.BAF ,,-@!D % 2 23La Pr r c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g) r< in a` `AutomationRuleCondition` contains conditions relevant to an
`Automation` rule.
Fields:
targetsPresentCondition: Optional. Details around targets enumerated in
the rule.
timedPromoteReleaseCondition: Optional. TimedPromoteReleaseCondition
contains rule conditions specific to a an Automation with a timed
promote release rule defined.
TargetsPresentConditionr TimedPromoteReleaseConditionr r N)
r
r r r r r" r= targetsPresentCondition timedPromoteReleaseConditionr r r r r< r< n s2 & 2 23La P!*!7!78VXY!Z r r< c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r \R " SS 5 r \R " S
5 r
\R " S 5 r\R " S 5 r\R " S
5 r\R " SS5 r\R " SS5 r\R " SS5 r\R " S5 r\R " S5 r\R, " SS5 r\R " S5 r\R " S5 r\R " SS5 r\R " S5 r\R " S 5 r S r g )
AutomationRuni~ a@ An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun`
represents an execution instance of an automation rule.
Enums:
StateValueValuesEnum: Output only. Current state of the `AutomationRun`.
Fields:
advanceRolloutOperation: Output only. Advances a rollout to the next
phase.
automationId: Output only. The ID of the automation that initiated the
operation.
automationSnapshot: Output only. Snapshot of the Automation taken at
AutomationRun creation time.
createTime: Output only. Time at which the `AutomationRun` was created.
etag: 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.
expireTime: Output only. Time the `AutomationRun` expires. An
`AutomationRun` expires after 14 days from its creation date.
name: Output only. Name of the `AutomationRun`. Format is `projects/{proje
ct}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automatio
nRuns/{automation_run}`.
policyViolation: Output only. Contains information about what policies
prevented the `AutomationRun` from proceeding.
promoteReleaseOperation: Output only. Promotes a release to a specified
'Target'.
repairRolloutOperation: Output only. Repairs a failed 'Rollout'.
ruleId: Output only. The ID of the automation rule that initiated the
operation.
serviceAccount: Output only. Email address of the user-managed IAM service
account that performs the operations against Cloud Deploy resources.
state: Output only. Current state of the `AutomationRun`.
stateDescription: Output only. Explains the current state of the
`AutomationRun`. Present only when an explanation is needed.
targetId: 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.
timedPromoteReleaseOperation: Output only. Promotes a release to a
specified 'Target' as defined in a Timed Promote Release rule.
updateTime: Output only. Time at which the automationRun was updated.
waitUntilTime: Output only. Earliest time the `AutomationRun` will attempt
to resume. Wait-time is configured by `wait` in automation rule.
c 4 \ rS rSrSrSrSrSrSrSr Sr
S r S
r g ) "AutomationRun.StateValueValuesEnumi a Output only. Current state of the `AutomationRun`.
Values:
STATE_UNSPECIFIED: The `AutomationRun` has an unspecified state.
SUCCEEDED: The `AutomationRun` has succeeded.
CANCELLED: The `AutomationRun` was cancelled.
FAILED: The `AutomationRun` has failed.
IN_PROGRESS: The `AutomationRun` is in progress.
PENDING: The `AutomationRun` is pending.
ABORTED: The `AutomationRun` was aborted.
r r r r) r* rb r r N)
r
r r r r STATE_UNSPECIFIED SUCCEEDED CANCELLEDFAILED IN_PROGRESSPENDINGABORTEDr r r r StateValueValuesEnumr s-
II
FKGGr r r' r r r r) r* rb r r PolicyViolationr PromoteReleaseOperationr RepairRolloutOperationr r r
TimedPromoteReleaseOperationr
r N) r
r r r r r" r r r= advanceRolloutOperationr# automationIdautomationSnapshotr r
expireTimer policyViolationpromoteReleaseOperationrepairRolloutOperationruleIdr r statestateDescriptiontargetId timedPromoteReleaseOperationr
waitUntilTimer r r r r r ~ sU +ZY^^ ( & 2 23La P&&q), --lA>$$Q'* q !$$$Q'* q !$ **+ r# membersroler r r r r
r
s? Ob $$VQ/) ! !!d 3' q !$r r
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)
BuildArtifactib a4 Description of an a image to use during Skaffold rendering.
Fields:
image: Optional. Image name in Skaffold configuration.
tag: 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".
r r r N)
r
r r r r r" r# imagetagr r r r r r b s)
"% a #r r c \ rS rSrSr\R " SS5 r\R " SS5 r\R " SS5 r S r
g
) Canaryip a; Canary represents the canary deployment strategy.
Fields:
canaryDeployment: Optional. Configures the progressive based deployment
for a Target.
customCanaryDeployment: 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.
runtimeConfig: 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.
CanaryDeploymentr CustomCanaryDeploymentr
RuntimeConfigr) r N) r
r r r r r" r= canaryDeploymentcustomCanaryDeployment
runtimeConfigr r r r r r p sC ++,>B$112JAN(( !<-r r c \ rS rSrSr\R " SS5 r\R " SS\R R S9r \R " SS 5 r \R " S
S 5 r
\R " S 5 r\R " S
S5 rSrg)r i a CanaryDeployment represents the canary deployment configuration
Fields:
analysis: Optional. Configuration for the analysis job. If configured, the
analysis will run after each percentage deployment.
percentages: 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.
postdeploy: Optional. Configuration for the postdeploy job of the last
phase. If this is not configured, there will be no postdeploy job for
this phase.
predeploy: Optional. Configuration for the predeploy job of the first
phase. If this is not configured, there will be no predeploy job for
this phase.
verify: Optional. Whether to run verify tests after each percentage
deployment via `skaffold verify`.
verifyConfig: Optional. Configuration for the verify job. Cannot be set if
`verify` is set to true.
rf r r T)r2 variant
Postdeployr) Predeployr* rb Verifyr r N)r
r r r r r" r= analysis IntegerFieldVariantINT32 percentages
postdeploy predeployr} verify verifyConfigr r r r r r s *
#
#J
2(&&q4ARARAXAXY+%%lA6*$$[!4) ! !! $&''!4,r r c \ rS rSrSrSrg)CancelAutomationRunRequesti z1The request object used by `CancelAutomationRun`.r Nr r r r r, r, s :r r, c \ rS rSrSrSrg)CancelAutomationRunResponsei z/The response object from `CancelAutomationRun`.r Nr r r r r. r. s 8r r. c \ rS rSrSrSrg)CancelOperationRequesti z3The request message for Operations.CancelOperation.r Nr r r r r0 r0 s ++A= ,,Q>r r= c < \ rS rSrSr\R " S5 rSrg)CloudRunLocationi zInformation specifying where to deploy a Cloud Run Service.
Fields:
location: Required. The location for the Cloud Run Service. Format must be
`projects/{project}/locations/{location}`.
r r N) r
r r r r r" r# locationr r r r rC rC s
"
"1
%(r rC c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
\R " SSS 9r S
r g ) CloudRunMetadatai aY CloudRunMetadata contains information from a Cloud Run deployment.
Fields:
job: Output only. The name of the Cloud Run job that is associated with a
`Rollout`. Format is
`projects/{project}/locations/{location}/jobs/{job_name}`.
previousRevision: Output only. The previous Cloud Run Revision name
associated with a `Rollout`. Only set when a canary deployment strategy
is configured. Format is projects/{project}/locations/{location}/service
s/{service}/revisions/{revision}.
revision: Output only. The Cloud Run Revision id associated with a
`Rollout`.
service: Output only. The name of the Cloud Run Service that is associated
with a `Rollout`. Format is
`projects/{project}/locations/{location}/services/{service}`.
serviceUrls: Output only. The Cloud Run Service urls that are associated
with a `Rollout`.
r r r) r* rb Tr1 r N)
r
r r r r r" r# jobpreviousRevisionrevisionr serviceUrlsr r r r rF rF s\ & a # **1-
"
"1
%( ! !! $'%%a$7+r rF c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)CloudRunRenderMetadatai aS CloudRunRenderMetadata contains Cloud Run information associated with a
`Release` render.
Fields:
job: Output only. The name of the Cloud Run Job in the rendered manifest.
Format is `projects/{project}/locations/{location}/jobs/{job}`.
revision: Output only. The name of the Cloud Run Revision in the rendered
manifest. Format is `projects/{project}/locations/{location}/services/{s
ervice}/revisions/{revision}`.
service: Output only. The name of the Cloud Run Service in the rendered
manifest. Format is
`projects/{project}/locations/{location}/services/{service}`.
r r r) r N) r
r r r r r" r# rG rI r r r r r rL rL s9 a #
"
"1
%( ! !! $'r rL c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
\R " S5 r \R " S5 r S r
g
) CloudServiceMeshi a Information about the Cloud Service Mesh configuration.
Fields:
deployment: Required. Name of the Kubernetes Deployment whose traffic is
managed by the specified Service.
grpcRoute: Required. Name of the GrpcRoute resource that defines how gRPC
traffic routed by a Mesh or Gateway resource is routed. Format is
`projects/{project}/locations/global/httpRoutes/{grpc_route}`
httpRoute: Required. Name of the HttpRoute resource that defines how HTTP
traffic should be routed by a Mesh or Gateway resource. Format is
`projects/{project}/locations/global/httpRoutes/{http_route}`.
podSelectorLabel: Optional. The label to use when selecting Pods for the
Deployment and Service resources. This label must already be present in
both resources.
routeUpdateWaitTime: Optional. The time to wait for route updates to
propagate. The maximum configurable time is 3 hours, in seconds format.
If unspecified, there is no wait time.
service: Required. Name of the Kubernetes Service.
r r r) r* rb r r N)r
r r r r r" r#
deployment grpcRoute httpRoutepodSelectorLabelrouteUpdateWaitTimer r r r r rN rN sk ( $$Q'*##A&)##A&) **1-!--a0 ! !! $'r rN c \ rS rSrSr\R " SS5 r\R " S5 r \R " SSS9r
\R " S 5 r \R " S
5 r
S rg )
:ClouddeployProjectsLocationsCustomTargetTypesCreateRequesti5 a3 A ClouddeployProjectsLocationsCustomTargetTypesCreateRequest object.
Fields:
customTargetType: A CustomTargetType resource to be passed as the request
body.
customTargetTypeId: Required. ID of the `CustomTargetType`.
parent: Required. The parent collection in which the `CustomTargetType`
must be created. The format is
`projects/{project_id}/locations/{location_name}`.
requestId: Optional. A request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server
guarantees that for at least 60 minutes after the first request. For
example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments. The request ID
must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
validateOnly: Optional. If set to true, the request is validated and the
user is provided with an expected result, but no actual change is made.
CustomTargetTyper r r) Trequiredr* rb r N)r
r r r r r" r= customTargetTyper# customTargetTypeIdparent requestIdr} validateOnlyr r r r rU rU 5 ` 0 ++,>B ,,Q/ T 2&##A&)''*,r rU c \ rS rSrSr\R " S5 r\R " S5 r \R " SSS9r
\R " S5 r \R " S 5 r S
r
g ) :ClouddeployProjectsLocationsCustomTargetTypesDeleteRequestiU a A ClouddeployProjectsLocationsCustomTargetTypesDeleteRequest object.
Fields:
allowMissing: Optional. If set to true, then deleting an already deleted
or non-existing `CustomTargetType` will succeed.
etag: 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.
name: Required. The name of the `CustomTargetType` to delete. Format must
be `projects/{project_id}/locations/{location_name}/customTargetTypes/{c
ustom_target_type}`.
requestId: Optional. A request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server
guarantees that for at least 60 minutes after the first request. For
example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments. The request ID
must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
validateOnly: Optional. If set to true, the request is validated but no
actual change is made.
r r r) TrW r* rb r Nr
r r r r r" r} allowMissingr# r r r\ r] r r r r r` r` U [ 4 ''*, q !$ q4 0$##A&)''*,r r` c \ rS rSrSr\R " S\R R S9r \R " SSS9r Sr g )
@ClouddeployProjectsLocationsCustomTargetTypesGetIamPolicyRequestiw aL A ClouddeployProjectsLocationsCustomTargetTypesGetIamPolicyRequest
object.
Fields:
options_requestedPolicyVersion: Optional. The maximum policy version that
will be used to format the policy. Valid values are 0, 1, and 3.
Requests specifying an invalid value will be rejected. Requests for
policies with any conditional role bindings must specify version 3.
Policies with no conditional role bindings may specify any valid value
or leave the field unset. The policy in the response might use the
policy version that you specified, or it might use a lower policy
version. For example, if you specify version 3, but the policy has no
conditional role bindings, the response uses version 1. To learn which
resources support conditions in their IAM policies, see the [IAM
documentation](https://cloud.google.com/iam/help/conditions/resource-
policies).
resource: REQUIRED: The resource for which the policy is being requested.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
r r r TrW r N
r
r r r r r" r# r$ r% options_requestedPolicyVersionr# resourcer r r r re re w : , $-#9#9!YEVEVE\E\#]
"
"1t
4(r re c : \ rS rSrSr\R " SSS9rSrg)7ClouddeployProjectsLocationsCustomTargetTypesGetRequesti zA ClouddeployProjectsLocationsCustomTargetTypesGetRequest object.
Fields:
name: Required. Name of the `CustomTargetType`. Format must be `projects/{
project_id}/locations/{location_name}/customTargetTypes/{custom_target_t
ype}`.
r TrW r N r
r r r r r" r# r r r r r rl rl
q4 0$r rl c \ rS rSrSr\R " S5 r\R " S5 r\R " S\R R S9r \R " S5 r
\R " SS S
9rS rg )
8ClouddeployProjectsLocationsCustomTargetTypesListRequesti a A ClouddeployProjectsLocationsCustomTargetTypesListRequest object.
Fields:
filter: Optional. Filter custom target types to be returned. See
https://google.aip.dev/160 for more details.
orderBy: Optional. Field to sort by. See
https://google.aip.dev/132#ordering for more details.
pageSize: Optional. The maximum number of `CustomTargetType` objects to
return. The service may return fewer than this value. If unspecified, at
most 50 `CustomTargetType` objects will be returned. The maximum value
is 1000; values above 1000 will be set to 1000.
pageToken: Optional. A page token, received from a previous
`ListCustomTargetTypes` call. Provide this to retrieve the subsequent
page. When paginating, all other provided parameters match the call that
provided the page token.
parent: Required. The parent that owns this collection of custom target
types. Format must be `projects/{project_id}/locations/{location_name}`.
r r r) rf r* rb TrW r Nr
r r r r r" r# filterorderByr# r$ r% pageSize pageTokenr[ r r r r rp rp i & #& ! !! $'
#
#Ay/@/@/F/F
G(##A&) T 2&r rp c \ rS rSrSr\R " S5 r\R " SS5 r \R " SSS9r \R " S 5 r \R " S
5 r
\R " S 5 rS rg
)9ClouddeployProjectsLocationsCustomTargetTypesPatchRequesti a8 A ClouddeployProjectsLocationsCustomTargetTypesPatchRequest object.
Fields:
allowMissing: Optional. If set to true, updating a `CustomTargetType` that
does not exist will result in the creation of a new `CustomTargetType`.
customTargetType: A CustomTargetType resource to be passed as the request
body.
name: Identifier. Name of the `CustomTargetType`. Format is `projects/{pro
ject}/locations/{location}/customTargetTypes/{customTargetType}`. The
`customTargetType` component must match
`[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
requestId: Optional. A request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server
guarantees that for at least 60 minutes after the first request. For
example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments. The request ID
must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
updateMask: Required. Field mask is used to specify the fields to be
overwritten by the update in the `CustomTargetType` resource. The fields
specified in the update_mask are relative to the resource, not the full
request. A field will be overwritten if it's in the mask. If the user
doesn't provide a mask then all fields are overwritten.
validateOnly: Optional. If set to true, the request is validated and the
user is provided with an expected result, but no actual change is made.
r rV r r) TrW r* rb r r N)r
r r r r r" r} rb r= rY r# r r\
updateMaskr] r r r r rx rx o > ''*, ++,>B q4 0$##A&)$$Q'*''*,r rx c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
@ClouddeployProjectsLocationsCustomTargetTypesSetIamPolicyRequesti a| A ClouddeployProjectsLocationsCustomTargetTypesSetIamPolicyRequest
object.
Fields:
resource: REQUIRED: The resource for which the policy is being specified.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the
request body.
r TrW SetIamPolicyRequestr r N r
r r r r r" r# ri r= setIamPolicyRequestr r r r r| r| /
"
"1t
4(!../DaHr r| c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
HClouddeployProjectsLocationsDeliveryPipelinesAutomationRunsCancelRequesti az A
ClouddeployProjectsLocationsDeliveryPipelinesAutomationRunsCancelRequest
object.
Fields:
cancelAutomationRunRequest: A CancelAutomationRunRequest resource to be
passed as the request body.
name: Required. Name of the `AutomationRun`. Format is `projects/{project}
/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRu
ns/{automation_run}`.
r, r r TrW r N) r
r r r r r" r= cancelAutomationRunRequestr# r r r r r r r s0
) 5 56RTU V q4 0$r r c : \ rS rSrSr\R " SSS9rSrg)EClouddeployProjectsLocationsDeliveryPipelinesAutomationRunsGetRequesti a A ClouddeployProjectsLocationsDeliveryPipelinesAutomationRunsGetRequest
object.
Fields:
name: Required. Name of the `AutomationRun`. Format must be `projects/{pro
ject}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automat
ionRuns/{automation_run}`.
r TrW r Nrm r r r r r
q4 0$r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S\R R S9r \R " S5 r
\R " SS S
9rS rg )
FClouddeployProjectsLocationsDeliveryPipelinesAutomationRunsListRequesti aq A ClouddeployProjectsLocationsDeliveryPipelinesAutomationRunsListRequest
object.
Fields:
filter: Filter automationRuns to be returned. All fields can be used in
the filter.
orderBy: Field to sort by.
pageSize: The maximum number of automationRuns to return. The service may
return fewer than this value. If unspecified, at most 50 automationRuns
will be returned. The maximum value is 1000; values above 1000 will be
set to 1000.
pageToken: A page token, received from a previous `ListAutomationRuns`
call. Provide this to retrieve the subsequent page. When paginating, all
other provided parameters match the call that provided the page token.
parent: Required. The parent `Delivery Pipeline`, which owns this
collection of automationRuns. Format must be `projects/{project}/locatio
ns/{location}/deliveryPipelines/{delivery_pipeline}`.
r r r) rf r* rb TrW r Nrq r r r r r rv r r c \ rS rSrSr\R " SS5 r\R " S5 r \R " SSS9r
\R " S 5 r \R " S
5 r
S rg )
EClouddeployProjectsLocationsDeliveryPipelinesAutomationsCreateRequesti+ a? A ClouddeployProjectsLocationsDeliveryPipelinesAutomationsCreateRequest
object.
Fields:
automation: A Automation resource to be passed as the request body.
automationId: Required. ID of the `Automation`.
parent: Required. The parent collection in which the `Automation` must be
created. The format is `projects/{project_id}/locations/{location_name}/
deliveryPipelines/{pipeline_name}`.
requestId: Optional. A request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server
guarantees that for at least 60 minutes after the first request. For
example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments. The request ID
must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
validateOnly: Optional. If set to true, the request is validated and the
user is provided with an expected result, but no actual change is made.
r r r r) TrW r* rb r N)r
r r r r r" r= r r# r r[ r\ r} r] r r r r r r + s] 0 %%lA6*&&q), T 2&##A&)''*,r r c \ rS rSrSr\R " S5 r\R " S5 r \R " SSS9r
\R " S5 r \R " S 5 r S
r
g ) EClouddeployProjectsLocationsDeliveryPipelinesAutomationsDeleteRequestiK a$ A ClouddeployProjectsLocationsDeliveryPipelinesAutomationsDeleteRequest
object.
Fields:
allowMissing: Optional. If set to true, then deleting an already deleted
or non-existing `Automation` will succeed.
etag: Optional. The weak etag of the request. 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.
name: Required. The name of the `Automation` to delete. The format is `pro
jects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline
_name}/automations/{automation_name}`.
requestId: Optional. A request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server
guarantees that for at least 60 minutes after the first request. For
example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments. The request ID
must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
validateOnly: Optional. If set, validate the request and verify whether
the resource exists, but do not actually post it.
r r r) TrW r* rb r Nra r r r r r K s[ 8 ''*, q !$ q4 0$##A&)''*,r r c : \ rS rSrSr\R " SSS9rSrg)BClouddeployProjectsLocationsDeliveryPipelinesAutomationsGetRequestio a A ClouddeployProjectsLocationsDeliveryPipelinesAutomationsGetRequest
object.
Fields:
name: Required. Name of the `Automation`. Format must be `projects/{projec
t_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automa
tions/{automation_name}`.
r TrW r Nrm r r r r r o r r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S\R R S9r \R " S5 r
\R " SS S
9rS rg )
CClouddeployProjectsLocationsDeliveryPipelinesAutomationsListRequesti| ac A ClouddeployProjectsLocationsDeliveryPipelinesAutomationsListRequest
object.
Fields:
filter: Filter automations to be returned. All fields can be used in the
filter.
orderBy: Field to sort by.
pageSize: The maximum number of automations to return. The service may
return fewer than this value. If unspecified, at most 50 automations
will be returned. The maximum value is 1000; values above 1000 will be
set to 1000.
pageToken: A page token, received from a previous `ListAutomations` call.
Provide this to retrieve the subsequent page. When paginating, all other
provided parameters match the call that provided the page token.
parent: Required. The parent `Delivery Pipeline`, which owns this
collection of automations. Format must be `projects/{project_id}/locatio
ns/{location_name}/deliveryPipelines/{pipeline_name}`.
r r r) rf r* rb TrW r Nrq r r r r r | rv r r c \ rS rSrSr\R " S5 r\R " SS5 r \R " SSS9r \R " S 5 r \R " S
5 r
\R " S 5 rS rg
)DClouddeployProjectsLocationsDeliveryPipelinesAutomationsPatchRequesti a A ClouddeployProjectsLocationsDeliveryPipelinesAutomationsPatchRequest
object.
Fields:
allowMissing: Optional. If set to true, updating a `Automation` that does
not exist will result in the creation of a new `Automation`.
automation: A Automation resource to be passed as the request body.
name: Output only. Name of the `Automation`. Format is `projects/{project}
/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/
{automation}`.
requestId: Optional. A request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server
guarantees that for at least 60 minutes after the first request. For
example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments. The request ID
must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
updateMask: Required. Field mask is used to specify the fields to be
overwritten by the update in the `Automation` resource. The fields
specified in the update_mask are relative to the resource, not the full
request. A field will be overwritten if it's in the mask. If the user
doesn't provide a mask then all fields are overwritten.
validateOnly: Optional. If set to true, the request is validated and the
user is provided with an expected result, but no actual change is made.
r r r r) TrW r* rb r r N)r
r r r r r" r} rb r= r r# r r\ ry r] r r r r r r sm < ''*,%%lA6* q4 0$##A&)$$Q'*''*,r r c \ rS rSrSr\R " SS5 r\R " S5 r \R " SSS9r
\R " S 5 r \R " S
5 r
S rg )
:ClouddeployProjectsLocationsDeliveryPipelinesCreateRequesti a3 A ClouddeployProjectsLocationsDeliveryPipelinesCreateRequest object.
Fields:
deliveryPipeline: A DeliveryPipeline resource to be passed as the request
body.
deliveryPipelineId: Required. ID of the `DeliveryPipeline`.
parent: Required. The parent collection in which the `DeliveryPipeline`
must be created. The format is
`projects/{project_id}/locations/{location_name}`.
requestId: Optional. A request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server
guarantees that for at least 60 minutes after the first request. For
example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments. The request ID
must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
validateOnly: Optional. If set to true, the request is validated and the
user is provided with an expected result, but no actual change is made.
DeliveryPipeliner r r) TrW r* rb r N)r
r r r r r" r= deliveryPipeliner# deliveryPipelineIdr[ r\ r} r] r r r r r r r^ r r c \ rS rSrSr\R " S5 r\R " S5 r \R " S5 r
\R " SSS9r \R " S 5 r \R " S
5 r
S rg )
:ClouddeployProjectsLocationsDeliveryPipelinesDeleteRequesti a A ClouddeployProjectsLocationsDeliveryPipelinesDeleteRequest object.
Fields:
allowMissing: Optional. If set to true, then deleting an already deleted
or non-existing `DeliveryPipeline` will succeed.
etag: 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.
force: Optional. If set to true, all child resources under this pipeline
will also be deleted. Otherwise, the request will only work if the
pipeline has no child resources.
name: Required. The name of the `DeliveryPipeline` to delete. The format
is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{p
ipeline_name}`.
requestId: Optional. A request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server
guarantees that for at least 60 minutes after the first request. For
example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments. The request ID
must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
validateOnly: Optional. If set, validate the request and preview the
review, but do not actually post it.
r r r) r* TrW rb r r N)r
r r r r r" r} rb r# r forcer r\ r] r r r r r r sk : ''*, q !$
#% q4 0$##A&)''*,r r c \ rS rSrSr\R " S\R R S9r \R " SSS9r Sr g )
@ClouddeployProjectsLocationsDeliveryPipelinesGetIamPolicyRequesti aL A ClouddeployProjectsLocationsDeliveryPipelinesGetIamPolicyRequest
object.
Fields:
options_requestedPolicyVersion: Optional. The maximum policy version that
will be used to format the policy. Valid values are 0, 1, and 3.
Requests specifying an invalid value will be rejected. Requests for
policies with any conditional role bindings must specify version 3.
Policies with no conditional role bindings may specify any valid value
or leave the field unset. The policy in the response might use the
policy version that you specified, or it might use a lower policy
version. For example, if you specify version 3, but the policy has no
conditional role bindings, the response uses version 1. To learn which
resources support conditions in their IAM policies, see the [IAM
documentation](https://cloud.google.com/iam/help/conditions/resource-
policies).
resource: REQUIRED: The resource for which the policy is being requested.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
r rf r TrW r Nrg r r r r r rj r r c : \ rS rSrSr\R " SSS9rSrg)7ClouddeployProjectsLocationsDeliveryPipelinesGetRequesti zA ClouddeployProjectsLocationsDeliveryPipelinesGetRequest object.
Fields:
name: Required. Name of the `DeliveryPipeline`. Format must be `projects/{
project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`
.
r TrW r Nrm r r r r r rn r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S\R R S9r \R " S5 r
\R " SS S
9rS rg )
8ClouddeployProjectsLocationsDeliveryPipelinesListRequesti+ ad A ClouddeployProjectsLocationsDeliveryPipelinesListRequest object.
Fields:
filter: Filter pipelines to be returned. See https://google.aip.dev/160
for more details.
orderBy: Field to sort by. See https://google.aip.dev/132#ordering for
more details.
pageSize: The maximum number of pipelines to return. The service may
return fewer than this value. If unspecified, at most 50 pipelines will
be returned. The maximum value is 1000; values above 1000 will be set to
1000.
pageToken: A page token, received from a previous `ListDeliveryPipelines`
call. Provide this to retrieve the subsequent page. When paginating, all
other provided parameters match the call that provided the page token.
parent: Required. The parent, which owns this collection of pipelines.
Format must be `projects/{project_id}/locations/{location_name}`.
r r r) rf r* rb TrW r Nrq r r r r r + i $ #& ! !! $'
#
#Ay/@/@/F/F
G(##A&) T 2&r r c \ rS rSrSr\R " S5 r\R " SS5 r \R " SSS9r \R " S 5 r \R " S
5 r
\R " S 5 rS rg
)9ClouddeployProjectsLocationsDeliveryPipelinesPatchRequestiE a8 A ClouddeployProjectsLocationsDeliveryPipelinesPatchRequest object.
Fields:
allowMissing: Optional. If set to true, updating a `DeliveryPipeline` that
does not exist will result in the creation of a new `DeliveryPipeline`.
deliveryPipeline: A DeliveryPipeline resource to be passed as the request
body.
name: Identifier. Name of the `DeliveryPipeline`. Format is `projects/{pro
ject}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The
`deliveryPipeline` component must match
`[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
requestId: Optional. A request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server
guarantees that for at least 60 minutes after the first request. For
example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments. The request ID
must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
updateMask: Required. Field mask is used to specify the fields to be
overwritten by the update in the `DeliveryPipeline` resource. The fields
specified in the update_mask are relative to the resource, not the full
request. A field will be overwritten if it's in the mask. If the user
doesn't provide a mask then all fields are overwritten.
validateOnly: Optional. If set to true, the request is validated and the
user is provided with an expected result, but no actual change is made.
r r r r) TrW r* rb r r N)r
r r r r r" r} rb r= r r# r r\ ry r] r r r r r r E rz r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
CClouddeployProjectsLocationsDeliveryPipelinesReleasesAbandonRequestim aP A ClouddeployProjectsLocationsDeliveryPipelinesReleasesAbandonRequest
object.
Fields:
abandonReleaseRequest: A AbandonReleaseRequest resource to be passed as
the request body.
name: Required. Name of the Release. Format is `projects/{project}/locatio
ns/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`.
r r r TrW r N) r
r r r r r" r= abandonReleaseRequestr# r r r r r r r m s/ $001H!L q4 0$r r c \ rS rSrSr\R " SSS9r\R " SSS9r\R " SS 5 r
\R " S
5 r \R " S 5 r \R " S 5 rS
rg)BClouddeployProjectsLocationsDeliveryPipelinesReleasesCreateRequesti| a A ClouddeployProjectsLocationsDeliveryPipelinesReleasesCreateRequest
object.
Fields:
overrideDeployPolicy: Optional. Deploy policies to override. Format is
`projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
parent: Required. The parent collection in which the `Release` is created.
The format is `projects/{project_id}/locations/{location_name}/deliveryP
ipelines/{pipeline_name}`.
release: A Release resource to be passed as the request body.
releaseId: Required. ID of the `Release`.
requestId: Optional. A request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server
guarantees that for at least 60 minutes after the first request. For
example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments. The request ID
must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
validateOnly: Optional. If set to true, the request is validated and the
user is provided with an expected result, but no actual change is made.
r Tr1 r rW Releaser) r* rb r r N)r
r r r r r" r# r3 r[ r= release releaseIdr\ r} r] r r r r r r | sp 4 #..q4@ T 2& " "9a 0'##A&)##A&)''*,r r c : \ rS rSrSr\R " SSS9rSrg)?ClouddeployProjectsLocationsDeliveryPipelinesReleasesGetRequesti a A ClouddeployProjectsLocationsDeliveryPipelinesReleasesGetRequest
object.
Fields:
name: Required. Name of the `Release`. Format must be `projects/{project_i
d}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/
{release_name}`.
r TrW r Nrm r r r r r r r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S\R R S9r \R " S5 r
\R " SS S
9rS rg )
@ClouddeployProjectsLocationsDeliveryPipelinesReleasesListRequesti ak A ClouddeployProjectsLocationsDeliveryPipelinesReleasesListRequest
object.
Fields:
filter: Optional. Filter releases to be returned. See
https://google.aip.dev/160 for more details.
orderBy: Optional. Field to sort by. See
https://google.aip.dev/132#ordering for more details.
pageSize: Optional. The maximum number of `Release` objects to return. The
service may return fewer than this value. If unspecified, at most 50
`Release` objects will be returned. The maximum value is 1000; values
above 1000 will be set to 1000.
pageToken: Optional. A page token, received from a previous `ListReleases`
call. Provide this to retrieve the subsequent page. When paginating, all
other provided parameters match the call that provided the page token.
parent: Required. The `DeliveryPipeline` which owns this collection of
`Release` objects.
r r r) rf r* rb TrW r Nrq r r r r r rv r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
KClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsAdvanceRequesti ap A
ClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsAdvanceRequest
object.
Fields:
advanceRolloutRequest: A AdvanceRolloutRequest resource to be passed as
the request body.
name: Required. Name of the Rollout. Format is `projects/{project}/locatio
ns/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/ro
llouts/{rollout}`.
r/ r r TrW r N) r
r r r r r" r= advanceRolloutRequestr# r r r r r r r /
$001H!L q4 0$r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
KClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsApproveRequesti ap A
ClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsApproveRequest
object.
Fields:
approveRolloutRequest: A ApproveRolloutRequest resource to be passed as
the request body.
name: Required. Name of the Rollout. Format is `projects/{project}/locatio
ns/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/ro
llouts/{rollout}`.
r| r r TrW r N) r
r r r r r" r= approveRolloutRequestr# r r r r r r r r r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
JClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsCancelRequesti am A
ClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsCancelRequest
object.
Fields:
cancelRolloutRequest: A CancelRolloutRequest resource to be passed as the
request body.
name: Required. Name of the Rollout. Format is `projects/{project}/locatio
ns/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/ro
llouts/{rollout}`.
r2 r r TrW r N) r
r r r r r" r= cancelRolloutRequestr# r r r r r r r s/
#//0FJ q4 0$r r c \ rS rSrSr\R " SSS9r\R " SSS9r\R " S5 r \R " S S
5 r \R " S 5 r \R " S 5 r
\R " S
5 rSrg)JClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsCreateRequesti ac A
ClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsCreateRequest
object.
Fields:
overrideDeployPolicy: Optional. Deploy policies to override. Format is
`projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
parent: Required. The parent collection in which the `Rollout` must be
created. The format is `projects/{project_id}/locations/{location_name}/
deliveryPipelines/{pipeline_name}/releases/{release_name}`.
requestId: Optional. A request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server
guarantees that for at least 60 minutes after the first request. For
example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments. The request ID
must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
rollout: A Rollout resource to be passed as the request body.
rolloutId: Required. ID of the `Rollout`.
startingPhaseId: Optional. The starting phase ID for the `Rollout`. If
empty the `Rollout` will start at the first phase.
validateOnly: Optional. If set to true, the request is validated and the
user is provided with an expected result, but no actual change is made.
r Tr1 r rW r) Rolloutr* rb r r r N)r
r r r r r" r# r3 r[ r\ r= r$ rolloutIdstartingPhaseIdr} r] r r r r r r s : #..q4@ T 2&##A&) " "9a 0'##A&) ))!,/''*,r r c : \ rS rSrSr\R " SSS9rSrg)GClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsGetRequesti! a" A
ClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsGetRequest
object.
Fields:
name: Required. Name of the `Rollout`. Format must be `projects/{project_i
d}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/
{release_name}/rollouts/{rollout_name}`.
r TrW r Nrm r r r r r ! s
q4 0$r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
MClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsIgnoreJobRequesti/ al A ClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsIgnoreJob
Request object.
Fields:
ignoreJobRequest: A IgnoreJobRequest resource to be passed as the request
body.
rollout: Required. Name of the Rollout. Format is `projects/{project}/loca
tions/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}
/rollouts/{rollout}`.
IgnoreJobRequestr r TrW r N) r
r r r r r" r= ignoreJobRequestr# r$ r r r r r r / s/ ++,>B ! !!d 3'r r c : \ rS rSrSr\R " SSS9rSrg)NClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsJobRunsGetRequesti? a@ A ClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsJobRunsGe
tRequest object.
Fields:
name: Required. Name of the `JobRun`. Format must be `projects/{project_id
}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{
release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}`.
r TrW r Nrm r r r r r ? r r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S\R R S9r \R " S5 r
\R " SS S
9rS rg )
OClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsJobRunsListRequestiL am A ClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsJobRunsLi
stRequest object.
Fields:
filter: Optional. Filter results to be returned. See
https://google.aip.dev/160 for more details.
orderBy: Optional. Field to sort by. See
https://google.aip.dev/132#ordering for more details.
pageSize: Optional. The maximum number of `JobRun` objects to return. The
service may return fewer than this value. If unspecified, at most 50
`JobRun` objects will be returned. The maximum value is 1000; values
above 1000 will be set to 1000.
pageToken: Optional. A page token, received from a previous `ListJobRuns`
call. Provide this to retrieve the subsequent page. When paginating, all
other provided parameters match the call that provided the page token.
parent: Required. The `Rollout` which owns this collection of `JobRun`
objects.
r r r) rf r* rb TrW r Nrq r r r r r L rv r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
TClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsJobRunsTerminateRequestig a A ClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsJobRunsTe
rminateRequest object.
Fields:
name: Required. Name of the `JobRun`. Format must be `projects/{project}/l
ocations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{relea
se}/rollouts/{rollout}/jobRuns/{jobRun}`.
terminateJobRunRequest: A TerminateJobRunRequest resource to be passed as
the request body.
r TrW TerminateJobRunRequestr r N) r
r r r r r" r# r r= terminateJobRunRequestr r r r r r g s/
q4 0$$112JANr r c \ rS rSrSr\R " S5 r\R " S5 r\R " S\R R S9r \R " S5 r
\R " SS S
9rS rg )
HClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsListRequestiw aj A
ClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsListRequest
object.
Fields:
filter: Optional. Filter rollouts to be returned. See
https://google.aip.dev/160 for more details.
orderBy: Optional. Field to sort by. See
https://google.aip.dev/132#ordering for more details.
pageSize: Optional. The maximum number of `Rollout` objects to return. The
service may return fewer than this value. If unspecified, at most 50
`Rollout` objects will be returned. The maximum value is 1000; values
above 1000 will be set to 1000.
pageToken: Optional. A page token, received from a previous `ListRollouts`
call. Provide this to retrieve the subsequent page. When paginating, all
other provided parameters match the call that provided the page token.
parent: Required. The `Release` which owns this collection of `Rollout`
objects.
r r r) rf r* rb TrW r Nrq r r r r r w i ( #& ! !! $'
#
#Ay/@/@/F/F
G(##A&) T 2&r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
LClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsRetryJobRequesti ah A
ClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsRetryJobRequest
object.
Fields:
retryJobRequest: A RetryJobRequest resource to be passed as the request
body.
rollout: Required. Name of the Rollout. Format is `projects/{project}/loca
tions/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}
/rollouts/{rollout}`.
RetryJobRequestr r TrW r N) r
r r r r r" r= retryJobRequestr# r$ r r r r r r s.
**+ #& q4 0$
#
#Ay/@/@/F/F
G(##A&)r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
3ClouddeployProjectsLocationsOperationsCancelRequesti zA ClouddeployProjectsLocationsOperationsCancelRequest object.
Fields:
cancelOperationRequest: A CancelOperationRequest resource to be passed as
the request body.
name: The name of the operation resource to be cancelled.
r0 r r TrW r N) r
r r r r r" r= cancelOperationRequestr# r r r r r r r s/ %112JAN q4 0$r r c : \ rS rSrSr\R " SSS9rSrg)3ClouddeployProjectsLocationsOperationsDeleteRequesti zA ClouddeployProjectsLocationsOperationsDeleteRequest object.
Fields:
name: The name of the operation resource to be deleted.
r TrW r Nrm r r r r r r r r c : \ rS rSrSr\R " SSS9rSrg)0ClouddeployProjectsLocationsOperationsGetRequesti zpA ClouddeployProjectsLocationsOperationsGetRequest object.
Fields:
name: The name of the operation resource.
r TrW r Nrm r r r r r r r r c \ rS rSrSr\R " S5 r\R " SSS9r\R " S\R R S9r \R " S 5 r
\R " S
5 rS rg )
1ClouddeployProjectsLocationsOperationsListRequesti a A ClouddeployProjectsLocationsOperationsListRequest object.
Fields:
filter: The standard list filter.
name: The name of the operation's parent resource.
pageSize: The standard list page size.
pageToken: The standard list page token.
returnPartialSuccess: When set to `true`, operations that are reachable
are returned as normal, and those that are unreachable are returned in
the [ListOperationsResponse.unreachable] field. This can only be `true`
when reading across collections e.g. when `parent` is set to
`"projects/example/locations/-"`. This field is not by default supported
and will result in an `UNIMPLEMENTED` error if set unless explicitly
documented otherwise in service or product specific documentation.
r r TrW r) rf r* rb r N)r
r r r r r" r# rr r r# r$ r% rt ru r} returnPartialSuccessr r r r r r sj #& q4 0$
#
#Ay/@/@/F/F
G(##A&)"//2r r c \ rS rSrSr\R " SSS9r\R " S5 r\R " SS5 r
\R " S 5 r \R " S
5 r
S rg )
0ClouddeployProjectsLocationsTargetsCreateRequesti a A ClouddeployProjectsLocationsTargetsCreateRequest object.
Fields:
parent: Required. The parent collection in which the `Target` must be
created. The format is
`projects/{project_id}/locations/{location_name}`.
requestId: Optional. A request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server
guarantees that for at least 60 minutes after the first request. For
example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments. The request ID
must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
target: A Target resource to be passed as the request body.
targetId: Required. ID of the `Target`.
validateOnly: Optional. If set to true, the request is validated and the
user is provided with an expected result, but no actual change is made.
r TrW r Targetr) r* rb r N)r
r r r r r" r# r[ r\ r= targetr r} r] r r r r r r s] . T 2&##A&) ! !(A .&
"
"1
%(''*,r r c \ rS rSrSr\R " S5 r\R " S5 r \R " SSS9r
\R " S5 r \R " S 5 r S
r
g ) 0ClouddeployProjectsLocationsTargetsDeleteRequesti a A ClouddeployProjectsLocationsTargetsDeleteRequest object.
Fields:
allowMissing: Optional. If set to true, then deleting an already deleted
or non-existing `Target` will succeed.
etag: 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.
name: Required. The name of the `Target` to delete. The format is
`projects/{project_id}/locations/{location_name}/targets/{target_name}`.
requestId: Optional. A request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server
guarantees that for at least 60 minutes after the first request. For
example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments. The request ID
must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
validateOnly: Optional. If set, validate the request and preview the
review, but do not actually post it.
r r r) TrW r* rb r Nra r r r r
r
s[ 2 ''*, q !$ q4 0$##A&)''*,r r
c \ rS rSrSr\R " S\R R S9r \R " SSS9r Sr g )
6ClouddeployProjectsLocationsTargetsGetIamPolicyRequesti4 aB A ClouddeployProjectsLocationsTargetsGetIamPolicyRequest object.
Fields:
options_requestedPolicyVersion: Optional. The maximum policy version that
will be used to format the policy. Valid values are 0, 1, and 3.
Requests specifying an invalid value will be rejected. Requests for
policies with any conditional role bindings must specify version 3.
Policies with no conditional role bindings may specify any valid value
or leave the field unset. The policy in the response might use the
policy version that you specified, or it might use a lower policy
version. For example, if you specify version 3, but the policy has no
conditional role bindings, the response uses version 1. To learn which
resources support conditions in their IAM policies, see the [IAM
documentation](https://cloud.google.com/iam/help/conditions/resource-
policies).
resource: REQUIRED: The resource for which the policy is being requested.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
r rf r TrW r Nrg r r r r r 4 r r r c : \ rS rSrSr\R " SSS9rSrg)-ClouddeployProjectsLocationsTargetsGetRequestiN zA ClouddeployProjectsLocationsTargetsGetRequest object.
Fields:
name: Required. Name of the `Target`. Format must be
`projects/{project_id}/locations/{location_name}/targets/{target_name}`.
r TrW r Nrm r r r r r N r r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S\R R S9r \R " S5 r
\R " SS S
9rS rg )
.ClouddeployProjectsLocationsTargetsListRequestiY a A ClouddeployProjectsLocationsTargetsListRequest object.
Fields:
filter: Optional. Filter targets to be returned. See
https://google.aip.dev/160 for more details.
orderBy: Optional. Field to sort by. See
https://google.aip.dev/132#ordering for more details.
pageSize: Optional. The maximum number of `Target` objects to return. The
service may return fewer than this value. If unspecified, at most 50
`Target` objects will be returned. The maximum value is 1000; values
above 1000 will be set to 1000.
pageToken: Optional. A page token, received from a previous `ListTargets`
call. Provide this to retrieve the subsequent page. When paginating, all
other provided parameters match the call that provided the page token.
parent: Required. The parent, which owns this collection of targets.
Format must be `projects/{project_id}/locations/{location_name}`.
r r r) rf r* rb TrW r Nrq r r r r r Y r r r c \ rS rSrSr\R " S5 r\R " SSS9r \R " S5 r
\R " SS 5 r \R " S
5 r
\R " S 5 rS rg
)/ClouddeployProjectsLocationsTargetsPatchRequestis a A ClouddeployProjectsLocationsTargetsPatchRequest object.
Fields:
allowMissing: Optional. If set to true, updating a `Target` that does not
exist will result in the creation of a new `Target`.
name: Identifier. Name of the `Target`. Format is
`projects/{project}/locations/{location}/targets/{target}`. The `target`
component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
requestId: Optional. A request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server
guarantees that for at least 60 minutes after the first request. For
example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments. The request ID
must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
target: A Target resource to be passed as the request body.
updateMask: Required. Field mask is used to specify the fields to be
overwritten by the update in the `Target` resource. The fields specified
in the update_mask are relative to the resource, not the full request. A
field will be overwritten if it's in the mask. If the user doesn't
provide a mask then all fields are overwritten.
validateOnly: Optional. If set to true, the request is validated and the
user is provided with an expected result, but no actual change is made.
r r TrW r) r r* rb r r N)r
r r r r r" r} rb r# r r\ r= r ry r] r r r r r r s sm : ''*, q4 0$##A&) ! !(A .&$$Q'*''*,r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
6ClouddeployProjectsLocationsTargetsSetIamPolicyRequesti ar A ClouddeployProjectsLocationsTargetsSetIamPolicyRequest object.
Fields:
resource: REQUIRED: The resource for which the policy is being specified.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the
request body.
r TrW r} r r Nr~ r r r r r r r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
DQr r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " S5 r
Srg )
ConfigTaski aV ConfigTask represents either a task in the Deploy Config or a custom
action in the Skaffold Config.
Messages:
EnvValue: Optional. Environment variables that are passed into the
containers defined for either the task in the Deploy Config or the
custom action in the Skaffold Config.
Fields:
env: Optional. Environment variables that are passed into the containers
defined for either the task in the Deploy Config or the custom action in
the Skaffold Config.
id: Required. The name of the task in the Deploy Config or the name of the
custom action in the Skaffold Config.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
ConfigTask.EnvValuei a9 Optional. Environment variables that are passed into the containers
defined for either the task in the Deploy Config or the custom action in
the Skaffold Config.
Messages:
AdditionalProperty: An additional property for a EnvValue object.
Fields:
additionalProperties: Additional properties of type EnvValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)&ConfigTask.EnvValue.AdditionalPropertyi |An additional property for a EnvValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r NrL r r r rO r# rP r rO r Tr1 r NrQ r r r EnvValuer! 2 'Y . . ' %112FTXYr r% r r r N)r
r r r r r rU r" rR r% r= envr# r? r r r r r r s[ !!"89Z"" Z :Z2 z1-# Q "r r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SSS9r \R " S SS9r \R " SS
5 r\R " S 5 rS rg
) Containeri a Container definition for the containers task.
Messages:
EnvValue: Optional. Environment variables that are set in the container.
Fields:
args: Optional. Args is the container arguments to use. This overrides the
default arguments defined in the container image.
command: Optional. Command is the container entrypoint to use. This
overrides the default entrypoint defined in the container image.
env: Optional. Environment variables that are set in the container.
image: Required. Image is the container image to use.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Container.EnvValuei
Optional. Environment variables that are set in the container.
Messages:
AdditionalProperty: An additional property for a EnvValue object.
Fields:
additionalProperties: Additional properties of type EnvValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)%Container.EnvValue.AdditionalPropertyi
r$ r r r NrL r r r rO r.
rP r rO r Tr1 r NrQ r r r r% r+
2 'Y . . ' %112FTXYr r% r Tr1 r r) r* r Nr
r r r r r rU r" rR r% r# argscommandr= r' r r r r r r) r) s !!"89Z"" Z :Z.
q4 0$ ! !!d 3' z1-#
"%r r) c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SSS9r \R " S SS9r \R " SS
5 r\R " S 5 rS rg
)
ContainerTaski(
aN This task is represented by a container that is executed in the Cloud
Build execution environment.
Messages:
EnvValue: Optional. Environment variables that are set in the container.
Fields:
args: Optional. Args is the container arguments to use. This overrides the
default arguments defined in the container image.
command: Optional. Command is the container entrypoint to use. This
overrides the default entrypoint defined in the container image.
env: Optional. Environment variables that are set in the container.
image: Required. Image is the container image to use.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
ContainerTask.EnvValuei8
r, c ` \ rS rSrSr\R " S5 r\R " S5 rSr g))ContainerTask.EnvValue.AdditionalPropertyiC
r$ r r r NrL r r r rO r8 C
rP r rO r Tr1 r NrQ r r r r% r6 8
r/ r r% r Tr1 r r) r* r Nr0 r r r r4 r4 (
s
!!"89Z"" Z :Z.
q4 0$ ! !!d 3' z1-#
"%r r4 c < \ rS rSrSr\R " SSSS9rSrg) ContainersTaskiV
zThis task is represented by a set of containers that are executed in
parallel in the Cloud Build execution environment.
Fields:
containers: Required. Set of containers that are executed in parallel.
r) r Tr1 r N) r
r r r r r" r=
containersr r r r r: r: V
s %%k1tD*r r: c \ rS rSrSrSrg)CreateChildRolloutJobia
zA createChildRollout Job.r Nr r r r r= r= a
s "r r= c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)CreateChildRolloutJobRunie
a~ CreateChildRolloutJobRun contains information specific to a
createChildRollout `JobRun`.
Fields:
rollout: Output only. Name of the `ChildRollout`. Format is `projects/{pro
ject}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases
/{release}/rollouts/{rollout}`.
rolloutPhaseId: Output only. The ID of the childRollout Phase initiated by
this JobRun.
r r r Nr! r r r r? r? e
s)
! !! $' ((+.r r? c < \ rS rSrSr\R " SSSS9rSrg) r iu
zCustomCanaryDeployment represents the custom canary deployment
configuration.
Fields:
phaseConfigs: Required. Configuration for each phase in the canary
deployment in the order executed.
PhaseConfigr Tr1 r N) r
r r r r r" r= phaseConfigsr r r r r r u
s ''
q4H,r r c \ rS rSrSr\R " S5 r\R " S5 r\R " SS5 r
Sr g) rh i
al CustomCheck configures a third-party metric provider to run the
analysis, via a Task that runs at a specified frequency.
Fields:
frequency: Optional. The frequency at which the custom check will be run,
with a minimum and default of 5 minutes.
id: Required. The ID of the custom Analysis check.
task: Required. The Task to be run for this custom check.
r r Taskr) r N) r
r r r r r" r# frequencyr? r= taskr r r r rh rh
s; ##A&) Q " *$r rh c D \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r \R " S5 r \R " S5 r
\R " S 5 r\R " S
S 5 r\R " S S
5 rSrg)rt i
a/ CustomCheckStatus contains information specific to a single iteration of
a custom analysis job.
Enums:
FailureCauseValueValuesEnum: Output only. The reason the analysis failed.
This will always be unspecified while the analysis is in progress or if
it succeeded.
Fields:
failureCause: Output only. The reason the analysis failed. This will
always be unspecified while the analysis is in progress or if it
succeeded.
failureMessage: Output only. Additional information about the analysis
failure, if available.
frequency: Output only. The frequency in minutes at which the custom check
is run.
id: Output only. The ID of the custom check.
latestBuild: 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}`.
metadata: Output only. Custom metadata provided by the user-defined custom
check operation. result.
task: Output only. The task that ran for this custom check.
c , \ rS rSrSrSrSrSrSrSr Sr
g )
-CustomCheckStatus.FailureCauseValueValuesEnumi
a_ Output only. The reason the analysis failed. This will always be
unspecified while the analysis is in progress or if it succeeded.
Values:
FAILURE_CAUSE_UNSPECIFIED: No reason for failure is specified.
CLOUD_BUILD_UNAVAILABLE: Cloud Build is not available, either because it
is not enabled or because Cloud Deploy has insufficient permissions.
See [required permission](https://cloud.google.com/deploy/docs/cloud-
deploy-service-account#required_permissions).
EXECUTION_FAILED: The analysis operation did not complete successfully;
check Cloud Build logs.
DEADLINE_EXCEEDED: The analysis job run did not complete within the
alloted time defined in the target's execution environment
configuration.
CLOUD_BUILD_REQUEST_FAILED: Cloud Build failed to fulfill Cloud Deploy's
request. See failure_message for additional details.
r r r r) r* r N r
r r r r FAILURE_CAUSE_UNSPECIFIEDCLOUD_BUILD_UNAVAILABLEEXECUTION_FAILEDDEADLINE_EXCEEDEDCLOUD_BUILD_REQUEST_FAILEDr r r r FailureCauseValueValuesEnumrI
s' " !" !" r rP r r r) r* rb CustomMetadatar rD r r N)r
r r r r r" r rP r failureCauser# rd rE r? latestBuildr= metadatarF r r r r rt rt
s 4#INN #0 $$%BAF, ((+.##A&) Q "%%a(+
#
#$4a
8( *$r rt c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r Sr g) rQ i
a CustomMetadata contains information from a user-defined operation.
Messages:
ValuesValue: Output only. Key-value pairs provided by the user-defined
operation.
Fields:
values: Output only. Key-value pairs provided by the user-defined
operation.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
CustomMetadata.ValuesValuei
zOutput only. Key-value pairs provided by the user-defined operation.
Messages:
AdditionalProperty: An additional property for a ValuesValue object.
Fields:
additionalProperties: Additional properties of type ValuesValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)-CustomMetadata.ValuesValue.AdditionalPropertyi
An additional property for a ValuesValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r NrL r r r rO rY
rP r rO r Tr1 r NrQ r r r ValuesValuerW
r/ r r[ r r N)
r
r r r r r rU r" rR r[ r= valuesr r r r rQ rQ
sK !!"89ZI%% Z :Z. ! !- 3&r rQ c < \ rS rSrSr\R " S5 rSrg) CustomTargeti
zInformation specifying a Custom Target.
Fields:
customTargetType: Required. The name of the CustomTargetType. Format must
be `projects/{project}/locations/{location}/customTargetTypes/{custom_ta
rget_type}`.
r r N) r
r r r r r" r# rY r r r r r^ r^
s **1-r r^ c < \ rS rSrSr\R " S5 rSrg)CustomTargetDeployMetadatai zCustomTargetDeployMetadata contains information from a Custom Target
deploy operation.
Fields:
skipMessage: Output only. Skip message provided in the results of a custom
deploy operation.
r r N) r
r r r r r" r# skipMessager r r r r` r` s %%a(+r r` c \ rS rSrSr\R " S5 r\R " SSSS9r \R " S5 r
S r g
) CustomTargetSkaffoldActionsi a* CustomTargetSkaffoldActions represents the `CustomTargetType`
configuration using Skaffold custom actions.
Fields:
deployAction: Required. The Skaffold custom action responsible for deploy
operations.
includeSkaffoldModules: Optional. List of Skaffold modules Cloud Deploy
will include in the Skaffold Config as required before performing
diagnose.
renderAction: Optional. The Skaffold custom action responsible for render
operations. If not provided then Cloud Deploy will perform the render
operations via `skaffold render`.
r SkaffoldModulesr Tr1 r) r N) r
r r r r r" r# deployActionr= includeSkaffoldModules renderActionr r r r rc rc s@ &&q),$112CQQUV&&q),r rc c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g)CustomTargetTasksi a, CustomTargetTasks represents the `CustomTargetType` configuration using
tasks.
Fields:
deploy: Required. The task responsible for deploy operations.
render: Optional. The task responsible for render operations. If not
provided then Cloud Deploy will perform its default rendering operation.
rD r r r N)
r
r r r r r" r= deployrenderr r r r ri ri s- ! !&! ,& ! !&! ,&r ri c T \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " SS5 r \R " S 5 r\R " S
S 5 r\R " S 5 r\R " S
5 r\R " S5 r\R " SS5 r\R " S5 r\R " SS5 r\R " S5 r\R " S5 rSrg)rV i. aK 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.
Messages:
AnnotationsValue: 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.
LabelsValue: 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.
Fields:
annotations: 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.
createTime: Output only. Time at which the `CustomTargetType` was created.
customActions: Optional. Configures render and deploy for the
`CustomTargetType` using Skaffold custom actions.
customTargetTypeId: Output only. Resource id of the `CustomTargetType`.
description: Optional. Description of the `CustomTargetType`. Max length
is 255 characters.
etag: 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.
labels: 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.
name: Identifier. Name of the `CustomTargetType`. Format is `projects/{pro
ject}/locations/{location}/customTargetTypes/{customTargetType}`. The
`customTargetType` component must match
`[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
tasks: Optional. Configures render and deploy for the `CustomTargetType`
using tasks.
uid: Output only. Unique identifier of the `CustomTargetType`.
updateTime: Output only. Most recent time at which the `CustomTargetType`
was updated.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
!CustomTargetType.AnnotationsValueic x 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.
Messages:
AdditionalProperty: An additional property for a AnnotationsValue
object.
Fields:
additionalProperties: Additional properties of type AnnotationsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)4CustomTargetType.AnnotationsValue.AdditionalPropertyir r r r r NrL r r r rO rq r rP r rO r Tr1 r NrQ r r r r rn c 2 'Y . . ' %112FTXYr r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
CustomTargetType.LabelsValuei 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.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)/CustomTargetType.LabelsValue.AdditionalPropertyi rK r r r NrL r r r rO rw rP r rO r Tr1 r NrQ r r r rS rt r r rS r r rc r) r* rb r r r ri r r r r N)r
r r r r r rU r" rR r rS r= r r# r
customActionsrZ r r rW r tasksr r r r r r rV rV . s& 2h !!"89Z** Z :Z6 !!"89 ZI%% Z : Z< &&'91=+$$Q'*(()FJ- ,,Q/%%a(+ q !$ ! !- 3& q !$
!4a
8% b!#$$R(*r rV c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " S5 r \R " SS5 r
S rg
) !CustomTargetTypeNotificationEventi a 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.
Enums:
TypeValueValuesEnum: Type of this notification, e.g. for a Pub/Sub
failure.
Fields:
customTargetType: The name of the `CustomTargetType`.
customTargetTypeUid: Unique identifier of the `CustomTargetType`.
message: Debug message for when a notification fails to send.
type: Type of this notification, e.g. for a Pub/Sub failure.
c < \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rg
)5CustomTargetTypeNotificationEvent.TypeValueValuesEnumi r r r r r) r* rb r r r r Nr r r r r r} r r r r r r) r* r N)r
r r r r r" r r r# rY customTargetTypeUidr r r r r r r r{ r{ s^ #INN #4 **1-!--a0 ! !! $' 2A 6$r r{ c \ rS rSrSr\R " S\R R S9r \R " S\R R S9r
\R " S\R R S9r Sr g) Datei a 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
Fields:
day: 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.
month: Month of a year. Must be from 1 to 12, or 0 to specify a year
without a month and day.
year: Year of the date. Must be from 1 to 9999, or 0 to specify a date
without a year.
r rf r r) r N)
r
r r r r r" r# r$ r% daymonthyearr r r r r r sc ( q)*;*;*A*AB#
I,=,=,C,C
D% 9+<+<+B+B C$r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g) DefaultPooli a
Execution using the default Cloud Build pool.
Fields:
artifactStorage: 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.
serviceAccount: Optional. Google service account to use for execution. If
unspecified, the project execution service account
(-compute@developer.gserviceaccount.com) will be used.
r r r N)
r
r r r r r" r# artifactStorager r r r r r r s)
))!,/ ((+.r r c T \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " SS5 r \R " S S
5 r
\R " S 5 r\R " S 5 r\R " S
5 r\R " SS5 r\R " S5 r\R " SS5 r\R* " S5 r\R " S5 r\R " S5 rSrg)r i a
A `DeliveryPipeline` resource in the Cloud Deploy API. A
`DeliveryPipeline` defines a pipeline through which a Skaffold configuration
can progress.
Messages:
AnnotationsValue: Optional. User annotations. These attributes can only be
set and used by the user, and not by Cloud Deploy.
LabelsValue: 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.
Fields:
annotations: Optional. User annotations. These attributes can only be set
and used by the user, and not by Cloud Deploy.
condition: Output only. Information around the state of the Delivery
Pipeline.
createTime: Output only. Time at which the pipeline was created.
description: Optional. Description of the `DeliveryPipeline`. Max length
is 255 characters.
etag: 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.
labels: 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.
name: Identifier. Name of the `DeliveryPipeline`. Format is `projects/{pro
ject}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The
`deliveryPipeline` component must match
`[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
serialPipeline: Optional. SerialPipeline defines a sequential set of
stages for a `DeliveryPipeline`.
suspended: Optional. When suspended, no new releases or rollouts can be
created, but in-progress ones will complete.
uid: Output only. Unique identifier of the `DeliveryPipeline`.
updateTime: Output only. Most recent time at which the pipeline was
updated.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
!DeliveryPipeline.AnnotationsValuei8 a Optional. User annotations. These attributes can only be set and used
by the user, and not by Cloud Deploy.
Messages:
AdditionalProperty: An additional property for a AnnotationsValue
object.
Fields:
additionalProperties: Additional properties of type AnnotationsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)4DeliveryPipeline.AnnotationsValue.AdditionalPropertyiE r r r r NrL r r r rO r E rP r rO r Tr1 r NrQ r r r r r 8 r& r r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
DeliveryPipeline.LabelsValueiR 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.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)/DeliveryPipeline.LabelsValue.AdditionalPropertyid rK r r r NrL r r r rO r d rP r rO r Tr1 r NrQ r r r rS r R r r rS r PipelineConditionr r) r* rb r r SerialPipeliner r r r r N)r
r r r r r rU r" rR r rS r= r r> r# r r r rW r serialPipeliner} r r r r r r r r r s% .` !!"89Z** Z :Z2 !!"89 ZI%% Z : Z< &&'91=+$$%8!<)$$Q'*%%a(+ q !$ ! !- 3& q !$ ))*:A>.$$Q') b!#$$R(*r r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 r \R " SS5 r
Srg )
DeliveryPipelineAttributei~ aQ Contains criteria for selecting DeliveryPipelines.
Messages:
LabelsValue: DeliveryPipeline labels.
Fields:
id: Optional. ID of the `DeliveryPipeline`. The value of this field could
be one of the following: * The last segment of a pipeline name * "*",
all delivery pipelines in a location
labels: DeliveryPipeline labels.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
%DeliveryPipelineAttribute.LabelsValuei zDeliveryPipeline labels.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)8DeliveryPipelineAttribute.LabelsValue.AdditionalPropertyi rK r r r NrL r r r rO r rP r rO r Tr1 r NrQ r r r rS r r/ r rS r r r Nr
r r r r r rU r" rR rS r# r? r= rW r r r r r r ~ s[
!!"89ZI%% Z :Z. Q " ! !- 3&r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " S5 r \R " SS5 r
S rg
) !DeliveryPipelineNotificationEventi a Payload proto for
"clouddeploy.googleapis.com/deliverypipeline_notification" Platform Log
event that describes the failure to send delivery pipeline status change
Pub/Sub notification.
Enums:
TypeValueValuesEnum: Type of this notification, e.g. for a Pub/Sub
failure.
Fields:
deliveryPipeline: The name of the `Delivery Pipeline`.
message: Debug message for when a notification fails to send.
pipelineUid: Unique identifier of the `DeliveryPipeline`.
type: Type of this notification, e.g. for a Pub/Sub failure.
c < \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rg
)5DeliveryPipelineNotificationEvent.TypeValueValuesEnumi r r r r r) r* rb r r r r Nr r r r r r r r r r r r) r* r N)r
r r r r r" r r r# r r r r r r r r r r r s] #INN #4 **1- ! !! $'%%a(+ 2A 6$r r c ^ \ rS rSrSr\R " S5 r\R " SSS9rSr g) DeployArtifacti a$ The artifacts produced by a deploy operation.
Fields:
artifactUri: Output only. URI of a directory containing the artifacts. All
paths are relative to this location.
manifestPaths: Output only. File paths of the manifests applied during the
deploy operation relative to the URI.
r r Tr1 r N)
r
r r r r r" r# artifactUri
manifestPathsr r r r r r s+ %%a(+''D9-r r c \ rS rSrSrSrg) DeployJobi z
A deploy Job.r Nr r r r r r s r r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r \R " SS5 r
\R " S 5 r\R " S
S 5 rS rg
) DeployJobRuni a; DeployJobRun contains information specific to a deploy `JobRun`.
Enums:
FailureCauseValueValuesEnum: Output only. The reason the deploy failed.
This will always be unspecified while the deploy is in progress or if it
succeeded.
Fields:
artifact: Output only. The artifact of a deploy job run, if available.
build: Output only. The resource name of the Cloud Build `Build` object
that is used to deploy. Format is
`projects/{project}/locations/{location}/builds/{build}`.
failureCause: Output only. The reason the deploy failed. This will always
be unspecified while the deploy is in progress or if it succeeded.
failureMessage: Output only. Additional information about the deploy
failure, if available.
metadata: Output only. Metadata containing information about the deploy
job run.
c 4 \ rS rSrSrSrSrSrSrSr Sr
S r S
r g ) (DeployJobRun.FailureCauseValueValuesEnumi a4 Output only. The reason the deploy failed. This will always be
unspecified while the deploy is in progress or if it succeeded.
Values:
FAILURE_CAUSE_UNSPECIFIED: No reason for failure is specified.
CLOUD_BUILD_UNAVAILABLE: Cloud Build is not available, either because it
is not enabled or because Cloud Deploy has insufficient permissions.
See [Required permission](https://cloud.google.com/deploy/docs/cloud-
deploy-service-account#required_permissions).
EXECUTION_FAILED: The deploy operation did not complete successfully;
check Cloud Build logs.
DEADLINE_EXCEEDED: The deploy job run did not complete within the
allotted time.
MISSING_RESOURCES_FOR_CANARY: There were missing resources in the
runtime environment required for a canary deployment. Check the Cloud
Build logs for more information.
CLOUD_BUILD_REQUEST_FAILED: Cloud Build failed to fulfill Cloud Deploy's
request. See failure_message for additional details.
DEPLOY_FEATURE_NOT_SUPPORTED: The deploy operation had a feature
configured that is not supported.
r r r r) r* rb r r N)
r
r r r r rK rL rM rN MISSING_RESOURCES_FOR_CANARYrO DEPLOY_FEATURE_NOT_SUPPORTEDr r r r rP r s3 * !" #$ !" #$ r rP r r r r) r* DeployJobRunMetadatarb r N)r
r r r r r" r rP r= artifactr# buildr rR rd rT r r r r r r sr ( %INN %<
#
#$4a
8(
"%$$%BAF, ((+.
#
#$:A
>(r r c \ rS rSrSr\R " SS5 r\R " SS5 r\R " SS5 r S r
g
) r i$
az DeployJobRunMetadata surfaces information associated with a
`DeployJobRun` to the user.
Fields:
cloudRun: Output only. The name of the Cloud Run Service that is
associated with a `DeployJobRun`.
custom: Output only. Custom metadata provided by user-defined deploy
operation.
customTarget: Output only. Custom Target metadata associated with a
`DeployJobRun`.
rF r rQ r r` r) r N) r
r r r r r" r= cloudRuncustom customTargetr r r r r r $
sB
#
#$6
:( ! !"2A 6&''(DaH,r r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " SS5 r \R " SS 5 r
S
rg ) DeployParametersi6
a{ DeployParameters contains deploy parameters information.
Messages:
MatchTargetLabelsValue: Optional. Deploy parameters are applied to targets
with match labels. If unspecified, deploy parameters are applied to all
targets (including child targets of a multi-target).
ValuesValue: Required. Values are deploy parameters in key-value pairs.
Fields:
matchTargetLabels: Optional. Deploy parameters are applied to targets with
match labels. If unspecified, deploy parameters are applied to all
targets (including child targets of a multi-target).
values: Required. Values are deploy parameters in key-value pairs.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
'DeployParameters.MatchTargetLabelsValueiF
ak Optional. Deploy parameters are applied to targets with match labels.
If unspecified, deploy parameters are applied to all targets (including
child targets of a multi-target).
Messages:
AdditionalProperty: An additional property for a MatchTargetLabelsValue
object.
Fields:
additionalProperties: Additional properties of type
MatchTargetLabelsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g):DeployParameters.MatchTargetLabelsValue.AdditionalPropertyiU
zAn additional property for a MatchTargetLabelsValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r NrL r r r rO r U
rP r rO r Tr1 r NrQ r r r MatchTargetLabelsValuer F
rr r r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
DeployParameters.ValuesValueib
zRequired. Values are deploy parameters in key-value pairs.
Messages:
AdditionalProperty: An additional property for a ValuesValue object.
Fields:
additionalProperties: Additional properties of type ValuesValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)/DeployParameters.ValuesValue.AdditionalPropertyim
rZ r r r NrL r r r rO r m
rP r rO r Tr1 r NrQ r r r r[ r b
r/ r r[ r r r N)r
r r r r r rU r" rR r r[ r= matchTargetLabelsr\ r r r r r r 6
s
!!"89Zy 0 0 Z :Z6 !!"89ZI%% Z :Z. ,,-EqI ! !- 3&r r c P \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " SS5 r \R " S 5 r\R " S
5 r\R " S 5 r\R " SS 5 r\R " S
5 r\R " SSSS9r\R " SSSS9r\R* " S5 r\R " S5 r\R " S5 rSrg)r i~
a A `DeployPolicy` resource in the Cloud Deploy API. A `DeployPolicy`
inhibits manual or automation-driven actions within a Delivery Pipeline or
Target.
Messages:
AnnotationsValue: 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.
LabelsValue: 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.
Fields:
annotations: 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.
createTime: Output only. Time at which the deploy policy was created.
description: Optional. Description of the `DeployPolicy`. Max length is
255 characters.
etag: The weak etag of the `DeployPolicy` 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.
labels: 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.
name: Output only. Name of the `DeployPolicy`. Format is
`projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
The `deployPolicy` component must match
`[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
rules: Required. Rules to apply. At least one rule must be present.
selectors: Required. Selected resources to which the policy will be
applied. At least one selector is required. If one selector matches the
resource the policy applies. For example, if there are two selectors and
the action being attempted matches one of them, the policy will apply to
that action.
suspended: Optional. When suspended, the policy will not prevent actions
from occurring, even if the action violates the policy.
uid: Output only. Unique identifier of the `DeployPolicy`.
updateTime: Output only. Most recent time at which the deploy policy was
updated.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
DeployPolicy.AnnotationsValuei
r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)0DeployPolicy.AnnotationsValue.AdditionalPropertyi
r r r r NrL r r r rO r
rP r rO r Tr1 r NrQ r r r r r
r r r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
DeployPolicy.LabelsValuei
r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)+DeployPolicy.LabelsValue.AdditionalPropertyi
rK r r r NrL r r r rO r
rP r rO r Tr1 r NrQ r r r rS r
r r rS r r r) r* rb r
PolicyRuler Tr1 DeployPolicyResourceSelectorr r r r r N)r
r r r r r rU r" rR r rS r= r r# r r r rW r r selectorsr} r r r r r r r r r ~
s+ GR !!"89!Z** !Z :!ZF !!"89 ZI%% Z : Z< &&'91=+$$Q'*%%a(+ q !$ ! !- 3& q !$
q4
@%$$%CQQUV)$$Q') b!#$$R(*r r c n \ rS rSrSr " S S\R 5 r " S S\R 5 r " S S\R 5 r \R " S 5 r \R " S
5 r
\R " S 5 r\R " S 5 r\R " SS
5 r\R " S5 r\R " SSSS9r\R " S5 r\R " S5 r\R " S5 r\R " S5 r\R " S5 r\R " SS5 rSrg)DeployPolicyEvaluationEventi a Payload proto for "clouddeploy.googleapis.com/deploypolicy_evaluation"
Platform Log event that describes the deploy policy evaluation event.
Enums:
InvokerValueValuesEnum: What invoked the action (e.g. a user or
automation).
OverridesValueListEntryValuesEnum:
VerdictValueValuesEnum: The policy verdict of the request.
Fields:
allowed: Whether the request is allowed. Allowed is set as true if: (1)
the request complies with the policy; or (2) the request doesn't comply
with the policy but the policy was overridden; or (3) the request
doesn't comply with the policy but the policy was suspended
deliveryPipeline: The name of the `Delivery Pipeline`.
deployPolicy: The name of the `DeployPolicy`.
deployPolicyUid: Unique identifier of the `DeployPolicy`.
invoker: What invoked the action (e.g. a user or automation).
message: Debug message for when a deploy policy event occurs.
overrides: Things that could have overridden the policy verdict. Overrides
together with verdict decide whether the request is allowed.
pipelineUid: Unique identifier of the `Delivery Pipeline`.
rule: Rule id.
ruleType: Rule type (e.g. Restrict Rollouts).
target: The name of the `Target`. This is an optional field, as a `Target`
may not always be applicable to a policy.
targetUid: Unique identifier of the `Target`. This is an optional field,
as a `Target` may not always be applicable to a policy.
verdict: The policy verdict of the request.
c $ \ rS rSrSrSrSrSrSrg)2DeployPolicyEvaluationEvent.InvokerValueValuesEnumi8 a What invoked the action (e.g. a user or automation).
Values:
INVOKER_UNSPECIFIED: Unspecified.
USER: The action is user-driven. For example, creating a rollout
manually via a gcloud create command.
DEPLOY_AUTOMATION: Automated action by Cloud Deploy.
r r r r N r
r r r r INVOKER_UNSPECIFIEDUSERDEPLOY_AUTOMATIONr r r r InvokerValueValuesEnumr 8 Dr r c $ \ rS rSrSrSrSrSrSrg)=DeployPolicyEvaluationEvent.OverridesValueListEntryValuesEnumiE zOverridesValueListEntryValuesEnum enum type.
Values:
POLICY_VERDICT_OVERRIDE_UNSPECIFIED: This should never happen.
POLICY_OVERRIDDEN: The policy was overridden.
POLICY_SUSPENDED: The policy was suspended.
r r r r N) r
r r r r #POLICY_VERDICT_OVERRIDE_UNSPECIFIEDPOLICY_OVERRIDDENPOLICY_SUSPENDEDr r r r !OverridesValueListEntryValuesEnumr E s +,'r r c $ \ rS rSrSrSrSrSrSrg)2DeployPolicyEvaluationEvent.VerdictValueValuesEnumiQ aE The policy verdict of the request.
Values:
POLICY_VERDICT_UNSPECIFIED: This should never happen.
ALLOWED_BY_POLICY: Allowed by policy. This enum value is not currently
used but may be used in the future. Currently logs are only generated
when a request is denied by policy.
DENIED_BY_POLICY: Denied by policy.
r r r r N) r
r r r r POLICY_VERDICT_UNSPECIFIEDALLOWED_BY_POLICYDENIED_BY_POLICYr r r r VerdictValueValuesEnumr Q s "# r r r r r) r* rb r r Tr1 r r r r r r r N)r
r r r r r" r r r r r} allowedr# r r deployPolicyUidr invokerr overridesr ruleruleTyper targetUidverdictr r r r r r s > y~~
)..
y~~
" "1 %' **1-&&q), ))!,/ 8! <' ! !! $'!!"EqSWX)%%a(+ q !$
"
"2
&( $&##B') 8" ='r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " S5 r \R " SS5 r
S rg
) DeployPolicyNotificationEventin a, Payload proto for
"clouddeploy.googleapis.com/deploypolicy_notification". Platform Log event
that describes the failure to send a pub/sub notification when there is a
DeployPolicy status change.
Enums:
TypeValueValuesEnum: Type of this notification, e.g. for a Pub/Sub
failure.
Fields:
deployPolicy: The name of the `DeployPolicy`.
deployPolicyUid: Unique identifier of the deploy policy.
message: Debug message for when a deploy policy fails to send a pub/sub
notification.
type: Type of this notification, e.g. for a Pub/Sub failure.
c < \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rg
)1DeployPolicyNotificationEvent.TypeValueValuesEnumi r r r r r) r* rb r r r r Nr r r r r r r r r r r r) r* r N)r
r r r r r" r r r# r r r r r r r r r r r n s\ "#INN #4 &&q), ))!,/ ! !! $' 2A 6$r r c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g) r i a Contains information on the resources to select for a deploy policy.
Attributes provided must all match the resource in order for policy
restrictions to apply. For example, if delivery pipelines attributes given
are an id "prod" and labels "foo: bar", a delivery pipeline resource must
match both that id and have that label in order to be subject to the policy.
Fields:
deliveryPipeline: Optional. Contains attributes about a delivery pipeline.
target: Optional. Contains attributes about a target.
r r r r r N)
r
r r r r r" r= r r r r r r r r s0 ++,GK ! !"3Q 7&r r c \ rS rSrSr\R " SS5 r\R " SS5 r\R " SS5 r \R " SS5 r
\R " SS5 r S r g
) DeploymentJobsi a Deployment job composition.
Fields:
analysisJob: Output only. The analysis Job. Runs after a verify if there
is a verify job and the verify job succeeds.
deployJob: Output only. The deploy Job. This is the deploy job in the
phase.
postdeployJob: Output only. The postdeploy Job, which is the last job on
the phase.
predeployJob: Output only. The predeploy Job, which is the first job on
the phase.
verifyJob: Output only. The verify Job. Runs after a deploy if the deploy
succeeds.
r9 r r r) r* rb r N)
r
r r r r r" r= analysisJob deployJob
postdeployJob predeployJob verifyJobr r r r r r sc
&&ua0+$$UA.)((2-''q1,$$UA.)r r c \ rS rSrSrSrg)Emptyi a 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); }
r Nr r r r r r s r r c f \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r \R " S5 r \R " S S
5 r
\R " S 5 r\R " SS S
S9r\R" " S5 r\R " S5 rSrg)ExecutionConfigi a Configuration of the environment to use when calling Skaffold.
Enums:
UsagesValueListEntryValuesEnum:
Fields:
artifactStorage: 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.
defaultPool: Optional. Use default Cloud Build pool.
executionTimeout: 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.
privatePool: Optional. Use private Cloud Build pool.
serviceAccount: Optional. Google service account to use for execution. If
unspecified, the project execution service account
(-compute@developer.gserviceaccount.com) is used.
usages: Required. Usages when this configuration should be applied.
verbose: Optional. If true, additional logging will be enabled when
running builds in this execution environment.
workerPool: 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.
c 4 \ rS rSrSrSrSrSrSrSr Sr
S r S
r g ) .ExecutionConfig.UsagesValueListEntryValuesEnumi a UsagesValueListEntryValuesEnum enum type.
Values:
EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIED: Default value. This value is
unused.
RENDER: Use for rendering.
DEPLOY: Use for deploying and deployment hooks.
VERIFY: Use for deployment verification.
PREDEPLOY: Use for predeploy job execution.
POSTDEPLOY: Use for postdeploy job execution.
ANALYSIS: Use for analysis job execution.
r r r r) r* rb r r N)
r
r r r r 'EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIEDRENDERDEPLOYVERIFY PREDEPLOY
POSTDEPLOYANALYSISr r r r UsagesValueListEntryValuesEnumr s- /0+
F
F
FIJHr r r r r r) PrivatePoolr* rb r Tr1 r r r N)r
r r r r r" r r r# r r= defaultPoolexecutionTimeout privatePoolr r usagesr} verbose
workerPoolr r r r r r s 8y~~ * ))!,/&&}a8+ **1-&&}a8+ ((+. ?T R& " "1 %'$$Q'*r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
Sr g) r i aq 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.
Fields:
description: Optional. Description of the expression. This is a longer
text which describes the expression, e.g. when hovered over it in a UI.
expression: Textual representation of an expression in Common Expression
Language syntax.
location: Optional. String indicating the location of the expression for
error reporting, e.g. a file name and a position in the file.
title: 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.
r r r) r* r N) r
r r r r r" r# r
expressionrD titler r r r r r sI : %%a(+$$Q'*
"
"1
%(
"%r r c ^ \ rS rSrSr\R " S5 r\R " SSS9rSr g) ra i0 a FailedAlertPolicy contains information about an alert policy that was
found to be firing during an alert policy check.
Fields:
alertPolicy: Output only. The name of the alert policy that was found to
be firing. Format is
`projects/{project}/locations/{location}/alertPolicies/{alertPolicy}`.
alerts: Output only. Open alerts for the alerting policies that matched
the alert policy check configuration.
r r Tr1 r N)
r
r r r r r" r# alertPolicyalertsr r r r ra ra 0 s+ %%a(+ T 2&r ra c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " SS5 r \R " S5 r \R " S 5 r
\R " S
5 rS rg )
GatewayServiceMeshi@ a Information about the Kubernetes Gateway API service mesh configuration.
Fields:
deployment: Required. Name of the Kubernetes Deployment whose traffic is
managed by the specified HTTPRoute and Service.
httpRoute: Required. Name of the Gateway API HTTPRoute.
podSelectorLabel: Optional. The label to use when selecting Pods for the
Deployment and Service resources. This label must already be present in
both resources.
routeDestinations: Optional. Route destinations allow configuring the
Gateway API HTTPRoute to be deployed to additional clusters. This option
is available for multi-cluster service mesh set ups that require the
route to exist in the clusters that call the service. If unspecified,
the HTTPRoute will only be deployed to the Target cluster.
routeUpdateWaitTime: Optional. The time to wait for route updates to
propagate. The maximum configurable time is 3 hours, in seconds format.
If unspecified, there is no wait time.
service: Required. Name of the Kubernetes Service.
stableCutbackDuration: Optional. The amount of time to migrate traffic
back from the canary Service to the original Service during the stable
phase deployment. If specified, must be between 15s and 3600s. If
unspecified, there is no cutback time.
r r r) RouteDestinationsr* rb r r r N)r
r r r r r" r# rO rQ rR r= routeDestinationsrS r stableCutbackDurationr r r r r r @ s 0 $$Q'*##A&) **1- ,,-@!D!--a0 ! !! $'#//2r r c \ rS rSrSr\R " S5 r\R " S5 r \R " S5 r
\R " S5 r Sr g) r ib a\ Information specifying a GKE Cluster.
Fields:
cluster: Optional. Information specifying a GKE Cluster. Format is
`projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`.
dnsEndpoint: Optional. If set, the cluster will be accessed using the DNS
endpoint. Note that both `dns_endpoint` and `internal_ip` cannot be set
to true.
internalIp: 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). Note that `internal_ip`
and `dns_endpoint` cannot both be set to true.
proxyUrl: Optional. If set, used to configure a
[proxy](https://kubernetes.io/docs/concepts/configuration/organize-
cluster-access-kubeconfig/#proxy) to the Kubernetes server.
r r r) r* r N)
r
r r r r r" r# clusterr} dnsEndpoint
internalIpproxyUrlr r r r r r b sI *
! !! $'&&q)+%%a(*
"
"1
%(r r c < \ rS rSrSr\R " SSSS9rSrg) ri i~ zGoogleCloudAnalysis is a set of Google Cloud-based checks to perform on
the deployment.
Fields:
alertPolicyChecks: Optional. A list of Cloud Monitoring Alert Policy
checks to perform as part of the analysis.
rB r Tr1 r N) r
r r r r r" r= alertPolicyChecksr r r r ri ri ~ s ,,-?TRr ri c \ rS rSrSr\R " S5 r\R " SSS9r\R " S5 r Sr
g )
r i a< The request object used by `IgnoreJob`.
Fields:
jobId: Required. The job ID for the Job to ignore.
overrideDeployPolicy: Optional. Deploy policies to override. Format is
`projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
phaseId: Required. The phase ID the Job to ignore belongs to.
r r Tr1 r) r N r
r r r r r" r# jobIdr3 r4 r r r r r r <
"%"..q4@ ! !! $'r r c \ rS rSrSrSrg)IgnoreJobResponsei z%The response object from `IgnoreJob`.r Nr r r r r r s .r r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " SS5 r
\R " S S
5 r \R " S S 5 r \R " S
5 r\R " S5 r\R " SS5 r\R " SS5 r\R " S5 r\R& " SS5 r\R " SS5 rSrg)r9 i a Job represents an operation for a `Rollout`.
Enums:
StateValueValuesEnum: Output only. The current state of the Job.
Fields:
advanceChildRolloutJob: Output only. An advanceChildRollout Job.
analysisJob: Output only. An analysis Job.
createChildRolloutJob: Output only. A createChildRollout Job.
deployJob: Output only. A deploy Job.
id: Output only. The ID of the Job.
jobRun: Output only. The name of the `JobRun` responsible for the most
recent invocation of this Job.
postdeployJob: Output only. A postdeploy Job.
predeployJob: Output only. A predeploy Job.
skipMessage: Output only. Additional information on why the Job was
skipped, if available.
state: Output only. The current state of the Job.
verifyJob: Output only. A verify Job.
c < \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rg
)Job.StateValueValuesEnumi a Output only. The current state of the Job.
Values:
STATE_UNSPECIFIED: The Job has an unspecified state.
PENDING: The Job is waiting for an earlier Phase(s) or Job(s) to
complete.
DISABLED: The Job is disabled.
IN_PROGRESS: The Job is in progress.
SUCCEEDED: The Job succeeded.
FAILED: The Job failed.
ABORTED: The Job was aborted.
SKIPPED: The Job was skipped.
IGNORED: The Job was ignored.
r r r r) r* rb r r r r N)r
r r r r r r DISABLEDr r r r SKIPPEDIGNOREDr r r r r r# s7
GHKI
FGGGr r r r ro r r= r) r r* rb r
PostdeployJobr PredeployJobr r r VerifyJobr r N)r
r r r r r" r r r= advanceChildRolloutJobr createChildRolloutJobr r# r? jobRunr r ra r r r r r r r r9 r9 s *Y^^ 2 %112JAN&&}a8+#001H!L$$[!4) Q " #&(( !<-'':,%%a(+
4b
9%$$["5)r r9 c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " SS5 r
\R " S S
5 r \R " S 5 r
\R " S S
5 r\R " S5 r\R " S5 r\R " S5 r\R " S5 r\R " S5 r\R " SS5 r\R " SS5 r\R " S5 r\R. " SS5 r\R " S5 r\R " SS5 rS rg ) JobRuni a} A `JobRun` resource in the Cloud Deploy API. A `JobRun` contains
information of a single `Rollout` job evaluation.
Enums:
StateValueValuesEnum: Output only. The current state of the `JobRun`.
Fields:
advanceChildRolloutJobRun: Output only. Information specific to an
advanceChildRollout `JobRun`
analysisJobRun: Output only. Information specific to an analysis `JobRun`.
createChildRolloutJobRun: Output only. Information specific to a
createChildRollout `JobRun`.
createTime: Output only. Time at which the `JobRun` was created.
deployJobRun: Output only. Information specific to a deploy `JobRun`.
endTime: Output only. Time at which the `JobRun` ended.
etag: 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.
jobId: Output only. ID of the `Rollout` job this `JobRun` corresponds to.
name: Output only. Name of the `JobRun`. Format is `projects/{project}/loc
ations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release
s}/rollouts/{rollouts}/jobRuns/{uuid}`.
phaseId: Output only. ID of the `Rollout` phase this `JobRun` belongs in.
postdeployJobRun: Output only. Information specific to a postdeploy
`JobRun`.
predeployJobRun: Output only. Information specific to a predeploy
`JobRun`.
startTime: Output only. Time at which the `JobRun` was started.
state: Output only. The current state of the `JobRun`.
uid: Output only. Unique identifier of the `JobRun`.
verifyJobRun: Output only. Information specific to a verify `JobRun`.
c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) JobRun.StateValueValuesEnumi aD Output only. The current state of the `JobRun`.
Values:
STATE_UNSPECIFIED: The `JobRun` has an unspecified state.
IN_PROGRESS: The `JobRun` is in progress.
SUCCEEDED: The `JobRun` has succeeded.
FAILED: The `JobRun` has failed.
TERMINATING: The `JobRun` is terminating.
TERMINATED: The `JobRun` was terminated.
r r r r) r* rb r N) r
r r r r r r r r TERMINATING
TERMINATEDr r r r r r0 s( KI
FKJr r r r rr r r? r) r* r rb r r r r r PostdeployJobRunr PredeployJobRunr r r r VerifyJobRunr
r N) r
r r r r r" r r r= advanceChildRolloutJobRunanalysisJobRuncreateChildRolloutJobRunr# r deployJobRunendTimer r r r4 postdeployJobRunpredeployJobRun startTimer r r verifyJobRunr r r r r. r. s5 BY^^ $ ( 4 45PRS T ))*:A>. & 3 34NPQ R$$Q'*'':, ! !! $' q !$
"% q !$ ! !" %' ++,>C **+B --.BAF ,,-@!Dr rF c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)KubernetesRenderMetadataih a KubernetesRenderMetadata contains Kubernetes information associated with
a `Release` render.
Fields:
canaryDeployment: Output only. Name of the canary version of the
Kubernetes Deployment that will be applied to the GKE cluster. Only set
if a canary deployment strategy was configured.
deployment: Output only. Name of the Kubernetes Deployment that will be
applied to the GKE cluster. Only set if a single Deployment was provided
in the rendered manifest.
kubernetesNamespace: Output only. Namespace the Kubernetes resources will
be applied to in the GKE cluster. Only set if applying resources to a
single namespace.
r r r) r N) r
r r r r r" r# r rO kubernetesNamespacer r r r rL rL h s;
**1-$$Q'*!--a0r rL c \ rS rSrSr\R " SSSS9r\R " S5 r \R " SSS9r
S r g
) ListAutomationRunsResponsei} a0 The response object from `ListAutomationRuns`.
Fields:
automationRuns: The `AutomationRuns` objects.
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
unreachable: Locations that could not be reached.
r r Tr1 r r) r N) r
r r r r r" r= automationRunsr#
nextPageToken unreachabler r r r rO rO } s? ))/1tL.''*-%%a$7+r rO c \ rS rSrSr\R " SSSS9r\R " S5 r \R " SSS9r
S r g
) ListAutomationsResponsei a& The response object from `ListAutomations`.
Fields:
automations: The `Automation` objects.
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
unreachable: Locations that could not be reached.
r r Tr1 r r) r N) r
r r r r r" r= automationsr# rQ rR r r r r rT rT s? &&|QF+''*-%%a$7+r rT c \ rS rSrSr\R " SSSS9r\R " S5 r \R " SSS9r
S r g
) ListCustomTargetTypesResponsei a8 The response object from `ListCustomTargetTypes.`
Fields:
customTargetTypes: The `CustomTargetType` objects.
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
unreachable: Locations that could not be reached.
rV r Tr1 r r) r N) r
r r r r r" r= customTargetTypesr# rQ rR r r r r rW rW A ,,-?TR''*-%%a$7+r rW c \ rS rSrSr\R " SSSS9r\R " S5 r \R " SSS9r
S r g
) ListDeliveryPipelinesResponsei a8 The response object from `ListDeliveryPipelines`.
Fields:
deliveryPipelines: The `DeliveryPipeline` objects.
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
unreachable: Locations that could not be reached.
r r Tr1 r r) r N) r
r r r r r" r= deliveryPipelinesr# rQ rR r r r r r[ r[ rY r r[ c \ rS rSrSr\R " SSSS9r\R " S5 r \R " SSS9r
S r g
) ListDeployPoliciesResponsei a. The response object from `ListDeployPolicies`.
Fields:
deployPolicies: The `DeployPolicy` objects.
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
unreachable: Locations that could not be reached.
r r Tr1 r r) r N) r
r r r r r" r= deployPoliciesr# rQ rR r r r r r^ r^ s? )).!dK.''*-%%a$7+r r^ c \ rS rSrSr\R " SSSS9r\R " S5 r \R " SSS9r
S r g
) ListJobRunsResponsei a7 ListJobRunsResponse is the response object returned by `ListJobRuns`.
Fields:
jobRuns: The `JobRun` objects.
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
unreachable: Locations that could not be reached
r. r Tr1 r r) r N) r
r r r r r" r= jobRunsr# rQ rR r r r r ra ra s?
" "8Q >'''*-%%a$7+r ra c ` \ rS rSrSr\R " SSSS9r\R " S5 r Sr
g )
ListLocationsResponsei zThe response message for Locations.ListLocations.
Fields:
locations: A list of locations that matches the specified filter in the
request.
nextPageToken: The standard List next-page token.
Locationr Tr1 r r N) r
r r r r r" r= locationsr# rQ r r r r rd rd s- $$ZTB)''*-r rd c \ rS rSrSr\R " S5 r\R " SSSS9r \R " SSS9r
S r g
) ListOperationsResponsei a The response message for Operations.ListOperations.
Fields:
nextPageToken: The standard List next-page token.
operations: A list of operations that matches the specified filter in the
request.
unreachable: Unordered list. Unreachable resources. Populated when the
request sets `ListOperationsRequest.return_partial_success` and reads
across collections e.g. when attempting to list all resources across all
supported locations.
r Operationr Tr1 r) r N) r
r r r r r" r# rQ r=
operationsrR r r r r rh rh s?
''*-%%k1tD*%%a$7+r rh c \ rS rSrSr\R " S5 r\R " SSSS9r \R " SSS9r
S r g
) ListReleasesResponsei a The response object from `ListReleases`.
Fields:
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
releases: The `Release` objects.
unreachable: Locations that could not be reached.
r r r Tr1 r) r N) r
r r r r r" r# rQ r= releasesrR r r r r rl rl ? ''*-
#
#Iq4
@(%%a$7+r rl c \ rS rSrSr\R " S5 r\R " SSSS9r \R " SSS9r
S r g
) ListRolloutsResponsei a< ListRolloutsResponse is the response object returned by `ListRollouts`.
Fields:
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
rollouts: The `Rollout` objects.
unreachable: Locations that could not be reached.
r r r Tr1 r) r N) r
r r r r r" r# rQ r= rolloutsrR r r r r rp rp rn r rp c \ rS rSrSr\R " S5 r\R " SSSS9r \R " SSS9r
S r g
) ListTargetsResponsei a The response object from `ListTargets`.
Fields:
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
targets: The `Target` objects.
unreachable: Locations that could not be reached.
r r r Tr1 r) r N) r
r r r r r" r# rQ r= r rR r r r r rs rs s? ''*- " "8Q >'%%a$7+r rs c x \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " S5 r \R " SS 5 r\R " S
5 r\R " SS 5 r\R " S 5 rS
rg)re i# aM A resource that represents a Google Cloud location.
Messages:
LabelsValue: Cross-service attributes for the location. For example
{"cloud.googleapis.com/region": "us-east1"}
MetadataValue: Service-specific metadata. For example the available
capacity at the given location.
Fields:
displayName: The friendly name for this location, typically a nearby city
name. For example, "Tokyo".
labels: Cross-service attributes for the location. For example
{"cloud.googleapis.com/region": "us-east1"}
locationId: The canonical id for this location. For example: `"us-east1"`.
metadata: Service-specific metadata. For example the available capacity at
the given location.
name: Resource name for the location, which may vary between
implementations. For example: `"projects/example-project/locations/us-
east1"`
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Location.LabelsValuei9 a Cross-service attributes for the location. For example
{"cloud.googleapis.com/region": "us-east1"}
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)'Location.LabelsValue.AdditionalPropertyiE rK r r r NrL r r r rO rx E rP r rO r Tr1 r NrQ r r r rS rv 9 rT r rS c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Location.MetadataValueiR a Service-specific metadata. For example the available capacity at the
given location.
Messages:
AdditionalProperty: An additional property for a MetadataValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g))Location.MetadataValue.AdditionalPropertyi_ An additional property for a MetadataValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r extra_types.JsonValuer r N r
r r r r r" r# rM r= rN r r r r rO r| _ ,
! !! $c$$%B ))*:A>. Q "%%a(+
4a
8%r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
Sr g)
PhaseArtifactiV a Contains the paths to the artifacts, relative to the URI, for a phase.
Fields:
backendServicePath: Output only. File path of the rendered backend service
configuration relative to the URI.
jobManifestsPath: Output only. File path of the directory of rendered job
manifests relative to the URI. This is only set if it is applicable.
manifestPath: Output only. File path of the rendered manifest relative to
the URI.
skaffoldConfigPath: Output only. File path of the resolved Skaffold
configuration relative to the URI.
r r r) r* r N) r
r r r r r" r# backendServicePathjobManifestsPath manifestPathskaffoldConfigPathr r r r r r V sL !,,Q/ **1-&&q), ,,Q/r r c d \ rS rSrSr\R " SS5 r\R " S\R R S9r \R " S5 r
\R " SS 5 r\R " S
S 5 r\R " S S
S9r\R" " S5 r\R " SS5 rSrg)rA ij a5 PhaseConfig represents the configuration for a phase in the custom
canary deployment.
Fields:
analysis: Optional. Configuration for the analysis job of this phase. If
this is not configured, there will be no analysis job for this phase.
percentage: Required. Percentage deployment for the phase.
phaseId: Required. The ID to assign to the `Rollout` phase. 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])?$`.
postdeploy: Optional. Configuration for the postdeploy job of this phase.
If this is not configured, there will be no postdeploy job for this
phase.
predeploy: Optional. Configuration for the predeploy job of this phase. If
this is not configured, there will be no predeploy job for this phase.
profiles: Optional. Skaffold profiles to use when rendering the manifest
for this phase. These are in addition to the profiles list specified in
the `DeliveryPipeline` stage.
verify: Optional. Whether to run verify tests after the deployment via
`skaffold verify`.
verifyConfig: Optional. Configuration for the verify job. Cannot be set if
`verify` is set to true.
rf r r rf r) r r* r rb r Tr1 r r! r r N)r
r r r r r" r= r" r# r$ r%
percentager# r4 r' r( profilesr} r) r* r r r r rA rA j s 4
#
#J
2(%%a1B1B1H1HI* ! !! $'%%lA6*$$[!4)
"
"1t
4( ! !! $&''!4,r rA c \ rS rSrSr\R " SS5 r\R " SS5 r\R " SS5 r S r
g
) r i a^ PipelineCondition contains all conditions relevant to a Delivery
Pipeline.
Fields:
pipelineReadyCondition: Details around the Pipeline's overall status.
targetsPresentCondition: Details around targets enumerated in the
pipeline.
targetsTypeCondition: Details on the whether the targets enumerated in the
pipeline are of the same type.
PipelineReadyConditionr r r TargetsTypeConditionr) r N) r
r r r r r" r= pipelineReadyConditionr targetsTypeConditionr r r r r r sE %112JAN % 2 23La P"//0FJr r c ` \ rS rSrSr\R " S5 r\R " S5 r Sr
g)r i a PipelineReadyCondition contains information around the status of the
Pipeline.
Fields:
status: 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.
updateTime: Last time the condition was updated.
r r r N) r
r r r r r" r} statusr# r r r r r r r s) ! !! $&$$Q'*r r c \ rS rSrSr\R " SSSS9r\R " SSSS9r\R " S 5 r
\R " S
\R R S 9rS rg
)Policyi aw 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/).
Fields:
auditConfigs: Specifies cloud audit logging configuration for this policy.
bindings: 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`.
etag: `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.
version: 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).
r r Tr1 r
r r) r* rf r N)r
r r r r r" r= auditConfigsbindings
BytesFieldr r# r$ r% versionr r r r r r sa EN ''
q4H,
#
#Iq4
@( a $ " "1i.?.?.E.E F'r r c > \ rS rSrSr\R " SS5 rSrg)r i zSDeploy Policy rule.
Fields:
rolloutRestriction: Optional. Rollout restrictions.
RolloutRestrictionr r N) r
r r r r r" r= rolloutRestrictionr r r r r r s !--.BAFr r c < \ rS rSrSr\R " SSSS9rSrg) r i zReturned from an action if one or more policies were violated, and
therefore the action was prevented. Contains information about what policies
were violated and why.
Fields:
policyViolationDetails: Policy violation details.
PolicyViolationDetailsr Tr1 r N) r
r r r r r" r= policyViolationDetailsr r r r r r s %112JAX\]r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)r i a~ Policy violation details.
Fields:
failureMessage: User readable message about why the request violated a
policy. This is not intended for machine parsing.
policy: Name of the policy that was violated. Policy resource will be in
the format of
`projects/{project}/locations/{location}/policies/{policy}`.
ruleId: Id of the rule that triggered the policy violation.
r r r) r N) r
r r r r r" r# rd policyr r r r r r r s9 ((+. #& #&r r c ^ \ rS rSrSr\R " SSS9r\R " SSSS9r Sr
g )
r i% a Postdeploy contains the postdeploy job configuration information.
Fields:
actions: Optional. A sequence of Skaffold custom actions to invoke during
execution of the postdeploy job.
tasks: Optional. The tasks that will run as a part of the postdeploy job.
The tasks are executed sequentially in the order specified. Only one of
`actions` or `tasks` can be specified.
r Tr1 rD r r N r
r r r r r" r# actionsr= ry r r r r r r % /
! !!d 3'
T
:%r r c ^ \ rS rSrSr\R " SSS9r\R " SSSS9r Sr
g )
r' i4 zA postdeploy Job.
Fields:
actions: Output only. The custom actions that the postdeploy Job executes.
tasks: Output only. The tasks that are executed as part of the postdeploy
Job.
r Tr1 rD r r Nr r r r r' r' 4 /
! !!d 3'
T
:%r r' c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r \R " S5 r Sr
g )
r3 iA a PostdeployJobRun contains information specific to a postdeploy `JobRun`.
Enums:
FailureCauseValueValuesEnum: Output only. The reason the postdeploy
failed. This will always be unspecified while the postdeploy is in
progress or if it succeeded.
Fields:
build: Output only. The resource name of the Cloud Build `Build` object
that is used to execute the custom actions associated with the
postdeploy Job. Format is
`projects/{project}/locations/{location}/builds/{build}`.
failureCause: Output only. The reason the postdeploy failed. This will
always be unspecified while the postdeploy is in progress or if it
succeeded.
failureMessage: Output only. Additional information about the postdeploy
failure, if available.
c , \ rS rSrSrSrSrSrSrSr Sr
g )
,PostdeployJobRun.FailureCauseValueValuesEnumiU a( Output only. The reason the postdeploy failed. This will always be
unspecified while the postdeploy is in progress or if it succeeded.
Values:
FAILURE_CAUSE_UNSPECIFIED: No reason for failure is specified.
CLOUD_BUILD_UNAVAILABLE: Cloud Build is not available, either because it
is not enabled or because Cloud Deploy has insufficient permissions.
See [required permission](https://cloud.google.com/deploy/docs/cloud-
deploy-service-account#required_permissions).
EXECUTION_FAILED: The postdeploy operation did not complete
successfully; check Cloud Build logs.
DEADLINE_EXCEEDED: The postdeploy job run did not complete within the
allotted time.
CLOUD_BUILD_REQUEST_FAILED: Cloud Build failed to fulfill Cloud Deploy's
request. See failure_message for additional details.
r r r r) r* r NrJ r r r rP r U ' !" !" r rP r r r) r Nr
r r r r r" r rP r# r r rR rd r r r r r3 r3 A sL &#INN #.
"%$$%BAF, ((+.r r3 c ^ \ rS rSrSr\R " SSS9r\R " SSSS9r Sr
g )
r iq a{ Predeploy contains the predeploy job configuration information.
Fields:
actions: Optional. A sequence of Skaffold custom actions to invoke during
execution of the predeploy job.
tasks: Optional. The tasks that will run as a part of the predeploy job.
The tasks are executed sequentially in the order specified. Only one of
`actions` or `tasks` can be specified.
r Tr1 rD r r Nr r r r r r q r r r c ^ \ rS rSrSr\R " SSS9r\R " SSSS9r Sr
g )
r( i zA predeploy Job.
Fields:
actions: Output only. The custom actions that the predeploy Job executes.
tasks: Output only. The tasks that are executed as part of the predeploy
Job.
r Tr1 rD r r Nr r r r r( r( r r r( c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r \R " S5 r Sr
g )
r4 i a PredeployJobRun contains information specific to a predeploy `JobRun`.
Enums:
FailureCauseValueValuesEnum: Output only. The reason the predeploy failed.
This will always be unspecified while the predeploy is in progress or if
it succeeded.
Fields:
build: Output only. The resource name of the Cloud Build `Build` object
that is used to execute the custom actions associated with the predeploy
Job. Format is `projects/{project}/locations/{location}/builds/{build}`.
failureCause: Output only. The reason the predeploy failed. This will
always be unspecified while the predeploy is in progress or if it
succeeded.
failureMessage: Output only. Additional information about the predeploy
failure, if available.
c , \ rS rSrSrSrSrSrSrSr Sr
g )
+PredeployJobRun.FailureCauseValueValuesEnumi a$ Output only. The reason the predeploy failed. This will always be
unspecified while the predeploy is in progress or if it succeeded.
Values:
FAILURE_CAUSE_UNSPECIFIED: No reason for failure is specified.
CLOUD_BUILD_UNAVAILABLE: Cloud Build is not available, either because it
is not enabled or because Cloud Deploy has insufficient permissions.
See [required permission](https://cloud.google.com/deploy/docs/cloud-
deploy-service-account#required_permissions).
EXECUTION_FAILED: The predeploy operation did not complete successfully;
check Cloud Build logs.
DEADLINE_EXCEEDED: The predeploy job run did not complete within the
allotted time.
CLOUD_BUILD_REQUEST_FAILED: Cloud Build failed to fulfill Cloud Deploy's
request. See failure_message for additional details.
r r r r) r* r NrJ r r r rP r r r rP r r r) r Nr r r r r4 r4 sL $#INN #.
"%$$%BAF, ((+.r r4 c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)r i a Execution using a private Cloud Build pool.
Fields:
artifactStorage: 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.
serviceAccount: Optional. Google service account to use for execution. If
unspecified, the project execution service account
(-compute@developer.gserviceaccount.com) will be used.
workerPool: Required. Resource name of the Cloud Build worker pool to use.
The format is
`projects/{project}/locations/{location}/workerPools/{pool}`.
r r r) r N) r
r r r r r" r# r r r r r r r r r s9
))!,/ ((+.$$Q'*r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
Sr g) r i a Contains the information of an automated promote-release operation.
Fields:
phase: Output only. The starting phase of the rollout created by this
operation.
rollout: Output only. The name of the rollout that initiates the
`AutomationRun`.
targetId: Output only. The ID of the target that represents the promotion
stage to which the release will be promoted. The value of this field is
the last segment of a target name.
wait: Output only. How long the operation will be paused.
r r r) r* r N) r
r r r r r" r# phaser$ r r- r r r r r r sI
"% ! !! $'
"
"1
%( q !$r r c \ rS rSrSr\R " SS5 r\R " S5 r \R " S5 r
\R " S5 r \R " S5 r S r
g
) r i a The `PromoteRelease` rule will automatically promote a release from the
current target to a specified target.
Fields:
condition: Output only. Information around the state of the Automation
rule.
destinationPhase: Optional. The starting phase of the rollout created by
this operation. Default to the first phase.
destinationTargetId: Optional. The ID of the stage in the pipeline to
which this `Release` is deploying. If unspecified, default it to the
next stage in the promotion flow. The value of this field could be one
of the following: * The last segment of a target name * "@next", the
next target in the promotion sequence
id: 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])?`.
wait: Optional. How long the release need to be paused until being
promoted to the next target.
r< r r r) r* rb r N)r
r r r r r" r= r> r# r+ r r? r- r r r r r r s^ ( $$%>B) **1-!--a0 Q " q !$r r c 4 \ rS rSrSr " S S\R 5 r\R " S5 " S S\R 5 5 r \R " S5 " S S \R 5 5 r \R " S5 " S
S \R 5 5 r
\R " S5 " S S
\R 5 5 r\R " S5 " S S\R 5 5 r\R " S5 r\R$ " SS5 r\R$ " SSSS9r\R$ " SS5 r\R, " S5 r\R$ " SSSS9r\R$ " SS 5 r\R$ " S S 5 r\R, " S 5 r\R, " S 5 r \R$ " S S 5 r \R, " S!5 r \R, " S"5 r \R, " S#5 r \RB " SS$5 r"\R, " S%5 r#\R, " S&5 r$\R, " S'5 r%\R$ " S
S(5 r&\R$ " SS)5 r'\R$ " S*S+SS9r(\R$ " S,S-5 r)\R, " S.5 r*S/r+g0)1r i a A `Release` resource in the Cloud Deploy API. A `Release` defines a
specific Skaffold configuration instance that can be deployed.
Enums:
RenderStateValueValuesEnum: Output only. Current state of the render
operation.
Messages:
AnnotationsValue: 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.
DeployParametersValue: Optional. The deploy parameters to use for all
targets in this release.
LabelsValue: 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.
TargetArtifactsValue: Output only. Map from target ID to the target
artifacts created during the render operation.
TargetRendersValue: Output only. Map from target ID to details of the
render operation for that target.
Fields:
abandoned: Output only. Indicates whether this is an abandoned release.
annotations: 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.
buildArtifacts: Optional. List of artifacts to pass through to Skaffold
command.
condition: Output only. Information around the state of the Release.
createTime: Output only. Time at which the `Release` was created.
customTargetTypeSnapshots: Output only. Snapshot of the custom target
types referenced by the targets taken at release creation time.
deliveryPipelineSnapshot: Output only. Snapshot of the parent pipeline
taken at release creation time.
deployParameters: Optional. The deploy parameters to use for all targets
in this release.
description: Optional. Description of the `Release`. Max length is 255
characters.
etag: 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.
labels: 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.
name: Identifier. Name of the `Release`. Format is `projects/{project}/loc
ations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release
}`. The `release` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
renderEndTime: Output only. Time at which the render completed.
renderStartTime: Output only. Time at which the render began.
renderState: Output only. Current state of the render operation.
skaffoldConfigPath: Optional. Filepath of the Skaffold config inside of
the config URI.
skaffoldConfigUri: Optional. Cloud Storage URI of tar.gz archive
containing Skaffold configuration.
skaffoldVersion: Optional. The Skaffold version to use when operating on
this release, such as "1.20.0". Not all versions are valid; Cloud Deploy
supports a specific set of versions. If unset, the most recent supported
Skaffold version will be used.
targetArtifacts: Output only. Map from target ID to the target artifacts
created during the render operation.
targetRenders: Output only. Map from target ID to details of the render
operation for that target.
targetSnapshots: Output only. Snapshot of the targets taken at release
creation time.
toolVersions: Optional. The tool versions to use for this release and all
subsequent operations involving this release. If unset, then it will
freeze the tool versions at the time of release creation.
uid: Output only. Unique identifier of the `Release`.
c ( \ rS rSrSrSrSrSrSrSr g) "Release.RenderStateValueValuesEnumiT aK Output only. Current state of the render operation.
Values:
RENDER_STATE_UNSPECIFIED: The render state is unspecified.
SUCCEEDED: All rendering operations have completed successfully.
FAILED: All rendering operations have completed, and one or more have
failed.
IN_PROGRESS: Rendering has started and is not complete.
r r r r) r N
r
r r r r RENDER_STATE_UNSPECIFIEDr r r r r r r RenderStateValueValuesEnumr T ! I
FKr r rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Release.AnnotationsValueic ro c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)+Release.AnnotationsValue.AdditionalPropertyir r r r r NrL r r r rO r r rP r rO r Tr1 r NrQ r r r r r c rr r r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Release.DeployParametersValuei a Optional. The deploy parameters to use for all targets in this
release.
Messages:
AdditionalProperty: An additional property for a DeployParametersValue
object.
Fields:
additionalProperties: Additional properties of type
DeployParametersValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)0Release.DeployParametersValue.AdditionalPropertyi An additional property for a DeployParametersValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r NrL r r r rO r rP r rO r Tr1 r NrQ r r r DeployParametersValuer s2
'Y . . ' %112FTXYr r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Release.LabelsValuei r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)&Release.LabelsValue.AdditionalPropertyi rK r r r NrL r r r rO r rP r rO r Tr1 r NrQ r r r rS r r r rS c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Release.TargetArtifactsValuei a Output only. Map from target ID to the target artifacts created during
the render operation.
Messages:
AdditionalProperty: An additional property for a TargetArtifactsValue
object.
Fields:
additionalProperties: Additional properties of type TargetArtifactsValue
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)/Release.TargetArtifactsValue.AdditionalPropertyi zAn additional property for a TargetArtifactsValue object.
Fields:
key: Name of the additional property.
value: A TargetArtifact attribute.
r TargetArtifactr r Nr r r r rO r s,
! !! $c$$%5q9er rO r Tr1 r NrQ r r r TargetArtifactsValuer s2 :Y . . : %112FTXYr r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Release.TargetRendersValuei a Output only. Map from target ID to details of the render operation for
that target.
Messages:
AdditionalProperty: An additional property for a TargetRendersValue
object.
Fields:
additionalProperties: Additional properties of type TargetRendersValue
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)-Release.TargetRendersValue.AdditionalPropertyi zAn additional property for a TargetRendersValue object.
Fields:
key: Name of the additional property.
value: A TargetRender attribute.
r TargetRenderr r Nr r r r rO r s+
! !! $c$$^Q7er rO r Tr1 r NrQ r r r TargetRendersValuer s2 8Y . . 8 %112FTXYr r r r r r) Tr1 ReleaseConditionr* rb rV r r r r r r r r r r r r
r r r r r r N),r
r r r r r" r r r rU rR r r rS r r r} abandonedr= r buildArtifactsr> r# r customTargetTypeSnapshotsdeliveryPipelineSnapshotdeployParametersr r rW r
renderEndTimerenderStartTimer renderStater skaffoldConfigUriskaffoldVersiontargetArtifacts
targetRenderstargetSnapshots toolVersionsr r r r r r r s Pd
9>>
!!"89Z** Z :Z6 !!"89Zi / / Z :Z4 !!"89 ZI%% Z : Z< !!"89ZY . . Z :Z2 !!"89Z9,, Z :Z2 $$Q')&&'91=+ ))/1tL.$$%7;)$$Q'* ' 4 45GUY Z & 3 34F J ++,CQG%%a(+ r "$ ! !- 4& r "$''+- ))"-/##$@"E+ ,,R0 ++B/ ))"-/ **+A2F/(()=rB- **8R$G/'';, b!#r r c H \ rS rSrSr\R " SS5 r\R " SS5 r\R " SS5 r \R " SS5 r
\R " SS5 r \R " S S
5 r \R " S S 5 r
\R " SS
5 rSrg)r i a ReleaseCondition contains all conditions relevant to a Release.
Fields:
dockerVersionSupportedCondition: Output only. Details around the support
state of the release's Docker version.
helmVersionSupportedCondition: Output only. Details around the support
state of the release's Helm version.
kptVersionSupportedCondition: Output only. Details around the support
state of the release's Kpt version.
kubectlVersionSupportedCondition: Output only. Details around the support
state of the release's Kubectl version.
kustomizeVersionSupportedCondition: Output only. Details around the
support state of the release's Kustomize version.
releaseReadyCondition: Details around the Releases's overall status.
skaffoldSupportedCondition: Details around the support state of the
release's Skaffold version.
skaffoldVersionSupportedCondition: Output only. Details around the support
state of the release's Skaffold version.
ToolVersionSupportedConditionr r r) r* rb ReleaseReadyConditionr SkaffoldSupportedConditionr r r N)r
r r r r r" r= dockerVersionSupportedCondition helmVersionSupportedCondition kptVersionSupportedCondition kubectlVersionSupportedCondition"kustomizeVersionSupportedConditionreleaseReadyConditionskaffoldSupportedCondition!skaffoldVersionSupportedConditionr r r r r r s ( %.$:$:;Z\]$^!"+"8"89XZ["\ !*!7!78WYZ![ %.%;%;<[]^%_"'0'='=>]_`'a$#001H!L ( 5 56RTU V &/&<&<=\^_&`#r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " S5 r \R " S5 r \R " SS 5 rS
rg ) ReleaseNotificationEventi% a Payload proto for "clouddeploy.googleapis.com/release_notification"
Platform Log event that describes the failure to send release status change
Pub/Sub notification.
Enums:
TypeValueValuesEnum: Type of this notification, e.g. for a Pub/Sub
failure.
Fields:
message: Debug message for when a notification fails to send.
pipelineUid: Unique identifier of the `DeliveryPipeline`.
release: The name of the `Release`.
releaseUid: Unique identifier of the `Release`.
type: Type of this notification, e.g. for a Pub/Sub failure.
c < \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rg
),ReleaseNotificationEvent.TypeValueValuesEnumi6 r r r r r) r* rb r r r r Nr r r r r r 6 r r r r r r) r* rb r N)r
r r r r r" r r r# r r r rC r r r r r r r r % sl #INN #4
! !! $'%%a(+ ! !! $'$$Q'* 2A 6$r r c < \ rS rSrSr\R " S5 rSrg)r iW a ReleaseReadyCondition contains information around the status of the
Release. If a release is not ready, you cannot create a rollout with the
release.
Fields:
status: True if the Release is in a valid state. Otherwise at least one
condition in `ReleaseCondition` 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 Release.
r r N) r
r r r r r" r} r r r r r r r W s ! !! $&r r c $ \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " S5 r
\R " S5 r \R " S 5 r \R " SS
5 r\R " SS 5 rS rg
)ReleaseRenderEventif a@ Payload proto for "clouddeploy.googleapis.com/release_render" Platform
Log event that describes the render status change.
Enums:
ReleaseRenderStateValueValuesEnum: The state of the release render.
TypeValueValuesEnum: Type of this notification, e.g. for a release render
state change event.
Fields:
message: Debug message for when a render transition occurs. Provides
further details as rendering progresses through render states.
pipelineUid: Unique identifier of the `DeliveryPipeline`.
release: The name of the release. release_uid is not in this log message
because we write some of these log messages at release creation time,
before we've generated the uid.
releaseRenderState: The state of the release render.
type: Type of this notification, e.g. for a release render state change
event.
c ( \ rS rSrSrSrSrSrSrSr g) 4ReleaseRenderEvent.ReleaseRenderStateValueValuesEnumi{ a8 The state of the release render.
Values:
RENDER_STATE_UNSPECIFIED: The render state is unspecified.
SUCCEEDED: All rendering operations have completed successfully.
FAILED: All rendering operations have completed, and one or more have
failed.
IN_PROGRESS: Rendering has started and is not complete.
r r r r) r Nr r r r !ReleaseRenderStateValueValuesEnumr# { r r r$ c < \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rg
)&ReleaseRenderEvent.TypeValueValuesEnumi a` Type of this notification, e.g. for a release render state change
event.
Values:
TYPE_UNSPECIFIED: Type is unspecified.
TYPE_PUBSUB_NOTIFICATION_FAILURE: A Pub/Sub notification failed to be
sent.
TYPE_RESOURCE_STATE_CHANGE: Resource state changed.
TYPE_PROCESS_ABORTED: A process aborted.
TYPE_RESTRICTION_VIOLATED: Restriction check failed.
TYPE_RESOURCE_DELETED: Resource deleted.
TYPE_ROLLOUT_UPDATE: Rollout updated.
TYPE_DEPLOY_POLICY_EVALUATION: Deploy Policy evaluation.
TYPE_RENDER_STATUES_CHANGE: Deprecated: This field is never used. Use
release_render log type instead.
r r r r) r* rb r r r r Nr r r r r r& s? '($!" ! $%!!" r r r r r) r* rb r N)r
r r r r r" r r$ r r# r r r r releaseRenderStater r r r r r! r! f s (
)..
#INN #6
! !! $'%%a(+ ! !! $' **+NPQR 2A 6$r r! c \ rS rSrSr\R " SS5 r\R " SS5 r\R " SS5 r S r
g
) RenderMetadatai am RenderMetadata includes information associated with a `Release` render.
Fields:
cloudRun: Output only. Metadata associated with rendering for Cloud Run.
custom: Output only. Custom metadata provided by user-defined render
operation.
kubernetes: Output only. Metadata associated with rendering for a
Kubernetes cluster (GKE or GKE Enterprise target).
rL r rQ r rL r) r N) r
r r r r r" r= r r
kubernetesr r r r r) r) sB
#
#$ r# r? jobsphasesr8 r r r r r r se 6 $$%>B) Q " q4 0$ T 2&''(;QN,r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r \R " S5 r
Srg )
r4 i aD Retries the failed job.
Enums:
BackoffModeValueValuesEnum: Optional. The pattern of how wait time will be
increased. Default is linear. Backoff mode will be ignored if `wait` is
0.
Fields:
attempts: Required. Total number of retries. Retry is skipped if set to 0;
The minimum value is 1, and the maximum value is 10.
backoffMode: Optional. The pattern of how wait time will be increased.
Default is linear. Backoff mode will be ignored if `wait` is 0.
wait: Optional. How long to wait for the first retry. Default is 0, and
the maximum value is 14d.
c $ \ rS rSrSrSrSrSrSrg) Retry.BackoffModeValueValuesEnumi a5 Optional. The pattern of how wait time will be increased. Default is
linear. Backoff mode will be ignored if `wait` is 0.
Values:
BACKOFF_MODE_UNSPECIFIED: No WaitMode is specified.
BACKOFF_MODE_LINEAR: Increases the wait time linearly.
BACKOFF_MODE_EXPONENTIAL: Increases the wait time exponentially.
r r r r N r
r r r r BACKOFF_MODE_UNSPECIFIEDBACKOFF_MODE_LINEARBACKOFF_MODE_EXPONENTIALr r r r BackoffModeValueValuesEnumr> ! r rC r r r) r N)r
r r r r r" r rC r# attemptsr backoffModer# r- r r r r r4 r4 sL !9>> !
#
#A
&(##$@!D+ q !$r r4 c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r \R " S5 r
\R " S5 rS rg
) RetryAttempti1 a RetryAttempt represents an action of retrying the failed Cloud Deploy
job.
Enums:
StateValueValuesEnum: Output only. Valid state of this retry action.
Fields:
attempt: Output only. The index of this retry attempt.
state: Output only. Valid state of this retry action.
stateDesc: Output only. Description of the state of the Retry.
wait: Output only. How long the operation will be paused.
c 4 \ rS rSrSrSrSrSrSrSr Sr
S r S
r g ) !RetryAttempt.StateValueValuesEnumi? a Output only. Valid state of this retry action.
Values:
REPAIR_STATE_UNSPECIFIED: The `repair` has an unspecified state.
REPAIR_STATE_SUCCEEDED: The `repair` action has succeeded.
REPAIR_STATE_CANCELLED: The `repair` action was cancelled.
REPAIR_STATE_FAILED: The `repair` action has failed.
REPAIR_STATE_IN_PROGRESS: The `repair` action is in progress.
REPAIR_STATE_PENDING: The `repair` action is pending.
REPAIR_STATE_ABORTED: The `repair` action was aborted.
r r r r) r* rb r r N
r
r r r r REPAIR_STATE_UNSPECIFIEDREPAIR_STATE_SUCCEEDEDREPAIR_STATE_CANCELLEDREPAIR_STATE_FAILEDREPAIR_STATE_IN_PROGRESSREPAIR_STATE_PENDINGREPAIR_STATE_ABORTEDr r r r r rJ ? 3
! r r r r r) r* r N)r
r r r r r" r r r# attemptr r r# stateDescr- r r r r rH rH 1 s\ Y^^ (
" "1 %'
4a
8%##A&) q !$r rH c \ rS rSrSr\R " S5 r\R " SSS9r\R " S5 r Sr
g )
r iY aL RetryJobRequest is the request object used by `RetryJob`.
Fields:
jobId: Required. The job ID for the Job to retry.
overrideDeployPolicy: Optional. Deploy policies to override. Format is
`projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
phaseId: Required. The phase ID the Job to retry belongs to.
r r Tr1 r) r Nr r r r r r Y r r r c \ rS rSrSrSrg)RetryJobResponseih z$The response object from 'RetryJob'.r Nr r r r rX rX h s -r rX c \ rS rSrSr " S S\R 5 r\R " SSSS9r \R " SS 5 r \R " S
5 r
S rg )
r- il a RetryPhase contains the retry attempts and the metadata for initiating a
new attempt.
Enums:
BackoffModeValueValuesEnum: Output only. The pattern of how the wait time
of the retry attempt is calculated.
Fields:
attempts: Output only. Detail of a retry action.
backoffMode: Output only. The pattern of how the wait time of the retry
attempt is calculated.
totalAttempts: Output only. The number of attempts that have been made.
c $ \ rS rSrSrSrSrSrSrg)%RetryPhase.BackoffModeValueValuesEnumi{ a
Output only. The pattern of how the wait time of the retry attempt is
calculated.
Values:
BACKOFF_MODE_UNSPECIFIED: No WaitMode is specified.
BACKOFF_MODE_LINEAR: Increases the wait time linearly.
BACKOFF_MODE_EXPONENTIAL: Increases the wait time exponentially.
r r r r Nr? r r r rC r[ { rD r rC rH r Tr1 r r) r N)r
r r r r r" r rC r= rE r rF r#
totalAttemptsr r r r r- r- l sP !9>> !
#
#NA
E(##$@!D+((+-r r- c ` \ rS rSrSr\R " S5 r\R " S5 r Sr
g)r5 i a, Rolls back a `Rollout`.
Fields:
destinationPhase: Optional. The starting phase ID for the `Rollout`. If
unspecified, the `Rollout` will start in the stable phase.
disableRollbackIfRolloutPending: Optional. If pending rollout exists on
the target, the rollback operation will be aborted.
r r r N) r
r r r r r" r# r+ r} disableRollbackIfRolloutPendingr r r r r5 r5 s+ **1-$-$:$:1$=!r r5 c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r \R " S5 r \R " SS5 r\R " S 5 rS
rg ) r. i a7 RollbackAttempt represents an action of rolling back a Cloud Deploy
'Target'.
Enums:
StateValueValuesEnum: Output only. Valid state of this rollback action.
Fields:
destinationPhase: Output only. The phase to which the rollout will be
rolled back to.
disableRollbackIfRolloutPending: Output only. If active rollout exists on
the target, abort this rollback.
rolloutId: Output only. ID of the rollback `Rollout` to create.
state: Output only. Valid state of this rollback action.
stateDesc: Output only. Description of the state of the Rollback.
c 4 \ rS rSrSrSrSrSrSrSr Sr
S r S
r g ) $RollbackAttempt.StateValueValuesEnumi a Output only. Valid state of this rollback action.
Values:
REPAIR_STATE_UNSPECIFIED: The `repair` has an unspecified state.
REPAIR_STATE_SUCCEEDED: The `repair` action has succeeded.
REPAIR_STATE_CANCELLED: The `repair` action was cancelled.
REPAIR_STATE_FAILED: The `repair` action has failed.
REPAIR_STATE_IN_PROGRESS: The `repair` action is in progress.
REPAIR_STATE_PENDING: The `repair` action is pending.
REPAIR_STATE_ABORTED: The `repair` action was aborted.
r r r r) r* rb r r NrK r r r r ra rS r r r r r) r* rb r N)r
r r r r r" r r r# r+ r} r^ r r r rU r r r r r. r. sn Y^^ ( **1-$-$:$:1$=!##A&)
4a
8%##A&)r r. c b \ rS rSrSr\R " SS5 r\R " S5 r Sr
g)RollbackTargetConfigi zConfigs for the Rollback rollout.
Fields:
rollout: Optional. The rollback `Rollout` to create.
startingPhaseId: Optional. The starting phase ID for the `Rollout`. If
unspecified, the `Rollout` will start in the stable phase.
r r r r N) r
r r r r r" r= r$ r# r r r r r rc rc s+
" "9a 0' ))!,/r rc c \ rS rSrSr\R " SSS9r\R " S5 r\R " SS5 r
\R " S 5 r \R " S
5 r \R " S 5 r
\R " S 5 rS
rg)r i a= The request object for `RollbackTarget`.
Fields:
overrideDeployPolicy: Optional. Deploy policies to override. Format is
`projects/{project}/locations/{location}/deployPolicies/{deploy_policy}`
.
releaseId: Optional. ID of the `Release` to roll back to. If this isn't
specified, the previous successful `Rollout` to the specified target
will be used to determine the `Release`.
rollbackConfig: Optional. Configs for the rollback `Rollout`.
rolloutId: Required. ID of the rollback `Rollout` to create.
rolloutToRollBack: Optional. If provided, this must be the latest
`Rollout` that is on the `Target`.
targetId: Required. ID of the `Target` that is being rolled back.
validateOnly: Optional. If set to true, the request is validated and the
user is provided with a `RollbackTargetResponse`.
r Tr1 r rc r) r* rb r r r N)r
r r r r r" r# r3 r r= rollbackConfigr rolloutToRollBackr r} r] r r r r r r s $ #..q4@##A&) ))*@!D.##A&) ++A.
"
"1
%(''*,r r c > \ rS rSrSr\R " SS5 rSrg)RollbackTargetResponsei zThe response object from `RollbackTarget`.
Fields:
rollbackConfig: The config of the rollback `Rollout` created or will be
created.
rc r r N) r
r r r r r" r= re r r r r rh rh s ))*@!D.r rh c \ rS rSrSr " S S\R 5 r " S S\R 5 r " S S\R 5 r \
R " S 5 " S
S \R 5 5 r
\
R " S 5 " S S
\R 5 5 r\R " S5 r\R" " S S5 r\R& " SS5 r\R " S5 r\R " S5 r\R " S5 r\R " S5 r\R& " SS5 r\R " S5 r\R " S5 r\R " S5 r \R " S5 r \R " S5 r \R " S5 r \R" " S
S 5 r \R" " S S 5 r!\R " S 5 r"\R" " S S!S"S#9r#\R " S$5 r$\R " S%S"S#9r%\R& " SS&5 r&\R " S'5 r'\R " S(5 r(S)r)g*)+r i a A `Rollout` resource in the Cloud Deploy API. A `Rollout` contains
information around a specific deployment to a `Target`.
Enums:
ApprovalStateValueValuesEnum: Output only. Approval state of the
`Rollout`.
DeployFailureCauseValueValuesEnum: Output only. The reason this rollout
failed. This will always be unspecified while the rollout is in
progress.
StateValueValuesEnum: Output only. Current state of the `Rollout`.
Messages:
AnnotationsValue: 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.
LabelsValue: 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.
Fields:
activeRepairAutomationRun: Output only. The AutomationRun actively
repairing the rollout.
annotations: 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.
approvalState: Output only. Approval state of the `Rollout`.
approveTime: Output only. Time at which the `Rollout` was approved.
controllerRollout: Output only. Name of the `ControllerRollout`. Format is
`projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipe
line}/releases/{release}/rollouts/{rollout}`.
createTime: Output only. Time at which the `Rollout` was created.
deployEndTime: Output only. Time at which the `Rollout` finished
deploying.
deployFailureCause: Output only. The reason this rollout failed. This will
always be unspecified while the rollout is in progress.
deployStartTime: Output only. Time at which the `Rollout` started
deploying.
deployingBuild: 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}`.
description: Optional. Description of the `Rollout` for user purposes. Max
length is 255 characters.
enqueueTime: Output only. Time at which the `Rollout` was enqueued.
etag: 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.
failureReason: Output only. Additional information about the rollout
failure, if available.
labels: 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.
metadata: Output only. Metadata contains information about the rollout.
name: Identifier. Name of the `Rollout`. Format is `projects/{project}/loc
ations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release
}/rollouts/{rollout}`. The `rollout` component must match
`[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
phases: Output only. The phases that represent the workflows of this
`Rollout`.
rollbackOfRollout: Output only. Name of the `Rollout` that is rolled back
by this `Rollout`. Empty if this `Rollout` wasn't created as a rollback.
rolledBackByRollouts: Output only. Names of `Rollouts` that rolled back
this `Rollout`.
state: Output only. Current state of the `Rollout`.
targetId: Required. The ID of Target to which this `Rollout` is deploying.
uid: Output only. Unique identifier of the `Rollout`.
c , \ rS rSrSrSrSrSrSrSr Sr
g )
$Rollout.ApprovalStateValueValuesEnumiK aZ Output only. Approval state of the `Rollout`.
Values:
APPROVAL_STATE_UNSPECIFIED: The `Rollout` has an unspecified approval
state.
NEEDS_APPROVAL: The `Rollout` requires approval.
DOES_NOT_NEED_APPROVAL: The `Rollout` does not require approval.
APPROVED: The `Rollout` has been approved.
REJECTED: The `Rollout` has been rejected.
r r r r) r* r N) r
r r r r APPROVAL_STATE_UNSPECIFIEDNEEDS_APPROVALDOES_NOT_NEED_APPROVALAPPROVEDREJECTEDr r r r ApprovalStateValueValuesEnumrk K s$ "# N HHr rq c < \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rg
))Rollout.DeployFailureCauseValueValuesEnumi\ a Output only. The reason this rollout failed. This will always be
unspecified while the rollout is in progress.
Values:
FAILURE_CAUSE_UNSPECIFIED: No reason for failure is specified.
CLOUD_BUILD_UNAVAILABLE: Cloud Build is not available, either because it
is not enabled or because Cloud Deploy has insufficient permissions.
See [required permission](https://cloud.google.com/deploy/docs/cloud-
deploy-service-account#required_permissions).
EXECUTION_FAILED: The deploy operation did not complete successfully;
check Cloud Build logs.
DEADLINE_EXCEEDED: Deployment did not complete within the allotted time.
RELEASE_FAILED: Release is in a failed state.
RELEASE_ABANDONED: Release is abandoned.
VERIFICATION_CONFIG_NOT_FOUND: No Skaffold verify configuration was
found.
CLOUD_BUILD_REQUEST_FAILED: Cloud Build failed to fulfill Cloud Deploy's
request. See failure_message for additional details.
OPERATION_FEATURE_NOT_SUPPORTED: A Rollout operation had a feature
configured that is not supported.
r r r r) r* rb r r r r N)r
r r r r rK rL rM rN RELEASE_FAILEDRELEASE_ABANDONED VERIFICATION_CONFIG_NOT_FOUNDrO OPERATION_FEATURE_NOT_SUPPORTEDr r r r !DeployFailureCauseValueValuesEnumrs \ s> * !" N$%!!" &'#r rx c D \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrg) Rollout.StateValueValuesEnumi| a Output only. Current state of the `Rollout`.
Values:
STATE_UNSPECIFIED: The `Rollout` has an unspecified state.
SUCCEEDED: The `Rollout` has completed successfully.
FAILED: The `Rollout` has failed.
IN_PROGRESS: The `Rollout` is being deployed.
PENDING_APPROVAL: The `Rollout` needs approval.
APPROVAL_REJECTED: An approver rejected the `Rollout`.
PENDING: The `Rollout` is waiting for an earlier Rollout(s) to complete
on this `Target`.
PENDING_RELEASE: The `Rollout` is waiting for the `Release` to be fully
rendered.
CANCELLING: The `Rollout` is in the process of being cancelled.
CANCELLED: The `Rollout` has been cancelled.
HALTED: The `Rollout` is halted.
r r r r) r* rb r r r r r r N)r
r r r r r r r r PENDING_APPROVALAPPROVAL_REJECTEDr PENDING_RELEASE
CANCELLINGr HALTEDr r r r r rz | sC " I
FKGOJI
Fr r rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Rollout.AnnotationsValuei ro c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)+Rollout.AnnotationsValue.AdditionalPropertyi r r r r NrL r r r rO r rP r rO r Tr1 r NrQ r r r r r rr r r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Rollout.LabelsValuei r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)&Rollout.LabelsValue.AdditionalPropertyi rK r r r NrL r r r rO r rP r rO r Tr1 r NrQ r r r rS r r r rS r r r) r* rb r r r r r r r r r r r r
r r r Tr1 r r r r r r N)*r
r r r r r" r rq rx r r rU rR r rS r# activeRepairAutomationRunr= r r
approvalState approveTimecontrollerRolloutr
deployEndTimedeployFailureCausedeployStartTimedeployingBuildr enqueueTimer
failureReasonrW rT r r; rollbackOfRolloutrolledBackByRolloutsr r r r r r r r r s( M^Y^^ " ().. (@ Y^^ < !!"89Z** Z :Z6 !!"89 ZI%% Z : Z< ( 3 3A 6&&'91=+%%&DaH-%%a(+ ++A.$$Q'*''*- **+NPQR ))!,/ ((,.%%b)+%%b)+ r "$''+- ! !- 4&
#
#J
3( r "$ ! !'2 =& ++B/"..rDA
4b
9%
"
"2
&( b!#r r c d \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " S5 r \R " S5 r \R " S 5 r
\R " S
5 r\R " S 5 r\R " SS 5 rS
rg)RolloutNotificationEventi a Payload proto for "clouddeploy.googleapis.com/rollout_notification"
Platform Log event that describes the failure to send rollout status change
Pub/Sub notification.
Enums:
TypeValueValuesEnum: Type of this notification, e.g. for a Pub/Sub
failure.
Fields:
message: Debug message for when a notification fails to send.
pipelineUid: Unique identifier of the `DeliveryPipeline`.
release: The name of the `Release`.
releaseUid: Unique identifier of the `Release`.
rollout: The name of the `Rollout`.
rolloutUid: Unique identifier of the `Rollout`.
targetId: ID of the `Target` that the rollout is deployed to.
type: Type of this notification, e.g. for a Pub/Sub failure.
c < \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rg
),RolloutNotificationEvent.TypeValueValuesEnumi r r r r r) r* rb r r r r Nr r r r r r r r r r r r) r* rb r r r r N)r
r r r r r" r r r# r r r rC r$ rD r r r r r r r r r s &#INN #4
! !! $'%%a(+ ! !! $'$$Q'* ! !! $'$$Q'*
"
"1
%( 2A 6$r r c \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " SSSS 9r
\R " S
5 r \R " SS SS 9r
\R " S S
5 rSrg)r i& a- Rollout restrictions.
Enums:
ActionsValueListEntryValuesEnum:
InvokersValueListEntryValuesEnum:
Fields:
actions: Optional. Rollout actions to be restricted as part of the policy.
If left empty, all actions will be restricted.
id: Required. Restriction rule ID. Required and must be unique within a
DeployPolicy. The format is `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
invokers: Optional. What invoked the action. If left empty, all invoker
types will be restricted.
timeWindows: Required. Time window within which actions are restricted.
c < \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rg
)2RolloutRestriction.ActionsValueListEntryValuesEnumi7 a ActionsValueListEntryValuesEnum enum type.
Values:
ROLLOUT_ACTIONS_UNSPECIFIED: Unspecified.
ADVANCE: Advance the rollout to the next phase.
APPROVE: Approve the rollout.
CANCEL: Cancel the rollout.
CREATE: Create a rollout.
IGNORE_JOB: Ignore a job result on the rollout.
RETRY_JOB: Retry a job for a rollout.
ROLLBACK: Rollback a rollout.
TERMINATE_JOBRUN: Terminate a jobrun.
r r r r) r* rb r r r r N)r
r r r r ROLLOUT_ACTIONS_UNSPECIFIEDADVANCEAPPROVECANCELCREATE
IGNORE_JOB RETRY_JOBROLLBACKTERMINATE_JOBRUNr r r r ActionsValueListEntryValuesEnumr 7 s8 #$ GG
F
FJIHr r c $ \ rS rSrSrSrSrSrSrg)3RolloutRestriction.InvokersValueListEntryValuesEnumiO zInvokersValueListEntryValuesEnum enum type.
Values:
INVOKER_UNSPECIFIED: Unspecified.
USER: The action is user-driven. For example, creating a rollout
manually via a gcloud create command.
DEPLOY_AUTOMATION: Automated action by Cloud Deploy.
r r r r Nr r r r InvokersValueListEntryValuesEnumr O r r r r Tr1 r r) TimeWindowsr* r N)r
r r r r r" r r r r r r# r? invokersr= timeWindowsr r r r r r & sv 0
A1t T' Q "
!CQQU
V(&&}a8+r r c \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " S5 r
\R " S5 r \R " S 5 r \R " S
5 r
\R " S 5 r\R " SS 5 r\R " S
5 r\R " SS5 rSrg)RolloutUpdateEventib a? Payload proto for "clouddeploy.googleapis.com/rollout_update" Platform
Log event that describes the rollout update event.
Enums:
RolloutUpdateTypeValueValuesEnum: The type of the rollout update.
TypeValueValuesEnum: Type of this notification, e.g. for a rollout update
event.
Fields:
message: Debug message for when a rollout update event occurs.
pipelineUid: Unique identifier of the pipeline.
release: The name of the `Release`.
releaseUid: Unique identifier of the release.
rollout: The name of the rollout. rollout_uid is not in this log message
because we write some of these log messages at rollout creation time,
before we've generated the uid.
rolloutUpdateType: The type of the rollout update.
targetId: ID of the target.
type: Type of this notification, e.g. for a rollout update event.
c P \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrg)3RolloutUpdateEvent.RolloutUpdateTypeValueValuesEnumix a The type of the rollout update.
Values:
ROLLOUT_UPDATE_TYPE_UNSPECIFIED: Rollout update type unspecified.
PENDING: Rollout state updated to pending (release has succeeded,
waiting on the rollout to start).
PENDING_RELEASE: Rollout state updated to pending release.
IN_PROGRESS: Rollout state updated to in progress.
CANCELLING: Rollout state updated to cancelling.
CANCELLED: Rollout state updated to cancelled.
HALTED: Rollout state updated to halted.
SUCCEEDED: Rollout state updated to succeeded.
FAILED: Rollout state updated to failed.
APPROVAL_REQUIRED: Rollout requires approval.
APPROVED: Rollout has been approved.
REJECTED: Rollout has been rejected.
ADVANCE_REQUIRED: Rollout requires advance to the next phase.
ADVANCED: Rollout has been advanced.
r r r r) r* rb r r r r r r r r r N)r
r r r r ROLLOUT_UPDATE_TYPE_UNSPECIFIEDr r} r r~ r r r r APPROVAL_REQUIREDro rp ADVANCE_REQUIREDADVANCEDr r r r RolloutUpdateTypeValueValuesEnumr x sR & '(#GOKJI
FI
FHHHr r c < \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rg
)&RolloutUpdateEvent.TypeValueValuesEnumi aS Type of this notification, e.g. for a rollout update event.
Values:
TYPE_UNSPECIFIED: Type is unspecified.
TYPE_PUBSUB_NOTIFICATION_FAILURE: A Pub/Sub notification failed to be
sent.
TYPE_RESOURCE_STATE_CHANGE: Resource state changed.
TYPE_PROCESS_ABORTED: A process aborted.
TYPE_RESTRICTION_VIOLATED: Restriction check failed.
TYPE_RESOURCE_DELETED: Resource deleted.
TYPE_ROLLOUT_UPDATE: Rollout updated.
TYPE_DEPLOY_POLICY_EVALUATION: Deploy Policy evaluation.
TYPE_RENDER_STATUES_CHANGE: Deprecated: This field is never used. Use
release_render log type instead.
r r r r) r* rb r r r r Nr r r r r r r r r r r r) r* rb r r r r N)r
r r r r r" r r r r# r r r rC r$ r rolloutUpdateTyper r r r r r r r b s *! !F#INN #4
! !! $'%%a(+ ! !! $'$$Q'* ! !! $' ))*LaP
"
"1
%( 2A 6$r r c ^ \ rS rSrSr\R " SSS9r\R " S5 r Sr
g) r i a Information about route destinations for the Gateway API service mesh.
Fields:
destinationIds: Required. The clusters where the Gateway API HTTPRoute
resource will be deployed to. Valid entries include the associated
entities IDs configured in the Target resource and "@self" to include
the Target cluster.
propagateService: Optional. Whether to propagate the Kubernetes Service to
the route destination clusters. The Service will always be deployed to
the Target cluster even if the HTTPRoute is not. This option may be used
to facilitate successful DNS lookup in the route destination clusters.
Can only be set to true if destinations are specified.
r Tr1 r r N) r
r r r r r" r# destinationIdsr} propagateServicer r r r r r s, ((T:. ++A.r r c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g) r i zRuntimeConfig contains the runtime specific configurations for a
deployment strategy.
Fields:
cloudRun: Optional. Cloud Run runtime configuration.
kubernetes: Optional. Kubernetes runtime configuration.
r= r rF r r N)
r
r r r r r" r= r r* r r r r r r s/
#
#$4a
8(%%&8!<*r r c < \ rS rSrSr\R " SSSS9rSrg) r i zSerialPipeline defines a sequential set of stages for a
`DeliveryPipeline`.
Fields:
stages: Optional. Each stage specifies configuration for a `Target`. The
ordering of this list defines the promotion flow.
Stager Tr1 r N) r
r r r r r" r= stagesr r r r r r s ! !'1t <&r r c \ rS rSrSr\R " S5 r\R " S5 r \R " S5 r
\R " S5 r Sr g) rG i a Information about the Kubernetes Service networking configuration.
Fields:
deployment: Required. Name of the Kubernetes Deployment whose traffic is
managed by the specified Service.
disablePodOverprovisioning: Optional. Whether to disable Pod
overprovisioning. If Pod overprovisioning is disabled then Cloud Deploy
will limit the number of total Pods used for the deployment strategy to
the number of Pods the Deployment has on the cluster.
podSelectorLabel: Optional. The label to use when selecting Pods for the
Deployment resource. This label must already be present in the
Deployment.
service: Required. Name of the Kubernetes Service.
r r r) r* r N)
r
r r r r r" r# rO r} disablePodOverprovisioningrR r r r r r rG rG sK
$$Q'* ( 5 5a 8 **1- ! !! $'r rG c b \ rS rSrSr\R " SS5 r\R " S5 r Sr
g)r} i a
Request message for `SetIamPolicy` method.
Fields:
policy: REQUIRED: The complete policy to be applied to the `resource`. The
size of the policy is limited to a few 10s of KB. An empty policy is a
valid policy but certain Google Cloud services (such as Projects) might
reject them.
updateMask: OPTIONAL: A FieldMask specifying which fields of the policy to
modify. Only the fields in the mask will be modified. If no mask is
provided, the following default mask is used: `paths: "bindings, etag"`
r r r r N) r
r r r r r" r= r r# ry r r r r r} r} s+
! !(A .&$$Q'*r r} c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)SkaffoldGCBRepoSourcei a Cloud Build V2 Repository containing Skaffold Configs.
Fields:
path: Optional. Relative path from the repository root to the Skaffold
Config file.
ref: Optional. Branch or tag to use when cloning the repository.
repository: Required. Name of the Cloud Build V2 Repository. Format is pro
jects/{project}/locations/{location}/connections/{connection}/repositori
es/{repository}.
r r r) r N) r
r r r r r" r# pathref
repositoryr r r r r r s9
q !$ a #$$Q'*r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)SkaffoldGCSSourcei# av Cloud Storage bucket containing Skaffold Config modules.
Fields:
path: Optional. Relative path from the source to the Skaffold file.
source: Required. Cloud Storage source paths to copy recursively. For
example, providing "gs://my-bucket/dir/configs/*" will result in
Skaffold copying all files within the "dir/configs" directory in the
bucket "my-bucket".
r r r N)
r
r r r r r" r# r sourcer r r r r r # s)
q !$ #&r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)SkaffoldGitSourcei2 a Git repository containing Skaffold Config modules.
Fields:
path: Optional. Relative path from the repository root to the Skaffold
file.
ref: Optional. Git branch or tag to use when cloning the repository.
repo: Required. Git repository the package should be cloned from.
r r r) r N) r
r r r r r" r# r r repor r r r r r 2 s9
q !$ a # q !$r r c \ rS rSrSr\R " SSS9r\R " SS5 r \R " SS 5 r
\R " S
S 5 r S r g
)rd iA a Skaffold Config modules and their remote source.
Fields:
configs: Optional. The Skaffold Config modules to use from the specified
source.
git: Optional. Remote git repository containing the Skaffold Config
modules.
googleCloudBuildRepo: Optional. Cloud Build V2 repository containing the
Skaffold Config modules.
googleCloudStorage: Optional. Cloud Storage bucket containing the Skaffold
Config modules.
r Tr1 r r r r) r r* r N)
r
r r r r r" r# configsr= gitgoogleCloudBuildRepogoogleCloudStorager r r r rd rd A sV
! !!d 3' 2A6#"//0GK --.A1Er rd c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r \R " S5 r
\R " S5 rS rg
) r iU av SkaffoldSupportedCondition contains information about when support for
the release's version of Skaffold ends.
Enums:
SkaffoldSupportStateValueValuesEnum: The Skaffold support state for this
release's version of Skaffold.
Fields:
maintenanceModeTime: The time at which this release's version of Skaffold
will enter maintenance mode.
skaffoldSupportState: The Skaffold support state for this release's
version of Skaffold.
status: True if the version of Skaffold used by this release is supported.
supportExpirationTime: The time at which this release's version of
Skaffold will no longer be supported.
c ( \ rS rSrSrSrSrSrSrSr g) >SkaffoldSupportedCondition.SkaffoldSupportStateValueValuesEnumig a The Skaffold support state for this release's version of Skaffold.
Values:
SKAFFOLD_SUPPORT_STATE_UNSPECIFIED: Default value. This value is unused.
SKAFFOLD_SUPPORT_STATE_SUPPORTED: This Skaffold version is currently
supported.
SKAFFOLD_SUPPORT_STATE_MAINTENANCE_MODE: This Skaffold version is in
maintenance mode.
SKAFFOLD_SUPPORT_STATE_UNSUPPORTED: This Skaffold version is no longer
supported.
r r r r) r N)
r
r r r r "SKAFFOLD_SUPPORT_STATE_UNSPECIFIED SKAFFOLD_SUPPORT_STATE_SUPPORTED'SKAFFOLD_SUPPORT_STATE_MAINTENANCE_MODE"SKAFFOLD_SUPPORT_STATE_UNSUPPORTEDr r r r #SkaffoldSupportStateValueValuesEnumr g s!
*+&'($./+)*&r r r r r) r* r N)r
r r r r r" r r r# maintenanceModeTimer skaffoldSupportStater} r supportExpirationTimer r r r r r U s` "+INN +" "--a0",,-RTUV ! !! $&#//2r r c \ rS rSrSr\R " S5 r\R " SS5 r \R " S5 r
\R " S5 r Sr g )
r i~ a Details of a supported Skaffold version.
Fields:
maintenanceModeTime: The time at which this version of Skaffold will enter
maintenance mode.
supportEndDate: Date when this version is expected to no longer be
supported.
supportExpirationTime: The time at which this version of Skaffold will no
longer be supported.
version: Release version number. For example, "1.20.3".
r r r r) r* r N)
r
r r r r r" r# r r= supportEndDater r r r r r r r ~ sM
"--a0 ))&!4.#//2 ! !! $'r r c \ rS rSrSr\R " SSSS9r\R " SSS9r \R " SS 5 r
\R " S
5 r S r g )
r i a Stage specifies a location to which to deploy.
Fields:
deployParameters: Optional. The deploy parameters to use for the target in
this stage.
profiles: Optional. Skaffold profiles to use when rendering the manifest
for this stage's `Target`.
strategy: Optional. The strategy to use for a `Rollout` to this stage.
targetId: Optional. The target_id to which this stage points. This field
refers exclusively to the last segment of a target name. For example,
this field would just be `my-target` (rather than
`projects/project/locations/location/targets/my-target`). The location
of the `Target` is inferred to be the same as the location of the
`DeliveryPipeline` that contains this `Stage`.
r r Tr1 r Strategyr) r* r N)
r
r r r r r" r= r r# r strategyr r r r r r r sS ++,>DQ
"
"1t
4(
#
#J
2(
"
"1
%(r r c \ rS rSrSr\R " SS5 r\R " SS5 r\R " SS5 r \R " S 5 r \R " S
S 5 r S r
g
)Standardi ay Standard represents the standard deployment strategy.
Fields:
analysis: Optional. Configuration for the analysis job. If this is not
configured, the analysis job will not be present.
postdeploy: Optional. Configuration for the postdeploy job. If this is not
configured, the postdeploy job will not be present.
predeploy: Optional. Configuration for the predeploy job. If this is not
configured, the predeploy job will not be present.
verify: Optional. Whether to verify a deployment via `skaffold verify`.
verifyConfig: Optional. Configuration for the verify job. Cannot be set if
`verify` is set to true.
rf r r r r r) r* r! rb r N)r
r r r r r" r= r" r' r( r} r) r* r r r r r r sa
#
#J
2(%%lA6*$$[!4) ! !! $&''!4,r r c \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " SS5 r
\R " S5 r \R " SS S
S 9r
\R " S 5 r\R " S
5 r\R " S5 r\R " S5 r\R$ " SSS 9r\R " S5 r\R " S5 r\R " S5 r\R " S5 rSrg)StandardQueryParametersi a Query parameters accepted by all methods.
Enums:
FXgafvValueValuesEnum: V1 error format.
AltValueValuesEnum: Data format for response.
Fields:
f__xgafv: V1 error format.
access_token: OAuth access token.
alt: Data format for response.
callback: JSONP
fields: Selector specifying which fields to include in a partial response.
key: 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.
oauth_token: OAuth 2.0 token for the current user.
prettyPrint: Returns response with indentations and line breaks.
quotaUser: 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.
trace: A tracing token of the form "token:" to include in api
requests.
uploadType: Legacy upload protocol for media (e.g. "media", "multipart").
upload_protocol: Upload protocol for media (e.g. "raw", "multipart").
c $ \ rS rSrSrSrSrSrSrg)*StandardQueryParameters.AltValueValuesEnumi zData format for response.
Values:
json: Responses with Content-Type of application/json
media: Media download with context-dependent Content-Type
proto: Responses with Content-Type of application/x-protobuf
r r r r N) r
r r r r jsonmediaprotor r r r AltValueValuesEnumr s
D
E
Er r c \ rS rSrSrSrSrSrg)-StandardQueryParameters.FXgafvValueValuesEnumi zFV1 error format.
Values:
_1: v1 error format
_2: v2 error format
r r r N)r
r r r r _1_2r r r r FXgafvValueValuesEnumr s
B
Br r r r r) r )defaultr* rb r r r Tr r r r r N)r
r r r r r" r r r r f__xgafvr# access_tokenaltcallbackfieldsrM oauth_tokenr} prettyPrint quotaUsertrace
uploadTypeupload_protocolr r r r r r s 4
9>>
inn
!8!
<(&&q), 0!VD#
"
"1
%( #& a #%%a(+&&q$7+##A&)
#%$$R(* ))"-/r r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S\R R S9r
\R " SSS S
9r\R " S 5 rS rg
)r i a The `Status` type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It is
used by [gRPC](https://github.com/grpc). Each `Status` message contains
three pieces of data: error code, error message, and error details. You can
find out more about this error model and how to work with it in the [API
Design Guide](https://cloud.google.com/apis/design/errors).
Messages:
DetailsValueListEntry: A DetailsValueListEntry object.
Fields:
code: The status code, which should be an enum value of google.rpc.Code.
details: A list of messages that carry the error details. There is a
common set of message types for APIs to use.
message: A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
google.rpc.Status.details field, or localized by the client.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Status.DetailsValueListEntryi zA DetailsValueListEntry object.
Messages:
AdditionalProperty: An additional property for a DetailsValueListEntry
object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)/Status.DetailsValueListEntry.AdditionalPropertyi zAn additional property for a DetailsValueListEntry object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r~ r r Nr r r r rO r r r rO r Tr1 r NrQ r r r DetailsValueListEntryr r r r r rf r Tr1 r) r N)r
r r r r r rU r" rR r r# r$ r% coder= detailsr# r r r r r r r s| & !!"89Zi / / Z :Z2
9+<+<+B+B C$ " "#:A M' ! !! $'r r c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g) r i0 a# Strategy contains deployment strategy information.
Fields:
canary: Optional. Canary deployment strategy provides progressive
percentage based deployments to a Target.
standard: Optional. Standard deployment strategy executes a single deploy
and allows verifying the deployment.
r r r r r N)
r
r r r r r" r= canarystandardr r r r r r 0 s- ! !(A .&
#
#J
2(r r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " S5 " S S \R 5 5 r \R " S5 " S
S \R 5 5 r \R " SS 5 r\R " S
S5 r\R " SS5 r\R" " S5 r\R " SS5 r\R " S S5 r\R" " S5 r\R" " S5 r\R " SSSS9r\R " SS5 r\R " S S 5 r\R " S S 5 r\R" " S 5 r\R8 " S 5 r \R " S!S"5 r \R" " S#5 r \R" " S$5 r \R" " S%5 r!S&r"g')(r i> a A `Target` resource in the Cloud Deploy API. A `Target` defines a
location to which a Skaffold configuration can be deployed.
Messages:
AnnotationsValue: 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.
AssociatedEntitiesValue: Optional. Map of entity IDs to their associated
entities. Associated entities allows specifying places other than the
deployment target for specific features. For example, the Gateway API
canary can be configured to deploy the HTTPRoute to a different
cluster(s) than the deployment cluster using associated entities. An
entity ID 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])?$`.
DeployParametersValue: Optional. The deploy parameters to use for this
target.
LabelsValue: 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.
Fields:
annotations: 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.
anthosCluster: Optional. Information specifying an Anthos Cluster.
associatedEntities: Optional. Map of entity IDs to their associated
entities. Associated entities allows specifying places other than the
deployment target for specific features. For example, the Gateway API
canary can be configured to deploy the HTTPRoute to a different
cluster(s) than the deployment cluster using associated entities. An
entity ID 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])?$`.
createTime: Output only. Time at which the `Target` was created.
customTarget: Optional. Information specifying a Custom Target.
deployParameters: Optional. The deploy parameters to use for this target.
description: Optional. Description of the `Target`. Max length is 255
characters.
etag: 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.
executionConfigs: Optional. Configurations for all execution that relates
to this `Target`. Each `ExecutionEnvironmentUsage` value may only be
used in a single configuration; using the same value multiple times is
an error. When one or more configurations are specified, they must
include the `RENDER` and `DEPLOY` `ExecutionEnvironmentUsage` values.
When no configurations are specified, execution will use the default
specified in `DefaultPool`.
gke: Optional. Information specifying a GKE Cluster.
labels: 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.
multiTarget: Optional. Information specifying a multiTarget.
name: Identifier. Name of the `Target`. Format is
`projects/{project}/locations/{location}/targets/{target}`. The `target`
component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
requireApproval: Optional. Whether or not the `Target` requires approval.
run: Optional. Information specifying a Cloud Run deployment target.
targetId: Output only. Resource id of the `Target`.
uid: Output only. Unique identifier of the `Target`.
updateTime: Output only. Most recent time at which the `Target` was
updated.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Target.AnnotationsValuei ro c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)*Target.AnnotationsValue.AdditionalPropertyi r r r r NrL r r r rO r rP r rO r Tr1 r NrQ r r r r r rr r r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Target.AssociatedEntitiesValuei a Optional. Map of entity IDs to their associated entities. Associated
entities allows specifying places other than the deployment target for
specific features. For example, the Gateway API canary can be configured
to deploy the HTTPRoute to a different cluster(s) than the deployment
cluster using associated entities. An entity ID 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])?$`.
Messages:
AdditionalProperty: An additional property for a AssociatedEntitiesValue
object.
Fields:
additionalProperties: Additional properties of type
AssociatedEntitiesValue
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)1Target.AssociatedEntitiesValue.AdditionalPropertyi zAn additional property for a AssociatedEntitiesValue object.
Fields:
key: Name of the additional property.
value: A AssociatedEntities attribute.
r r r r Nr r r r rO r s,
! !! $c$$%91=er rO r Tr1 r NrQ r r r AssociatedEntitiesValuer
s2 $ >Y . . > %112FTXYr r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Target.DeployParametersValuei zOptional. The deploy parameters to use for this target.
Messages:
AdditionalProperty: An additional property for a DeployParametersValue
object.
Fields:
additionalProperties: Additional properties of type
DeployParametersValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)/Target.DeployParametersValue.AdditionalPropertyi r r r r NrL r r r rO r rP r rO r Tr1 r NrQ r r r r r r& r r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Target.LabelsValuei ru c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)%Target.LabelsValue.AdditionalPropertyi rK r r r NrL r r r rO r rP r rO r Tr1 r NrQ r r r rS r r r rS r ry r r) r* r^ rb r r r r r Tr1 r r r r r r r rC r r
r r r N)#r
r r r r r rU r" rR r r r rS r= r
anthosClusterassociatedEntitiesr# r r r r r executionConfigsgkerW multiTargetr r} requireApprovalrunr r r r r r r r r > s
M^ !!"89Z** Z :Z6 !!"89 Z 1 1 Z : Z@ !!"89Zi / / Z :Z2 !!"89 ZI%% Z : Z< &&'91=+(( !<- --.GK$$Q'*'':, ++,CQG%%a(+ q !$ ++,=q4P |R0# ! !- 4&&&}b9+ r "$ **2./ 126#
"
"2
&( b!#$$R(*r r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 r \R " S5 r \R " SS5 r\R " S 5 rS
rg ) r i a The artifacts produced by a target render operation.
Messages:
PhaseArtifactsValue: Output only. Map from the phase ID to the phase
artifacts for the `Target`.
Fields:
artifactUri: Output only. URI of a directory containing the artifacts.
This contains deployment configuration used by Skaffold during a
rollout, and all paths are relative to this location.
manifestPath: Output only. File path of the rendered manifest relative to
the URI for the stable phase.
phaseArtifacts: Output only. Map from the phase ID to the phase artifacts
for the `Target`.
skaffoldConfigPath: Output only. File path of the resolved Skaffold
configuration for the stable phase, relative to the URI.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
"TargetArtifact.PhaseArtifactsValuei+ zOutput only. Map from the phase ID to the phase artifacts for the
`Target`.
Messages:
AdditionalProperty: An additional property for a PhaseArtifactsValue
object.
Fields:
additionalProperties: Additional properties of type PhaseArtifactsValue
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)5TargetArtifact.PhaseArtifactsValue.AdditionalPropertyi8 zAn additional property for a PhaseArtifactsValue object.
Fields:
key: Name of the additional property.
value: A PhaseArtifact attribute.
r r r r Nr r r r rO r$ 8 s+
! !! $c$$_a8er rO r Tr1 r NrQ r r r PhaseArtifactsValuer" + s2 9Y . . 9 %112FTXYr r% r r r) r* r N)r
r r r r r rU r" rR r% r# r r r= phaseArtifactsr r r r r r r s} $ !!"89ZI - - Z :Z2 %%a(+&&q), ))*?C. ,,Q/r r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 r \R " SS5 r
Srg )
r iK ak Contains criteria for selecting Targets. This could be used to select
targets for a Deploy Policy or for an Automation.
Messages:
LabelsValue: Target labels.
Fields:
id: Optional. ID of the `Target`. The value of this field could be one of
the following: * The last segment of a target name * "*", all targets in
a location
labels: Target labels.
rD c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
TargetAttribute.LabelsValueiY zTarget labels.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g).TargetAttribute.LabelsValue.AdditionalPropertyid rK r r r NrL r r r rO r+ d rP r rO r Tr1 r NrQ r r r rS r) Y r/ r rS r r r Nr r r r r r K s[ !!"89ZI%% Z :Z. Q " ! !- 3&r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " SS5 r Sr
g )
TargetNotificationEventiu a Payload proto for "clouddeploy.googleapis.com/target_notification"
Platform Log event that describes the failure to send target status change
Pub/Sub notification.
Enums:
TypeValueValuesEnum: Type of this notification, e.g. for a Pub/Sub
failure.
Fields:
message: Debug message for when a notification fails to send.
target: The name of the `Target`.
type: Type of this notification, e.g. for a Pub/Sub failure.
c < \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rg
)+TargetNotificationEvent.TypeValueValuesEnumi r r r r r) r* rb r r r r Nr r r r r r/ r r r r r r) r N)r
r r r r r" r r r# r r r r r r r r r- r- u sL #INN #4
! !! $' #& 2A 6$r r- c & \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " SS5 r
\R " S5 r \R " S S
5 r\R " S 5 r\R " SS 5 rS
rg)r i a Details of rendering for a single target.
Enums:
FailureCauseValueValuesEnum: Output only. Reason this render failed. This
will always be unspecified while the render in progress.
RenderingStateValueValuesEnum: Output only. Current state of the render
operation for this Target.
Fields:
failureCause: Output only. Reason this render failed. This will always be
unspecified while the render in progress.
failureMessage: Output only. Additional information about the render
failure, if available.
metadata: Output only. Metadata related to the `Release` render for this
Target.
renderingBuild: Output only. The resource name of the Cloud Build `Build`
object that is used to render the manifest for this target. Format is
`projects/{project}/locations/{location}/builds/{build}`.
renderingState: Output only. Current state of the render operation for
this Target.
c < \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rg
)(TargetRender.FailureCauseValueValuesEnumi a2 Output only. Reason this render failed. This will always be
unspecified while the render in progress.
Values:
FAILURE_CAUSE_UNSPECIFIED: No reason for failure is specified.
CLOUD_BUILD_UNAVAILABLE: Cloud Build is not available, either because it
is not enabled or because Cloud Deploy has insufficient permissions.
See [required permission](https://cloud.google.com/deploy/docs/cloud-
deploy-service-account#required_permissions).
EXECUTION_FAILED: The render operation did not complete successfully;
check Cloud Build logs.
CLOUD_BUILD_REQUEST_FAILED: Cloud Build failed to fulfill Cloud Deploy's
request. See failure_message for additional details.
VERIFICATION_CONFIG_NOT_FOUND: The render operation did not complete
successfully because the verification stanza required for verify was
not found on the Skaffold configuration.
CUSTOM_ACTION_NOT_FOUND: The render operation did not complete
successfully because the custom action(s) required for Rollout jobs
were not found in the Skaffold configuration. See failure_message for
additional details.
DEPLOYMENT_STRATEGY_NOT_SUPPORTED: Release failed during rendering
because the release configuration is not supported with the specified
deployment strategy.
RENDER_FEATURE_NOT_SUPPORTED: The render operation had a feature
configured that is not supported.
TASK_NOT_FOUND: The render operation did not complete successfully
because the task(s) required for Rollout jobs were not found in the
configuration file. See failure_message for additional details.
r r r r) r* rb r r r r N)r
r r r r rK rL rM rO rv CUSTOM_ACTION_NOT_FOUND!DEPLOYMENT_STRATEGY_NOT_SUPPORTED RENDER_FEATURE_NOT_SUPPORTEDTASK_NOT_FOUNDr r r r rP r2 s> : !" !" $%! ()%#$ Nr rP c ( \ rS rSrSrSrSrSrSrSr g) *TargetRender.RenderingStateValueValuesEnumi a< Output only. Current state of the render operation for this Target.
Values:
TARGET_RENDER_STATE_UNSPECIFIED: The render operation state is
unspecified.
SUCCEEDED: The render operation has completed successfully.
FAILED: The render operation has failed.
IN_PROGRESS: The render operation is in progress.
r r r r) r N)
r
r r r r TARGET_RENDER_STATE_UNSPECIFIEDr r r r r r r RenderingStateValueValuesEnumr8 s '(#I
FKr r: r r r) r) r* rb r N)r
r r r r r" r rP r: r rR r# rd r= rT renderingBuildrenderingStater r r r r r s ,&INN &P
inn
$$%BAF, ((+.
#
#$4a
8( ((+. &&'FJ.r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)Targetsi zThe targets involved in a single timed promotion.
Fields:
destinationTargetId: Optional. The destination target ID.
sourceTargetId: Optional. The source target ID.
r r r N)
r
r r r r r" r# r sourceTargetIdr r r r r> r> s* "--a0 ((+.r r> c \ rS rSrSr\R " SSS9r\R " S5 r \R " S5 r
Sr g )
r i a `TargetsPresentCondition` contains information on any Targets referenced
in the Delivery Pipeline that do not actually exist.
Fields:
missingTargets: The list of Target names that do not exist. For example,
`projects/{project_id}/locations/{location_name}/targets/{target_name}`.
status: True if there aren't any missing Targets.
updateTime: Last time the condition was updated.
r Tr1 r r) r N) r
r r r r r" r# missingTargetsr} r r r r r r r r s; ((T:. ! !! $&$$Q'*r r c ` \ rS rSrSr\R " S5 r\R " S5 r Sr
g)r i a{ TargetsTypeCondition contains information on whether the Targets defined
in the Delivery Pipeline are of the same type.
Fields:
errorDetails: Human readable error message.
status: True if the targets are all a comparable type. For example this is
true if all targets are GKE clusters. This is false if some targets are
Cloud Run targets and others are GKE clusters.
r r r N) r
r r r r r" r# errorDetailsr} r r r r r r r s) &&q), ! !! $&r r c \ rS rSrSr\R " SS5 r\R " SS5 r\R " SS5 r S r
g
) rD i# a A Task represents a unit of work that is executed as part of a Job.
Fields:
config: Optional. This task is represented by either a task in the Deploy
Config or a custom action in the Skaffold Config.
container: Optional. This task is represented by a container that is
executed in the Cloud Build execution environment.
containersTask: Optional. This task is represented by a set of containers
that are executed in parallel in the Cloud Build execution environment.
r r r4 r r: r) r N) r
r r r r r" r= config containercontainersTaskr r r r rD rD # s@ ! !, 2&$$_a8) ))*:A>.r rD c : \ rS rSrSr\R " SSS9rSrg)r i4 zThe request object used by `TerminateJobRun`.
Fields:
overrideDeployPolicy: Optional. Deploy policies to override. Format is
`projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
r Tr1 r Nr3 r r r r r 4 r4 r r c \ rS rSrSrSrg)TerminateJobRunResponsei? z+The response object from `TerminateJobRun`.r Nr r r r rJ rJ ? s 4r rJ c : \ rS rSrSr\R " SSS9rSrg)r iC a3 Request message for `TestIamPermissions` method.
Fields:
permissions: The set of permissions to check for the `resource`.
Permissions with wildcards (such as `*` or `storage.*`) are not allowed.
For more information see [IAM
Overview](https://cloud.google.com/iam/docs/overview#permissions).
r Tr1 r N r
r r r r r" r# permissionsr r r r r r C s %%a$7+r r c : \ rS rSrSr\R " SSS9rSrg)TestIamPermissionsResponseiP zResponse message for `TestIamPermissions` method.
Fields:
permissions: A subset of `TestPermissionsRequest.permissions` that the
caller is allowed.
r Tr1 r NrL r r r rO rO P s %%a$7+r rO c @ \ rS rSrSr\R " S\R R S9r \R " S\R R S9r
\R " S\R R S9r \R " S\R R S9r Sr
g )
r i[ aS Represents a time of day. The date and time zone are either not
significant or are specified elsewhere. An API may choose to allow leap
seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
Fields:
hours: Hours of a day in 24 hour format. Must be greater than or equal to
0 and typically must be less than or equal to 23. An API may choose to
allow the value "24:00:00" for scenarios like business closing time.
minutes: Minutes of an hour. Must be greater than or equal to 0 and less
than or equal to 59.
nanos: Fractions of seconds, in nanoseconds. Must be greater than or equal
to 0 and less than or equal to 999,999,999.
seconds: Seconds of a minute. Must be greater than or equal to 0 and
typically must be less than or equal to 59. An API may allow the value
60 if it allows leap-seconds.
r rf r r) r* r N)r
r r r r r" r# r$ r% hoursminutesnanossecondsr r r r r r [ s "
I,=,=,C,C
D% " "1i.?.?.E.E F'
I,=,=,C,C
D% " "1i.?.?.E.E F'r r c \ rS rSrSr\R " SSSS9r\R " S5 r \R " SS SS9r
S
r g ) r is a Time windows within which actions are restricted. See the
[documentation](https://cloud.google.com/deploy/docs/deploy-
policy#dates_times) for more information on how to configure dates/times.
Fields:
oneTimeWindows: Optional. One-time windows within which actions are
restricted.
timeZone: Required. The time zone in IANA format [IANA Time Zone
Database](https://www.iana.org/time-zones) (e.g. America/New_York).
weeklyWindows: Optional. Recurring weekly windows within which actions are
restricted.
r r Tr1 r WeeklyWindowr) r N) r
r r r r r" r= oneTimeWindowsr# timeZone
weeklyWindowsr r r r r r s sA ))/1tL.
"
"1
%((( TJ-r r c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
r i a7 `TimedPromoteReleaseCondition` contains conditions specific to an
Automation with a Timed Promote Release rule defined.
Fields:
nextPromotionTime: Output only. When the next scheduled promotion(s) will
occur.
targetsList: Output only. A list of targets involved in the upcoming timed
promotion(s).
r r> r Tr1 r N) r
r r r r r" r# nextPromotionTimer= targetsListr r r r r r s. ++A.&&y!dC+r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)r i a Contains the information of an automated timed promote-release
operation.
Fields:
phase: Output only. The starting phase of the rollout created by this
operation.
release: Output only. The name of the release to be promoted.
targetId: Output only. The ID of the target that represents the promotion
stage to which the release will be promoted. The value of this field is
the last segment of a target name.
r r r) r N) r
r r r r r" r# r r r r r r r r r s9
"% ! !! $'
"
"1
%(r r c \ rS rSrSr\R " SS5 r\R " S5 r \R " S5 r
\R " S5 r \R " S5 r \R " S 5 r
S
rg ) r i aH The `TimedPromoteReleaseRule` will automatically promote a release from
the current target(s) to the specified target(s) on a configured schedule.
Fields:
condition: Output only. Information around the state of the Automation
rule.
destinationPhase: Optional. The starting phase of the rollout created by
this rule. Default to the first phase.
destinationTargetId: Optional. The ID of the stage in the pipeline to
which this `Release` is deploying. If unspecified, default it to the
next stage in the promotion flow. The value of this field could be one
of the following: * The last segment of a target name * "@next", the
next target in the promotion sequence
id: 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])?`.
schedule: Required. Schedule in crontab format. e.g. "0 9 * * 1" for every
Monday at 9am.
timeZone: Required. The time zone in IANA format [IANA Time Zone
Database](https://www.iana.org/time-zones) (e.g. America/New_York).
r< r r r) r* rb r r N)r
r r r r r" r= r> r# r+ r r? schedulerX r r r r r r sn , $$%>B) **1-!--a0 Q "
"
"1
%(
"
"1
%(r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r \R " S5 r \R " SS5 rS rg
) r i a ToolVersionSupportedCondition contains information about when support
for the release's version of a Tool ends.
Enums:
ToolVersionSupportStateValueValuesEnum: Output only. The Tool support
state for this release's version of the Tool.
Fields:
maintenanceModeTime: Output only. The time at which this release's version
of the Tool will enter maintenance mode.
status: Output only. True if the version of Tool used by this release is
supported.
supportExpirationTime: Output only. The time at which this release's
version of the Tool will no longer be supported.
toolVersionSupportState: Output only. The Tool support state for this
release's version of the Tool.
c ( \ rS rSrSrSrSrSrSrSr g) DToolVersionSupportedCondition.ToolVersionSupportStateValueValuesEnumi a Output only. The Tool support state for this release's version of the
Tool.
Values:
TOOL_VERSION_SUPPORT_STATE_UNSPECIFIED: Default value. This value is
unused.
TOOL_VERSION_SUPPORT_STATE_SUPPORTED: This Tool version is currently
supported.
TOOL_VERSION_SUPPORT_STATE_MAINTENANCE_MODE: This Tool version is in
maintenance mode.
TOOL_VERSION_SUPPORT_STATE_UNSUPPORTED: This Tool version is no longer
supported.
r r r r) r N)
r
r r r r &TOOL_VERSION_SUPPORT_STATE_UNSPECIFIED$TOOL_VERSION_SUPPORT_STATE_SUPPORTED+TOOL_VERSION_SUPPORT_STATE_MAINTENANCE_MODE&TOOL_VERSION_SUPPORT_STATE_UNSUPPORTEDr r r r &ToolVersionSupportStateValueValuesEnumrb s! ./*+,(23/-.*r rg r r r) r* r N)r
r r r r r" r rg r# r r} r r r toolVersionSupportStater r r r r r s` $/y~~ /& "--a0 ! !! $&#//2 % / /0XZ[ \r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
\R " S5 r \R " S5 r S r
g
) r i a Details of ToolVersions for the release.
Fields:
docker: Optional. The docker version to use for Cloud Deploy operations.
helm: Optional. The helm version to use for Cloud Deploy operations.
kpt: Optional. The kpt version to use for Cloud Deploy operations.
kubectl: Optional. The kubectl version to use for Cloud Deploy operations.
kustomize: Optional. The kustomize version to use for Cloud Deploy
operations.
skaffold: Optional. The skaffold version to use for Cloud Deploy
operations.
r r r) r* rb r r N)r
r r r r r" r# dockerhelmkptkubectl kustomizeskaffoldr r r r r r si #& q !$ a # ! !! $'##A&)
"
"1
%(r r c < \ rS rSrSr\R " SSSS9rSrg) r! i zVerify contains the verify job configuration information.
Fields:
tasks: Optional. The tasks that will run as a part of the verify job. The
tasks are executed sequentially in the order specified.
rD r Tr1 r N r
r r r r r" r= ry r r r r r! r! s
T
:%r r! c < \ rS rSrSr\R " SSSS9rSrg) r) i zdA verify Job.
Fields:
tasks: Output only. The tasks that are executed as part of the verify Job.
rD r Tr1 r Nrq r r r r) r) s
T
:%r r) c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " S5 r \R " SS5 r
\R " S 5 r\R " S
S 5 rS rg
)r5 i a VerifyJobRun contains information specific to a verify `JobRun`.
Enums:
FailureCauseValueValuesEnum: Output only. The reason the verify failed.
This will always be unspecified while the verify is in progress or if it
succeeded.
Fields:
artifactUri: Output only. URI of a directory containing the verify
artifacts. This contains the Skaffold event log.
build: Output only. The resource name of the Cloud Build `Build` object
that is used to verify. Format is
`projects/{project}/locations/{location}/builds/{build}`.
eventLogPath: Output only. File path of the Skaffold event log relative to
the artifact URI.
failureCause: Output only. The reason the verify failed. This will always
be unspecified while the verify is in progress or if it succeeded.
failureMessage: Output only. Additional information about the verify
failure, if available.
metadata: Output only. Metadata containing information about the verify
`JobRun`.
c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) (VerifyJobRun.FailureCauseValueValuesEnumi5 ai Output only. The reason the verify failed. This will always be
unspecified while the verify is in progress or if it succeeded.
Values:
FAILURE_CAUSE_UNSPECIFIED: No reason for failure is specified.
CLOUD_BUILD_UNAVAILABLE: Cloud Build is not available, either because it
is not enabled or because Cloud Deploy has insufficient permissions.
See [required permission](https://cloud.google.com/deploy/docs/cloud-
deploy-service-account#required_permissions).
EXECUTION_FAILED: The verify operation did not complete successfully;
check Cloud Build logs.
DEADLINE_EXCEEDED: The verify job run did not complete within the
allotted time.
VERIFICATION_CONFIG_NOT_FOUND: No Skaffold verify configuration was
found.
CLOUD_BUILD_REQUEST_FAILED: Cloud Build failed to fulfill Cloud Deploy's
request. See failure_message for additional details.
r r r r) r* rb r N) r
r r r r rK rL rM rN rv rO r r r r rP ru 5 s- $ !" $%!!" r rP r r r) r* rb VerifyJobRunMetadatar r N)r
r r r r r" r rP r# r r eventLogPathr rR rd r= rT r r r r r5 r5 s .#INN #4 %%a(+
"%&&q),$$%BAF, ((+.
#
#$:A
>(r r5 c > \ rS rSrSr\R " SS5 rSrg)rv iW zVerifyJobRunMetadata contains metadata about the verify `JobRun`.
Fields:
custom: Output only. Custom metadata provided by user-defined verify
operation.
rQ r r N) r
r r r r r" r= r r r r r rv rv W s ! !"2A 6&r rv c \ rS rSrSr " S S\R 5 r\R " SSSS9r \R " SS 5 r \R " SS
5 r S r
g )
rV ib a Weekly windows. For example, blocking actions every Saturday and Sunday.
Another example would be blocking actions every weekday from 5pm to
midnight.
Enums:
DaysOfWeekValueListEntryValuesEnum:
Fields:
daysOfWeek: Optional. Days of week. If left empty, all days of the week
will be included.
endTime: Optional. End time (exclusive). Use 24:00 to indicate midnight.
If you specify end_time you must also specify start_time. If left empty,
this will block for the entire day for the days specified in
days_of_week.
startTime: Optional. Start time (inclusive). Use 00:00 for the beginning
of the day. If you specify start_time you must also specify end_time. If
left empty, this will block for the entire day for the days specified in
days_of_week.
c 8 \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
g )
/WeeklyWindow.DaysOfWeekValueListEntryValuesEnumiw zDaysOfWeekValueListEntryValuesEnum enum type.
Values:
DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
MONDAY: Monday
TUESDAY: Tuesday
WEDNESDAY: Wednesday
THURSDAY: Thursday
FRIDAY: Friday
SATURDAY: Saturday
SUNDAY: Sunday
r r r r) r* rb r r r N)r
r r r r DAY_OF_WEEK_UNSPECIFIEDMONDAYTUESDAY WEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAYr r r r "DaysOfWeekValueListEntryValuesEnumr{ w s2
FGIH
FH
Fr r r Tr1 r r r) r N)r
r r r r r" r r r
daysOfWeekr= r: r= r r r r rV rV b sS (9>> , ""#GUYZ* " "; 2'$$[!4)r rV r z$.xgafvr 1r 2rh z options.requestedPolicyVersionN( r
__future__r apitools.base.protorpcliter r" apitools.base.pyr r packagerR r r r r r' r/ r6 r: rB rY rf ro rr ry r| r r r r r r r r r r< r r r
r r r r, r. r0 r2 r6 r8 r= rC rF rL rN rU r` re rl rp rx r| r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r
r r r r r r r r r) r4 r: r= r? r rh rt rQ r^ r` rc ri rV r{ r r r r r r r r r r r r r r r r r r ra r r ri r r r9 r. r@ rF rL rO rT rW r[ r^ ra rd rh rl rp rs re r r r ri r r r rA r r r r r r r r' r3 r r( r4 r r r r r r r r! r) r, r3 r r r4 rH r rX r- r5 r. rc r rh r r r r r r r rG r} r r r rd r r r r r r r r r r r- r r> r r rD r rJ r rO r r r r r r r r! r) r5 rv rV AddCustomJsonFieldMappingAddCustomJsonEnumMappingr r r r r s!
' < % ( 6I - - 63Y . . 3%Y . . % , 1 1 , "i / / "$
%I - -
%4Y . . 4"** "0-4y(( -4`34Y . . 34lAy A(A)## A&+Y&& +$ (I%% (
AI - -
A4Y . . 4 G** G %)## %: =Y&& =DZ)"" Z)z-7i'' -7`H!2!2 HA 1 1 A$QY&& Q*
[i / /
[ S,I%% S,l47** 47nT"i T"n !I%% ! =Y
=&5y(( 5<;!2!2 ;9)"3"3 9=Y . . =A9,, A3I - - 3 Fy(( F?Y&& ?,&y(( &8y(( 86%Y . . %(%y(( %: +ARAR +@ +ARAR +D5yGXGX 56 1i>O>O 13y?P?P 36%+ @Q@Q %+PIyGXGX I"1yO`O` 1"
1IL]L]
13YM^M^ 36 +IL]L] +@!+IL]L] !+H
1IZIZ
13)J[J[ 36$+9K\K\ $+N +ARAR +@#+ARAR #+L5yGXGX 56 1i>O>O 13y?P?P 34%+ @Q@Q %+P 1)J[J[ 1 +IZIZ +F
1iFWFW
13yGXGX 361R[RcRc 1"1R[RcRc 1"1QZQbQb 1"$+QZQbQb $+N 1iN_N_ 1
4T]TeTe
4
1U^UfUf
13V_VgVg 36
O[d[l[l
O 3yO`O` 384S\SdSd 4"
MIZIZ
M IyGXGX I"UYM^M^ U" +i>O>O +> +i>O>O +D5IDUDU 5419;L;L 13I-> 1'i.?.? '0
1):K:K
11):K:K 11y7H7H 13 8I8I 30 +y7H7H +> +y7H7H +B5Y=N=N 541I4E4E 13Y5F5F 34#+i6G6G #+L
IY=N=N
I
U9CTCT
U RY
R&, "" , ^*# !! *#Z+#I%% +#\EY&& E#I - - #
,y 0 0
, IY . . I
+)##
+ 9+ )) 9+x$4Y&& $4N .9$$ . )!2!2 )*)"3"3 *( - )) - z)y(( z)z.7 (9(9 .7bD9 D4,)## ,"t)y(( t)n&4 1 1 &4R.7 (9(9 .7b :Y&& : !! 7?9$$ 7?tI9,, I$E4y(( E4PW)9$$ W)tS>)"3"3 S>l/7I$5$5 /7d
89#4#4
8 /Y&& /.I 9(i'' 9(x!#9 !#H
3 ))
3 3** 3D&"" &8 S)++ S %y(( % / )) /96)
96xC/7y 0 0 /7d %I - - % C7** C7L
EY&&
E
:)##
: 3 )) 3%Y . . %, O )) OF "I "F%"9$$ %"P %i'' % .y(( . ,"" ,B >y > )'i'' )'X
-9,,
-+I - - +8EY . . Ep"i p"f57y 0 0 57p99** 99xZ7** Z7z/ )) /&
=I%%
= =Y&& =% )) %,()++ ("(I - - (" $ )) $ " )) " Fi'' F(&3!2!2 &3R%i'' %&&I &.5y 5,<.i / / <.~0%Y
0%f 3y 3 W)Y
W)t00Y&& 00f'4i'' '4T+7i / / +7\RK9$$ RKj ,i ,
(i / /
( %9,, % ?9 ?"AY . . A5i / / 5
8 1 1
88!2!2 8G !! G0K)## K& D9#4#4 D &9#4#4 &$ &i / / &>)]I$5$5 )]X&9$$ &,;Y
;; !! ;7?9$$ 7?t79,, 7-59$$ -5` " "Z4 ! !114> ! !114> " "DFf iIJ " "DFf iIJ " "ACc fFG " ":<\^~@r