class Google::Cloud::Location::Locations::Rest::Client
{::Google::Cloud::Location::Location#metadata Location.metadata} field.
a service. Service-specific metadata is provided through the
An abstract interface that provides location-related information for
REST client for the Locations service.
#
def self.configure
-
(Client::Configuration)
-
Other tags:
- Yieldparam: config -
Other tags:
- Yield: - Configure the Client client.
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
def configure
-
(Client::Configuration)
-
Other tags:
- Yieldparam: config -
Other tags:
- Yield: - Configure the Client client.
def configure yield @config if block_given? @config end
def get_location request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the REST call is aborted.
Returns:
-
(::Google::Cloud::Location::Location)
-
Other tags:
- Yieldparam: operation -
Yieldparam: result -
Other tags:
- Yield: - Access the result along with the TransportOperation object
Parameters:
-
name
(::String
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Cloud::Location::GetLocationRequest, ::Hash
) --
Overloads:
-
get_location(name: nil)
-
get_location(request, options = nil)
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 call_metadata = @config.rpcs.get_location.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Location::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_location.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_location.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy bindings_override = @config.bindings_override["google.cloud.location.Locations.GetLocation"] @locations_stub.get_location request, options, bindings_override: bindings_override do |result, operation| yield result, operation if block_given? end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end
def initialize
- Yieldparam: config -
Other tags:
- Yield: - Configure the Locations client.
def initialize # 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.nil? || (@config.endpoint == Configuration::DEFAULT_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 = ::Google::Cloud::Location::Locations::Rest::ServiceStub.new( endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, credentials: credentials, logger: @config.logger ) @locations_stub.logger(stub: true)&.info do |entry| entry.set_system_name entry.set_service entry.message = "Created client for #{entry.service}" entry.set_credentials_fields credentials entry.set "customEndpoint", @config.endpoint if @config.endpoint entry.set "defaultTimeout", @config.timeout if @config.timeout entry.set "quotaProject", @quota_project_id if @quota_project_id end end
def list_locations request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the REST call is aborted.
Returns:
-
(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Location::Location>)
-
Other tags:
- Yieldparam: operation -
Yieldparam: result -
Other tags:
- Yield: - Access the result along with the TransportOperation object
Parameters:
-
page_token
(::String
) -- -
page_size
(::Integer
) -- -
filter
(::String
) -- -
name
(::String
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Cloud::Location::ListLocationsRequest, ::Hash
) --
Overloads:
-
list_locations(name: nil, filter: nil, page_size: nil, page_token: nil)
-
list_locations(request, options = nil)
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 call_metadata = @config.rpcs.list_locations.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Location::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_locations.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_locations.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy bindings_override = @config.bindings_override["google.cloud.location.Locations.ListLocations"] @locations_stub.list_locations request, options, bindings_override: bindings_override do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @locations_stub, :list_locations, "locations", request, result, options yield result, operation if block_given? throw :response, result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end
def logger
-
(Logger)
-
def logger @locations_stub.logger end
def universe_domain
-
(String)
-
def universe_domain @locations_stub.universe_domain end