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

Instance Method Details

#endpoint ⇒ String

The effective endpoint

Returns:

  • (String) 


62
63
64
 
# File 'lib/google/cloud/location/locations/rest/service_stub.rb', line 62

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) 


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
 
# File 'lib/google/cloud/location/locations/rest/service_stub.rb', line 133

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,
    method_name: "get_location",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Location::Location.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
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) 


91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/google/cloud/location/locations/rest/service_stub.rb', line 91

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,
    method_name: "list_locations",
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Location::ListLocationsResponse.decode_json response.body, ignore_unknown_fields: true
  catch :response do
    yield result, operation if block_given?
    result
  end
end

#logger(stub: false) ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


71
72
73
 
# File 'lib/google/cloud/location/locations/rest/service_stub.rb', line 71

def logger stub: false
  stub ? @client_stub.stub_logger : @client_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


53
54
55
 
# File 'lib/google/cloud/location/locations/rest/service_stub.rb', line 53

def universe_domain
  @client_stub.universe_domain
end