Debian Codegraph @

docs/dyn/config_v1.projects.locations.deployments.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="config_v1.html">Infrastructure Manager API</a> . <a href="config_v1.projects.html">projects</a> . <a href="config_v1.projects.locations.html">locations</a> . <a href="config_v1.projects.locations.deployments.html">deployments</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="config_v1.projects.locations.deployments.revisions.html">revisions()</a></code>
79 </p>
80 <p class="firstline">Returns the revisions Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="#close">close()</a></code></p>
84 <p class="firstline">Close httplib2 connections.</p>
85 <p class="toc_element">
86 <code><a href="#create">create(parent, body=None, deploymentId=None, requestId=None, x__xgafv=None)</a></code></p>
87 <p class="firstline">Creates a Deployment.</p>
88 <p class="toc_element">
89 <code><a href="#delete">delete(name, deletePolicy=None, force=None, requestId=None, x__xgafv=None)</a></code></p>
90 <p class="firstline">Deletes a Deployment.</p>
91 <p class="toc_element">
92 <code><a href="#deleteState">deleteState(name, body=None, x__xgafv=None)</a></code></p>
93 <p class="firstline">Deletes Terraform state file in a given deployment.</p>
94 <p class="toc_element">
95 <code><a href="#exportLock">exportLock(name, x__xgafv=None)</a></code></p>
96 <p class="firstline">Exports the lock info on a locked deployment.</p>
97 <p class="toc_element">
98 <code><a href="#exportState">exportState(parent, body=None, x__xgafv=None)</a></code></p>
99 <p class="firstline">Exports Terraform state file from a given deployment.</p>
100 <p class="toc_element">
101 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
102 <p class="firstline">Gets details about a Deployment.</p>
103 <p class="toc_element">
104 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
105 <p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
106 <p class="toc_element">
107 <code><a href="#importState">importState(parent, body=None, x__xgafv=None)</a></code></p>
108 <p class="firstline">Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.</p>
109 <p class="toc_element">
110 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
111 <p class="firstline">Lists Deployments in a given project and location.</p>
112 <p class="toc_element">
113 <code><a href="#list_next">list_next()</a></code></p>
114 <p class="firstline">Retrieves the next page of results.</p>
115 <p class="toc_element">
116 <code><a href="#lock">lock(name, body=None, x__xgafv=None)</a></code></p>
117 <p class="firstline">Locks a deployment.</p>
118 <p class="toc_element">
119 <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
120 <p class="firstline">Updates a Deployment.</p>
121 <p class="toc_element">
122 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
123 <p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>
124 <p class="toc_element">
125 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
126 <p class="firstline">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.</p>
127 <p class="toc_element">
128 <code><a href="#unlock">unlock(name, body=None, x__xgafv=None)</a></code></p>
129 <p class="firstline">Unlocks a locked deployment.</p>
130 <h3>Method Details</h3>
131 <div class="method">
132 <code class="details" id="close">close()</code>
133 <pre>Close httplib2 connections.</pre>
134 </div>
135
136 <div class="method">
137 <code class="details" id="create">create(parent, body=None, deploymentId=None, requestId=None, x__xgafv=None)</code>
138 <pre>Creates a Deployment.
139
140 Args:
141 parent: string, Required. The parent in whose context the Deployment is created. The parent value is in the format: &#x27;projects/{project_id}/locations/{location}&#x27;. (required)
142 body: object, The request body.
143 The object takes the form of:
144
145 { # A Deployment is a group of resources and configs managed and provisioned by Infra Manager.
146 &quot;annotations&quot;: { # Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployments during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.
147 &quot;a_key&quot;: &quot;A String&quot;,
148 },
149 &quot;artifactsGcsBucket&quot;: &quot;A String&quot;, # User-defined location of Cloud Build logs and artifacts in Google Cloud Storage. Format: `gs://{bucket}/{folder}` A default bucket will be bootstrapped if the field is not set or empty. Default bucket format: `gs://--blueprint-config` Constraints: - The bucket needs to be in the same project as the deployment - The path cannot be within the path of `gcs_source` - The field cannot be updated, including changing its presence
150 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the deployment was created.
151 &quot;deleteBuild&quot;: &quot;A String&quot;, # Output only. Cloud Build instance UUID associated with deleting this deployment.
152 &quot;deleteLogs&quot;: &quot;A String&quot;, # Output only. Location of Cloud Build logs in Google Cloud Storage, populated when deleting this deployment. Format: `gs://{bucket}/{object}`.
153 &quot;deleteResults&quot;: { # Outputs and artifacts from applying a deployment. # Output only. Location of artifacts from a DeleteDeployment operation.
154 &quot;artifacts&quot;: &quot;A String&quot;, # Location of artifacts (e.g. logs) in Google Cloud Storage. Format: `gs://{bucket}/{object}`
155 &quot;content&quot;: &quot;A String&quot;, # Location of a blueprint copy and other manifests in Google Cloud Storage. Format: `gs://{bucket}/{object}`
156 &quot;outputs&quot;: { # Map of output name to output info.
157 &quot;a_key&quot;: { # Describes a Terraform output.
158 &quot;sensitive&quot;: True or False, # Identifies whether Terraform has set this output as a potential sensitive value.
159 &quot;value&quot;: &quot;&quot;, # Value of output.
160 },
161 },
162 },
163 &quot;errorCode&quot;: &quot;A String&quot;, # Output only. Error code describing errors that may have occurred.
164 &quot;errorLogs&quot;: &quot;A String&quot;, # Output only. Location of Terraform error logs in Google Cloud Storage. Format: `gs://{bucket}/{object}`.
165 &quot;importExistingResources&quot;: True or False, # By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation. Not all resource types are supported, refer to documentation.
166 &quot;labels&quot;: { # Optional. User-defined metadata for the deployment.
167 &quot;a_key&quot;: &quot;A String&quot;,
168 },
169 &quot;latestRevision&quot;: &quot;A String&quot;, # Output only. Revision name that was most recently applied. Format: `projects/{project}/locations/{location}/deployments/{deployment}/ revisions/{revision}`
170 &quot;lockState&quot;: &quot;A String&quot;, # Output only. Current lock state of the deployment.
171 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
172 &quot;providerConfig&quot;: { # ProviderConfig contains the provider configurations. # Optional. This field specifies the provider configurations.
173 &quot;sourceType&quot;: &quot;A String&quot;, # Optional. ProviderSource specifies the source type of the provider.
174 },
175 &quot;quotaValidation&quot;: &quot;A String&quot;, # Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.
176 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. User-specified Service Account (SA) credentials to be used when actuating resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
177 &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the deployment.
178 &quot;stateDetail&quot;: &quot;A String&quot;, # Output only. Additional information regarding the current state.
179 &quot;terraformBlueprint&quot;: { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform&#x27;s HashiCorp Configuration Language as a root module.
180 &quot;externalValues&quot;: { # Optional. Map of input variable names in this blueprint to configurations for importing values from external sources.
181 &quot;a_key&quot;: { # Configuration for a source of an external value.
182 &quot;deploymentSource&quot;: { # Configuration for a value sourced from a Deployment. # A source from a Deployment.
183 &quot;deployment&quot;: &quot;A String&quot;, # Required. The resource name of the source Deployment to import the output from. Format: projects/{project}/locations/{location}/deployments/{deployment} The source deployment must be in the same project and location.
184 &quot;outputName&quot;: &quot;A String&quot;, # Required. The name of the output variable in the source deployment&#x27;s latest successfully applied revision.
185 },
186 },
187 },
188 &quot;gcsSource&quot;: &quot;A String&quot;, # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
189 &quot;gitSource&quot;: { # A set of files in a Git repository. # URI of a public Git repo.
190 &quot;directory&quot;: &quot;A String&quot;, # Subdirectory inside the repository. Example: &#x27;staging/my-package&#x27;
191 &quot;ref&quot;: &quot;A String&quot;, # Git reference (e.g. branch or tag).
192 &quot;repo&quot;: &quot;A String&quot;, # Repository URL. Example: &#x27;https://github.com/kubernetes/examples.git&#x27;
193 },
194 &quot;inputValues&quot;: { # Optional. Input variable values for the Terraform blueprint.
195 &quot;a_key&quot;: { # A Terraform input variable.
196 &quot;inputValue&quot;: &quot;&quot;, # Optional. Input variable value.
197 },
198 },
199 },
200 &quot;tfErrors&quot;: [ # Output only. Errors encountered when deleting this deployment. Errors are truncated to 10 entries, see `delete_results` and `error_logs` for full details.
201 { # Errors encountered during actuation using Terraform
202 &quot;error&quot;: { # 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). # Output only. Original error response from underlying Google API, if available.
203 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
204 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
205 {
206 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
207 },
208 ],
209 &quot;message&quot;: &quot;A String&quot;, # 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.
210 },
211 &quot;errorDescription&quot;: &quot;A String&quot;, # A human-readable error description.
212 &quot;httpResponseCode&quot;: 42, # HTTP response code returned from Google Cloud Platform APIs when Terraform fails to provision the resource. If unset or 0, no HTTP response code was returned by Terraform.
213 &quot;resourceAddress&quot;: &quot;A String&quot;, # Address of the resource associated with the error, e.g. `google_compute_network.vpc_network`.
214 },
215 ],
216 &quot;tfVersion&quot;: &quot;A String&quot;, # Output only. The current Terraform version set on the deployment. It is in the format of &quot;Major.Minor.Patch&quot;, for example, &quot;1.3.10&quot;.
217 &quot;tfVersionConstraint&quot;: &quot;A String&quot;, # The user-specified Terraform version constraint. Example: &quot;=1.3.10&quot;.
218 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when the deployment was last modified.
219 &quot;workerPool&quot;: &quot;A String&quot;, # The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.
220 }
221
222 deploymentId: string, Required. The Deployment ID.
223 requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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).
224 x__xgafv: string, V1 error format.
225 Allowed values
226 1 - v1 error format
227 2 - v2 error format
228
229 Returns:
230 An object of the form:
231
232 { # This resource represents a long-running operation that is the result of a network API call.
233 &quot;done&quot;: 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.
234 &quot;error&quot;: { # 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.
235 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
236 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
237 {
238 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
239 },
240 ],
241 &quot;message&quot;: &quot;A String&quot;, # 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.
242 },
243 &quot;metadata&quot;: { # 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.
244 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
245 },
246 &quot;name&quot;: &quot;A String&quot;, # 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}`.
247 &quot;response&quot;: { # 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`.
248 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
249 },
250 }</pre>
251 </div>
252
253 <div class="method">
254 <code class="details" id="delete">delete(name, deletePolicy=None, force=None, requestId=None, x__xgafv=None)</code>
255 <pre>Deletes a Deployment.
256
257 Args:
258 name: string, Required. The name of the Deployment in the format: &#x27;projects/{project_id}/locations/{location}/deployments/{deployment}&#x27;. (required)
259 deletePolicy: string, Optional. Policy on how resources actuated by the deployment should be deleted. If unspecified, the default behavior is to delete the underlying resources.
260 Allowed values
261 DELETE_POLICY_UNSPECIFIED - Unspecified policy, resources will be deleted.
262 DELETE - Deletes resources actuated by the deployment.
263 ABANDON - Abandons resources and only deletes the deployment and its metadata.
264 force: boolean, Optional. If set to true, any revisions for this deployment will also be deleted. (Otherwise, the request will only work if the deployment has no revisions.)
265 requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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).
266 x__xgafv: string, V1 error format.
267 Allowed values
268 1 - v1 error format
269 2 - v2 error format
270
271 Returns:
272 An object of the form:
273
274 { # This resource represents a long-running operation that is the result of a network API call.
275 &quot;done&quot;: 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.
276 &quot;error&quot;: { # 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.
277 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
278 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
279 {
280 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
281 },
282 ],
283 &quot;message&quot;: &quot;A String&quot;, # 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.
284 },
285 &quot;metadata&quot;: { # 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.
286 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
287 },
288 &quot;name&quot;: &quot;A String&quot;, # 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}`.
289 &quot;response&quot;: { # 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`.
290 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
291 },
292 }</pre>
293 </div>
294
295 <div class="method">
296 <code class="details" id="deleteState">deleteState(name, body=None, x__xgafv=None)</code>
297 <pre>Deletes Terraform state file in a given deployment.
298
299 Args:
300 name: string, Required. The name of the deployment in the format: &#x27;projects/{project_id}/locations/{location}/deployments/{deployment}&#x27;. (required)
301 body: object, The request body.
302 The object takes the form of:
303
304 { # A request to delete a state file passed to a &#x27;DeleteStatefile&#x27; call.
305 &quot;lockId&quot;: &quot;A String&quot;, # Required. Lock ID of the lock file to verify that the user who is deleting the state file previously locked the Deployment.
306 }
307
308 x__xgafv: string, V1 error format.
309 Allowed values
310 1 - v1 error format
311 2 - v2 error format
312
313 Returns:
314 An object of the form:
315
316 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
317 }</pre>
318 </div>
319
320 <div class="method">
321 <code class="details" id="exportLock">exportLock(name, x__xgafv=None)</code>
322 <pre>Exports the lock info on a locked deployment.
323
324 Args:
325 name: string, Required. The name of the deployment in the format: &#x27;projects/{project_id}/locations/{location}/deployments/{deployment}&#x27;. (required)
326 x__xgafv: string, V1 error format.
327 Allowed values
328 1 - v1 error format
329 2 - v2 error format
330
331 Returns:
332 An object of the form:
333
334 { # Details about the lock which locked the deployment.
335 &quot;createTime&quot;: &quot;A String&quot;, # Time that the lock was taken.
336 &quot;info&quot;: &quot;A String&quot;, # Extra information to store with the lock, provided by the caller.
337 &quot;lockId&quot;: &quot;A String&quot;, # Unique ID for the lock to be overridden with generation ID in the backend.
338 &quot;operation&quot;: &quot;A String&quot;, # Terraform operation, provided by the caller.
339 &quot;version&quot;: &quot;A String&quot;, # Terraform version
340 &quot;who&quot;: &quot;A String&quot;, # user@hostname when available
341 }</pre>
342 </div>
343
344 <div class="method">
345 <code class="details" id="exportState">exportState(parent, body=None, x__xgafv=None)</code>
346 <pre>Exports Terraform state file from a given deployment.
347
348 Args:
349 parent: string, Required. The parent in whose context the statefile is listed. The parent value is in the format: &#x27;projects/{project_id}/locations/{location}/deployments/{deployment}&#x27;. (required)
350 body: object, The request body.
351 The object takes the form of:
352
353 { # A request to export a state file passed to a &#x27;ExportDeploymentStatefile&#x27; call.
354 &quot;draft&quot;: True or False, # Optional. If this flag is set to true, the exported deployment state file will be the draft state. This will enable the draft file to be validated before copying it over to the working state on unlock.
355 }
356
357 x__xgafv: string, V1 error format.
358 Allowed values
359 1 - v1 error format
360 2 - v2 error format
361
362 Returns:
363 An object of the form:
364
365 { # Contains info about a Terraform state file
366 &quot;signedUri&quot;: &quot;A String&quot;, # Output only. Cloud Storage signed URI used for downloading or uploading the state file.
367 }</pre>
368 </div>
369
370 <div class="method">
371 <code class="details" id="get">get(name, x__xgafv=None)</code>
372 <pre>Gets details about a Deployment.
373
374 Args:
375 name: string, Required. The name of the deployment. Format: &#x27;projects/{project_id}/locations/{location}/deployments/{deployment}&#x27;. (required)
376 x__xgafv: string, V1 error format.
377 Allowed values
378 1 - v1 error format
379 2 - v2 error format
380
381 Returns:
382 An object of the form:
383
384 { # A Deployment is a group of resources and configs managed and provisioned by Infra Manager.
385 &quot;annotations&quot;: { # Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployments during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.
386 &quot;a_key&quot;: &quot;A String&quot;,
387 },
388 &quot;artifactsGcsBucket&quot;: &quot;A String&quot;, # User-defined location of Cloud Build logs and artifacts in Google Cloud Storage. Format: `gs://{bucket}/{folder}` A default bucket will be bootstrapped if the field is not set or empty. Default bucket format: `gs://--blueprint-config` Constraints: - The bucket needs to be in the same project as the deployment - The path cannot be within the path of `gcs_source` - The field cannot be updated, including changing its presence
389 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the deployment was created.
390 &quot;deleteBuild&quot;: &quot;A String&quot;, # Output only. Cloud Build instance UUID associated with deleting this deployment.
391 &quot;deleteLogs&quot;: &quot;A String&quot;, # Output only. Location of Cloud Build logs in Google Cloud Storage, populated when deleting this deployment. Format: `gs://{bucket}/{object}`.
392 &quot;deleteResults&quot;: { # Outputs and artifacts from applying a deployment. # Output only. Location of artifacts from a DeleteDeployment operation.
393 &quot;artifacts&quot;: &quot;A String&quot;, # Location of artifacts (e.g. logs) in Google Cloud Storage. Format: `gs://{bucket}/{object}`
394 &quot;content&quot;: &quot;A String&quot;, # Location of a blueprint copy and other manifests in Google Cloud Storage. Format: `gs://{bucket}/{object}`
395 &quot;outputs&quot;: { # Map of output name to output info.
396 &quot;a_key&quot;: { # Describes a Terraform output.
397 &quot;sensitive&quot;: True or False, # Identifies whether Terraform has set this output as a potential sensitive value.
398 &quot;value&quot;: &quot;&quot;, # Value of output.
399 },
400 },
401 },
402 &quot;errorCode&quot;: &quot;A String&quot;, # Output only. Error code describing errors that may have occurred.
403 &quot;errorLogs&quot;: &quot;A String&quot;, # Output only. Location of Terraform error logs in Google Cloud Storage. Format: `gs://{bucket}/{object}`.
404 &quot;importExistingResources&quot;: True or False, # By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation. Not all resource types are supported, refer to documentation.
405 &quot;labels&quot;: { # Optional. User-defined metadata for the deployment.
406 &quot;a_key&quot;: &quot;A String&quot;,
407 },
408 &quot;latestRevision&quot;: &quot;A String&quot;, # Output only. Revision name that was most recently applied. Format: `projects/{project}/locations/{location}/deployments/{deployment}/ revisions/{revision}`
409 &quot;lockState&quot;: &quot;A String&quot;, # Output only. Current lock state of the deployment.
410 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
411 &quot;providerConfig&quot;: { # ProviderConfig contains the provider configurations. # Optional. This field specifies the provider configurations.
412 &quot;sourceType&quot;: &quot;A String&quot;, # Optional. ProviderSource specifies the source type of the provider.
413 },
414 &quot;quotaValidation&quot;: &quot;A String&quot;, # Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.
415 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. User-specified Service Account (SA) credentials to be used when actuating resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
416 &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the deployment.
417 &quot;stateDetail&quot;: &quot;A String&quot;, # Output only. Additional information regarding the current state.
418 &quot;terraformBlueprint&quot;: { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform&#x27;s HashiCorp Configuration Language as a root module.
419 &quot;externalValues&quot;: { # Optional. Map of input variable names in this blueprint to configurations for importing values from external sources.
420 &quot;a_key&quot;: { # Configuration for a source of an external value.
421 &quot;deploymentSource&quot;: { # Configuration for a value sourced from a Deployment. # A source from a Deployment.
422 &quot;deployment&quot;: &quot;A String&quot;, # Required. The resource name of the source Deployment to import the output from. Format: projects/{project}/locations/{location}/deployments/{deployment} The source deployment must be in the same project and location.
423 &quot;outputName&quot;: &quot;A String&quot;, # Required. The name of the output variable in the source deployment&#x27;s latest successfully applied revision.
424 },
425 },
426 },
427 &quot;gcsSource&quot;: &quot;A String&quot;, # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
428 &quot;gitSource&quot;: { # A set of files in a Git repository. # URI of a public Git repo.
429 &quot;directory&quot;: &quot;A String&quot;, # Subdirectory inside the repository. Example: &#x27;staging/my-package&#x27;
430 &quot;ref&quot;: &quot;A String&quot;, # Git reference (e.g. branch or tag).
431 &quot;repo&quot;: &quot;A String&quot;, # Repository URL. Example: &#x27;https://github.com/kubernetes/examples.git&#x27;
432 },
433 &quot;inputValues&quot;: { # Optional. Input variable values for the Terraform blueprint.
434 &quot;a_key&quot;: { # A Terraform input variable.
435 &quot;inputValue&quot;: &quot;&quot;, # Optional. Input variable value.
436 },
437 },
438 },
439 &quot;tfErrors&quot;: [ # Output only. Errors encountered when deleting this deployment. Errors are truncated to 10 entries, see `delete_results` and `error_logs` for full details.
440 { # Errors encountered during actuation using Terraform
441 &quot;error&quot;: { # 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). # Output only. Original error response from underlying Google API, if available.
442 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
443 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
444 {
445 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
446 },
447 ],
448 &quot;message&quot;: &quot;A String&quot;, # 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.
449 },
450 &quot;errorDescription&quot;: &quot;A String&quot;, # A human-readable error description.
451 &quot;httpResponseCode&quot;: 42, # HTTP response code returned from Google Cloud Platform APIs when Terraform fails to provision the resource. If unset or 0, no HTTP response code was returned by Terraform.
452 &quot;resourceAddress&quot;: &quot;A String&quot;, # Address of the resource associated with the error, e.g. `google_compute_network.vpc_network`.
453 },
454 ],
455 &quot;tfVersion&quot;: &quot;A String&quot;, # Output only. The current Terraform version set on the deployment. It is in the format of &quot;Major.Minor.Patch&quot;, for example, &quot;1.3.10&quot;.
456 &quot;tfVersionConstraint&quot;: &quot;A String&quot;, # The user-specified Terraform version constraint. Example: &quot;=1.3.10&quot;.
457 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when the deployment was last modified.
458 &quot;workerPool&quot;: &quot;A String&quot;, # The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.
459 }</pre>
460 </div>
461
462 <div class="method">
463 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
464 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
465
466 Args:
467 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)
468 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).
469 x__xgafv: string, V1 error format.
470 Allowed values
471 1 - v1 error format
472 2 - v2 error format
473
474 Returns:
475 An object of the form:
476
477 { # 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:** ``` { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:[email protected]&quot;, &quot;group:[email protected]&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:[email protected]&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:[email protected]&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
478 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
479 { # 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: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging.
480 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
481 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting [email protected] from DATA_READ logging.
482 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
483 &quot;A String&quot;,
484 ],
485 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
486 },
487 ],
488 &quot;service&quot;: &quot;A String&quot;, # 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.
489 },
490 ],
491 &quot;bindings&quot;: [ # 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:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
492 { # Associates `members`, or principals, with a `role`.
493 &quot;condition&quot;: { # 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: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; 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).
494 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
495 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
496 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
497 &quot;title&quot;: &quot;A String&quot;, # 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.
498 },
499 &quot;members&quot;: [ # 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, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `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, `[email protected]`. * `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, `[email protected]?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, `[email protected]?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, `[email protected]?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`.
500 &quot;A String&quot;,
501 ],
502 &quot;role&quot;: &quot;A String&quot;, # 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).
503 },
504 ],
505 &quot;etag&quot;: &quot;A String&quot;, # `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.
506 &quot;version&quot;: 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).
507 }</pre>
508 </div>
509
510 <div class="method">
511 <code class="details" id="importState">importState(parent, body=None, x__xgafv=None)</code>
512 <pre>Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.
513
514 Args:
515 parent: string, Required. The parent in whose context the statefile is listed. The parent value is in the format: &#x27;projects/{project_id}/locations/{location}/deployments/{deployment}&#x27;. (required)
516 body: object, The request body.
517 The object takes the form of:
518
519 { # A request to import a state file passed to a &#x27;ImportStatefile&#x27; call.
520 &quot;lockId&quot;: &quot;A String&quot;, # Required. Lock ID of the lock file to verify that the user who is importing the state file previously locked the Deployment.
521 }
522
523 x__xgafv: string, V1 error format.
524 Allowed values
525 1 - v1 error format
526 2 - v2 error format
527
528 Returns:
529 An object of the form:
530
531 { # Contains info about a Terraform state file
532 &quot;signedUri&quot;: &quot;A String&quot;, # Output only. Cloud Storage signed URI used for downloading or uploading the state file.
533 }</pre>
534 </div>
535
536 <div class="method">
537 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
538 <pre>Lists Deployments in a given project and location.
539
540 Args:
541 parent: string, Required. The parent in whose context the Deployments are listed. The parent value is in the format: &#x27;projects/{project_id}/locations/{location}&#x27;. (required)
542 filter: string, Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form &#x27;{field} {operator} {value}&#x27; where operators: &#x27;&lt;&#x27;, &#x27;&gt;&#x27;, &#x27;&lt;=&#x27;, &#x27;&gt;=&#x27;, &#x27;!=&#x27;, &#x27;=&#x27;, &#x27;:&#x27; are supported (colon &#x27;:&#x27; represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = &quot;projects/foo/locations/us-central1/deployments/bar - Filter by labels: - Resources that have a key called &#x27;foo&#x27; labels.foo:* - Resources that have a key called &#x27;foo&#x27; whose value is &#x27;bar&#x27; labels.foo = bar - Filter by state: - Deployments in CREATING state. state=CREATING
543 orderBy: string, Field to use to sort the list.
544 pageSize: integer, When requesting a page of resources, &#x27;page_size&#x27; specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
545 pageToken: string, Token returned by previous call to &#x27;ListDeployments&#x27; which specifies the position in the list from where to continue listing the resources.
546 x__xgafv: string, V1 error format.
547 Allowed values
548 1 - v1 error format
549 2 - v2 error format
550
551 Returns:
552 An object of the form:
553
554 {
555 &quot;deployments&quot;: [ # List of Deployments.
556 { # A Deployment is a group of resources and configs managed and provisioned by Infra Manager.
557 &quot;annotations&quot;: { # Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployments during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.
558 &quot;a_key&quot;: &quot;A String&quot;,
559 },
560 &quot;artifactsGcsBucket&quot;: &quot;A String&quot;, # User-defined location of Cloud Build logs and artifacts in Google Cloud Storage. Format: `gs://{bucket}/{folder}` A default bucket will be bootstrapped if the field is not set or empty. Default bucket format: `gs://--blueprint-config` Constraints: - The bucket needs to be in the same project as the deployment - The path cannot be within the path of `gcs_source` - The field cannot be updated, including changing its presence
561 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the deployment was created.
562 &quot;deleteBuild&quot;: &quot;A String&quot;, # Output only. Cloud Build instance UUID associated with deleting this deployment.
563 &quot;deleteLogs&quot;: &quot;A String&quot;, # Output only. Location of Cloud Build logs in Google Cloud Storage, populated when deleting this deployment. Format: `gs://{bucket}/{object}`.
564 &quot;deleteResults&quot;: { # Outputs and artifacts from applying a deployment. # Output only. Location of artifacts from a DeleteDeployment operation.
565 &quot;artifacts&quot;: &quot;A String&quot;, # Location of artifacts (e.g. logs) in Google Cloud Storage. Format: `gs://{bucket}/{object}`
566 &quot;content&quot;: &quot;A String&quot;, # Location of a blueprint copy and other manifests in Google Cloud Storage. Format: `gs://{bucket}/{object}`
567 &quot;outputs&quot;: { # Map of output name to output info.
568 &quot;a_key&quot;: { # Describes a Terraform output.
569 &quot;sensitive&quot;: True or False, # Identifies whether Terraform has set this output as a potential sensitive value.
570 &quot;value&quot;: &quot;&quot;, # Value of output.
571 },
572 },
573 },
574 &quot;errorCode&quot;: &quot;A String&quot;, # Output only. Error code describing errors that may have occurred.
575 &quot;errorLogs&quot;: &quot;A String&quot;, # Output only. Location of Terraform error logs in Google Cloud Storage. Format: `gs://{bucket}/{object}`.
576 &quot;importExistingResources&quot;: True or False, # By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation. Not all resource types are supported, refer to documentation.
577 &quot;labels&quot;: { # Optional. User-defined metadata for the deployment.
578 &quot;a_key&quot;: &quot;A String&quot;,
579 },
580 &quot;latestRevision&quot;: &quot;A String&quot;, # Output only. Revision name that was most recently applied. Format: `projects/{project}/locations/{location}/deployments/{deployment}/ revisions/{revision}`
581 &quot;lockState&quot;: &quot;A String&quot;, # Output only. Current lock state of the deployment.
582 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
583 &quot;providerConfig&quot;: { # ProviderConfig contains the provider configurations. # Optional. This field specifies the provider configurations.
584 &quot;sourceType&quot;: &quot;A String&quot;, # Optional. ProviderSource specifies the source type of the provider.
585 },
586 &quot;quotaValidation&quot;: &quot;A String&quot;, # Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.
587 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. User-specified Service Account (SA) credentials to be used when actuating resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
588 &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the deployment.
589 &quot;stateDetail&quot;: &quot;A String&quot;, # Output only. Additional information regarding the current state.
590 &quot;terraformBlueprint&quot;: { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform&#x27;s HashiCorp Configuration Language as a root module.
591 &quot;externalValues&quot;: { # Optional. Map of input variable names in this blueprint to configurations for importing values from external sources.
592 &quot;a_key&quot;: { # Configuration for a source of an external value.
593 &quot;deploymentSource&quot;: { # Configuration for a value sourced from a Deployment. # A source from a Deployment.
594 &quot;deployment&quot;: &quot;A String&quot;, # Required. The resource name of the source Deployment to import the output from. Format: projects/{project}/locations/{location}/deployments/{deployment} The source deployment must be in the same project and location.
595 &quot;outputName&quot;: &quot;A String&quot;, # Required. The name of the output variable in the source deployment&#x27;s latest successfully applied revision.
596 },
597 },
598 },
599 &quot;gcsSource&quot;: &quot;A String&quot;, # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
600 &quot;gitSource&quot;: { # A set of files in a Git repository. # URI of a public Git repo.
601 &quot;directory&quot;: &quot;A String&quot;, # Subdirectory inside the repository. Example: &#x27;staging/my-package&#x27;
602 &quot;ref&quot;: &quot;A String&quot;, # Git reference (e.g. branch or tag).
603 &quot;repo&quot;: &quot;A String&quot;, # Repository URL. Example: &#x27;https://github.com/kubernetes/examples.git&#x27;
604 },
605 &quot;inputValues&quot;: { # Optional. Input variable values for the Terraform blueprint.
606 &quot;a_key&quot;: { # A Terraform input variable.
607 &quot;inputValue&quot;: &quot;&quot;, # Optional. Input variable value.
608 },
609 },
610 },
611 &quot;tfErrors&quot;: [ # Output only. Errors encountered when deleting this deployment. Errors are truncated to 10 entries, see `delete_results` and `error_logs` for full details.
612 { # Errors encountered during actuation using Terraform
613 &quot;error&quot;: { # 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). # Output only. Original error response from underlying Google API, if available.
614 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
615 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
616 {
617 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
618 },
619 ],
620 &quot;message&quot;: &quot;A String&quot;, # 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.
621 },
622 &quot;errorDescription&quot;: &quot;A String&quot;, # A human-readable error description.
623 &quot;httpResponseCode&quot;: 42, # HTTP response code returned from Google Cloud Platform APIs when Terraform fails to provision the resource. If unset or 0, no HTTP response code was returned by Terraform.
624 &quot;resourceAddress&quot;: &quot;A String&quot;, # Address of the resource associated with the error, e.g. `google_compute_network.vpc_network`.
625 },
626 ],
627 &quot;tfVersion&quot;: &quot;A String&quot;, # Output only. The current Terraform version set on the deployment. It is in the format of &quot;Major.Minor.Patch&quot;, for example, &quot;1.3.10&quot;.
628 &quot;tfVersionConstraint&quot;: &quot;A String&quot;, # The user-specified Terraform version constraint. Example: &quot;=1.3.10&quot;.
629 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when the deployment was last modified.
630 &quot;workerPool&quot;: &quot;A String&quot;, # The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.
631 },
632 ],
633 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to be supplied to the next ListDeployments request via `page_token` to obtain the next set of results.
634 &quot;unreachable&quot;: [ # Locations that could not be reached.
635 &quot;A String&quot;,
636 ],
637 }</pre>
638 </div>
639
640 <div class="method">
641 <code class="details" id="list_next">list_next()</code>
642 <pre>Retrieves the next page of results.
643
644 Args:
645 previous_request: The request for the previous page. (required)
646 previous_response: The response from the request for the previous page. (required)
647
648 Returns:
649 A request object that you can call &#x27;execute()&#x27; on to request the next
650 page. Returns None if there are no more items in the collection.
651 </pre>
652 </div>
653
654 <div class="method">
655 <code class="details" id="lock">lock(name, body=None, x__xgafv=None)</code>
656 <pre>Locks a deployment.
657
658 Args:
659 name: string, Required. The name of the deployment in the format: &#x27;projects/{project_id}/locations/{location}/deployments/{deployment}&#x27;. (required)
660 body: object, The request body.
661 The object takes the form of:
662
663 { # A request to lock a deployment passed to a &#x27;LockDeployment&#x27; call.
664 }
665
666 x__xgafv: string, V1 error format.
667 Allowed values
668 1 - v1 error format
669 2 - v2 error format
670
671 Returns:
672 An object of the form:
673
674 { # This resource represents a long-running operation that is the result of a network API call.
675 &quot;done&quot;: 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.
676 &quot;error&quot;: { # 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.
677 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
678 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
679 {
680 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
681 },
682 ],
683 &quot;message&quot;: &quot;A String&quot;, # 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.
684 },
685 &quot;metadata&quot;: { # 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.
686 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
687 },
688 &quot;name&quot;: &quot;A String&quot;, # 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}`.
689 &quot;response&quot;: { # 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`.
690 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
691 },
692 }</pre>
693 </div>
694
695 <div class="method">
696 <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
697 <pre>Updates a Deployment.
698
699 Args:
700 name: string, Identifier. Resource name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}` (required)
701 body: object, The request body.
702 The object takes the form of:
703
704 { # A Deployment is a group of resources and configs managed and provisioned by Infra Manager.
705 &quot;annotations&quot;: { # Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployments during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.
706 &quot;a_key&quot;: &quot;A String&quot;,
707 },
708 &quot;artifactsGcsBucket&quot;: &quot;A String&quot;, # User-defined location of Cloud Build logs and artifacts in Google Cloud Storage. Format: `gs://{bucket}/{folder}` A default bucket will be bootstrapped if the field is not set or empty. Default bucket format: `gs://--blueprint-config` Constraints: - The bucket needs to be in the same project as the deployment - The path cannot be within the path of `gcs_source` - The field cannot be updated, including changing its presence
709 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the deployment was created.
710 &quot;deleteBuild&quot;: &quot;A String&quot;, # Output only. Cloud Build instance UUID associated with deleting this deployment.
711 &quot;deleteLogs&quot;: &quot;A String&quot;, # Output only. Location of Cloud Build logs in Google Cloud Storage, populated when deleting this deployment. Format: `gs://{bucket}/{object}`.
712 &quot;deleteResults&quot;: { # Outputs and artifacts from applying a deployment. # Output only. Location of artifacts from a DeleteDeployment operation.
713 &quot;artifacts&quot;: &quot;A String&quot;, # Location of artifacts (e.g. logs) in Google Cloud Storage. Format: `gs://{bucket}/{object}`
714 &quot;content&quot;: &quot;A String&quot;, # Location of a blueprint copy and other manifests in Google Cloud Storage. Format: `gs://{bucket}/{object}`
715 &quot;outputs&quot;: { # Map of output name to output info.
716 &quot;a_key&quot;: { # Describes a Terraform output.
717 &quot;sensitive&quot;: True or False, # Identifies whether Terraform has set this output as a potential sensitive value.
718 &quot;value&quot;: &quot;&quot;, # Value of output.
719 },
720 },
721 },
722 &quot;errorCode&quot;: &quot;A String&quot;, # Output only. Error code describing errors that may have occurred.
723 &quot;errorLogs&quot;: &quot;A String&quot;, # Output only. Location of Terraform error logs in Google Cloud Storage. Format: `gs://{bucket}/{object}`.
724 &quot;importExistingResources&quot;: True or False, # By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation. Not all resource types are supported, refer to documentation.
725 &quot;labels&quot;: { # Optional. User-defined metadata for the deployment.
726 &quot;a_key&quot;: &quot;A String&quot;,
727 },
728 &quot;latestRevision&quot;: &quot;A String&quot;, # Output only. Revision name that was most recently applied. Format: `projects/{project}/locations/{location}/deployments/{deployment}/ revisions/{revision}`
729 &quot;lockState&quot;: &quot;A String&quot;, # Output only. Current lock state of the deployment.
730 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
731 &quot;providerConfig&quot;: { # ProviderConfig contains the provider configurations. # Optional. This field specifies the provider configurations.
732 &quot;sourceType&quot;: &quot;A String&quot;, # Optional. ProviderSource specifies the source type of the provider.
733 },
734 &quot;quotaValidation&quot;: &quot;A String&quot;, # Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.
735 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. User-specified Service Account (SA) credentials to be used when actuating resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
736 &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the deployment.
737 &quot;stateDetail&quot;: &quot;A String&quot;, # Output only. Additional information regarding the current state.
738 &quot;terraformBlueprint&quot;: { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform&#x27;s HashiCorp Configuration Language as a root module.
739 &quot;externalValues&quot;: { # Optional. Map of input variable names in this blueprint to configurations for importing values from external sources.
740 &quot;a_key&quot;: { # Configuration for a source of an external value.
741 &quot;deploymentSource&quot;: { # Configuration for a value sourced from a Deployment. # A source from a Deployment.
742 &quot;deployment&quot;: &quot;A String&quot;, # Required. The resource name of the source Deployment to import the output from. Format: projects/{project}/locations/{location}/deployments/{deployment} The source deployment must be in the same project and location.
743 &quot;outputName&quot;: &quot;A String&quot;, # Required. The name of the output variable in the source deployment&#x27;s latest successfully applied revision.
744 },
745 },
746 },
747 &quot;gcsSource&quot;: &quot;A String&quot;, # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
748 &quot;gitSource&quot;: { # A set of files in a Git repository. # URI of a public Git repo.
749 &quot;directory&quot;: &quot;A String&quot;, # Subdirectory inside the repository. Example: &#x27;staging/my-package&#x27;
750 &quot;ref&quot;: &quot;A String&quot;, # Git reference (e.g. branch or tag).
751 &quot;repo&quot;: &quot;A String&quot;, # Repository URL. Example: &#x27;https://github.com/kubernetes/examples.git&#x27;
752 },
753 &quot;inputValues&quot;: { # Optional. Input variable values for the Terraform blueprint.
754 &quot;a_key&quot;: { # A Terraform input variable.
755 &quot;inputValue&quot;: &quot;&quot;, # Optional. Input variable value.
756 },
757 },
758 },
759 &quot;tfErrors&quot;: [ # Output only. Errors encountered when deleting this deployment. Errors are truncated to 10 entries, see `delete_results` and `error_logs` for full details.
760 { # Errors encountered during actuation using Terraform
761 &quot;error&quot;: { # 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). # Output only. Original error response from underlying Google API, if available.
762 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
763 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
764 {
765 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
766 },
767 ],
768 &quot;message&quot;: &quot;A String&quot;, # 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.
769 },
770 &quot;errorDescription&quot;: &quot;A String&quot;, # A human-readable error description.
771 &quot;httpResponseCode&quot;: 42, # HTTP response code returned from Google Cloud Platform APIs when Terraform fails to provision the resource. If unset or 0, no HTTP response code was returned by Terraform.
772 &quot;resourceAddress&quot;: &quot;A String&quot;, # Address of the resource associated with the error, e.g. `google_compute_network.vpc_network`.
773 },
774 ],
775 &quot;tfVersion&quot;: &quot;A String&quot;, # Output only. The current Terraform version set on the deployment. It is in the format of &quot;Major.Minor.Patch&quot;, for example, &quot;1.3.10&quot;.
776 &quot;tfVersionConstraint&quot;: &quot;A String&quot;, # The user-specified Terraform version constraint. Example: &quot;=1.3.10&quot;.
777 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when the deployment was last modified.
778 &quot;workerPool&quot;: &quot;A String&quot;, # The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.
779 }
780
781 requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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).
782 updateMask: string, Optional. Field mask used to specify the fields to be overwritten in the Deployment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
783 x__xgafv: string, V1 error format.
784 Allowed values
785 1 - v1 error format
786 2 - v2 error format
787
788 Returns:
789 An object of the form:
790
791 { # This resource represents a long-running operation that is the result of a network API call.
792 &quot;done&quot;: 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.
793 &quot;error&quot;: { # 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.
794 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
795 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
796 {
797 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
798 },
799 ],
800 &quot;message&quot;: &quot;A String&quot;, # 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.
801 },
802 &quot;metadata&quot;: { # 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.
803 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
804 },
805 &quot;name&quot;: &quot;A String&quot;, # 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}`.
806 &quot;response&quot;: { # 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`.
807 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
808 },
809 }</pre>
810 </div>
811
812 <div class="method">
813 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
814 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
815
816 Args:
817 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)
818 body: object, The request body.
819 The object takes the form of:
820
821 { # Request message for `SetIamPolicy` method.
822 &quot;policy&quot;: { # 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:** ``` { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:[email protected]&quot;, &quot;group:[email protected]&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:[email protected]&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:[email protected]&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) 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.
823 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
824 { # 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: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging.
825 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
826 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting [email protected] from DATA_READ logging.
827 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
828 &quot;A String&quot;,
829 ],
830 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
831 },
832 ],
833 &quot;service&quot;: &quot;A String&quot;, # 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.
834 },
835 ],
836 &quot;bindings&quot;: [ # 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:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
837 { # Associates `members`, or principals, with a `role`.
838 &quot;condition&quot;: { # 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: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; 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).
839 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
840 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
841 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
842 &quot;title&quot;: &quot;A String&quot;, # 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.
843 },
844 &quot;members&quot;: [ # 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, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `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, `[email protected]`. * `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, `[email protected]?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, `[email protected]?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, `[email protected]?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`.
845 &quot;A String&quot;,
846 ],
847 &quot;role&quot;: &quot;A String&quot;, # 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).
848 },
849 ],
850 &quot;etag&quot;: &quot;A String&quot;, # `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.
851 &quot;version&quot;: 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).
852 },
853 &quot;updateMask&quot;: &quot;A String&quot;, # 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: &quot;bindings, etag&quot;`
854 }
855
856 x__xgafv: string, V1 error format.
857 Allowed values
858 1 - v1 error format
859 2 - v2 error format
860
861 Returns:
862 An object of the form:
863
864 { # 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:** ``` { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:[email protected]&quot;, &quot;group:[email protected]&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:[email protected]&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:[email protected]&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
865 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
866 { # 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: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging.
867 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
868 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting [email protected] from DATA_READ logging.
869 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
870 &quot;A String&quot;,
871 ],
872 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
873 },
874 ],
875 &quot;service&quot;: &quot;A String&quot;, # 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.
876 },
877 ],
878 &quot;bindings&quot;: [ # 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:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
879 { # Associates `members`, or principals, with a `role`.
880 &quot;condition&quot;: { # 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: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; 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).
881 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
882 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
883 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
884 &quot;title&quot;: &quot;A String&quot;, # 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.
885 },
886 &quot;members&quot;: [ # 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, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `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, `[email protected]`. * `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, `[email protected]?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, `[email protected]?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, `[email protected]?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`.
887 &quot;A String&quot;,
888 ],
889 &quot;role&quot;: &quot;A String&quot;, # 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).
890 },
891 ],
892 &quot;etag&quot;: &quot;A String&quot;, # `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.
893 &quot;version&quot;: 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).
894 }</pre>
895 </div>
896
897 <div class="method">
898 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
899 <pre>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 &quot;fail open&quot; without warning.
900
901 Args:
902 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)
903 body: object, The request body.
904 The object takes the form of:
905
906 { # Request message for `TestIamPermissions` method.
907 &quot;permissions&quot;: [ # 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).
908 &quot;A String&quot;,
909 ],
910 }
911
912 x__xgafv: string, V1 error format.
913 Allowed values
914 1 - v1 error format
915 2 - v2 error format
916
917 Returns:
918 An object of the form:
919
920 { # Response message for `TestIamPermissions` method.
921 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
922 &quot;A String&quot;,
923 ],
924 }</pre>
925 </div>
926
927 <div class="method">
928 <code class="details" id="unlock">unlock(name, body=None, x__xgafv=None)</code>
929 <pre>Unlocks a locked deployment.
930
931 Args:
932 name: string, Required. The name of the deployment in the format: &#x27;projects/{project_id}/locations/{location}/deployments/{deployment}&#x27;. (required)
933 body: object, The request body.
934 The object takes the form of:
935
936 { # A request to unlock a state file passed to a &#x27;UnlockDeployment&#x27; call.
937 &quot;lockId&quot;: &quot;A String&quot;, # Required. Lock ID of the lock file to be unlocked.
938 }
939
940 x__xgafv: string, V1 error format.
941 Allowed values
942 1 - v1 error format
943 2 - v2 error format
944
945 Returns:
946 An object of the form:
947
948 { # This resource represents a long-running operation that is the result of a network API call.
949 &quot;done&quot;: 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.
950 &quot;error&quot;: { # 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.
951 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
952 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
953 {
954 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
955 },
956 ],
957 &quot;message&quot;: &quot;A String&quot;, # 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.
958 },
959 &quot;metadata&quot;: { # 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.
960 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
961 },
962 &quot;name&quot;: &quot;A String&quot;, # 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}`.
963 &quot;response&quot;: { # 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`.
964 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
965 },
966 }</pre>
967 </div>
968
969 </body></html>