gapic-common - Class Gapic::Rest::ClientStub (v1.2.0)

Reference documentation and code samples for the gapic-common class Gapic::Rest::ClientStub.

A class for making REST calls through Faraday ClientStub's responsibilities:

• wrap Faraday methods with a bounded explicit interface
• store service endpoint and create full url for the request
• store credentials and add auth information to the request

Inherits

• Object

Includes

• Gapic::LoggingConcerns
• Gapic::UniverseDomainConcerns

Initializes with an endpoint and credentials

• endpoint (String) (defaults to: nil) — The endpoint of the API. Overrides any endpoint_template.
• endpoint_template (String) (defaults to: nil) — The endpoint of the API, where the universe domain component of the hostname is marked by the string in the constant UniverseDomainConcerns::ENDPOINT_SUBSTITUTION .
• universe_domain (String) (defaults to: nil) — The universe domain in which calls should be made. Defaults to googleapis.com.
• credentials (Google::Auth::Credentials) — Credentials to send with calls in form of a googleauth credentials object. (see the googleauth docs)
• numeric_enums (Boolean) (defaults to: false) — Whether to signal the server to JSON-encode enums as ints
• raise_faraday_errors (Boolean) (defaults to: true) — Whether to raise Faraday errors instead of wrapping them in Gapic::Rest::Error Added for backwards compatibility. Default is true. All REST clients (except for old versions of google-cloud-compute-v1) should explicitly set this parameter to false.
• logger (Logger, :default, nil) (defaults to: :default) — An explicit logger to use, or one of the values :default (the default) to construct a default logger, or nil to disable logging explicitly.

• (Faraday::Connection)

• (ClientStub) — a new instance of ClientStub

Makes a DELETE request

• uri (String) — uri to send this request to
• params (Hash) (defaults to: {}) — query string parameters for the request
• options (::Gapic::CallOptions, Hash) (defaults to: {}) — gapic options to be applied to the REST call. Currently only timeout and headers are supported.

• (Faraday::Response)

Makes a GET request

• uri (String) — uri to send this request to
• params (Hash) (defaults to: {}) — query string parameters for the request
• options (::Gapic::CallOptions, Hash) (defaults to: {}) — gapic options to be applied to the REST call. Currently only timeout and headers are supported.

• (Faraday::Response)

Makes a PATCH request

• uri (String) — uri to send this request to
• body (String) — a body to send with the request, nil for requests without a body
• params (Hash) (defaults to: {}) — query string parameters for the request
• options (::Gapic::CallOptions, Hash) (defaults to: {}) — gapic options to be applied to the REST call. Currently only timeout and headers are supported.

• (Faraday::Response)

Makes a POST request

• uri (String) — uri to send this request to
• body (String) (defaults to: nil) — a body to send with the request, nil for requests without a body
• params (Hash) (defaults to: {}) — query string parameters for the request
• options (::Gapic::CallOptions, Hash) (defaults to: {}) — gapic options to be applied to the REST call. Currently only timeout and headers are supported.

• (Faraday::Response)

Makes a PUT request

• uri (String) — uri to send this request to
• body (String) (defaults to: nil) — a body to send with the request, nil for requests without a body
• params (Hash) (defaults to: {}) — query string parameters for the request
• options (::Gapic::CallOptions, Hash) (defaults to: {}) — gapic options to be applied to the REST call. Currently only timeout and headers are supported.

• (Faraday::Response)