Class: Google::Cloud::Location::Locations::Rest::ServiceStub

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

Overview

REST service stub for the Locations service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Instance Method Summary collapse

Constructor Details

#initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) ⇒ ServiceStub

Returns a new instance of ServiceStub.



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/google/cloud/location/locations/rest/service_stub.rb', line 32

def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
  # These require statements are intentionally placed here to initialize
  # the REST modules only when it's required.
  require "gapic/rest"

  @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
                                               endpoint_template: endpoint_template,
                                               universe_domain: universe_domain,
                                               credentials: credentials,
                                               numeric_enums: true,
                                               raise_faraday_errors: false
end

Instance Method Details

#endpoint ⇒ String

The effective endpoint

Returns:

  • (String) 


59
60
61
 
# File 'lib/google/cloud/location/locations/rest/service_stub.rb', line 59

def endpoint
  @client_stub.endpoint
end

#get_location(request_pb, options = nil, bindings_override: nil) {|result, operation| ... } ⇒ ::Google::Cloud::Location::Location

Baseline implementation for the get_location REST call

Parameters:

  • request_pb (::Google::Cloud::Location::GetLocationRequest) —

    A request object representing the call parameters. Required.

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

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

  • bindings_override (::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>, nil) (defaults to: nil) —

    Binding overrides for the transcoding. Only used internally.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/google/cloud/location/locations/rest/service_stub.rb', line 119

def get_location request_pb, options = nil, bindings_override: nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_get_location_request request_pb, bindings_override: bindings_override
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Location::Location.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#list_locations(request_pb, options = nil, bindings_override: nil) {|result, operation| ... } ⇒ ::Google::Cloud::Location::ListLocationsResponse

Baseline implementation for the list_locations REST call

Parameters:

  • request_pb (::Google::Cloud::Location::ListLocationsRequest) —

    A request object representing the call parameters. Required.

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

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

  • bindings_override (::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>, nil) (defaults to: nil) —

    Binding overrides for the transcoding. Only used internally.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/google/cloud/location/locations/rest/service_stub.rb', line 79

def list_locations request_pb, options = nil, bindings_override: nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_list_locations_request request_pb, bindings_override: bindings_override
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Location::ListLocationsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


50
51
52
 
# File 'lib/google/cloud/location/locations/rest/service_stub.rb', line 50

def universe_domain
  @client_stub.universe_domain
end