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:



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/google/cloud/location/locations/rest/client.rb', line 110

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 == 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, credentials: credentials
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:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/google/cloud/location/locations/rest/client.rb', line 57

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:



89
90
91
92
 
# File 'lib/google/cloud/location/locations/rest/client.rb', line 89

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.



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/google/cloud/location/locations/rest/client.rb', line 271

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 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::Location::VERSION,
    transports_version_send: [:rest]

  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?
    return result
  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.



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/google/cloud/location/locations/rest/client.rb', line 190

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 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::Location::VERSION,
    transports_version_send: [:rest]

  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?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end