Debian Codegraph @

docs/dyn/compute_alpha.regionNotificationEndpoints.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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionNotificationEndpoints.html">regionNotificationEndpoints</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Retrieves the list of all NotificationEndpoint resources,</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
82 <p class="firstline">Retrieves the next page of results.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#delete">delete(project, region, notificationEndpoint, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified NotificationEndpoint in the given region</p>
89 <p class="toc_element">
90 <code><a href="#get">get(project, region, notificationEndpoint, x__xgafv=None)</a></code></p>
91 <p class="firstline">Returns the specified NotificationEndpoint resource in the given region.</p>
92 <p class="toc_element">
93 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Create a NotificationEndpoint in the specified project in the given region</p>
95 <p class="toc_element">
96 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Lists the NotificationEndpoints for a project in the given region.</p>
98 <p class="toc_element">
99 <code><a href="#list_next">list_next()</a></code></p>
100 <p class="firstline">Retrieves the next page of results.</p>
101 <p class="toc_element">
102 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
107 <pre>Retrieves the list of all NotificationEndpoint resources,
108 regional and global, available to the specified project.
109
110 Args:
111 project: string, Name of the project scoping this request. (required)
112 filter: string, A filter expression that filters resources listed in the response. Most
113 Compute resources support two types of filter expressions:
114 expressions that support regular expressions and expressions that follow
115 API improvement proposal AIP-160.
116 These two types of filter expressions cannot be mixed in one request.
117
118 If you want to use AIP-160, your expression must specify the field name, an
119 operator, and the value that you want to use for filtering. The value
120 must be a string, a number, or a boolean. The operator
121 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
122
123 For example, if you are filtering Compute Engine instances, you can
124 exclude instances named `example-instance` by specifying
125 `name != example-instance`.
126
127 The `:*` comparison can be used to test whether a key has been defined.
128 For example, to find all objects with `owner` label use:
129 ```
130 labels.owner:*
131 ```
132
133 You can also filter nested fields. For example, you could specify
134 `scheduling.automaticRestart = false` to include instances only
135 if they are not scheduled for automatic restarts. You can use filtering
136 on nested fields to filter based onresource labels.
137
138 To filter on multiple expressions, provide each separate expression within
139 parentheses. For example:
140 ```
141 (scheduling.automaticRestart = true)
142 (cpuPlatform = &quot;Intel Skylake&quot;)
143 ```
144 By default, each expression is an `AND` expression. However, you
145 can include `AND` and `OR` expressions explicitly.
146 For example:
147 ```
148 (cpuPlatform = &quot;Intel Skylake&quot;) OR
149 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
150 (scheduling.automaticRestart = true)
151 ```
152
153 If you want to use a regular expression, use the `eq` (equal) or `ne`
154 (not equal) operator against a single un-parenthesized expression with or
155 without quotes or against multiple parenthesized expressions. Examples:
156
157 `fieldname eq unquoted literal`
158 `fieldname eq &#x27;single quoted literal&#x27;`
159 `fieldname eq &quot;double quoted literal&quot;`
160 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
161
162 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
163 The literal value must match the entire field.
164
165 For example, to filter for instances that do not end with name &quot;instance&quot;,
166 you would use `name ne .*instance`.
167
168 You cannot combine constraints on multiple fields using regular
169 expressions.
170 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
171 global) should be included in the response. For new resource types added
172 after this field, the flag has no effect as new resource types will always
173 include every visible scope for each scope type in response. For resource
174 types which predate this field, if this flag is omitted or false, only
175 scopes of the scope types where the resource type is expected to be found
176 will be included.
177 maxResults: integer, The maximum number of results per page that should be returned.
178 If the number of available results is larger than `maxResults`,
179 Compute Engine returns a `nextPageToken` that can be used to get
180 the next page of results in subsequent list requests. Acceptable values are
181 `0` to `500`, inclusive. (Default: `500`)
182 orderBy: string, Sorts list results by a certain order. By default, results
183 are returned in alphanumerical order based on the resource name.
184
185 You can also sort results in descending order based on the creation
186 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
187 results based on the `creationTimestamp` field in
188 reverse chronological order (newest result first). Use this to sort
189 resources like operations so that the newest operation is returned first.
190
191 Currently, only sorting by `name` or
192 `creationTimestamp desc` is supported.
193 pageToken: string, Specifies a page token to use. Set `pageToken` to the
194 `nextPageToken` returned by a previous list request to get
195 the next page of results.
196 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
197 of failure. The default value is false.
198
199 For example, when partial success behavior is enabled, aggregatedList for a
200 single zone scope either returns all resources in the zone or no resources,
201 with an error code.
202 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
203 aggregated list request is invoked for subnetworks list-usable api.
204 x__xgafv: string, V1 error format.
205 Allowed values
206 1 - v1 error format
207 2 - v2 error format
208
209 Returns:
210 An object of the form:
211
212 { # Contains a list of NotificationEndpointsScopedList.
213 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
214 &quot;items&quot;: { # A list of NotificationEndpointsScopedList resources.
215 &quot;a_key&quot;: { # Name of the scope containing this set of NotificationEndpoints.
216 &quot;resources&quot;: [ # A list of NotificationEndpoints contained in this scope.
217 { # Represents a notification endpoint.
218 #
219 # A notification endpoint resource defines an endpoint to receive notifications
220 # when there are status changes detected by the associated health check
221 # service.
222 #
223 # For more information, see
224 # Health checks overview.
225 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
226 # text format.
227 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
228 # create the resource.
229 &quot;grpcSettings&quot;: { # Represents a gRPC setting that describes one gRPC notification endpoint and # Settings of the gRPC notification endpoint including the endpoint URL and
230 # the retry duration.
231 # the retry duration attempting to send notification to this endpoint.
232 &quot;authority&quot;: &quot;A String&quot;, # Optional. If specified, this field is used to set the authority header by
233 # the sender of notifications. See
234 # https://tools.ietf.org/html/rfc7540#section-8.1.2.3
235 &quot;endpoint&quot;: &quot;A String&quot;, # Endpoint to which gRPC notifications are sent. This must be a valid
236 # gRPCLB DNS name.
237 &quot;payloadName&quot;: &quot;A String&quot;, # Optional. If specified, this field is used to populate the &quot;name&quot; field
238 # in gRPC requests.
239 &quot;resendInterval&quot;: { # A Duration represents a fixed-length span of time represented # Optional. This field is used to configure how often to send a full update
240 # of all non-healthy backends. If unspecified, full updates are not sent.
241 # If specified, must be in the range between 600 seconds to 3600 seconds.
242 # Nanos are disallowed. Can only be set for regional notification
243 # endpoints.
244 # as a count of seconds and fractions of seconds at nanosecond
245 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
246 # or &quot;month&quot;. Range is approximately 10,000 years.
247 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
248 # Durations less than one second are represented with a 0
249 # `seconds` field and a positive `nanos` field. Must be from 0
250 # to 999,999,999 inclusive.
251 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
252 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
253 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
254 },
255 &quot;retryDurationSec&quot;: 42, # How much time (in seconds) is spent attempting notification retries
256 # until a successful response is received. Default is 30s. Limit is 20m
257 # (1200s). Must be a positive number.
258 },
259 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] A unique identifier for this resource type. The server
260 # generates this identifier.
261 &quot;kind&quot;: &quot;compute#notificationEndpoint&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.
262 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
263 # The name must be 1-63 characters long, and comply withRFC1035.
264 # Specifically, the name must be 1-63 characters long and match the regular
265 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
266 # character must be a lowercase letter, and all following characters must
267 # be a dash, lowercase letter, or digit, except the last character, which
268 # cannot be a dash.
269 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the notification endpoint resides.
270 # This field applies only to the regional resource. You must specify this
271 # field as part of the HTTP request URL. It is not settable as a field in
272 # the request body.
273 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
274 },
275 ],
276 &quot;warning&quot;: { # Informational warning which replaces the list of
277 # notification endpoints when the list is empty.
278 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
279 # Engine returns NO_RESULTS_ON_PAGE if there
280 # are no results in the response.
281 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
282 # value format. For example:
283 #
284 # &quot;data&quot;: [
285 # {
286 # &quot;key&quot;: &quot;scope&quot;,
287 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
288 # }
289 {
290 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
291 # returned. For example, for warnings where there are no results in a list
292 # request for a particular zone, this key might be scope and
293 # the key value might be the zone name. Other examples might be a key
294 # indicating a deprecated resource and a suggested replacement, or a
295 # warning about invalid network settings (for example, if an instance
296 # attempts to perform IP forwarding but is not enabled for IP forwarding).
297 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
298 },
299 ],
300 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
301 },
302 },
303 },
304 &quot;kind&quot;: &quot;compute#notificationEndpointAggregatedList&quot;, # Output only. Type of resource.
305 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
306 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
307 # the query parameter pageToken in the next list request.
308 # Subsequent list requests will have their own nextPageToken to
309 # continue paging through the results.
310 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
311 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
312 &quot;A String&quot;,
313 ],
314 &quot;warning&quot;: { # [Output Only] Informational warning message.
315 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
316 # Engine returns NO_RESULTS_ON_PAGE if there
317 # are no results in the response.
318 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
319 # value format. For example:
320 #
321 # &quot;data&quot;: [
322 # {
323 # &quot;key&quot;: &quot;scope&quot;,
324 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
325 # }
326 {
327 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
328 # returned. For example, for warnings where there are no results in a list
329 # request for a particular zone, this key might be scope and
330 # the key value might be the zone name. Other examples might be a key
331 # indicating a deprecated resource and a suggested replacement, or a
332 # warning about invalid network settings (for example, if an instance
333 # attempts to perform IP forwarding but is not enabled for IP forwarding).
334 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
335 },
336 ],
337 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
338 },
339 }</pre>
340 </div>
341
342 <div class="method">
343 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
344 <pre>Retrieves the next page of results.
345
346 Args:
347 previous_request: The request for the previous page. (required)
348 previous_response: The response from the request for the previous page. (required)
349
350 Returns:
351 A request object that you can call &#x27;execute()&#x27; on to request the next
352 page. Returns None if there are no more items in the collection.
353 </pre>
354 </div>
355
356 <div class="method">
357 <code class="details" id="close">close()</code>
358 <pre>Close httplib2 connections.</pre>
359 </div>
360
361 <div class="method">
362 <code class="details" id="delete">delete(project, region, notificationEndpoint, requestId=None, x__xgafv=None)</code>
363 <pre>Deletes the specified NotificationEndpoint in the given region
364
365 Args:
366 project: string, Project ID for this request. (required)
367 region: string, Name of the region scoping this request. (required)
368 notificationEndpoint: string, Name of the NotificationEndpoint resource to delete. (required)
369 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
370 that if you must retry your request, the server will know to ignore the
371 request if it has already been completed.
372
373 For example, consider a situation where you make an initial request and
374 the request times out. If you make the request again with the same
375 request ID, the server can check if original operation with the same
376 request ID was received, and if so, will ignore the second request. This
377 prevents clients from accidentally creating duplicate commitments.
378
379 The request ID must be
380 a valid UUID with the exception that zero UUID is not supported
381 (00000000-0000-0000-0000-000000000000).
382 x__xgafv: string, V1 error format.
383 Allowed values
384 1 - v1 error format
385 2 - v2 error format
386
387 Returns:
388 An object of the form:
389
390 { # Represents an Operation resource.
391 #
392 # Google Compute Engine has three Operation resources:
393 #
394 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
395 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
396 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
397 #
398 # You can use an operation resource to manage asynchronous API requests.
399 # For more information, readHandling
400 # API responses.
401 #
402 # Operations can be global, regional or zonal.
403 #
404 # - For global operations, use the `globalOperations`
405 # resource.
406 # - For regional operations, use the
407 # `regionOperations` resource.
408 # - For zonal operations, use
409 # the `zoneOperations` resource.
410 #
411 #
412 #
413 # For more information, read
414 # Global, Regional, and Zonal Resources.
415 #
416 # Note that completed Operation resources have a limited
417 # retention period.
418 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
419 # Not present otherwise.
420 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
421 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
422 # set when the operation is created.
423 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
424 # text format.
425 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
426 # this field will be populated.
427 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
428 # operation.
429 {
430 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
431 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
432 # details. There is a set of defined message types to use for providing
433 # details.The syntax depends on the error code. For example,
434 # QuotaExceededInfo will have details when the error code is
435 # QUOTA_EXCEEDED.
436 {
437 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
438 #
439 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
440 # is not enabled:
441 #
442 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
443 # &quot;domain&quot;: &quot;googleapis.com&quot;
444 # &quot;metadata&quot;: {
445 # &quot;resource&quot;: &quot;projects/123&quot;,
446 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
447 # }
448 # }
449 #
450 # This response indicates that the pubsub.googleapis.com API is not enabled.
451 #
452 # Example of an error that is returned when attempting to create a Spanner
453 # instance in a region that is out of stock:
454 #
455 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
456 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
457 # &quot;metadata&quot;: {
458 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
459 # }
460 # }
461 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
462 # is typically the registered service name of the tool or product that
463 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
464 # generated by some common infrastructure, the error domain must be a
465 # globally unique value that identifies the infrastructure. For Google API
466 # infrastructure, the error domain is &quot;googleapis.com&quot;.
467 &quot;metadatas&quot;: { # Additional structured details about this error.
468 #
469 # Keys must match a regular expression of `a-z+` but should
470 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
471 # length. When identifying the current value of an exceeded limit, the units
472 # should be contained in the key, not the value. For example, rather than
473 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
474 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
475 # instances that can be created in a single (batch) request.
476 &quot;a_key&quot;: &quot;A String&quot;,
477 },
478 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
479 # proximate cause of the error. Error reasons are unique within a particular
480 # domain of errors. This should be at most 63 characters and match a
481 # regular expression of `A-Z+[A-Z0-9]`, which represents
482 # UPPER_SNAKE_CASE.
483 },
484 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
485 #
486 # For example, if a quota check failed with an error indicating the calling
487 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
488 # directly to the right place in the developer console to flip the bit.
489 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
490 { # Describes a URL link.
491 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
492 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
493 },
494 ],
495 },
496 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
497 # which can be attached to an RPC error.
498 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
499 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
500 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
501 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
502 },
503 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
504 &quot;dimensions&quot;: { # The map holding related quota dimensions.
505 &quot;a_key&quot;: &quot;A String&quot;,
506 },
507 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
508 # type or metric.
509 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
510 # or metric.
511 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
512 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
513 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
514 },
515 },
516 ],
517 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
518 # This property is optional.
519 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
520 },
521 ],
522 },
523 &quot;getVersionOperationMetadata&quot;: {
524 &quot;inlineSbomInfo&quot;: {
525 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
526 # appropriate identifiers.
527 &quot;a_key&quot;: &quot;A String&quot;,
528 },
529 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
530 # identifiers.
531 &quot;a_key&quot;: &quot;A String&quot;,
532 },
533 },
534 },
535 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
536 # message that was returned, such as `NOT FOUND`.
537 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
538 # status code that was returned. For example, a `404` means the
539 # resource was not found.
540 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
541 # defined by the server.
542 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
543 # This value is inRFC3339
544 # text format.
545 &quot;instancesBulkInsertOperationMetadata&quot;: {
546 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
547 # Example key: zones/us-central1-a
548 &quot;a_key&quot;: {
549 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
550 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
551 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
552 # error.
553 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
554 # if the flow is rolling forward or rolling back.
555 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
556 },
557 },
558 },
559 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
560 # Operation resources.
561 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
562 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
563 # group of operations results from a `bulkInsert` API request.
564 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
565 # `update`, or `delete`, and so on.
566 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
567 # There is no requirement that this be linear or support any granularity of
568 # operations. This should not be used to guess when the operation will be
569 # complete. This number should monotonically increase as the operation
570 # progresses.
571 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
572 # applicable when performing regional operations.
573 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
574 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
575 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
576 # this field will contain information on all underlying zonal actions and
577 # their state.
578 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
579 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
580 # Example key: zones/us-central1-a
581 &quot;a_key&quot;: {
582 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
583 # populated.
584 # different programming environments, including REST APIs and RPC APIs. It is
585 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
586 # three pieces of data: error code, error message, and error details.
587 #
588 # You can find out more about this error model and how to work with it in the
589 # [API Design Guide](https://cloud.google.com/apis/design/errors).
590 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
591 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
592 # message types for APIs to use.
593 {
594 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
595 },
596 ],
597 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
598 # user-facing error message should be localized and sent in the
599 # google.rpc.Status.details field, or localized by the client.
600 },
601 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
602 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
603 },
604 },
605 },
606 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
607 # This value is inRFC3339
608 # text format.
609 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
610 # following:
611 # `PENDING`, `RUNNING`, or `DONE`.
612 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
613 # operation.
614 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
615 # of the target resource.
616 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
617 # operations related to creating a snapshot, this points to the disk
618 # that the snapshot was created from.
619 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
620 # `[email protected]` or
621 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
622 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
623 # operation, this field will be populated.
624 {
625 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
626 # Engine returns NO_RESULTS_ON_PAGE if there
627 # are no results in the response.
628 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
629 # value format. For example:
630 #
631 # &quot;data&quot;: [
632 # {
633 # &quot;key&quot;: &quot;scope&quot;,
634 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
635 # }
636 {
637 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
638 # returned. For example, for warnings where there are no results in a list
639 # request for a particular zone, this key might be scope and
640 # the key value might be the zone name. Other examples might be a key
641 # indicating a deprecated resource and a suggested replacement, or a
642 # warning about invalid network settings (for example, if an instance
643 # attempts to perform IP forwarding but is not enabled for IP forwarding).
644 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
645 },
646 ],
647 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
648 },
649 ],
650 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
651 # applicable when performing per-zone operations.
652 }</pre>
653 </div>
654
655 <div class="method">
656 <code class="details" id="get">get(project, region, notificationEndpoint, x__xgafv=None)</code>
657 <pre>Returns the specified NotificationEndpoint resource in the given region.
658
659 Args:
660 project: string, Project ID for this request. (required)
661 region: string, Name of the region scoping this request. (required)
662 notificationEndpoint: string, Name of the NotificationEndpoint resource to return. (required)
663 x__xgafv: string, V1 error format.
664 Allowed values
665 1 - v1 error format
666 2 - v2 error format
667
668 Returns:
669 An object of the form:
670
671 { # Represents a notification endpoint.
672 #
673 # A notification endpoint resource defines an endpoint to receive notifications
674 # when there are status changes detected by the associated health check
675 # service.
676 #
677 # For more information, see
678 # Health checks overview.
679 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
680 # text format.
681 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
682 # create the resource.
683 &quot;grpcSettings&quot;: { # Represents a gRPC setting that describes one gRPC notification endpoint and # Settings of the gRPC notification endpoint including the endpoint URL and
684 # the retry duration.
685 # the retry duration attempting to send notification to this endpoint.
686 &quot;authority&quot;: &quot;A String&quot;, # Optional. If specified, this field is used to set the authority header by
687 # the sender of notifications. See
688 # https://tools.ietf.org/html/rfc7540#section-8.1.2.3
689 &quot;endpoint&quot;: &quot;A String&quot;, # Endpoint to which gRPC notifications are sent. This must be a valid
690 # gRPCLB DNS name.
691 &quot;payloadName&quot;: &quot;A String&quot;, # Optional. If specified, this field is used to populate the &quot;name&quot; field
692 # in gRPC requests.
693 &quot;resendInterval&quot;: { # A Duration represents a fixed-length span of time represented # Optional. This field is used to configure how often to send a full update
694 # of all non-healthy backends. If unspecified, full updates are not sent.
695 # If specified, must be in the range between 600 seconds to 3600 seconds.
696 # Nanos are disallowed. Can only be set for regional notification
697 # endpoints.
698 # as a count of seconds and fractions of seconds at nanosecond
699 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
700 # or &quot;month&quot;. Range is approximately 10,000 years.
701 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
702 # Durations less than one second are represented with a 0
703 # `seconds` field and a positive `nanos` field. Must be from 0
704 # to 999,999,999 inclusive.
705 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
706 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
707 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
708 },
709 &quot;retryDurationSec&quot;: 42, # How much time (in seconds) is spent attempting notification retries
710 # until a successful response is received. Default is 30s. Limit is 20m
711 # (1200s). Must be a positive number.
712 },
713 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] A unique identifier for this resource type. The server
714 # generates this identifier.
715 &quot;kind&quot;: &quot;compute#notificationEndpoint&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.
716 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
717 # The name must be 1-63 characters long, and comply withRFC1035.
718 # Specifically, the name must be 1-63 characters long and match the regular
719 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
720 # character must be a lowercase letter, and all following characters must
721 # be a dash, lowercase letter, or digit, except the last character, which
722 # cannot be a dash.
723 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the notification endpoint resides.
724 # This field applies only to the regional resource. You must specify this
725 # field as part of the HTTP request URL. It is not settable as a field in
726 # the request body.
727 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
728 }</pre>
729 </div>
730
731 <div class="method">
732 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
733 <pre>Create a NotificationEndpoint in the specified project in the given region
734 using the parameters that are included in the request.
735
736 Args:
737 project: string, Project ID for this request. (required)
738 region: string, Name of the region scoping this request. (required)
739 body: object, The request body.
740 The object takes the form of:
741
742 { # Represents a notification endpoint.
743 #
744 # A notification endpoint resource defines an endpoint to receive notifications
745 # when there are status changes detected by the associated health check
746 # service.
747 #
748 # For more information, see
749 # Health checks overview.
750 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
751 # text format.
752 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
753 # create the resource.
754 &quot;grpcSettings&quot;: { # Represents a gRPC setting that describes one gRPC notification endpoint and # Settings of the gRPC notification endpoint including the endpoint URL and
755 # the retry duration.
756 # the retry duration attempting to send notification to this endpoint.
757 &quot;authority&quot;: &quot;A String&quot;, # Optional. If specified, this field is used to set the authority header by
758 # the sender of notifications. See
759 # https://tools.ietf.org/html/rfc7540#section-8.1.2.3
760 &quot;endpoint&quot;: &quot;A String&quot;, # Endpoint to which gRPC notifications are sent. This must be a valid
761 # gRPCLB DNS name.
762 &quot;payloadName&quot;: &quot;A String&quot;, # Optional. If specified, this field is used to populate the &quot;name&quot; field
763 # in gRPC requests.
764 &quot;resendInterval&quot;: { # A Duration represents a fixed-length span of time represented # Optional. This field is used to configure how often to send a full update
765 # of all non-healthy backends. If unspecified, full updates are not sent.
766 # If specified, must be in the range between 600 seconds to 3600 seconds.
767 # Nanos are disallowed. Can only be set for regional notification
768 # endpoints.
769 # as a count of seconds and fractions of seconds at nanosecond
770 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
771 # or &quot;month&quot;. Range is approximately 10,000 years.
772 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
773 # Durations less than one second are represented with a 0
774 # `seconds` field and a positive `nanos` field. Must be from 0
775 # to 999,999,999 inclusive.
776 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
777 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
778 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
779 },
780 &quot;retryDurationSec&quot;: 42, # How much time (in seconds) is spent attempting notification retries
781 # until a successful response is received. Default is 30s. Limit is 20m
782 # (1200s). Must be a positive number.
783 },
784 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] A unique identifier for this resource type. The server
785 # generates this identifier.
786 &quot;kind&quot;: &quot;compute#notificationEndpoint&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.
787 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
788 # The name must be 1-63 characters long, and comply withRFC1035.
789 # Specifically, the name must be 1-63 characters long and match the regular
790 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
791 # character must be a lowercase letter, and all following characters must
792 # be a dash, lowercase letter, or digit, except the last character, which
793 # cannot be a dash.
794 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the notification endpoint resides.
795 # This field applies only to the regional resource. You must specify this
796 # field as part of the HTTP request URL. It is not settable as a field in
797 # the request body.
798 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
799 }
800
801 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
802 that if you must retry your request, the server will know to ignore the
803 request if it has already been completed.
804
805 For example, consider a situation where you make an initial request and
806 the request times out. If you make the request again with the same
807 request ID, the server can check if original operation with the same
808 request ID was received, and if so, will ignore the second request. This
809 prevents clients from accidentally creating duplicate commitments.
810
811 The request ID must be
812 a valid UUID with the exception that zero UUID is not supported
813 (00000000-0000-0000-0000-000000000000).
814 x__xgafv: string, V1 error format.
815 Allowed values
816 1 - v1 error format
817 2 - v2 error format
818
819 Returns:
820 An object of the form:
821
822 { # Represents an Operation resource.
823 #
824 # Google Compute Engine has three Operation resources:
825 #
826 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
827 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
828 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
829 #
830 # You can use an operation resource to manage asynchronous API requests.
831 # For more information, readHandling
832 # API responses.
833 #
834 # Operations can be global, regional or zonal.
835 #
836 # - For global operations, use the `globalOperations`
837 # resource.
838 # - For regional operations, use the
839 # `regionOperations` resource.
840 # - For zonal operations, use
841 # the `zoneOperations` resource.
842 #
843 #
844 #
845 # For more information, read
846 # Global, Regional, and Zonal Resources.
847 #
848 # Note that completed Operation resources have a limited
849 # retention period.
850 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
851 # Not present otherwise.
852 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
853 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
854 # set when the operation is created.
855 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
856 # text format.
857 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
858 # this field will be populated.
859 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
860 # operation.
861 {
862 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
863 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
864 # details. There is a set of defined message types to use for providing
865 # details.The syntax depends on the error code. For example,
866 # QuotaExceededInfo will have details when the error code is
867 # QUOTA_EXCEEDED.
868 {
869 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
870 #
871 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
872 # is not enabled:
873 #
874 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
875 # &quot;domain&quot;: &quot;googleapis.com&quot;
876 # &quot;metadata&quot;: {
877 # &quot;resource&quot;: &quot;projects/123&quot;,
878 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
879 # }
880 # }
881 #
882 # This response indicates that the pubsub.googleapis.com API is not enabled.
883 #
884 # Example of an error that is returned when attempting to create a Spanner
885 # instance in a region that is out of stock:
886 #
887 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
888 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
889 # &quot;metadata&quot;: {
890 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
891 # }
892 # }
893 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
894 # is typically the registered service name of the tool or product that
895 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
896 # generated by some common infrastructure, the error domain must be a
897 # globally unique value that identifies the infrastructure. For Google API
898 # infrastructure, the error domain is &quot;googleapis.com&quot;.
899 &quot;metadatas&quot;: { # Additional structured details about this error.
900 #
901 # Keys must match a regular expression of `a-z+` but should
902 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
903 # length. When identifying the current value of an exceeded limit, the units
904 # should be contained in the key, not the value. For example, rather than
905 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
906 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
907 # instances that can be created in a single (batch) request.
908 &quot;a_key&quot;: &quot;A String&quot;,
909 },
910 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
911 # proximate cause of the error. Error reasons are unique within a particular
912 # domain of errors. This should be at most 63 characters and match a
913 # regular expression of `A-Z+[A-Z0-9]`, which represents
914 # UPPER_SNAKE_CASE.
915 },
916 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
917 #
918 # For example, if a quota check failed with an error indicating the calling
919 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
920 # directly to the right place in the developer console to flip the bit.
921 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
922 { # Describes a URL link.
923 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
924 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
925 },
926 ],
927 },
928 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
929 # which can be attached to an RPC error.
930 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
931 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
932 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
933 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
934 },
935 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
936 &quot;dimensions&quot;: { # The map holding related quota dimensions.
937 &quot;a_key&quot;: &quot;A String&quot;,
938 },
939 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
940 # type or metric.
941 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
942 # or metric.
943 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
944 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
945 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
946 },
947 },
948 ],
949 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
950 # This property is optional.
951 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
952 },
953 ],
954 },
955 &quot;getVersionOperationMetadata&quot;: {
956 &quot;inlineSbomInfo&quot;: {
957 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
958 # appropriate identifiers.
959 &quot;a_key&quot;: &quot;A String&quot;,
960 },
961 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
962 # identifiers.
963 &quot;a_key&quot;: &quot;A String&quot;,
964 },
965 },
966 },
967 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
968 # message that was returned, such as `NOT FOUND`.
969 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
970 # status code that was returned. For example, a `404` means the
971 # resource was not found.
972 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
973 # defined by the server.
974 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
975 # This value is inRFC3339
976 # text format.
977 &quot;instancesBulkInsertOperationMetadata&quot;: {
978 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
979 # Example key: zones/us-central1-a
980 &quot;a_key&quot;: {
981 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
982 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
983 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
984 # error.
985 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
986 # if the flow is rolling forward or rolling back.
987 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
988 },
989 },
990 },
991 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
992 # Operation resources.
993 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
994 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
995 # group of operations results from a `bulkInsert` API request.
996 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
997 # `update`, or `delete`, and so on.
998 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
999 # There is no requirement that this be linear or support any granularity of
1000 # operations. This should not be used to guess when the operation will be
1001 # complete. This number should monotonically increase as the operation
1002 # progresses.
1003 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1004 # applicable when performing regional operations.
1005 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1006 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1007 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1008 # this field will contain information on all underlying zonal actions and
1009 # their state.
1010 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1011 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1012 # Example key: zones/us-central1-a
1013 &quot;a_key&quot;: {
1014 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
1015 # populated.
1016 # different programming environments, including REST APIs and RPC APIs. It is
1017 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1018 # three pieces of data: error code, error message, and error details.
1019 #
1020 # You can find out more about this error model and how to work with it in the
1021 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1022 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1023 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1024 # message types for APIs to use.
1025 {
1026 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1027 },
1028 ],
1029 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1030 # user-facing error message should be localized and sent in the
1031 # google.rpc.Status.details field, or localized by the client.
1032 },
1033 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1034 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1035 },
1036 },
1037 },
1038 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1039 # This value is inRFC3339
1040 # text format.
1041 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1042 # following:
1043 # `PENDING`, `RUNNING`, or `DONE`.
1044 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1045 # operation.
1046 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1047 # of the target resource.
1048 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1049 # operations related to creating a snapshot, this points to the disk
1050 # that the snapshot was created from.
1051 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1052 # `[email protected]` or
1053 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1054 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1055 # operation, this field will be populated.
1056 {
1057 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1058 # Engine returns NO_RESULTS_ON_PAGE if there
1059 # are no results in the response.
1060 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1061 # value format. For example:
1062 #
1063 # &quot;data&quot;: [
1064 # {
1065 # &quot;key&quot;: &quot;scope&quot;,
1066 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1067 # }
1068 {
1069 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1070 # returned. For example, for warnings where there are no results in a list
1071 # request for a particular zone, this key might be scope and
1072 # the key value might be the zone name. Other examples might be a key
1073 # indicating a deprecated resource and a suggested replacement, or a
1074 # warning about invalid network settings (for example, if an instance
1075 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1076 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1077 },
1078 ],
1079 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1080 },
1081 ],
1082 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1083 # applicable when performing per-zone operations.
1084 }</pre>
1085 </div>
1086
1087 <div class="method">
1088 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1089 <pre>Lists the NotificationEndpoints for a project in the given region.
1090
1091 Args:
1092 project: string, Project ID for this request. (required)
1093 region: string, Name of the region scoping this request. (required)
1094 filter: string, A filter expression that filters resources listed in the response. Most
1095 Compute resources support two types of filter expressions:
1096 expressions that support regular expressions and expressions that follow
1097 API improvement proposal AIP-160.
1098 These two types of filter expressions cannot be mixed in one request.
1099
1100 If you want to use AIP-160, your expression must specify the field name, an
1101 operator, and the value that you want to use for filtering. The value
1102 must be a string, a number, or a boolean. The operator
1103 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1104
1105 For example, if you are filtering Compute Engine instances, you can
1106 exclude instances named `example-instance` by specifying
1107 `name != example-instance`.
1108
1109 The `:*` comparison can be used to test whether a key has been defined.
1110 For example, to find all objects with `owner` label use:
1111 ```
1112 labels.owner:*
1113 ```
1114
1115 You can also filter nested fields. For example, you could specify
1116 `scheduling.automaticRestart = false` to include instances only
1117 if they are not scheduled for automatic restarts. You can use filtering
1118 on nested fields to filter based onresource labels.
1119
1120 To filter on multiple expressions, provide each separate expression within
1121 parentheses. For example:
1122 ```
1123 (scheduling.automaticRestart = true)
1124 (cpuPlatform = &quot;Intel Skylake&quot;)
1125 ```
1126 By default, each expression is an `AND` expression. However, you
1127 can include `AND` and `OR` expressions explicitly.
1128 For example:
1129 ```
1130 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1131 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1132 (scheduling.automaticRestart = true)
1133 ```
1134
1135 If you want to use a regular expression, use the `eq` (equal) or `ne`
1136 (not equal) operator against a single un-parenthesized expression with or
1137 without quotes or against multiple parenthesized expressions. Examples:
1138
1139 `fieldname eq unquoted literal`
1140 `fieldname eq &#x27;single quoted literal&#x27;`
1141 `fieldname eq &quot;double quoted literal&quot;`
1142 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1143
1144 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1145 The literal value must match the entire field.
1146
1147 For example, to filter for instances that do not end with name &quot;instance&quot;,
1148 you would use `name ne .*instance`.
1149
1150 You cannot combine constraints on multiple fields using regular
1151 expressions.
1152 maxResults: integer, The maximum number of results per page that should be returned.
1153 If the number of available results is larger than `maxResults`,
1154 Compute Engine returns a `nextPageToken` that can be used to get
1155 the next page of results in subsequent list requests. Acceptable values are
1156 `0` to `500`, inclusive. (Default: `500`)
1157 orderBy: string, Sorts list results by a certain order. By default, results
1158 are returned in alphanumerical order based on the resource name.
1159
1160 You can also sort results in descending order based on the creation
1161 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1162 results based on the `creationTimestamp` field in
1163 reverse chronological order (newest result first). Use this to sort
1164 resources like operations so that the newest operation is returned first.
1165
1166 Currently, only sorting by `name` or
1167 `creationTimestamp desc` is supported.
1168 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1169 `nextPageToken` returned by a previous list request to get
1170 the next page of results.
1171 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1172 of failure. The default value is false.
1173
1174 For example, when partial success behavior is enabled, aggregatedList for a
1175 single zone scope either returns all resources in the zone or no resources,
1176 with an error code.
1177 x__xgafv: string, V1 error format.
1178 Allowed values
1179 1 - v1 error format
1180 2 - v2 error format
1181
1182 Returns:
1183 An object of the form:
1184
1185 {
1186 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1187 &quot;items&quot;: [ # A list of NotificationEndpoint resources.
1188 { # Represents a notification endpoint.
1189 #
1190 # A notification endpoint resource defines an endpoint to receive notifications
1191 # when there are status changes detected by the associated health check
1192 # service.
1193 #
1194 # For more information, see
1195 # Health checks overview.
1196 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1197 # text format.
1198 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1199 # create the resource.
1200 &quot;grpcSettings&quot;: { # Represents a gRPC setting that describes one gRPC notification endpoint and # Settings of the gRPC notification endpoint including the endpoint URL and
1201 # the retry duration.
1202 # the retry duration attempting to send notification to this endpoint.
1203 &quot;authority&quot;: &quot;A String&quot;, # Optional. If specified, this field is used to set the authority header by
1204 # the sender of notifications. See
1205 # https://tools.ietf.org/html/rfc7540#section-8.1.2.3
1206 &quot;endpoint&quot;: &quot;A String&quot;, # Endpoint to which gRPC notifications are sent. This must be a valid
1207 # gRPCLB DNS name.
1208 &quot;payloadName&quot;: &quot;A String&quot;, # Optional. If specified, this field is used to populate the &quot;name&quot; field
1209 # in gRPC requests.
1210 &quot;resendInterval&quot;: { # A Duration represents a fixed-length span of time represented # Optional. This field is used to configure how often to send a full update
1211 # of all non-healthy backends. If unspecified, full updates are not sent.
1212 # If specified, must be in the range between 600 seconds to 3600 seconds.
1213 # Nanos are disallowed. Can only be set for regional notification
1214 # endpoints.
1215 # as a count of seconds and fractions of seconds at nanosecond
1216 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1217 # or &quot;month&quot;. Range is approximately 10,000 years.
1218 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1219 # Durations less than one second are represented with a 0
1220 # `seconds` field and a positive `nanos` field. Must be from 0
1221 # to 999,999,999 inclusive.
1222 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1223 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1224 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1225 },
1226 &quot;retryDurationSec&quot;: 42, # How much time (in seconds) is spent attempting notification retries
1227 # until a successful response is received. Default is 30s. Limit is 20m
1228 # (1200s). Must be a positive number.
1229 },
1230 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] A unique identifier for this resource type. The server
1231 # generates this identifier.
1232 &quot;kind&quot;: &quot;compute#notificationEndpoint&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.
1233 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1234 # The name must be 1-63 characters long, and comply withRFC1035.
1235 # Specifically, the name must be 1-63 characters long and match the regular
1236 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1237 # character must be a lowercase letter, and all following characters must
1238 # be a dash, lowercase letter, or digit, except the last character, which
1239 # cannot be a dash.
1240 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the notification endpoint resides.
1241 # This field applies only to the regional resource. You must specify this
1242 # field as part of the HTTP request URL. It is not settable as a field in
1243 # the request body.
1244 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1245 },
1246 ],
1247 &quot;kind&quot;: &quot;compute#notificationEndpointList&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.
1248 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1249 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1250 # the query parameter pageToken in the next list request.
1251 # Subsequent list requests will have their own nextPageToken to
1252 # continue paging through the results.
1253 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
1254 &quot;warning&quot;: { # [Output Only] Informational warning message.
1255 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1256 # Engine returns NO_RESULTS_ON_PAGE if there
1257 # are no results in the response.
1258 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1259 # value format. For example:
1260 #
1261 # &quot;data&quot;: [
1262 # {
1263 # &quot;key&quot;: &quot;scope&quot;,
1264 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1265 # }
1266 {
1267 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1268 # returned. For example, for warnings where there are no results in a list
1269 # request for a particular zone, this key might be scope and
1270 # the key value might be the zone name. Other examples might be a key
1271 # indicating a deprecated resource and a suggested replacement, or a
1272 # warning about invalid network settings (for example, if an instance
1273 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1274 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1275 },
1276 ],
1277 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1278 },
1279 }</pre>
1280 </div>
1281
1282 <div class="method">
1283 <code class="details" id="list_next">list_next()</code>
1284 <pre>Retrieves the next page of results.
1285
1286 Args:
1287 previous_request: The request for the previous page. (required)
1288 previous_response: The response from the request for the previous page. (required)
1289
1290 Returns:
1291 A request object that you can call &#x27;execute()&#x27; on to request the next
1292 page. Returns None if there are no more items in the collection.
1293 </pre>
1294 </div>
1295
1296 <div class="method">
1297 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
1298 <pre>Returns permissions that a caller has on the specified resource.
1299
1300 Args:
1301 project: string, Project ID for this request. (required)
1302 region: string, The name of the region for this request. (required)
1303 resource: string, Name or id of the resource for this request. (required)
1304 body: object, The request body.
1305 The object takes the form of:
1306
1307 {
1308 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
1309 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
1310 &quot;A String&quot;,
1311 ],
1312 }
1313
1314 x__xgafv: string, V1 error format.
1315 Allowed values
1316 1 - v1 error format
1317 2 - v2 error format
1318
1319 Returns:
1320 An object of the form:
1321
1322 {
1323 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1324 # allowed.
1325 &quot;A String&quot;,
1326 ],
1327 }</pre>
1328 </div>
1329
1330 </body></html>