API Keys V2 API - Class Google::Cloud::ApiKeys::V2::ApiKeys::Rest::ServiceStub (v0.5.2)

Reference documentation and code samples for the API Keys V2 API class Google::Cloud::ApiKeys::V2::ApiKeys::Rest::ServiceStub.

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

Inherits

  • Object

Methods

#create_key

def create_key(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_key REST call

Parameters
  • request_pb (::Google::Cloud::ApiKeys::V2::CreateKeyRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_key

def delete_key(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_key REST call

Parameters
  • request_pb (::Google::Cloud::ApiKeys::V2::DeleteKeyRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#get_key

def get_key(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiKeys::V2::Key

Baseline implementation for the get_key REST call

Parameters
  • request_pb (::Google::Cloud::ApiKeys::V2::GetKeyRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_key_string

def get_key_string(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiKeys::V2::GetKeyStringResponse

Baseline implementation for the get_key_string REST call

Parameters
  • request_pb (::Google::Cloud::ApiKeys::V2::GetKeyStringRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#initialize

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

#list_keys

def list_keys(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiKeys::V2::ListKeysResponse

Baseline implementation for the list_keys REST call

Parameters
  • request_pb (::Google::Cloud::ApiKeys::V2::ListKeysRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#lookup_key

def lookup_key(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiKeys::V2::LookupKeyResponse

Baseline implementation for the lookup_key REST call

Parameters
  • request_pb (::Google::Cloud::ApiKeys::V2::LookupKeyRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#undelete_key

def undelete_key(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the undelete_key REST call

Parameters
  • request_pb (::Google::Cloud::ApiKeys::V2::UndeleteKeyRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_key

def update_key(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_key REST call

Parameters
  • request_pb (::Google::Cloud::ApiKeys::V2::UpdateKeyRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)