close()

Close httplib2 connections.

create(parent, body=None, deliveryPipelineId=None, requestId=None, validateOnly=None, x__xgafv=None)

Creates a new DeliveryPipeline in a given project and location.

Args:
parent: string, Required. The parent collection in which the `DeliveryPipeline` must be created. The format is `projects/{project_id}/locations/{location_name}`. (required)
body: object, The request body.
The object takes the form of:

{ # A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
"a_key": "A String",
},
"condition": { # PipelineCondition contains all conditions relevant to a Delivery Pipeline. # Output only. Information around the state of the Delivery Pipeline.
"pipelineReadyCondition": { # PipelineReadyCondition contains information around the status of the Pipeline. # Details around the Pipeline's overall status.
"status": True or False, # 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": "A String", # Last time the condition was updated.
},
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"targetsTypeCondition": { # TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type. # Details on the whether the targets enumerated in the pipeline are of the same type.
"errorDetails": "A String", # Human readable error message.
"status": True or False, # 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.
},
},
"createTime": "A String", # Output only. Time at which the pipeline was created.
"description": "A String", # Description of the `DeliveryPipeline`. Max length is 255 characters.
"etag": "A String", # 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.
"a_key": "A String",
},
"name": "A String", # Optional. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"serialPipeline": { # SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`. # SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.
"stages": [ # Each stage specifies configuration for a `Target`. The ordering of this list defines the promotion flow.
{ # Stage specifies a location to which to deploy.
"deployParameters": [ # Optional. The deploy parameters to use for the target in this stage.
{ # DeployParameters contains deploy parameters information.
"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).
"a_key": "A String",
},
"values": { # Required. Values are deploy parameters in key-value pairs.
"a_key": "A String",
},
},
],
"profiles": [ # Skaffold profiles to use when rendering the manifest for this stage's `Target`.
"A String",
],
"strategy": { # Strategy contains deployment strategy information. # Optional. The strategy to use for a `Rollout` to this stage.
"canary": { # Canary represents the canary deployment strategy. # Canary deployment strategy provides progressive percentage based deployments to a Target.
"canaryDeployment": { # CanaryDeployment represents the canary deployment configuration # Configures the progressive based deployment for a Target.
"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.
42,
],
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"verify": True or False, # Whether to run verify tests after each percentage deployment.
},
"customCanaryDeployment": { # CustomCanaryDeployment represents the custom canary deployment configuration. # Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.
"phaseConfigs": [ # Required. Configuration for each phase in the canary deployment in the order executed.
{ # PhaseConfig represents the configuration for a phase in the custom canary deployment.
"percentage": 42, # Required. Percentage deployment for the phase.
"phaseId": "A String", # 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": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job of this phase. If this is not configured, there will be no postdeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job of this phase. If this is not configured, there will be no predeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"profiles": [ # Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the `DeliveryPipeline` stage.
"A String",
],
"verify": True or False, # Whether to run verify tests after the deployment.
},
],
},
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # 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.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
"canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary phase is in progress.
"A String",
],
"priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary phase is in progress.
"A String",
],
"stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision when the stable phase is applied.
"A String",
],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service.
"httpRoute": "A String", # Required. Name of the Gateway API HTTPRoute.
"podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources.
"routeDestinations": { # Information about route destinations for the Gateway API service mesh. # 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.
"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.
"A String",
],
"propagateService": True or False, # 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 facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.
},
"routeUpdateWaitTime": "A String", # 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": "A String", # Required. Name of the Kubernetes Service.
"stableCutbackDuration": "A String", # 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.
},
"serviceNetworking": { # Information about the Kubernetes Service networking configuration. # Kubernetes Service networking configuration.
"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified Service.
"disablePodOverprovisioning": True or False, # 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": "A String", # Optional. The label to use when selecting Pods for the Deployment resource. This label must already be present in the Deployment.
"service": "A String", # Required. Name of the Kubernetes Service.
},
},
},
},
"standard": { # Standard represents the standard deployment strategy. # Standard deployment strategy executes a single deploy and allows verifying the deployment.
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job. If this is not configured, postdeploy job will not be present.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job. If this is not configured, predeploy job will not be present.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"verify": True or False, # Whether to verify a deployment.
},
},
"targetId": "A String", # 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`.
},
],
},
"suspended": True or False, # When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
"uid": "A String", # Output only. Unique identifier of the `DeliveryPipeline`.
"updateTime": "A String", # Output only. Most recent time at which the pipeline was updated.
}

deliveryPipelineId: string, Required. ID of the `DeliveryPipeline`.
requestId: string, 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: boolean, Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # 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.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

delete(name, allowMissing=None, etag=None, force=None, requestId=None, validateOnly=None, x__xgafv=None)

Deletes a single DeliveryPipeline.

Args:
name: string, Required. The name of the `DeliveryPipeline` to delete. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`. (required)
allowMissing: boolean, Optional. If set to true, then deleting an already deleted or non-existing `DeliveryPipeline` will succeed.
etag: string, 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: boolean, 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.
requestId: string, 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: boolean, Optional. If set, validate the request and preview the review, but do not actually post it.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # 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.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Gets details of a single DeliveryPipeline.

Args:
name: string, Required. Name of the `DeliveryPipeline`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
"a_key": "A String",
},
"condition": { # PipelineCondition contains all conditions relevant to a Delivery Pipeline. # Output only. Information around the state of the Delivery Pipeline.
"pipelineReadyCondition": { # PipelineReadyCondition contains information around the status of the Pipeline. # Details around the Pipeline's overall status.
"status": True or False, # 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": "A String", # Last time the condition was updated.
},
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"targetsTypeCondition": { # TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type. # Details on the whether the targets enumerated in the pipeline are of the same type.
"errorDetails": "A String", # Human readable error message.
"status": True or False, # 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.
},
},
"createTime": "A String", # Output only. Time at which the pipeline was created.
"description": "A String", # Description of the `DeliveryPipeline`. Max length is 255 characters.
"etag": "A String", # 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.
"a_key": "A String",
},
"name": "A String", # Optional. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"serialPipeline": { # SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`. # SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.
"stages": [ # Each stage specifies configuration for a `Target`. The ordering of this list defines the promotion flow.
{ # Stage specifies a location to which to deploy.
"deployParameters": [ # Optional. The deploy parameters to use for the target in this stage.
{ # DeployParameters contains deploy parameters information.
"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).
"a_key": "A String",
},
"values": { # Required. Values are deploy parameters in key-value pairs.
"a_key": "A String",
},
},
],
"profiles": [ # Skaffold profiles to use when rendering the manifest for this stage's `Target`.
"A String",
],
"strategy": { # Strategy contains deployment strategy information. # Optional. The strategy to use for a `Rollout` to this stage.
"canary": { # Canary represents the canary deployment strategy. # Canary deployment strategy provides progressive percentage based deployments to a Target.
"canaryDeployment": { # CanaryDeployment represents the canary deployment configuration # Configures the progressive based deployment for a Target.
"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.
42,
],
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"verify": True or False, # Whether to run verify tests after each percentage deployment.
},
"customCanaryDeployment": { # CustomCanaryDeployment represents the custom canary deployment configuration. # Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.
"phaseConfigs": [ # Required. Configuration for each phase in the canary deployment in the order executed.
{ # PhaseConfig represents the configuration for a phase in the custom canary deployment.
"percentage": 42, # Required. Percentage deployment for the phase.
"phaseId": "A String", # 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": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job of this phase. If this is not configured, there will be no postdeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job of this phase. If this is not configured, there will be no predeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"profiles": [ # Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the `DeliveryPipeline` stage.
"A String",
],
"verify": True or False, # Whether to run verify tests after the deployment.
},
],
},
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # 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.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
"canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary phase is in progress.
"A String",
],
"priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary phase is in progress.
"A String",
],
"stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision when the stable phase is applied.
"A String",
],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service.
"httpRoute": "A String", # Required. Name of the Gateway API HTTPRoute.
"podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources.
"routeDestinations": { # Information about route destinations for the Gateway API service mesh. # 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.
"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.
"A String",
],
"propagateService": True or False, # 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 facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.
},
"routeUpdateWaitTime": "A String", # 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": "A String", # Required. Name of the Kubernetes Service.
"stableCutbackDuration": "A String", # 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.
},
"serviceNetworking": { # Information about the Kubernetes Service networking configuration. # Kubernetes Service networking configuration.
"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified Service.
"disablePodOverprovisioning": True or False, # 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": "A String", # Optional. The label to use when selecting Pods for the Deployment resource. This label must already be present in the Deployment.
"service": "A String", # Required. Name of the Kubernetes Service.
},
},
},
},
"standard": { # Standard represents the standard deployment strategy. # Standard deployment strategy executes a single deploy and allows verifying the deployment.
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job. If this is not configured, postdeploy job will not be present.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job. If this is not configured, predeploy job will not be present.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"verify": True or False, # Whether to verify a deployment.
},
},
"targetId": "A String", # 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`.
},
],
},
"suspended": True or False, # When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
"uid": "A String", # Output only. Unique identifier of the `DeliveryPipeline`.
"updateTime": "A String", # Output only. Most recent time at which the pipeline was updated.
}

getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Args:
  resource: string, 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. (required)
  options_requestedPolicyVersion: integer, 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).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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/).
  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
      "auditLogConfigs": [ # The configuration for logging of each type of permission.
        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
            "A String",
          ],
          "logType": "A String", # The log type that this config enables.
        },
      ],
      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
    },
  ],
  "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`.
    { # Associates `members`, or principals, with a `role`.
      "condition": { # 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
        "title": "A String", # 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.
      },
      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
        "A String",
      ],
      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
    },
  ],
  "etag": "A String", # `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": 42, # 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).
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists DeliveryPipelines in a given project and location.

Args:
parent: string, Required. The parent, which owns this collection of pipelines. Format must be `projects/{project_id}/locations/{location_name}`. (required)
filter: string, Filter pipelines to be returned. See https://google.aip.dev/160 for more details.
orderBy: string, Field to sort by. See https://google.aip.dev/132#ordering for more details.
pageSize: integer, 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: string, 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The response object from `ListDeliveryPipelines`.
"deliveryPipelines": [ # The `DeliveryPipeline` objects.
{ # A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
"a_key": "A String",
},
"condition": { # PipelineCondition contains all conditions relevant to a Delivery Pipeline. # Output only. Information around the state of the Delivery Pipeline.
"pipelineReadyCondition": { # PipelineReadyCondition contains information around the status of the Pipeline. # Details around the Pipeline's overall status.
"status": True or False, # 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": "A String", # Last time the condition was updated.
},
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"targetsTypeCondition": { # TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type. # Details on the whether the targets enumerated in the pipeline are of the same type.
"errorDetails": "A String", # Human readable error message.
"status": True or False, # 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.
},
},
"createTime": "A String", # Output only. Time at which the pipeline was created.
"description": "A String", # Description of the `DeliveryPipeline`. Max length is 255 characters.
"etag": "A String", # 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.
"a_key": "A String",
},
"name": "A String", # Optional. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"serialPipeline": { # SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`. # SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.
"stages": [ # Each stage specifies configuration for a `Target`. The ordering of this list defines the promotion flow.
{ # Stage specifies a location to which to deploy.
"deployParameters": [ # Optional. The deploy parameters to use for the target in this stage.
{ # DeployParameters contains deploy parameters information.
"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).
"a_key": "A String",
},
"values": { # Required. Values are deploy parameters in key-value pairs.
"a_key": "A String",
},
},
],
"profiles": [ # Skaffold profiles to use when rendering the manifest for this stage's `Target`.
"A String",
],
"strategy": { # Strategy contains deployment strategy information. # Optional. The strategy to use for a `Rollout` to this stage.
"canary": { # Canary represents the canary deployment strategy. # Canary deployment strategy provides progressive percentage based deployments to a Target.
"canaryDeployment": { # CanaryDeployment represents the canary deployment configuration # Configures the progressive based deployment for a Target.
"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.
42,
],
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"verify": True or False, # Whether to run verify tests after each percentage deployment.
},
"customCanaryDeployment": { # CustomCanaryDeployment represents the custom canary deployment configuration. # Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.
"phaseConfigs": [ # Required. Configuration for each phase in the canary deployment in the order executed.
{ # PhaseConfig represents the configuration for a phase in the custom canary deployment.
"percentage": 42, # Required. Percentage deployment for the phase.
"phaseId": "A String", # 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": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job of this phase. If this is not configured, there will be no postdeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job of this phase. If this is not configured, there will be no predeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"profiles": [ # Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the `DeliveryPipeline` stage.
"A String",
],
"verify": True or False, # Whether to run verify tests after the deployment.
},
],
},
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # 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.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
"canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary phase is in progress.
"A String",
],
"priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary phase is in progress.
"A String",
],
"stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision when the stable phase is applied.
"A String",
],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service.
"httpRoute": "A String", # Required. Name of the Gateway API HTTPRoute.
"podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources.
"routeDestinations": { # Information about route destinations for the Gateway API service mesh. # 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.
"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.
"A String",
],
"propagateService": True or False, # 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 facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.
},
"routeUpdateWaitTime": "A String", # 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": "A String", # Required. Name of the Kubernetes Service.
"stableCutbackDuration": "A String", # 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.
},
"serviceNetworking": { # Information about the Kubernetes Service networking configuration. # Kubernetes Service networking configuration.
"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified Service.
"disablePodOverprovisioning": True or False, # 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": "A String", # Optional. The label to use when selecting Pods for the Deployment resource. This label must already be present in the Deployment.
"service": "A String", # Required. Name of the Kubernetes Service.
},
},
},
},
"standard": { # Standard represents the standard deployment strategy. # Standard deployment strategy executes a single deploy and allows verifying the deployment.
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job. If this is not configured, postdeploy job will not be present.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job. If this is not configured, predeploy job will not be present.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"verify": True or False, # Whether to verify a deployment.
},
},
"targetId": "A String", # 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`.
},
],
},
"suspended": True or False, # When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
"uid": "A String", # Output only. Unique identifier of the `DeliveryPipeline`.
"updateTime": "A String", # Output only. Most recent time at which the pipeline was updated.
},
],
"nextPageToken": "A String", # 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.
"A String",
],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)

Updates the parameters of a single DeliveryPipeline.

Args:
name: string, Optional. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` (required)
body: object, The request body.
The object takes the form of:

{ # A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
"a_key": "A String",
},
"condition": { # PipelineCondition contains all conditions relevant to a Delivery Pipeline. # Output only. Information around the state of the Delivery Pipeline.
"pipelineReadyCondition": { # PipelineReadyCondition contains information around the status of the Pipeline. # Details around the Pipeline's overall status.
"status": True or False, # 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": "A String", # Last time the condition was updated.
},
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"targetsTypeCondition": { # TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type. # Details on the whether the targets enumerated in the pipeline are of the same type.
"errorDetails": "A String", # Human readable error message.
"status": True or False, # 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.
},
},
"createTime": "A String", # Output only. Time at which the pipeline was created.
"description": "A String", # Description of the `DeliveryPipeline`. Max length is 255 characters.
"etag": "A String", # 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.
"a_key": "A String",
},
"name": "A String", # Optional. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"serialPipeline": { # SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`. # SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.
"stages": [ # Each stage specifies configuration for a `Target`. The ordering of this list defines the promotion flow.
{ # Stage specifies a location to which to deploy.
"deployParameters": [ # Optional. The deploy parameters to use for the target in this stage.
{ # DeployParameters contains deploy parameters information.
"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).
"a_key": "A String",
},
"values": { # Required. Values are deploy parameters in key-value pairs.
"a_key": "A String",
},
},
],
"profiles": [ # Skaffold profiles to use when rendering the manifest for this stage's `Target`.
"A String",
],
"strategy": { # Strategy contains deployment strategy information. # Optional. The strategy to use for a `Rollout` to this stage.
"canary": { # Canary represents the canary deployment strategy. # Canary deployment strategy provides progressive percentage based deployments to a Target.
"canaryDeployment": { # CanaryDeployment represents the canary deployment configuration # Configures the progressive based deployment for a Target.
"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.
42,
],
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"verify": True or False, # Whether to run verify tests after each percentage deployment.
},
"customCanaryDeployment": { # CustomCanaryDeployment represents the custom canary deployment configuration. # Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.
"phaseConfigs": [ # Required. Configuration for each phase in the canary deployment in the order executed.
{ # PhaseConfig represents the configuration for a phase in the custom canary deployment.
"percentage": 42, # Required. Percentage deployment for the phase.
"phaseId": "A String", # 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": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job of this phase. If this is not configured, there will be no postdeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job of this phase. If this is not configured, there will be no predeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"profiles": [ # Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the `DeliveryPipeline` stage.
"A String",
],
"verify": True or False, # Whether to run verify tests after the deployment.
},
],
},
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # 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.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
"canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary phase is in progress.
"A String",
],
"priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary phase is in progress.
"A String",
],
"stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision when the stable phase is applied.
"A String",
],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Kubernetes Gateway API service mesh configuration.
"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service.
"httpRoute": "A String", # Required. Name of the Gateway API HTTPRoute.
"podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources.
"routeDestinations": { # Information about route destinations for the Gateway API service mesh. # 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.
"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.
"A String",
],
"propagateService": True or False, # 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 facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.
},
"routeUpdateWaitTime": "A String", # 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": "A String", # Required. Name of the Kubernetes Service.
"stableCutbackDuration": "A String", # 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.
},
"serviceNetworking": { # Information about the Kubernetes Service networking configuration. # Kubernetes Service networking configuration.
"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified Service.
"disablePodOverprovisioning": True or False, # 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": "A String", # Optional. The label to use when selecting Pods for the Deployment resource. This label must already be present in the Deployment.
"service": "A String", # Required. Name of the Kubernetes Service.
},
},
},
},
"standard": { # Standard represents the standard deployment strategy. # Standard deployment strategy executes a single deploy and allows verifying the deployment.
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job. If this is not configured, postdeploy job will not be present.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job. If this is not configured, predeploy job will not be present.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"verify": True or False, # Whether to verify a deployment.
},
},
"targetId": "A String", # 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`.
},
],
},
"suspended": True or False, # When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
"uid": "A String", # Output only. Unique identifier of the `DeliveryPipeline`.
"updateTime": "A String", # Output only. Most recent time at which the pipeline was updated.
}

allowMissing: boolean, Optional. If set to true, updating a `DeliveryPipeline` that does not exist will result in the creation of a new `DeliveryPipeline`.
requestId: string, 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: string, 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: boolean, Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # 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.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

rollbackTarget(name, body=None, x__xgafv=None)

Creates a `Rollout` to roll back the specified target.

Args:
  name: string, Required. The `DeliveryPipeline` for which the rollback `Rollout` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request object for `RollbackTarget`.
  "overrideDeployPolicy": [ # Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deploy_policy}`.
    "A String",
  ],
  "releaseId": "A String", # 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": { # Configs for the Rollback rollout. # Optional. Configs for the rollback `Rollout`.
    "rollout": { # A `Rollout` resource in the Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`. # Optional. The rollback `Rollout` to create.
      "activeRepairAutomationRun": "A String", # Output only. The AutomationRun actively repairing the rollout.
      "annotations": { # 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.
        "a_key": "A String",
      },
      "approvalState": "A String", # Output only. Approval state of the `Rollout`.
      "approveTime": "A String", # Output only. Time at which the `Rollout` was approved.
      "controllerRollout": "A String", # Output only. Name of the `ControllerRollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
      "createTime": "A String", # Output only. Time at which the `Rollout` was created.
      "deployEndTime": "A String", # Output only. Time at which the `Rollout` finished deploying.
      "deployFailureCause": "A String", # Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
      "deployStartTime": "A String", # Output only. Time at which the `Rollout` started deploying.
      "deployingBuild": "A String", # 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": "A String", # Description of the `Rollout` for user purposes. Max length is 255 characters.
      "enqueueTime": "A String", # Output only. Time at which the `Rollout` was enqueued.
      "etag": "A String", # 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": "A String", # 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.
        "a_key": "A String",
      },
      "metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout.
        "automation": { # AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout. # Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
          "advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule.
            "A String",
          ],
          "promoteAutomationRun": "A String", # 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.
            "A String",
          ],
        },
        "cloudRun": { # CloudRunMetadata contains information from a Cloud Run deployment. # Output only. The name of the Cloud Run Service that is associated with a `Rollout`.
          "job": "A String", # Output only. The name of the Cloud Run job that is associated with a `Rollout`. Format is `projects/{project}/locations/{location}/jobs/{job_name}`.
          "revision": "A String", # Output only. The Cloud Run Revision id associated with a `Rollout`.
          "service": "A String", # 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`.
            "A String",
          ],
        },
        "custom": { # CustomMetadata contains information from a user-defined operation. # Output only. Custom metadata provided by user-defined `Rollout` operations.
          "values": { # Output only. Key-value pairs provided by the user-defined operation.
            "a_key": "A String",
          },
        },
      },
      "name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{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`.
        { # Phase represents a collection of jobs that are logically grouped together for a `Rollout`.
          "childRolloutJobs": { # ChildRollouts job composition # Output only. ChildRollout job composition.
            "advanceRolloutJobs": [ # Output only. List of AdvanceChildRolloutJobs
              { # Job represents an operation for a `Rollout`.
                "advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
                },
                "createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
                },
                "deployJob": { # A deploy Job. # Output only. A deploy Job.
                },
                "id": "A String", # Output only. The ID of the Job.
                "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
                "postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
                  "actions": [ # Output only. The custom actions that the postdeploy Job executes.
                    "A String",
                  ],
                },
                "predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
                  "actions": [ # Output only. The custom actions that the predeploy Job executes.
                    "A String",
                  ],
                },
                "skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
                "state": "A String", # Output only. The current state of the Job.
                "verifyJob": { # A verify Job. # Output only. A verify Job.
                },
              },
            ],
            "createRolloutJobs": [ # Output only. List of CreateChildRolloutJobs
              { # Job represents an operation for a `Rollout`.
                "advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
                },
                "createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
                },
                "deployJob": { # A deploy Job. # Output only. A deploy Job.
                },
                "id": "A String", # Output only. The ID of the Job.
                "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
                "postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
                  "actions": [ # Output only. The custom actions that the postdeploy Job executes.
                    "A String",
                  ],
                },
                "predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
                  "actions": [ # Output only. The custom actions that the predeploy Job executes.
                    "A String",
                  ],
                },
                "skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
                "state": "A String", # Output only. The current state of the Job.
                "verifyJob": { # A verify Job. # Output only. A verify Job.
                },
              },
            ],
          },
          "deploymentJobs": { # Deployment job composition. # Output only. Deployment job composition.
            "deployJob": { # Job represents an operation for a `Rollout`. # Output only. The deploy Job. This is the deploy job in the phase.
              "advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
              },
              "createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
              },
              "deployJob": { # A deploy Job. # Output only. A deploy Job.
              },
              "id": "A String", # Output only. The ID of the Job.
              "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
              "postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
                "actions": [ # Output only. The custom actions that the postdeploy Job executes.
                  "A String",
                ],
              },
              "predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
                "actions": [ # Output only. The custom actions that the predeploy Job executes.
                  "A String",
                ],
              },
              "skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
              "state": "A String", # Output only. The current state of the Job.
              "verifyJob": { # A verify Job. # Output only. A verify Job.
              },
            },
            "postdeployJob": { # Job represents an operation for a `Rollout`. # Output only. The postdeploy Job, which is the last job on the phase.
              "advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
              },
              "createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
              },
              "deployJob": { # A deploy Job. # Output only. A deploy Job.
              },
              "id": "A String", # Output only. The ID of the Job.
              "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
              "postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
                "actions": [ # Output only. The custom actions that the postdeploy Job executes.
                  "A String",
                ],
              },
              "predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
                "actions": [ # Output only. The custom actions that the predeploy Job executes.
                  "A String",
                ],
              },
              "skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
              "state": "A String", # Output only. The current state of the Job.
              "verifyJob": { # A verify Job. # Output only. A verify Job.
              },
            },
            "predeployJob": { # Job represents an operation for a `Rollout`. # Output only. The predeploy Job, which is the first job on the phase.
              "advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
              },
              "createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
              },
              "deployJob": { # A deploy Job. # Output only. A deploy Job.
              },
              "id": "A String", # Output only. The ID of the Job.
              "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
              "postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
                "actions": [ # Output only. The custom actions that the postdeploy Job executes.
                  "A String",
                ],
              },
              "predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
                "actions": [ # Output only. The custom actions that the predeploy Job executes.
                  "A String",
                ],
              },
              "skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
              "state": "A String", # Output only. The current state of the Job.
              "verifyJob": { # A verify Job. # Output only. A verify Job.
              },
            },
            "verifyJob": { # Job represents an operation for a `Rollout`. # Output only. The verify Job. Runs after a deploy if the deploy succeeds.
              "advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
              },
              "createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
              },
              "deployJob": { # A deploy Job. # Output only. A deploy Job.
              },
              "id": "A String", # Output only. The ID of the Job.
              "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
              "postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
                "actions": [ # Output only. The custom actions that the postdeploy Job executes.
                  "A String",
                ],
              },
              "predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
                "actions": [ # Output only. The custom actions that the predeploy Job executes.
                  "A String",
                ],
              },
              "skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
              "state": "A String", # Output only. The current state of the Job.
              "verifyJob": { # A verify Job. # Output only. A verify Job.
              },
            },
          },
          "id": "A String", # Output only. The ID of the Phase.
          "skipMessage": "A String", # Output only. Additional information on why the Phase was skipped, if available.
          "state": "A String", # Output only. Current state of the Phase.
        },
      ],
      "rollbackOfRollout": "A String", # 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`.
        "A String",
      ],
      "state": "A String", # Output only. Current state of the `Rollout`.
      "targetId": "A String", # Required. The ID of Target to which this `Rollout` is deploying.
      "uid": "A String", # Output only. Unique identifier of the `Rollout`.
    },
    "startingPhaseId": "A String", # Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase.
  },
  "rolloutId": "A String", # Required. ID of the rollback `Rollout` to create.
  "rolloutToRollBack": "A String", # Optional. If provided, this must be the latest `Rollout` that is on the `Target`.
  "targetId": "A String", # Required. ID of the `Target` that is being rolled back.
  "validateOnly": True or False, # Optional. If set to true, the request is validated and the user is provided with a `RollbackTargetResponse`.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response object from `RollbackTarget`.
  "rollbackConfig": { # Configs for the Rollback rollout. # The config of the rollback `Rollout` created or will be created.
    "rollout": { # A `Rollout` resource in the Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`. # Optional. The rollback `Rollout` to create.
      "activeRepairAutomationRun": "A String", # Output only. The AutomationRun actively repairing the rollout.
      "annotations": { # 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.
        "a_key": "A String",
      },
      "approvalState": "A String", # Output only. Approval state of the `Rollout`.
      "approveTime": "A String", # Output only. Time at which the `Rollout` was approved.
      "controllerRollout": "A String", # Output only. Name of the `ControllerRollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
      "createTime": "A String", # Output only. Time at which the `Rollout` was created.
      "deployEndTime": "A String", # Output only. Time at which the `Rollout` finished deploying.
      "deployFailureCause": "A String", # Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
      "deployStartTime": "A String", # Output only. Time at which the `Rollout` started deploying.
      "deployingBuild": "A String", # 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": "A String", # Description of the `Rollout` for user purposes. Max length is 255 characters.
      "enqueueTime": "A String", # Output only. Time at which the `Rollout` was enqueued.
      "etag": "A String", # 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": "A String", # 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.
        "a_key": "A String",
      },
      "metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout.
        "automation": { # AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout. # Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
          "advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule.
            "A String",
          ],
          "promoteAutomationRun": "A String", # 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.
            "A String",
          ],
        },
        "cloudRun": { # CloudRunMetadata contains information from a Cloud Run deployment. # Output only. The name of the Cloud Run Service that is associated with a `Rollout`.
          "job": "A String", # Output only. The name of the Cloud Run job that is associated with a `Rollout`. Format is `projects/{project}/locations/{location}/jobs/{job_name}`.
          "revision": "A String", # Output only. The Cloud Run Revision id associated with a `Rollout`.
          "service": "A String", # 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`.
            "A String",
          ],
        },
        "custom": { # CustomMetadata contains information from a user-defined operation. # Output only. Custom metadata provided by user-defined `Rollout` operations.
          "values": { # Output only. Key-value pairs provided by the user-defined operation.
            "a_key": "A String",
          },
        },
      },
      "name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{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`.
        { # Phase represents a collection of jobs that are logically grouped together for a `Rollout`.
          "childRolloutJobs": { # ChildRollouts job composition # Output only. ChildRollout job composition.
            "advanceRolloutJobs": [ # Output only. List of AdvanceChildRolloutJobs
              { # Job represents an operation for a `Rollout`.
                "advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
                },
                "createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
                },
                "deployJob": { # A deploy Job. # Output only. A deploy Job.
                },
                "id": "A String", # Output only. The ID of the Job.
                "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
                "postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
                  "actions": [ # Output only. The custom actions that the postdeploy Job executes.
                    "A String",
                  ],
                },
                "predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
                  "actions": [ # Output only. The custom actions that the predeploy Job executes.
                    "A String",
                  ],
                },
                "skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
                "state": "A String", # Output only. The current state of the Job.
                "verifyJob": { # A verify Job. # Output only. A verify Job.
                },
              },
            ],
            "createRolloutJobs": [ # Output only. List of CreateChildRolloutJobs
              { # Job represents an operation for a `Rollout`.
                "advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
                },
                "createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
                },
                "deployJob": { # A deploy Job. # Output only. A deploy Job.
                },
                "id": "A String", # Output only. The ID of the Job.
                "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
                "postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
                  "actions": [ # Output only. The custom actions that the postdeploy Job executes.
                    "A String",
                  ],
                },
                "predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
                  "actions": [ # Output only. The custom actions that the predeploy Job executes.
                    "A String",
                  ],
                },
                "skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
                "state": "A String", # Output only. The current state of the Job.
                "verifyJob": { # A verify Job. # Output only. A verify Job.
                },
              },
            ],
          },
          "deploymentJobs": { # Deployment job composition. # Output only. Deployment job composition.
            "deployJob": { # Job represents an operation for a `Rollout`. # Output only. The deploy Job. This is the deploy job in the phase.
              "advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
              },
              "createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
              },
              "deployJob": { # A deploy Job. # Output only. A deploy Job.
              },
              "id": "A String", # Output only. The ID of the Job.
              "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
              "postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
                "actions": [ # Output only. The custom actions that the postdeploy Job executes.
                  "A String",
                ],
              },
              "predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
                "actions": [ # Output only. The custom actions that the predeploy Job executes.
                  "A String",
                ],
              },
              "skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
              "state": "A String", # Output only. The current state of the Job.
              "verifyJob": { # A verify Job. # Output only. A verify Job.
              },
            },
            "postdeployJob": { # Job represents an operation for a `Rollout`. # Output only. The postdeploy Job, which is the last job on the phase.
              "advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
              },
              "createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
              },
              "deployJob": { # A deploy Job. # Output only. A deploy Job.
              },
              "id": "A String", # Output only. The ID of the Job.
              "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
              "postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
                "actions": [ # Output only. The custom actions that the postdeploy Job executes.
                  "A String",
                ],
              },
              "predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
                "actions": [ # Output only. The custom actions that the predeploy Job executes.
                  "A String",
                ],
              },
              "skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
              "state": "A String", # Output only. The current state of the Job.
              "verifyJob": { # A verify Job. # Output only. A verify Job.
              },
            },
            "predeployJob": { # Job represents an operation for a `Rollout`. # Output only. The predeploy Job, which is the first job on the phase.
              "advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
              },
              "createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
              },
              "deployJob": { # A deploy Job. # Output only. A deploy Job.
              },
              "id": "A String", # Output only. The ID of the Job.
              "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
              "postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
                "actions": [ # Output only. The custom actions that the postdeploy Job executes.
                  "A String",
                ],
              },
              "predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
                "actions": [ # Output only. The custom actions that the predeploy Job executes.
                  "A String",
                ],
              },
              "skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
              "state": "A String", # Output only. The current state of the Job.
              "verifyJob": { # A verify Job. # Output only. A verify Job.
              },
            },
            "verifyJob": { # Job represents an operation for a `Rollout`. # Output only. The verify Job. Runs after a deploy if the deploy succeeds.
              "advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
              },
              "createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
              },
              "deployJob": { # A deploy Job. # Output only. A deploy Job.
              },
              "id": "A String", # Output only. The ID of the Job.
              "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
              "postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
                "actions": [ # Output only. The custom actions that the postdeploy Job executes.
                  "A String",
                ],
              },
              "predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
                "actions": [ # Output only. The custom actions that the predeploy Job executes.
                  "A String",
                ],
              },
              "skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
              "state": "A String", # Output only. The current state of the Job.
              "verifyJob": { # A verify Job. # Output only. A verify Job.
              },
            },
          },
          "id": "A String", # Output only. The ID of the Phase.
          "skipMessage": "A String", # Output only. Additional information on why the Phase was skipped, if available.
          "state": "A String", # Output only. Current state of the Phase.
        },
      ],
      "rollbackOfRollout": "A String", # 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`.
        "A String",
      ],
      "state": "A String", # Output only. Current state of the `Rollout`.
      "targetId": "A String", # Required. The ID of Target to which this `Rollout` is deploying.
      "uid": "A String", # Output only. Unique identifier of the `Rollout`.
    },
    "startingPhaseId": "A String", # Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase.
  },
}

setIamPolicy(resource, body=None, x__xgafv=None)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

Args:
  resource: string, 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. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
  "policy": { # 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/). # 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.
    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
        "auditLogConfigs": [ # The configuration for logging of each type of permission.
          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
              "A String",
            ],
            "logType": "A String", # The log type that this config enables.
          },
        ],
        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
      },
    ],
    "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`.
      { # Associates `members`, or principals, with a `role`.
        "condition": { # 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
          "title": "A String", # 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.
        },
        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
          "A String",
        ],
        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
      },
    ],
    "etag": "A String", # `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": 42, # 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).
  },
  "updateMask": "A String", # 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"`
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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/).
  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
      "auditLogConfigs": [ # The configuration for logging of each type of permission.
        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
            "A String",
          ],
          "logType": "A String", # The log type that this config enables.
        },
      ],
      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
    },
  ],
  "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`.
    { # Associates `members`, or principals, with a `role`.
      "condition": { # 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
        "title": "A String", # 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.
      },
      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
        "A String",
      ],
      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
    },
  ],
  "etag": "A String", # `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": 42, # 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).
}

testIamPermissions(resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
  "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).
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
    "A String",
  ],
}

Cloud Deploy API . projects . locations . deliveryPipelines

Instance Methods

Method Details