Locations API - Class Google::Cloud::Location::Locations::Rest::ServiceStub (v0.8.1)

Reference documentation and code samples for the Locations API class Google::Cloud::Location::Locations::Rest::ServiceStub.

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

Inherits

Object

Methods

#endpoint

def endpoint() -> String

The effective endpoint

Returns

(String)

#get_location

def 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) — 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

result (::Google::Cloud::Location::Location)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Location::Location) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

(ServiceStub) — a new instance of ServiceStub

#list_locations

def 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) — 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

result (::Google::Cloud::Location::ListLocationsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Location::ListLocationsResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)