GKE Hub API - Module Google::Cloud::GkeHub (v2.0.1)

Reference documentation and code samples for the GKE Hub API module Google::Cloud::GkeHub.

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

Configure the google-cloud-gke_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.

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

Create a new client object for GkeHub.

By default, this returns an instance of Google::Cloud::GkeHub::V1::GkeHub::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 GkeHub 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.

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

About GkeHub

The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters.

The GKE Hub service operates on the following resources:

• Membership
• Feature

GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones . Feature is only available in global region while membership is global region and all the regions.

Membership management may be non-trivial:it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

  def 
  
 self 
 . 
 gke_hub_available? 
 ( 
 version 
 : 
  
 :v1 
 , 
  
 transport 
 : 
  
 :grpc 
 ) 
  
 - 
>  
 boolean 
 

Determines whether the GkeHub service is supported by the current client. If true, you can retrieve a client object by calling GkeHub.gke_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 GkeHub service, or if the versioned client gem needs an update to support the GkeHub service.

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

Create a new client object for GkeHub.

By default, this returns an instance of Google::Cloud::GkeHub::V1::GkeHub::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 GkeHub 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.

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

About GkeHub

The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters.

The GKE Hub service operates on the following resources:

• Membership
• Feature

GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones . Feature is only available in global region while membership is global region and all the regions.

Membership management may be non-trivial:it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

value: "2.0.1"