lib/google/cloud/compute/v1/instance_templates/rest/client.rb in google-cloud-compute-v1-2.0.0 vs lib/google/cloud/compute/v1/instance_templates/rest/client.rb in google-cloud-compute-v1-2.1.0
- old
+ new
@@ -63,10 +63,15 @@
break parent_const.configure if parent_const.respond_to? :configure
namespace.pop
end
default_config = Client::Configuration.new parent_config
+ default_config.rpcs.aggregated_list.timeout = 600.0
+ default_config.rpcs.aggregated_list.retry_policy = {
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
+ }
+
default_config.rpcs.delete.timeout = 600.0
default_config.rpcs.get.timeout = 600.0
default_config.rpcs.get.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
@@ -169,10 +174,85 @@
attr_reader :global_operations
# Service calls
##
+ # Retrieves the list of all InstanceTemplates resources, regional and global, available to the specified project.
+ #
+ # @overload aggregated_list(request, options = nil)
+ # Pass arguments to `aggregated_list` via a request object, either of type
+ # {::Google::Cloud::Compute::V1::AggregatedListInstanceTemplatesRequest} or an equivalent Hash.
+ #
+ # @param request [::Google::Cloud::Compute::V1::AggregatedListInstanceTemplatesRequest, ::Hash]
+ # A request object representing the call parameters. Required. To specify no
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
+ # @param options [::Gapic::CallOptions, ::Hash]
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+ #
+ # @overload aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil)
+ # Pass arguments to `aggregated_list` via keyword arguments. Note that at
+ # least one keyword argument is required. To specify no parameters, or to keep all
+ # the default parameter values, pass an empty Hash as a request object (see above).
+ #
+ # @param filter [::String]
+ # 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. 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 `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. 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`.
+ # @param include_all_scopes [::Boolean]
+ # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
+ # @param max_results [::Integer]
+ # 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`)
+ # @param order_by [::String]
+ # 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.
+ # @param page_token [::String]
+ # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+ # @param project [::String]
+ # Name of the project scoping this request.
+ # @param return_partial_success [::Boolean]
+ # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
+ # @yield [result, operation] Access the result along with the TransportOperation object
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::InstanceTemplatesScopedList>]
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
+ #
+ # @return [::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::InstanceTemplatesScopedList>]
+ #
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
+ def aggregated_list request, options = nil
+ raise ::ArgumentError, "request must be provided" if request.nil?
+
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AggregatedListInstanceTemplatesRequest
+
+ # Converts hash and nil to an options object
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+ # Customize the options with defaults
+ call_metadata = @config.rpcs.aggregated_list.metadata.to_h
+
+ # Set x-goog-api-client and x-goog-user-project headers
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
+ gapic_version: ::Google::Cloud::Compute::V1::VERSION,
+ transports_version_send: [:rest]
+
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+ options.apply_defaults timeout: @config.rpcs.aggregated_list.timeout,
+ metadata: call_metadata,
+ retry_policy: @config.rpcs.aggregated_list.retry_policy
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
+ retry_policy: @config.retry_policy
+
+ @instance_templates_stub.aggregated_list request, options do |result, operation|
+ result = ::Gapic::Rest::PagedEnumerable.new @instance_templates_stub, :aggregated_list, "items", request, result, options
+ yield result, operation if block_given?
+ return result
+ end
+ rescue ::Gapic::Rest::Error => e
+ raise ::Google::Cloud::Error.from_error(e)
+ end
+
+ ##
# Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group.
#
# @overload delete(request, options = nil)
# Pass arguments to `delete` via a request object, either of type
# {::Google::Cloud::Compute::V1::DeleteInstanceTemplateRequest} or an equivalent Hash.
@@ -243,11 +323,11 @@
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
- # Returns the specified instance template. Gets a list of available instance templates by making a list() request.
+ # Returns the specified instance template.
#
# @overload get(request, options = nil)
# Pass arguments to `get` via a request object, either of type
# {::Google::Cloud::Compute::V1::GetInstanceTemplateRequest} or an equivalent Hash.
#
@@ -667,21 +747,21 @@
# on construction.
#
# @example
#
# # Modify the global config, setting the timeout for
- # # delete to 20 seconds,
+ # # aggregated_list to 20 seconds,
# # and all remaining timeouts to 10 seconds.
# ::Google::Cloud::Compute::V1::InstanceTemplates::Rest::Client.configure do |config|
# config.timeout = 10.0
- # config.rpcs.delete.timeout = 20.0
+ # config.rpcs.aggregated_list.timeout = 20.0
# end
#
# # Apply the above configuration only to a new client.
# client = ::Google::Cloud::Compute::V1::InstanceTemplates::Rest::Client.new do |config|
# config.timeout = 10.0
- # config.rpcs.delete.timeout = 20.0
+ # config.rpcs.aggregated_list.timeout = 20.0
# end
#
# @!attribute [rw] endpoint
# The hostname or hostname:port of the service endpoint.
# Defaults to `"compute.googleapis.com"`.
@@ -689,13 +769,13 @@
# @!attribute [rw] credentials
# Credentials to send with calls. You may provide any of the following types:
# * (`String`) The path to a service account key file in JSON format
# * (`Hash`) A service account key as a Hash
# * (`Google::Auth::Credentials`) A googleauth credentials object
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
# * (`nil`) indicating no credentials
# @return [::Object]
# @!attribute [rw] scope
# The OAuth scopes
# @return [::Array<::String>]
@@ -775,10 +855,15 @@
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
# trigger a retry.
#
class Rpcs
##
+ # RPC-specific configuration for `aggregated_list`
+ # @return [::Gapic::Config::Method]
+ #
+ attr_reader :aggregated_list
+ ##
# RPC-specific configuration for `delete`
# @return [::Gapic::Config::Method]
#
attr_reader :delete
##
@@ -812,9 +897,11 @@
#
attr_reader :test_iam_permissions
# @private
def initialize parent_rpcs = nil
+ aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
+ @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
@delete = ::Gapic::Config::Method.new delete_config
get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
@get = ::Gapic::Config::Method.new get_config
get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy