Class: Google::Cloud::Location::Locations::Rest::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/location/locations/rest/client.rb

Overview

REST client for the Locations service.

An abstract interface that provides location-related information for a service. Service-specific metadata is provided through the Location.metadata field.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Locations REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Location::Locations::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Location::Locations::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Locations client.

Yield Parameters:



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/google/cloud/location/locations/rest/client.rb', line 125

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

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Locations Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all Locations clients
::Google::Cloud::Location::Locations::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/google/cloud/location/locations/rest/client.rb', line 63

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

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



95
96
97
98
 
# File 'lib/google/cloud/location/locations/rest/client.rb', line 95

def configure
  yield @config if block_given?
  @config
end

#get_location(request, options = nil) ⇒ ::Google::Cloud::Location::Location #get_location(name: nil) ⇒ ::Google::Cloud::Location::Location

Gets information about a location.

Examples:

Basic example

require "google/cloud/location"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Location::Locations::Rest::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

Overloads:

  • #get_location(request, options = nil) ⇒ ::Google::Cloud::Location::Location

    Pass arguments to get_location via a request object, either of type GetLocationRequest or an equivalent Hash.

    Parameters:

    • 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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_location(name: nil) ⇒ ::Google::Cloud::Location::Location

    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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Resource name for the location.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/google/cloud/location/locations/rest/client.rb', line 313

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

#list_locations(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Location::Location> #list_locations(name: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Location::Location>

Lists information about the supported locations for this service.

Examples:

Basic example

require "google/cloud/location"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Location::Locations::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Location::Location.
  p item
end

Overloads:

  • #list_locations(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Location::Location>

    Pass arguments to list_locations via a request object, either of type Google::Cloud::Location::ListLocationsRequest or an equivalent Hash.

    Parameters:

    • 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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_locations(name: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Location::Location>

    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).

    Parameters:

    • name (::String) (defaults to: nil) —

      The resource that owns the locations collection, if applicable.

    • filter (::String) (defaults to: nil) —

      The standard list filter.

    • page_size (::Integer) (defaults to: nil) —

      The standard list page size.

    • page_token (::String) (defaults to: nil) —

      The standard list page token.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/google/cloud/location/locations/rest/client.rb', line 231

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

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


172
173
174
 
# File 'lib/google/cloud/location/locations/rest/client.rb', line 172

def logger
  @locations_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


105
106
107
 
# File 'lib/google/cloud/location/locations/rest/client.rb', line 105

def universe_domain
  @locations_stub.universe_domain
end