API Gateway V1 API - Class Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::ServiceStub (v0.6.2)

Reference documentation and code samples for the API Gateway V1 API class Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::ServiceStub.

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

Inherits

  • Object

Methods

#create_api

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

Baseline implementation for the create_api REST call

Parameters
  • request_pb (::Google::Cloud::ApiGateway::V1::CreateApiRequest) — 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)

#create_api_config

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

Baseline implementation for the create_api_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_gateway

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

Baseline implementation for the create_gateway REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_api

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

Baseline implementation for the delete_api REST call

Parameters
  • request_pb (::Google::Cloud::ApiGateway::V1::DeleteApiRequest) — 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_api_config

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

Baseline implementation for the delete_api_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_gateway

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

Baseline implementation for the delete_gateway REST call

Parameters
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_api

def get_api(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiGateway::V1::Api

Baseline implementation for the get_api REST call

Parameters
  • request_pb (::Google::Cloud::ApiGateway::V1::GetApiRequest) — 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_api_config

def get_api_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiGateway::V1::ApiConfig

Baseline implementation for the get_api_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_gateway

def get_gateway(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiGateway::V1::Gateway

Baseline implementation for the get_gateway REST call

Parameters
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_api_configs

def list_api_configs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiGateway::V1::ListApiConfigsResponse

Baseline implementation for the list_api_configs REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_apis

def list_apis(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiGateway::V1::ListApisResponse

Baseline implementation for the list_apis REST call

Parameters
  • request_pb (::Google::Cloud::ApiGateway::V1::ListApisRequest) — 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)

#list_gateways

def list_gateways(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiGateway::V1::ListGatewaysResponse

Baseline implementation for the list_gateways REST call

Parameters
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_api

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

Baseline implementation for the update_api REST call

Parameters
  • request_pb (::Google::Cloud::ApiGateway::V1::UpdateApiRequest) — 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)

#update_api_config

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

Baseline implementation for the update_api_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_gateway

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

Baseline implementation for the update_gateway REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)