class Google::Cloud::Location::Locations::Client
Client
for the Locations
service.
An abstract interface that provides location-related information for a service. Service-specific metadata is provided through the {::Google::Cloud::Location::Location#metadata Location.metadata} field.
Attributes
@private
Public Class Methods
Configure the Locations
Client
class.
See {::Google::Cloud::Location::Locations::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all Locations clients ::Google::Cloud::Location::Locations::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/location/locations/client.rb, line 55 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Location"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config end yield @configure if block_given? @configure end
Create a new Locations
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Location::Locations::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Location::Locations::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the Locations
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/location/locations/client.rb, line 108 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/location/locations_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @locations_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Location::Locations::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the Locations
Client
instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.
See {::Google::Cloud::Location::Locations::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/location/locations/client.rb, line 87 def configure yield @config if block_given? @config end
Gets information about a location.
@overload get_location
(request, options = nil)
Pass arguments to `get_location` via a request object, either of type {::Google::Cloud::Location::GetLocationRequest} or an equivalent Hash. @param request [::Google::Cloud::Location::GetLocationRequest, ::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 get_location
(name: nil)
Pass arguments to `get_location` 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 name [::String] Resource name for the location.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Location::Location] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Location::Location]
@raise [::Google::Cloud::Error] if the RPC is aborted.
@example Basic example
require "google/cloud/location" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Location::Locations::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Location::GetLocationRequest.new # Call the get_location method. result = client.get_location request # The returned object is of type Google::Cloud::Location::Location. p result
# File lib/google/cloud/location/locations/client.rb, line 288 def get_location request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Location::GetLocationRequest # 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 metadata = @config.rpcs.get_location.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::Location::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_location.timeout, metadata: metadata, retry_policy: @config.rpcs.get_location.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @locations_stub.call_rpc :get_location, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists information about the supported locations for this service.
@overload list_locations
(request, options = nil)
Pass arguments to `list_locations` via a request object, either of type {::Google::Cloud::Location::ListLocationsRequest} or an equivalent Hash. @param request [::Google::Cloud::Location::ListLocationsRequest, ::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 list_locations
(name: nil, filter: nil, page_size: nil, page_token: nil)
Pass arguments to `list_locations` 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 name [::String] The resource that owns the locations collection, if applicable. @param filter [::String] The standard list filter. @param page_size [::Integer] The standard list page size. @param page_token [::String] The standard list page token.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Location::Location>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Location::Location>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
@example Basic example
require "google/cloud/location" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Location::Locations::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Location::ListLocationsRequest.new # Call the list_locations method. result = client.list_locations request # The returned object is of type Gapic::PagedEnumerable. You can # iterate over all elements by calling #each, and the enumerable # will lazily make API calls to fetch subsequent pages. Other # methods are also available for managing paging directly. result.each do |response| # Each element is of type ::Google::Cloud::Location::Location. p response end
# File lib/google/cloud/location/locations/client.rb, line 202 def list_locations request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Location::ListLocationsRequest # 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 metadata = @config.rpcs.list_locations.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::Location::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_locations.timeout, metadata: metadata, retry_policy: @config.rpcs.list_locations.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @locations_stub.call_rpc :list_locations, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @locations_stub, :list_locations, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end