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

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

Methods

.api_hub

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

Create a new client object for ApiHub.

By default, this returns an instance of Google::Cloud::ApiHub::V1::ApiHub::Rest::Client for a REST 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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the ApiHub service. You can determine whether the method will succeed by calling ApiHub.api_hub_available?.

About ApiHub

This service provides all methods related to the API hub.

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

.api_hub_available?

def self.api_hub_available?(version: :v1) -> boolean

Determines whether the ApiHub service is supported by the current client. If true, you can retrieve a client object by calling ApiHub.api_hub. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ApiHub service, or if the versioned client gem needs an update to support the ApiHub service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (boolean) — Whether the service is available.

.api_hub_dependencies

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

Create a new client object for ApiHubDependencies.

By default, this returns an instance of Google::Cloud::ApiHub::V1::ApiHubDependencies::Rest::Client for a REST 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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the ApiHubDependencies service. You can determine whether the method will succeed by calling ApiHub.api_hub_dependencies_available?.

About ApiHubDependencies

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

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

.api_hub_dependencies_available?

def self.api_hub_dependencies_available?(version: :v1) -> boolean

Determines whether the ApiHubDependencies service is supported by the current client. If true, you can retrieve a client object by calling ApiHub.api_hub_dependencies. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ApiHubDependencies service, or if the versioned client gem needs an update to support the ApiHubDependencies service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (boolean) — Whether the service is available.

.api_hub_plugin

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

Create a new client object for ApiHubPlugin.

By default, this returns an instance of Google::Cloud::ApiHub::V1::ApiHubPlugin::Rest::Client for a REST 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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the ApiHubPlugin service. You can determine whether the method will succeed by calling ApiHub.api_hub_plugin_available?.

About ApiHubPlugin

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

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

.api_hub_plugin_available?

def self.api_hub_plugin_available?(version: :v1) -> boolean

Determines whether the ApiHubPlugin service is supported by the current client. If true, you can retrieve a client object by calling ApiHub.api_hub_plugin. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ApiHubPlugin service, or if the versioned client gem needs an update to support the ApiHubPlugin service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (boolean) — Whether the service is available.

.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.
  • 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, &block) -> ::Object

Create a new client object for HostProjectRegistrationService.

By default, this returns an instance of Google::Cloud::ApiHub::V1::HostProjectRegistrationService::Rest::Client for a REST 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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the HostProjectRegistrationService service. You can determine whether the method will succeed by calling ApiHub.host_project_registration_service_available?.

About HostProjectRegistrationService

This service is used for managing the host project registrations.

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

.host_project_registration_service_available?

def self.host_project_registration_service_available?(version: :v1) -> boolean

Determines whether the HostProjectRegistrationService service is supported by the current client. If true, you can retrieve a client object by calling ApiHub.host_project_registration_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the HostProjectRegistrationService service, or if the versioned client gem needs an update to support the HostProjectRegistrationService service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (boolean) — Whether the service is available.

.linting_service

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

Create a new client object for LintingService.

By default, this returns an instance of Google::Cloud::ApiHub::V1::LintingService::Rest::Client for a REST 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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the LintingService service. You can determine whether the method will succeed by calling ApiHub.linting_service_available?.

About LintingService

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

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

.linting_service_available?

def self.linting_service_available?(version: :v1) -> boolean

Determines whether the LintingService service is supported by the current client. If true, you can retrieve a client object by calling ApiHub.linting_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the LintingService service, or if the versioned client gem needs an update to support the LintingService service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (boolean) — Whether the service is available.

.provisioning

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

Create a new client object for Provisioning.

By default, this returns an instance of Google::Cloud::ApiHub::V1::Provisioning::Rest::Client for a REST 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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the Provisioning service. You can determine whether the method will succeed by calling ApiHub.provisioning_available?.

About Provisioning

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

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

.provisioning_available?

def self.provisioning_available?(version: :v1) -> boolean

Determines whether the Provisioning service is supported by the current client. If true, you can retrieve a client object by calling ApiHub.provisioning. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Provisioning service, or if the versioned client gem needs an update to support the Provisioning service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (boolean) — Whether the service is available.

.runtime_project_attachment_service

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

Create a new client object for RuntimeProjectAttachmentService.

By default, this returns an instance of Google::Cloud::ApiHub::V1::RuntimeProjectAttachmentService::Rest::Client for a REST 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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the RuntimeProjectAttachmentService service. You can determine whether the method will succeed by calling ApiHub.runtime_project_attachment_service_available?.

About RuntimeProjectAttachmentService

This service is used for managing the runtime project attachments.

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

.runtime_project_attachment_service_available?

def self.runtime_project_attachment_service_available?(version: :v1) -> boolean

Determines whether the RuntimeProjectAttachmentService service is supported by the current client. If true, you can retrieve a client object by calling ApiHub.runtime_project_attachment_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the RuntimeProjectAttachmentService service, or if the versioned client gem needs an update to support the RuntimeProjectAttachmentService service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "0.3.0"