API hub API - Module Google::Cloud::ApiHub (v0.1.0)

Reference documentation and code samples for the API hub API module Google::Cloud::ApiHub.

Methods

.api_hub

def self.api_hub(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for ApiHub.

By default, this returns an instance of Google::Cloud::ApiHub::V1::ApiHub::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ApiHub service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About ApiHub

This service provides all methods related to the API hub.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.api_hub_dependencies

def self.api_hub_dependencies(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for ApiHubDependencies.

By default, this returns an instance of Google::Cloud::ApiHub::V1::ApiHubDependencies::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ApiHubDependencies service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About ApiHubDependencies

This service provides methods for various operations related to a Dependency in the API hub.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.api_hub_plugin

def self.api_hub_plugin(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for ApiHubPlugin.

By default, this returns an instance of Google::Cloud::ApiHub::V1::ApiHubPlugin::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ApiHubPlugin service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About ApiHubPlugin

This service is used for managing plugins inside the API Hub.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-api_hub library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.api_hub)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.host_project_registration_service

def self.host_project_registration_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for HostProjectRegistrationService.

By default, this returns an instance of Google::Cloud::ApiHub::V1::HostProjectRegistrationService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the HostProjectRegistrationService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About HostProjectRegistrationService

This service is used for managing the host project registrations.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.linting_service

def self.linting_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for LintingService.

By default, this returns an instance of Google::Cloud::ApiHub::V1::LintingService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the LintingService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About LintingService

This service provides all methods related to the 1p Linter.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.provisioning

def self.provisioning(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for Provisioning.

By default, this returns an instance of Google::Cloud::ApiHub::V1::Provisioning::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the Provisioning service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Provisioning

This service is used for managing the data plane provisioning of the API hub.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.runtime_project_attachment_service

def self.runtime_project_attachment_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for RuntimeProjectAttachmentService.

By default, this returns an instance of Google::Cloud::ApiHub::V1::RuntimeProjectAttachmentService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the RuntimeProjectAttachmentService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About RuntimeProjectAttachmentService

This service is used for managing the runtime project attachments.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

Constants

VERSION

value: "0.1.0"