API hub V1 API - Class Google::Cloud::ApiHub::V1::ApiHub::Rest::ServiceStub (v0.2.0)

Reference documentation and code samples for the API hub V1 API class Google::Cloud::ApiHub::V1::ApiHub::Rest::ServiceStub.

REST service stub for the ApiHub 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::Cloud::ApiHub::V1::Api

Baseline implementation for the create_api REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::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_attribute

def create_attribute(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::Attribute

Baseline implementation for the create_attribute REST call

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

#create_deployment

def create_deployment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::Deployment

Baseline implementation for the create_deployment REST call

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

#create_external_api

def create_external_api(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::ExternalApi

Baseline implementation for the create_external_api REST call

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

#create_spec

def create_spec(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::Spec

Baseline implementation for the create_spec REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::V1::CreateSpecRequest) — 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_version

def create_version(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::Version

Baseline implementation for the create_version REST call

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

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

Baseline implementation for the delete_api REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::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_attribute

def delete_attribute(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_attribute REST call

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

#delete_deployment

def delete_deployment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_deployment REST call

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

#delete_external_api

def delete_external_api(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_external_api REST call

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

#delete_spec

def delete_spec(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_spec REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::V1::DeleteSpecRequest) — 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_version

def delete_version(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_version REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::V1::DeleteVersionRequest) — 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_api

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

Baseline implementation for the get_api REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::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_operation

def get_api_operation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::ApiOperation

Baseline implementation for the get_api_operation REST call

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

#get_attribute

def get_attribute(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::Attribute

Baseline implementation for the get_attribute REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::V1::GetAttributeRequest) — 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_definition

def get_definition(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::Definition

Baseline implementation for the get_definition REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::V1::GetDefinitionRequest) — 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_deployment

def get_deployment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::Deployment

Baseline implementation for the get_deployment REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::V1::GetDeploymentRequest) — 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_external_api

def get_external_api(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::ExternalApi

Baseline implementation for the get_external_api REST call

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

#get_spec

def get_spec(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::Spec

Baseline implementation for the get_spec REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::V1::GetSpecRequest) — 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_spec_contents

def get_spec_contents(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::SpecContents

Baseline implementation for the get_spec_contents REST call

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

#get_version

def get_version(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::Version

Baseline implementation for the get_version REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::V1::GetVersionRequest) — 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_api_operations

def list_api_operations(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::ListApiOperationsResponse

Baseline implementation for the list_api_operations 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::ApiHub::V1::ListApisResponse

Baseline implementation for the list_apis REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::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_attributes

def list_attributes(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::ListAttributesResponse

Baseline implementation for the list_attributes REST call

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

#list_deployments

def list_deployments(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::ListDeploymentsResponse

Baseline implementation for the list_deployments REST call

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

#list_external_apis

def list_external_apis(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::ListExternalApisResponse

Baseline implementation for the list_external_apis REST call

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

#list_specs

def list_specs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::ListSpecsResponse

Baseline implementation for the list_specs REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::V1::ListSpecsRequest) — 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_versions

def list_versions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::ListVersionsResponse

Baseline implementation for the list_versions REST call

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

#search_resources

def search_resources(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::SearchResourcesResponse

Baseline implementation for the search_resources 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::Cloud::ApiHub::V1::Api

Baseline implementation for the update_api REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::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_attribute

def update_attribute(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::Attribute

Baseline implementation for the update_attribute REST call

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

#update_deployment

def update_deployment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::Deployment

Baseline implementation for the update_deployment REST call

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

#update_external_api

def update_external_api(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::ExternalApi

Baseline implementation for the update_external_api REST call

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

#update_spec

def update_spec(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::Spec

Baseline implementation for the update_spec REST call

Parameters
  • request_pb (::Google::Cloud::ApiHub::V1::UpdateSpecRequest) — 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_version

def update_version(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ApiHub::V1::Version

Baseline implementation for the update_version REST call

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