google-cloud-compute-v1 3.3.0 → 3.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (182) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/compute/v1/accelerator_types/rest/client.rb +181 -14
  3. data/lib/google/cloud/compute/v1/addresses/rest/client.rb +330 -20
  4. data/lib/google/cloud/compute/v1/addresses/rest/service_stub.rb +64 -0
  5. data/lib/google/cloud/compute/v1/advice/credentials.rb +52 -0
  6. data/lib/google/cloud/compute/v1/advice/rest/client.rb +431 -0
  7. data/lib/google/cloud/compute/v1/advice/rest/service_stub.rb +144 -0
  8. data/lib/google/cloud/compute/v1/advice/rest.rb +51 -0
  9. data/lib/google/cloud/compute/v1/advice.rb +47 -0
  10. data/lib/google/cloud/compute/v1/autoscalers/rest/client.rb +334 -21
  11. data/lib/google/cloud/compute/v1/autoscalers/rest/service_stub.rb +64 -0
  12. data/lib/google/cloud/compute/v1/backend_buckets/rest/client.rb +198 -23
  13. data/lib/google/cloud/compute/v1/backend_services/rest/client.rb +499 -40
  14. data/lib/google/cloud/compute/v1/backend_services/rest/service_stub.rb +62 -0
  15. data/lib/google/cloud/compute/v1/compute_pb.rb +281 -25
  16. data/lib/google/cloud/compute/v1/cross_site_networks/credentials.rb +52 -0
  17. data/lib/google/cloud/compute/v1/cross_site_networks/rest/client.rb +975 -0
  18. data/lib/google/cloud/compute/v1/cross_site_networks/rest/service_stub.rb +391 -0
  19. data/lib/google/cloud/compute/v1/cross_site_networks/rest.rb +51 -0
  20. data/lib/google/cloud/compute/v1/cross_site_networks.rb +47 -0
  21. data/lib/google/cloud/compute/v1/disk_types/rest/client.rb +181 -14
  22. data/lib/google/cloud/compute/v1/disks/rest/client.rb +390 -42
  23. data/lib/google/cloud/compute/v1/external_vpn_gateways/rest/client.rb +118 -11
  24. data/lib/google/cloud/compute/v1/firewall_policies/rest/client.rb +240 -25
  25. data/lib/google/cloud/compute/v1/firewalls/rest/client.rb +238 -13
  26. data/lib/google/cloud/compute/v1/firewalls/rest/service_stub.rb +63 -0
  27. data/lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb +258 -23
  28. data/lib/google/cloud/compute/v1/future_reservations/credentials.rb +52 -0
  29. data/lib/google/cloud/compute/v1/future_reservations/rest/client.rb +1287 -0
  30. data/lib/google/cloud/compute/v1/future_reservations/rest/service_stub.rb +520 -0
  31. data/lib/google/cloud/compute/v1/future_reservations/rest.rb +51 -0
  32. data/lib/google/cloud/compute/v1/future_reservations.rb +47 -0
  33. data/lib/google/cloud/compute/v1/global_addresses/rest/client.rb +217 -10
  34. data/lib/google/cloud/compute/v1/global_addresses/rest/service_stub.rb +63 -0
  35. data/lib/google/cloud/compute/v1/global_forwarding_rules/rest/client.rb +151 -15
  36. data/lib/google/cloud/compute/v1/global_network_endpoint_groups/rest/client.rb +246 -21
  37. data/lib/google/cloud/compute/v1/global_operations/rest/client.rb +203 -18
  38. data/lib/google/cloud/compute/v1/global_organization_operations/rest/client.rb +91 -9
  39. data/lib/google/cloud/compute/v1/global_public_delegated_prefixes/rest/client.rb +128 -10
  40. data/lib/google/cloud/compute/v1/health_checks/rest/client.rb +333 -21
  41. data/lib/google/cloud/compute/v1/health_checks/rest/service_stub.rb +63 -0
  42. data/lib/google/cloud/compute/v1/image_family_views/rest/client.rb +2 -1
  43. data/lib/google/cloud/compute/v1/images/rest/client.rb +161 -18
  44. data/lib/google/cloud/compute/v1/instance_group_manager_resize_requests/rest/client.rb +159 -24
  45. data/lib/google/cloud/compute/v1/instance_group_managers/rest/client.rb +920 -95
  46. data/lib/google/cloud/compute/v1/instance_groups/rest/client.rb +473 -40
  47. data/lib/google/cloud/compute/v1/instance_groups/rest/service_stub.rb +64 -0
  48. data/lib/google/cloud/compute/v1/instance_settings_service/rest/client.rb +13 -1
  49. data/lib/google/cloud/compute/v1/instance_templates/rest/client.rb +220 -20
  50. data/lib/google/cloud/compute/v1/instances/rest/client.rb +1144 -99
  51. data/lib/google/cloud/compute/v1/instances/rest/service_stub.rb +127 -0
  52. data/lib/google/cloud/compute/v1/instant_snapshots/rest/client.rb +235 -21
  53. data/lib/google/cloud/compute/v1/interconnect_attachment_groups/rest/client.rb +139 -14
  54. data/lib/google/cloud/compute/v1/interconnect_attachments/rest/client.rb +242 -21
  55. data/lib/google/cloud/compute/v1/interconnect_groups/rest/client.rb +139 -14
  56. data/lib/google/cloud/compute/v1/interconnect_locations/rest/client.rb +87 -7
  57. data/lib/google/cloud/compute/v1/interconnect_remote_locations/rest/client.rb +87 -7
  58. data/lib/google/cloud/compute/v1/interconnects/rest/client.rb +145 -14
  59. data/lib/google/cloud/compute/v1/license_codes/rest/client.rb +9 -2
  60. data/lib/google/cloud/compute/v1/licenses/rest/client.rb +161 -16
  61. data/lib/google/cloud/compute/v1/machine_images/rest/client.rb +124 -13
  62. data/lib/google/cloud/compute/v1/machine_types/rest/client.rb +181 -14
  63. data/lib/google/cloud/compute/v1/network_attachments/rest/client.rb +232 -20
  64. data/lib/google/cloud/compute/v1/network_edge_security_services/rest/client.rb +138 -12
  65. data/lib/google/cloud/compute/v1/network_endpoint_groups/rest/client.rb +361 -37
  66. data/lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb +354 -33
  67. data/lib/google/cloud/compute/v1/network_profiles/rest/client.rb +85 -6
  68. data/lib/google/cloud/compute/v1/networks/rest/client.rb +281 -23
  69. data/lib/google/cloud/compute/v1/node_groups/rest/client.rb +381 -32
  70. data/lib/google/cloud/compute/v1/node_templates/rest/client.rb +213 -19
  71. data/lib/google/cloud/compute/v1/node_types/rest/client.rb +181 -14
  72. data/lib/google/cloud/compute/v1/organization_security_policies/credentials.rb +52 -0
  73. data/lib/google/cloud/compute/v1/organization_security_policies/rest/client.rb +2259 -0
  74. data/lib/google/cloud/compute/v1/organization_security_policies/rest/service_stub.rb +1054 -0
  75. data/lib/google/cloud/compute/v1/organization_security_policies/rest.rb +51 -0
  76. data/lib/google/cloud/compute/v1/organization_security_policies.rb +47 -0
  77. data/lib/google/cloud/compute/v1/packet_mirrorings/rest/client.rb +226 -19
  78. data/lib/google/cloud/compute/v1/preview_features/credentials.rb +52 -0
  79. data/lib/google/cloud/compute/v1/preview_features/rest/client.rb +739 -0
  80. data/lib/google/cloud/compute/v1/preview_features/rest/service_stub.rb +267 -0
  81. data/lib/google/cloud/compute/v1/preview_features/rest.rb +51 -0
  82. data/lib/google/cloud/compute/v1/preview_features.rb +47 -0
  83. data/lib/google/cloud/compute/v1/projects/rest/client.rb +346 -30
  84. data/lib/google/cloud/compute/v1/public_advertised_prefixes/rest/client.rb +154 -12
  85. data/lib/google/cloud/compute/v1/public_delegated_prefixes/rest/client.rb +255 -22
  86. data/lib/google/cloud/compute/v1/region_autoscalers/rest/client.rb +238 -13
  87. data/lib/google/cloud/compute/v1/region_autoscalers/rest/service_stub.rb +64 -0
  88. data/lib/google/cloud/compute/v1/region_backend_services/rest/client.rb +260 -26
  89. data/lib/google/cloud/compute/v1/region_commitments/rest/client.rb +212 -18
  90. data/lib/google/cloud/compute/v1/region_composite_health_checks/credentials.rb +52 -0
  91. data/lib/google/cloud/compute/v1/region_composite_health_checks/rest/client.rb +1268 -0
  92. data/lib/google/cloud/compute/v1/region_composite_health_checks/rest/service_stub.rb +521 -0
  93. data/lib/google/cloud/compute/v1/region_composite_health_checks/rest.rb +51 -0
  94. data/lib/google/cloud/compute/v1/region_composite_health_checks.rb +47 -0
  95. data/lib/google/cloud/compute/v1/region_disk_types/rest/client.rb +83 -5
  96. data/lib/google/cloud/compute/v1/region_disks/rest/client.rb +269 -29
  97. data/lib/google/cloud/compute/v1/region_health_aggregation_policies/credentials.rb +52 -0
  98. data/lib/google/cloud/compute/v1/region_health_aggregation_policies/rest/client.rb +1268 -0
  99. data/lib/google/cloud/compute/v1/region_health_aggregation_policies/rest/service_stub.rb +521 -0
  100. data/lib/google/cloud/compute/v1/region_health_aggregation_policies/rest.rb +51 -0
  101. data/lib/google/cloud/compute/v1/region_health_aggregation_policies.rb +47 -0
  102. data/lib/google/cloud/compute/v1/region_health_check_services/rest/client.rb +427 -17
  103. data/lib/google/cloud/compute/v1/region_health_check_services/rest/service_stub.rb +125 -0
  104. data/lib/google/cloud/compute/v1/region_health_checks/rest/client.rb +238 -13
  105. data/lib/google/cloud/compute/v1/region_health_checks/rest/service_stub.rb +64 -0
  106. data/lib/google/cloud/compute/v1/region_health_sources/credentials.rb +52 -0
  107. data/lib/google/cloud/compute/v1/region_health_sources/rest/client.rb +1268 -0
  108. data/lib/google/cloud/compute/v1/region_health_sources/rest/service_stub.rb +521 -0
  109. data/lib/google/cloud/compute/v1/region_health_sources/rest.rb +51 -0
  110. data/lib/google/cloud/compute/v1/region_health_sources.rb +47 -0
  111. data/lib/google/cloud/compute/v1/region_instance_group_managers/rest/client.rb +750 -64
  112. data/lib/google/cloud/compute/v1/region_instance_groups/rest/client.rb +280 -14
  113. data/lib/google/cloud/compute/v1/region_instance_groups/rest/service_stub.rb +64 -0
  114. data/lib/google/cloud/compute/v1/region_instance_templates/rest/client.rb +115 -10
  115. data/lib/google/cloud/compute/v1/region_instances/rest/client.rb +15 -2
  116. data/lib/google/cloud/compute/v1/region_instant_snapshots/rest/client.rb +139 -13
  117. data/lib/google/cloud/compute/v1/region_network_endpoint_groups/rest/client.rb +264 -28
  118. data/lib/google/cloud/compute/v1/region_network_firewall_policies/rest/client.rb +213 -20
  119. data/lib/google/cloud/compute/v1/region_notification_endpoints/rest/client.rb +399 -11
  120. data/lib/google/cloud/compute/v1/region_notification_endpoints/rest/service_stub.rb +125 -0
  121. data/lib/google/cloud/compute/v1/region_operations/rest/client.rb +107 -10
  122. data/lib/google/cloud/compute/v1/region_security_policies/rest/client.rb +149 -14
  123. data/lib/google/cloud/compute/v1/region_ssl_certificates/rest/client.rb +116 -10
  124. data/lib/google/cloud/compute/v1/region_ssl_policies/rest/client.rb +220 -20
  125. data/lib/google/cloud/compute/v1/region_target_http_proxies/rest/client.rb +126 -10
  126. data/lib/google/cloud/compute/v1/region_target_https_proxies/rest/client.rb +158 -14
  127. data/lib/google/cloud/compute/v1/region_target_tcp_proxies/rest/client.rb +113 -9
  128. data/lib/google/cloud/compute/v1/region_url_maps/rest/client.rb +104 -14
  129. data/lib/google/cloud/compute/v1/region_zones/rest/client.rb +85 -6
  130. data/lib/google/cloud/compute/v1/regions/rest/client.rb +120 -7
  131. data/lib/google/cloud/compute/v1/reservation_blocks/rest/client.rb +396 -11
  132. data/lib/google/cloud/compute/v1/reservation_blocks/rest/service_stub.rb +194 -0
  133. data/lib/google/cloud/compute/v1/reservation_slots/credentials.rb +52 -0
  134. data/lib/google/cloud/compute/v1/reservation_slots/rest/client.rb +863 -0
  135. data/lib/google/cloud/compute/v1/reservation_slots/rest/service_stub.rb +338 -0
  136. data/lib/google/cloud/compute/v1/reservation_slots/rest.rb +51 -0
  137. data/lib/google/cloud/compute/v1/reservation_slots.rb +47 -0
  138. data/lib/google/cloud/compute/v1/reservation_sub_blocks/rest/client.rb +642 -12
  139. data/lib/google/cloud/compute/v1/reservation_sub_blocks/rest/service_stub.rb +327 -3
  140. data/lib/google/cloud/compute/v1/reservations/rest/client.rb +257 -24
  141. data/lib/google/cloud/compute/v1/resource_policies/rest/client.rb +224 -19
  142. data/lib/google/cloud/compute/v1/rest.rb +10 -0
  143. data/lib/google/cloud/compute/v1/routers/rest/client.rb +555 -50
  144. data/lib/google/cloud/compute/v1/routes/rest/client.rb +202 -8
  145. data/lib/google/cloud/compute/v1/routes/rest/service_stub.rb +63 -0
  146. data/lib/google/cloud/compute/v1/security_policies/rest/client.rb +316 -26
  147. data/lib/google/cloud/compute/v1/service_attachments/rest/client.rb +234 -22
  148. data/lib/google/cloud/compute/v1/snapshot_settings_service/rest/client.rb +13 -1
  149. data/lib/google/cloud/compute/v1/snapshots/rest/client.rb +130 -13
  150. data/lib/google/cloud/compute/v1/ssl_certificates/rest/client.rb +210 -17
  151. data/lib/google/cloud/compute/v1/ssl_policies/rest/client.rb +315 -27
  152. data/lib/google/cloud/compute/v1/storage_pool_types/rest/client.rb +181 -14
  153. data/lib/google/cloud/compute/v1/storage_pools/rest/client.rb +321 -28
  154. data/lib/google/cloud/compute/v1/subnetworks/rest/client.rb +378 -34
  155. data/lib/google/cloud/compute/v1/target_grpc_proxies/rest/client.rb +128 -10
  156. data/lib/google/cloud/compute/v1/target_http_proxies/rest/client.rb +240 -20
  157. data/lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb +306 -30
  158. data/lib/google/cloud/compute/v1/target_instances/rest/client.rb +320 -20
  159. data/lib/google/cloud/compute/v1/target_instances/rest/service_stub.rb +64 -0
  160. data/lib/google/cloud/compute/v1/target_pools/rest/client.rb +387 -26
  161. data/lib/google/cloud/compute/v1/target_pools/rest/service_stub.rb +64 -0
  162. data/lib/google/cloud/compute/v1/target_ssl_proxies/rest/client.rb +281 -19
  163. data/lib/google/cloud/compute/v1/target_ssl_proxies/rest/service_stub.rb +63 -0
  164. data/lib/google/cloud/compute/v1/target_tcp_proxies/rest/client.rb +329 -20
  165. data/lib/google/cloud/compute/v1/target_tcp_proxies/rest/service_stub.rb +63 -0
  166. data/lib/google/cloud/compute/v1/target_vpn_gateways/rest/client.rb +224 -19
  167. data/lib/google/cloud/compute/v1/url_maps/rest/client.rb +354 -24
  168. data/lib/google/cloud/compute/v1/url_maps/rest/service_stub.rb +63 -0
  169. data/lib/google/cloud/compute/v1/version.rb +1 -1
  170. data/lib/google/cloud/compute/v1/vpn_gateways/rest/client.rb +224 -19
  171. data/lib/google/cloud/compute/v1/vpn_tunnels/rest/client.rb +224 -19
  172. data/lib/google/cloud/compute/v1/wire_groups/credentials.rb +52 -0
  173. data/lib/google/cloud/compute/v1/wire_groups/rest/client.rb +980 -0
  174. data/lib/google/cloud/compute/v1/wire_groups/rest/service_stub.rb +396 -0
  175. data/lib/google/cloud/compute/v1/wire_groups/rest.rb +51 -0
  176. data/lib/google/cloud/compute/v1/wire_groups.rb +47 -0
  177. data/lib/google/cloud/compute/v1/zone_operations/rest/client.rb +106 -10
  178. data/lib/google/cloud/compute/v1/zones/rest/client.rb +83 -5
  179. data/lib/google/cloud/compute/v1.rb +10 -0
  180. data/proto_docs/google/api/client.rb +149 -29
  181. data/proto_docs/google/cloud/compute/v1/compute.rb +44226 -5514
  182. metadata +52 -2
@@ -85,6 +85,8 @@ module Google
85
85
 
86
86
  default_config.rpcs.set_named_ports.timeout = 600.0
87
87
 
88
+ default_config.rpcs.test_iam_permissions.timeout = 600.0
89
+
88
90
  default_config
89
91
  end
90
92
  yield @configure if block_given?
@@ -286,7 +288,8 @@ module Google
286
288
  end
287
289
 
288
290
  ##
289
- # Retrieves the list of instance group resources contained within the specified region.
291
+ # Retrieves the list of instance group resources contained within
292
+ # the specified region.
290
293
  #
291
294
  # @overload list(request, options = nil)
292
295
  # Pass arguments to `list` via a request object, either of type
@@ -304,19 +307,97 @@ module Google
304
307
  # the default parameter values, pass an empty Hash as a request object (see above).
305
308
  #
306
309
  # @param filter [::String]
307
- # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
310
+ # A filter expression that filters resources listed in the response. Most
311
+ # Compute resources support two types of filter expressions:
312
+ # expressions that support regular expressions and expressions that follow
313
+ # API improvement proposal AIP-160.
314
+ # These two types of filter expressions cannot be mixed in one request.
315
+ #
316
+ # If you want to use AIP-160, your expression must specify the field name, an
317
+ # operator, and the value that you want to use for filtering. The value
318
+ # must be a string, a number, or a boolean. The operator
319
+ # must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
320
+ #
321
+ # For example, if you are filtering Compute Engine instances, you can
322
+ # exclude instances named `example-instance` by specifying
323
+ # `name != example-instance`.
324
+ #
325
+ # The `:*` comparison can be used to test whether a key has been defined.
326
+ # For example, to find all objects with `owner` label use:
327
+ # ```
328
+ # labels.owner:*
329
+ # ```
330
+ #
331
+ # You can also filter nested fields. For example, you could specify
332
+ # `scheduling.automaticRestart = false` to include instances only
333
+ # if they are not scheduled for automatic restarts. You can use filtering
334
+ # on nested fields to filter based onresource labels.
335
+ #
336
+ # To filter on multiple expressions, provide each separate expression within
337
+ # parentheses. For example:
338
+ # ```
339
+ # (scheduling.automaticRestart = true)
340
+ # (cpuPlatform = "Intel Skylake")
341
+ # ```
342
+ # By default, each expression is an `AND` expression. However, you
343
+ # can include `AND` and `OR` expressions explicitly.
344
+ # For example:
345
+ # ```
346
+ # (cpuPlatform = "Intel Skylake") OR
347
+ # (cpuPlatform = "Intel Broadwell") AND
348
+ # (scheduling.automaticRestart = true)
349
+ # ```
350
+ #
351
+ # If you want to use a regular expression, use the `eq` (equal) or `ne`
352
+ # (not equal) operator against a single un-parenthesized expression with or
353
+ # without quotes or against multiple parenthesized expressions. Examples:
354
+ #
355
+ # `fieldname eq unquoted literal`
356
+ # `fieldname eq 'single quoted literal'`
357
+ # `fieldname eq "double quoted literal"`
358
+ # `(fieldname1 eq literal) (fieldname2 ne "literal")`
359
+ #
360
+ # The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
361
+ # The literal value must match the entire field.
362
+ #
363
+ # For example, to filter for instances that do not end with name "instance",
364
+ # you would use `name ne .*instance`.
365
+ #
366
+ # You cannot combine constraints on multiple fields using regular
367
+ # expressions.
308
368
  # @param max_results [::Integer]
309
- # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
369
+ # The maximum number of results per page that should be returned.
370
+ # If the number of available results is larger than `maxResults`,
371
+ # Compute Engine returns a `nextPageToken` that can be used to get
372
+ # the next page of results in subsequent list requests. Acceptable values are
373
+ # `0` to `500`, inclusive. (Default: `500`)
310
374
  # @param order_by [::String]
311
- # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
375
+ # Sorts list results by a certain order. By default, results
376
+ # are returned in alphanumerical order based on the resource name.
377
+ #
378
+ # You can also sort results in descending order based on the creation
379
+ # timestamp using `orderBy="creationTimestamp desc"`. This sorts
380
+ # results based on the `creationTimestamp` field in
381
+ # reverse chronological order (newest result first). Use this to sort
382
+ # resources like operations so that the newest operation is returned first.
383
+ #
384
+ # Currently, only sorting by `name` or
385
+ # `creationTimestamp desc` is supported.
312
386
  # @param page_token [::String]
313
- # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
387
+ # Specifies a page token to use. Set `pageToken` to the
388
+ # `nextPageToken` returned by a previous list request to get
389
+ # the next page of results.
314
390
  # @param project [::String]
315
391
  # Project ID for this request.
316
392
  # @param region [::String]
317
393
  # Name of the region scoping this request.
318
394
  # @param return_partial_success [::Boolean]
319
- # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
395
+ # Opt-in for partial success behavior which provides partial results in case
396
+ # of failure. The default value is false.
397
+ #
398
+ # For example, when partial success behavior is enabled, aggregatedList for a
399
+ # single zone scope either returns all resources in the zone or no resources,
400
+ # with an error code.
320
401
  # @yield [result, operation] Access the result along with the TransportOperation object
321
402
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::InstanceGroup>]
322
403
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -378,7 +459,10 @@ module Google
378
459
  end
379
460
 
380
461
  ##
381
- # Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported.
462
+ # Lists the instances in the specified instance group and displays
463
+ # information about the named ports. Depending on the specified options, this
464
+ # method can list all instances or only the instances that are running.
465
+ # The orderBy query parameter is not supported.
382
466
  #
383
467
  # @overload list_instances(request, options = nil)
384
468
  # Pass arguments to `list_instances` via a request object, either of type
@@ -396,15 +480,89 @@ module Google
396
480
  # the default parameter values, pass an empty Hash as a request object (see above).
397
481
  #
398
482
  # @param filter [::String]
399
- # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
483
+ # A filter expression that filters resources listed in the response. Most
484
+ # Compute resources support two types of filter expressions:
485
+ # expressions that support regular expressions and expressions that follow
486
+ # API improvement proposal AIP-160.
487
+ # These two types of filter expressions cannot be mixed in one request.
488
+ #
489
+ # If you want to use AIP-160, your expression must specify the field name, an
490
+ # operator, and the value that you want to use for filtering. The value
491
+ # must be a string, a number, or a boolean. The operator
492
+ # must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
493
+ #
494
+ # For example, if you are filtering Compute Engine instances, you can
495
+ # exclude instances named `example-instance` by specifying
496
+ # `name != example-instance`.
497
+ #
498
+ # The `:*` comparison can be used to test whether a key has been defined.
499
+ # For example, to find all objects with `owner` label use:
500
+ # ```
501
+ # labels.owner:*
502
+ # ```
503
+ #
504
+ # You can also filter nested fields. For example, you could specify
505
+ # `scheduling.automaticRestart = false` to include instances only
506
+ # if they are not scheduled for automatic restarts. You can use filtering
507
+ # on nested fields to filter based onresource labels.
508
+ #
509
+ # To filter on multiple expressions, provide each separate expression within
510
+ # parentheses. For example:
511
+ # ```
512
+ # (scheduling.automaticRestart = true)
513
+ # (cpuPlatform = "Intel Skylake")
514
+ # ```
515
+ # By default, each expression is an `AND` expression. However, you
516
+ # can include `AND` and `OR` expressions explicitly.
517
+ # For example:
518
+ # ```
519
+ # (cpuPlatform = "Intel Skylake") OR
520
+ # (cpuPlatform = "Intel Broadwell") AND
521
+ # (scheduling.automaticRestart = true)
522
+ # ```
523
+ #
524
+ # If you want to use a regular expression, use the `eq` (equal) or `ne`
525
+ # (not equal) operator against a single un-parenthesized expression with or
526
+ # without quotes or against multiple parenthesized expressions. Examples:
527
+ #
528
+ # `fieldname eq unquoted literal`
529
+ # `fieldname eq 'single quoted literal'`
530
+ # `fieldname eq "double quoted literal"`
531
+ # `(fieldname1 eq literal) (fieldname2 ne "literal")`
532
+ #
533
+ # The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
534
+ # The literal value must match the entire field.
535
+ #
536
+ # For example, to filter for instances that do not end with name "instance",
537
+ # you would use `name ne .*instance`.
538
+ #
539
+ # You cannot combine constraints on multiple fields using regular
540
+ # expressions.
400
541
  # @param instance_group [::String]
401
- # Name of the regional instance group for which we want to list the instances.
542
+ # Name of the regional instance group for which we want to list the
543
+ # instances.
402
544
  # @param max_results [::Integer]
403
- # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
545
+ # The maximum number of results per page that should be returned.
546
+ # If the number of available results is larger than `maxResults`,
547
+ # Compute Engine returns a `nextPageToken` that can be used to get
548
+ # the next page of results in subsequent list requests. Acceptable values are
549
+ # `0` to `500`, inclusive. (Default: `500`)
404
550
  # @param order_by [::String]
405
- # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
551
+ # Sorts list results by a certain order. By default, results
552
+ # are returned in alphanumerical order based on the resource name.
553
+ #
554
+ # You can also sort results in descending order based on the creation
555
+ # timestamp using `orderBy="creationTimestamp desc"`. This sorts
556
+ # results based on the `creationTimestamp` field in
557
+ # reverse chronological order (newest result first). Use this to sort
558
+ # resources like operations so that the newest operation is returned first.
559
+ #
560
+ # Currently, only sorting by `name` or
561
+ # `creationTimestamp desc` is supported.
406
562
  # @param page_token [::String]
407
- # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
563
+ # Specifies a page token to use. Set `pageToken` to the
564
+ # `nextPageToken` returned by a previous list request to get
565
+ # the next page of results.
408
566
  # @param project [::String]
409
567
  # Project ID for this request.
410
568
  # @param region [::String]
@@ -412,7 +570,12 @@ module Google
412
570
  # @param region_instance_groups_list_instances_request_resource [::Google::Cloud::Compute::V1::RegionInstanceGroupsListInstancesRequest, ::Hash]
413
571
  # The body resource for this request
414
572
  # @param return_partial_success [::Boolean]
415
- # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
573
+ # Opt-in for partial success behavior which provides partial results in case
574
+ # of failure. The default value is false.
575
+ #
576
+ # For example, when partial success behavior is enabled, aggregatedList for a
577
+ # single zone scope either returns all resources in the zone or no resources,
578
+ # with an error code.
416
579
  # @yield [result, operation] Access the result along with the TransportOperation object
417
580
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::InstanceWithNamedPorts>]
418
581
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -500,7 +663,19 @@ module Google
500
663
  # @param region_instance_groups_set_named_ports_request_resource [::Google::Cloud::Compute::V1::RegionInstanceGroupsSetNamedPortsRequest, ::Hash]
501
664
  # The body resource for this request
502
665
  # @param request_id [::String]
503
- # 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. 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).
666
+ # An optional request ID to identify requests. Specify a unique request ID so
667
+ # that if you must retry your request, the server will know to ignore the
668
+ # request if it has already been completed.
669
+ #
670
+ # For example, consider a situation where you make an initial request and
671
+ # the request times out. If you make the request again with the same
672
+ # request ID, the server can check if original operation with the same
673
+ # request ID was received, and if so, will ignore the second request. This
674
+ # prevents clients from accidentally creating duplicate commitments.
675
+ #
676
+ # The request ID must be
677
+ # a valid UUID with the exception that zero UUID is not supported
678
+ # (00000000-0000-0000-0000-000000000000).
504
679
  # @yield [result, operation] Access the result along with the TransportOperation object
505
680
  # @yieldparam result [::Gapic::GenericLRO::Operation]
506
681
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -569,6 +744,90 @@ module Google
569
744
  raise ::Google::Cloud::Error.from_error(e)
570
745
  end
571
746
 
747
+ ##
748
+ # Returns permissions that a caller has on the specified resource.
749
+ #
750
+ # @overload test_iam_permissions(request, options = nil)
751
+ # Pass arguments to `test_iam_permissions` via a request object, either of type
752
+ # {::Google::Cloud::Compute::V1::TestIamPermissionsRegionInstanceGroupRequest} or an equivalent Hash.
753
+ #
754
+ # @param request [::Google::Cloud::Compute::V1::TestIamPermissionsRegionInstanceGroupRequest, ::Hash]
755
+ # A request object representing the call parameters. Required. To specify no
756
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
757
+ # @param options [::Gapic::CallOptions, ::Hash]
758
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
759
+ #
760
+ # @overload test_iam_permissions(project: nil, region: nil, resource: nil, test_permissions_request_resource: nil)
761
+ # Pass arguments to `test_iam_permissions` via keyword arguments. Note that at
762
+ # least one keyword argument is required. To specify no parameters, or to keep all
763
+ # the default parameter values, pass an empty Hash as a request object (see above).
764
+ #
765
+ # @param project [::String]
766
+ # Project ID for this request.
767
+ # @param region [::String]
768
+ # The name of the region for this request.
769
+ # @param resource [::String]
770
+ # Name or id of the resource for this request.
771
+ # @param test_permissions_request_resource [::Google::Cloud::Compute::V1::TestPermissionsRequest, ::Hash]
772
+ # The body resource for this request
773
+ # @yield [result, operation] Access the result along with the TransportOperation object
774
+ # @yieldparam result [::Google::Cloud::Compute::V1::TestPermissionsResponse]
775
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
776
+ #
777
+ # @return [::Google::Cloud::Compute::V1::TestPermissionsResponse]
778
+ #
779
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
780
+ #
781
+ # @example Basic example
782
+ # require "google/cloud/compute/v1"
783
+ #
784
+ # # Create a client object. The client can be reused for multiple calls.
785
+ # client = Google::Cloud::Compute::V1::RegionInstanceGroups::Rest::Client.new
786
+ #
787
+ # # Create a request. To set request fields, pass in keyword arguments.
788
+ # request = Google::Cloud::Compute::V1::TestIamPermissionsRegionInstanceGroupRequest.new
789
+ #
790
+ # # Call the test_iam_permissions method.
791
+ # result = client.test_iam_permissions request
792
+ #
793
+ # # The returned object is of type Google::Cloud::Compute::V1::TestPermissionsResponse.
794
+ # p result
795
+ #
796
+ def test_iam_permissions request, options = nil
797
+ raise ::ArgumentError, "request must be provided" if request.nil?
798
+
799
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::TestIamPermissionsRegionInstanceGroupRequest
800
+
801
+ # Converts hash and nil to an options object
802
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
803
+
804
+ # Customize the options with defaults
805
+ call_metadata = @config.rpcs.test_iam_permissions.metadata.to_h
806
+
807
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
808
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
809
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
810
+ gapic_version: ::Google::Cloud::Compute::V1::VERSION,
811
+ transports_version_send: [:rest]
812
+
813
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
814
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
815
+
816
+ options.apply_defaults timeout: @config.rpcs.test_iam_permissions.timeout,
817
+ metadata: call_metadata,
818
+ retry_policy: @config.rpcs.test_iam_permissions.retry_policy
819
+
820
+ options.apply_defaults timeout: @config.timeout,
821
+ metadata: @config.metadata,
822
+ retry_policy: @config.retry_policy
823
+
824
+ @region_instance_groups_stub.test_iam_permissions request, options do |result, operation|
825
+ yield result, operation if block_given?
826
+ end
827
+ rescue ::Gapic::Rest::Error => e
828
+ raise ::Google::Cloud::Error.from_error(e)
829
+ end
830
+
572
831
  ##
573
832
  # Configuration class for the RegionInstanceGroups REST API.
574
833
  #
@@ -735,6 +994,11 @@ module Google
735
994
  # @return [::Gapic::Config::Method]
736
995
  #
737
996
  attr_reader :set_named_ports
997
+ ##
998
+ # RPC-specific configuration for `test_iam_permissions`
999
+ # @return [::Gapic::Config::Method]
1000
+ #
1001
+ attr_reader :test_iam_permissions
738
1002
 
739
1003
  # @private
740
1004
  def initialize parent_rpcs = nil
@@ -746,6 +1010,8 @@ module Google
746
1010
  @list_instances = ::Gapic::Config::Method.new list_instances_config
747
1011
  set_named_ports_config = parent_rpcs.set_named_ports if parent_rpcs.respond_to? :set_named_ports
748
1012
  @set_named_ports = ::Gapic::Config::Method.new set_named_ports_config
1013
+ test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
1014
+ @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
749
1015
 
750
1016
  yield self if block_given?
751
1017
  end
@@ -233,6 +233,46 @@ module Google
233
233
  end
234
234
  end
235
235
 
236
+ ##
237
+ # Baseline implementation for the test_iam_permissions REST call
238
+ #
239
+ # @param request_pb [::Google::Cloud::Compute::V1::TestIamPermissionsRegionInstanceGroupRequest]
240
+ # A request object representing the call parameters. Required.
241
+ # @param options [::Gapic::CallOptions]
242
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
243
+ #
244
+ # @yield [result, operation] Access the result along with the TransportOperation object
245
+ # @yieldparam result [::Google::Cloud::Compute::V1::TestPermissionsResponse]
246
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
247
+ #
248
+ # @return [::Google::Cloud::Compute::V1::TestPermissionsResponse]
249
+ # A result object deserialized from the server's reply
250
+ def test_iam_permissions request_pb, options = nil
251
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
252
+
253
+ verb, uri, query_string_params, body = ServiceStub.transcode_test_iam_permissions_request request_pb
254
+ query_string_params = if query_string_params.any?
255
+ query_string_params.to_h { |p| p.split "=", 2 }
256
+ else
257
+ {}
258
+ end
259
+
260
+ response = @client_stub.make_http_request(
261
+ verb,
262
+ uri: uri,
263
+ body: body || "",
264
+ params: query_string_params,
265
+ method_name: "test_iam_permissions",
266
+ options: options
267
+ )
268
+ operation = ::Gapic::Rest::TransportOperation.new response
269
+ result = ::Google::Cloud::Compute::V1::TestPermissionsResponse.decode_json response.body, ignore_unknown_fields: true
270
+ catch :response do
271
+ yield result, operation if block_given?
272
+ result
273
+ end
274
+ end
275
+
236
276
  ##
237
277
  # @private
238
278
  #
@@ -325,6 +365,30 @@ module Google
325
365
  )
326
366
  transcoder.transcode request_pb
327
367
  end
368
+
369
+ ##
370
+ # @private
371
+ #
372
+ # GRPC transcoding helper method for the test_iam_permissions REST call
373
+ #
374
+ # @param request_pb [::Google::Cloud::Compute::V1::TestIamPermissionsRegionInstanceGroupRequest]
375
+ # A request object representing the call parameters. Required.
376
+ # @return [Array(String, [String, nil], Hash{String => String})]
377
+ # Uri, Body, Query string parameters
378
+ def self.transcode_test_iam_permissions_request request_pb
379
+ transcoder = Gapic::Rest::GrpcTranscoder.new
380
+ .with_bindings(
381
+ uri_method: :post,
382
+ uri_template: "/compute/v1/projects/{project}/regions/{region}/instanceGroups/{resource}/testIamPermissions",
383
+ body: "test_permissions_request_resource",
384
+ matches: [
385
+ ["project", %r{^[^/]+/?$}, false],
386
+ ["region", %r{^[^/]+/?$}, false],
387
+ ["resource", %r{^[^/]+/?$}, false]
388
+ ]
389
+ )
390
+ transcoder.transcode request_pb
391
+ end
328
392
  end
329
393
  end
330
394
  end
@@ -204,7 +204,8 @@ module Google
204
204
  # Service calls
205
205
 
206
206
  ##
207
- # Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone.
207
+ # Deletes the specified instance template. Deleting an instance template is
208
+ # permanent and cannot be undone.
208
209
  #
209
210
  # @overload delete(request, options = nil)
210
211
  # Pass arguments to `delete` via a request object, either of type
@@ -228,7 +229,19 @@ module Google
228
229
  # @param region [::String]
229
230
  # The name of the region for this request.
230
231
  # @param request_id [::String]
231
- # 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. 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).
232
+ # An optional request ID to identify requests. Specify a unique request ID so
233
+ # that if you must retry your request, the server will know to ignore the
234
+ # request if it has already been completed.
235
+ #
236
+ # For example, consider a situation where you make an initial request and
237
+ # the request times out. If you make the request again with the same
238
+ # request ID, the server can check if original operation with the same
239
+ # request ID was received, and if so, will ignore the second request. This
240
+ # prevents clients from accidentally creating duplicate commitments.
241
+ #
242
+ # The request ID must be
243
+ # a valid UUID with the exception that zero UUID is not supported
244
+ # (00000000-0000-0000-0000-000000000000).
232
245
  # @yield [result, operation] Access the result along with the TransportOperation object
233
246
  # @yieldparam result [::Gapic::GenericLRO::Operation]
234
247
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -380,7 +393,8 @@ module Google
380
393
  end
381
394
 
382
395
  ##
383
- # Creates an instance template in the specified project and region using the global instance template whose URL is included in the request.
396
+ # Creates an instance template in the specified project and region using the
397
+ # global instance template whose URL is included in the request.
384
398
  #
385
399
  # @overload insert(request, options = nil)
386
400
  # Pass arguments to `insert` via a request object, either of type
@@ -404,7 +418,19 @@ module Google
404
418
  # @param region [::String]
405
419
  # The name of the region for this request.
406
420
  # @param request_id [::String]
407
- # 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. 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).
421
+ # An optional request ID to identify requests. Specify a unique request ID so
422
+ # that if you must retry your request, the server will know to ignore the
423
+ # request if it has already been completed.
424
+ #
425
+ # For example, consider a situation where you make an initial request and
426
+ # the request times out. If you make the request again with the same
427
+ # request ID, the server can check if original operation with the same
428
+ # request ID was received, and if so, will ignore the second request. This
429
+ # prevents clients from accidentally creating duplicate commitments.
430
+ #
431
+ # The request ID must be
432
+ # a valid UUID with the exception that zero UUID is not supported
433
+ # (00000000-0000-0000-0000-000000000000).
408
434
  # @yield [result, operation] Access the result along with the TransportOperation object
409
435
  # @yieldparam result [::Gapic::GenericLRO::Operation]
410
436
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -474,7 +500,8 @@ module Google
474
500
  end
475
501
 
476
502
  ##
477
- # Retrieves a list of instance templates that are contained within the specified project and region.
503
+ # Retrieves a list of instance templates that are contained within the
504
+ # specified project and region.
478
505
  #
479
506
  # @overload list(request, options = nil)
480
507
  # Pass arguments to `list` via a request object, either of type
@@ -492,19 +519,97 @@ module Google
492
519
  # the default parameter values, pass an empty Hash as a request object (see above).
493
520
  #
494
521
  # @param filter [::String]
495
- # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
522
+ # A filter expression that filters resources listed in the response. Most
523
+ # Compute resources support two types of filter expressions:
524
+ # expressions that support regular expressions and expressions that follow
525
+ # API improvement proposal AIP-160.
526
+ # These two types of filter expressions cannot be mixed in one request.
527
+ #
528
+ # If you want to use AIP-160, your expression must specify the field name, an
529
+ # operator, and the value that you want to use for filtering. The value
530
+ # must be a string, a number, or a boolean. The operator
531
+ # must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
532
+ #
533
+ # For example, if you are filtering Compute Engine instances, you can
534
+ # exclude instances named `example-instance` by specifying
535
+ # `name != example-instance`.
536
+ #
537
+ # The `:*` comparison can be used to test whether a key has been defined.
538
+ # For example, to find all objects with `owner` label use:
539
+ # ```
540
+ # labels.owner:*
541
+ # ```
542
+ #
543
+ # You can also filter nested fields. For example, you could specify
544
+ # `scheduling.automaticRestart = false` to include instances only
545
+ # if they are not scheduled for automatic restarts. You can use filtering
546
+ # on nested fields to filter based onresource labels.
547
+ #
548
+ # To filter on multiple expressions, provide each separate expression within
549
+ # parentheses. For example:
550
+ # ```
551
+ # (scheduling.automaticRestart = true)
552
+ # (cpuPlatform = "Intel Skylake")
553
+ # ```
554
+ # By default, each expression is an `AND` expression. However, you
555
+ # can include `AND` and `OR` expressions explicitly.
556
+ # For example:
557
+ # ```
558
+ # (cpuPlatform = "Intel Skylake") OR
559
+ # (cpuPlatform = "Intel Broadwell") AND
560
+ # (scheduling.automaticRestart = true)
561
+ # ```
562
+ #
563
+ # If you want to use a regular expression, use the `eq` (equal) or `ne`
564
+ # (not equal) operator against a single un-parenthesized expression with or
565
+ # without quotes or against multiple parenthesized expressions. Examples:
566
+ #
567
+ # `fieldname eq unquoted literal`
568
+ # `fieldname eq 'single quoted literal'`
569
+ # `fieldname eq "double quoted literal"`
570
+ # `(fieldname1 eq literal) (fieldname2 ne "literal")`
571
+ #
572
+ # The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
573
+ # The literal value must match the entire field.
574
+ #
575
+ # For example, to filter for instances that do not end with name "instance",
576
+ # you would use `name ne .*instance`.
577
+ #
578
+ # You cannot combine constraints on multiple fields using regular
579
+ # expressions.
496
580
  # @param max_results [::Integer]
497
- # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
581
+ # The maximum number of results per page that should be returned.
582
+ # If the number of available results is larger than `maxResults`,
583
+ # Compute Engine returns a `nextPageToken` that can be used to get
584
+ # the next page of results in subsequent list requests. Acceptable values are
585
+ # `0` to `500`, inclusive. (Default: `500`)
498
586
  # @param order_by [::String]
499
- # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
587
+ # Sorts list results by a certain order. By default, results
588
+ # are returned in alphanumerical order based on the resource name.
589
+ #
590
+ # You can also sort results in descending order based on the creation
591
+ # timestamp using `orderBy="creationTimestamp desc"`. This sorts
592
+ # results based on the `creationTimestamp` field in
593
+ # reverse chronological order (newest result first). Use this to sort
594
+ # resources like operations so that the newest operation is returned first.
595
+ #
596
+ # Currently, only sorting by `name` or
597
+ # `creationTimestamp desc` is supported.
500
598
  # @param page_token [::String]
501
- # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
599
+ # Specifies a page token to use. Set `pageToken` to the
600
+ # `nextPageToken` returned by a previous list request to get
601
+ # the next page of results.
502
602
  # @param project [::String]
503
603
  # Project ID for this request.
504
604
  # @param region [::String]
505
605
  # The name of the regions for this request.
506
606
  # @param return_partial_success [::Boolean]
507
- # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
607
+ # Opt-in for partial success behavior which provides partial results in case
608
+ # of failure. The default value is false.
609
+ #
610
+ # For example, when partial success behavior is enabled, aggregatedList for a
611
+ # single zone scope either returns all resources in the zone or no resources,
612
+ # with an error code.
508
613
  # @yield [result, operation] Access the result along with the TransportOperation object
509
614
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::InstanceTemplate>]
510
615
  # @yieldparam operation [::Gapic::Rest::TransportOperation]