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.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the AttachedClusters service.
You can determine whether the method will succeed by calling
GkeMultiCloud.attached_clusters_available?.
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.
Determines whether the AttachedClusters service is supported by the current client.
If true, you can retrieve a client object by calling GkeMultiCloud.attached_clusters.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the AttachedClusters service,
or if the versioned client gem needs an update to support the AttachedClusters service.
Parameter
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
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.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the AwsClusters service.
You can determine whether the method will succeed by calling
GkeMultiCloud.aws_clusters_available?.
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.
Determines whether the AwsClusters service is supported by the current client.
If true, you can retrieve a client object by calling GkeMultiCloud.aws_clusters.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the AwsClusters service,
or if the versioned client gem needs an update to support the AwsClusters service.
Parameter
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
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.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the AzureClusters service.
You can determine whether the method will succeed by calling
GkeMultiCloud.azure_clusters_available?.
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.
Determines whether the AzureClusters service is supported by the current client.
If true, you can retrieve a client object by calling GkeMultiCloud.azure_clusters.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the AzureClusters service,
or if the versioned client gem needs an update to support the AzureClusters 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
defself.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
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Anthos Multi-Cloud API - Module Google::Cloud::GkeMultiCloud (v1.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.1 (latest)](/ruby/docs/reference/google-cloud-gke_multi_cloud/latest/Google-Cloud-GkeMultiCloud)\n- [1.3.0](/ruby/docs/reference/google-cloud-gke_multi_cloud/1.3.0/Google-Cloud-GkeMultiCloud)\n- [1.2.1](/ruby/docs/reference/google-cloud-gke_multi_cloud/1.2.1/Google-Cloud-GkeMultiCloud)\n- [1.1.0](/ruby/docs/reference/google-cloud-gke_multi_cloud/1.1.0/Google-Cloud-GkeMultiCloud)\n- [1.0.0](/ruby/docs/reference/google-cloud-gke_multi_cloud/1.0.0/Google-Cloud-GkeMultiCloud)\n- [0.3.0](/ruby/docs/reference/google-cloud-gke_multi_cloud/0.3.0/Google-Cloud-GkeMultiCloud)\n- [0.2.0](/ruby/docs/reference/google-cloud-gke_multi_cloud/0.2.0/Google-Cloud-GkeMultiCloud)\n- [0.1.0](/ruby/docs/reference/google-cloud-gke_multi_cloud/0.1.0/Google-Cloud-GkeMultiCloud) \nReference documentation and code samples for the Anthos Multi-Cloud API module Google::Cloud::GkeMultiCloud.\n\nMethods\n-------\n\n### .attached_clusters\n\n def self.attached_clusters(version: :v1, &block) -\u003e ::Object\n\nCreate a new client object for AttachedClusters.\n\n\nBy default, this returns an instance of\n[Google::Cloud::GkeMultiCloud::V1::AttachedClusters::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/latest/Google-Cloud-GkeMultiCloud-V1-AttachedClusters-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the AttachedClusters service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\n\n\u003cbr /\u003e\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the AttachedClusters service.\nYou can determine whether the method will succeed by calling\n[GkeMultiCloud.attached_clusters_available?](/ruby/docs/reference/google-cloud-gke_multi_cloud/latest/Google-Cloud-GkeMultiCloud#Google__Cloud__GkeMultiCloud_attached_clusters_available__class_ \"Google::Cloud::GkeMultiCloud.attached_clusters_available? (method)\").\n\n#### About AttachedClusters\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nThe AttachedClusters API provides a single centrally managed service\nto register and manage Anthos attached clusters that run on customer's owned\ninfrastructure. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .attached_clusters_available?\n\n def self.attached_clusters_available?(version: :v1) -\u003e boolean\n\nDetermines whether the AttachedClusters service is supported by the current client.\nIf true, you can retrieve a client object by calling [GkeMultiCloud.attached_clusters](/ruby/docs/reference/google-cloud-gke_multi_cloud/latest/Google-Cloud-GkeMultiCloud#Google__Cloud__GkeMultiCloud_attached_clusters_class_ \"Google::Cloud::GkeMultiCloud.attached_clusters (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the AttachedClusters service,\nor if the versioned client gem needs an update to support the AttachedClusters service. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\n### .aws_clusters\n\n def self.aws_clusters(version: :v1, &block) -\u003e ::Object\n\nCreate a new client object for AwsClusters.\n\n\nBy default, this returns an instance of\n[Google::Cloud::GkeMultiCloud::V1::AwsClusters::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/latest/Google-Cloud-GkeMultiCloud-V1-AwsClusters-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the AwsClusters service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\n\n\u003cbr /\u003e\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the AwsClusters service.\nYou can determine whether the method will succeed by calling\n[GkeMultiCloud.aws_clusters_available?](/ruby/docs/reference/google-cloud-gke_multi_cloud/latest/Google-Cloud-GkeMultiCloud#Google__Cloud__GkeMultiCloud_aws_clusters_available__class_ \"Google::Cloud::GkeMultiCloud.aws_clusters_available? (method)\").\n\n#### About AwsClusters\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nThe AwsClusters API provides a single centrally managed service\nto create and manage Anthos clusters that run on AWS infrastructure. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .aws_clusters_available?\n\n def self.aws_clusters_available?(version: :v1) -\u003e boolean\n\nDetermines whether the AwsClusters service is supported by the current client.\nIf true, you can retrieve a client object by calling [GkeMultiCloud.aws_clusters](/ruby/docs/reference/google-cloud-gke_multi_cloud/latest/Google-Cloud-GkeMultiCloud#Google__Cloud__GkeMultiCloud_aws_clusters_class_ \"Google::Cloud::GkeMultiCloud.aws_clusters (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the AwsClusters service,\nor if the versioned client gem needs an update to support the AwsClusters service. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\n### .azure_clusters\n\n def self.azure_clusters(version: :v1, &block) -\u003e ::Object\n\nCreate a new client object for AzureClusters.\n\n\nBy default, this returns an instance of\n[Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/latest/Google-Cloud-GkeMultiCloud-V1-AzureClusters-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the AzureClusters service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\n\n\u003cbr /\u003e\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the AzureClusters service.\nYou can determine whether the method will succeed by calling\n[GkeMultiCloud.azure_clusters_available?](/ruby/docs/reference/google-cloud-gke_multi_cloud/latest/Google-Cloud-GkeMultiCloud#Google__Cloud__GkeMultiCloud_azure_clusters_available__class_ \"Google::Cloud::GkeMultiCloud.azure_clusters_available? (method)\").\n\n#### About AzureClusters\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nThe AzureClusters API provides a single centrally managed service\nto create and manage Anthos clusters that run on Azure infrastructure. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .azure_clusters_available?\n\n def self.azure_clusters_available?(version: :v1) -\u003e boolean\n\nDetermines whether the AzureClusters service is supported by the current client.\nIf true, you can retrieve a client object by calling [GkeMultiCloud.azure_clusters](/ruby/docs/reference/google-cloud-gke_multi_cloud/latest/Google-Cloud-GkeMultiCloud#Google__Cloud__GkeMultiCloud_azure_clusters_class_ \"Google::Cloud::GkeMultiCloud.azure_clusters (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the AzureClusters service,\nor if the versioned client gem needs an update to support the AzureClusters service. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-gke_multi_cloud library.\n\nThe following configuration parameters are supported:\n\n- `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.\n- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.\n- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.\n- `interceptors` (*type:* `Array\u003cGRPC::ClientInterceptor\u003e`) - An array of interceptors that are run before calls are executed.\n- `timeout` (*type:* `Numeric`) - Default timeout in seconds.\n- `metadata` (*type:* `Hash{Symbol=\u003eString}`) - Additional headers to be sent with the call.\n- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:\n - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Yields**\n\n- (::Google::Cloud.configure.gke_multi_cloud) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"1.3.1\""]]