Anthos Multi-Cloud API - Module Google::Cloud::GkeMultiCloud (v0.3.0)

Reference documentation and code samples for the Anthos Multi-Cloud API module Google::Cloud::GkeMultiCloud.

Methods

.attached_clusters

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

Create a new client object for AttachedClusters.

By default, this returns an instance of Google::Cloud::GkeMultiCloud::V1::AttachedClusters::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 AttachedClusters service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About AttachedClusters

The AttachedClusters API provides a single centrally managed service to register and manage Anthos attached clusters that run on customer's owned infrastructure.

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.

.aws_clusters

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

Create a new client object for AwsClusters.

By default, this returns an instance of Google::Cloud::GkeMultiCloud::V1::AwsClusters::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 AwsClusters service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About AwsClusters

The AwsClusters API provides a single centrally managed service to create and manage Anthos clusters that run on AWS infrastructure.

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.

.azure_clusters

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

Create a new client object for AzureClusters.

By default, this returns an instance of Google::Cloud::GkeMultiCloud::V1::AzureClusters::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 AzureClusters service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About AzureClusters

The AzureClusters API provides a single centrally managed service to create and manage Anthos clusters that run on Azure infrastructure.

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.

.configure

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

Configure the google-cloud-gke_multi_cloud 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.gke_multi_cloud)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

Constants

VERSION

value: "0.3.0"