Module: Google::Cloud::GkeMultiCloud

Defined in:
lib/google/cloud/gke_multi_cloud.rb,
lib/google/cloud/gke_multi_cloud/version.rb

Constant Summary collapse

VERSION = 
"1.3.0"

Class Method Summary collapse

Class Method Details

.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.

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 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.

Parameters:

  • 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.



74
75
76
77
78
79
80
81
82
83
 
# File 'lib/google/cloud/gke_multi_cloud.rb', line 74

def self.attached_clusters version: :v1, &block
  require "google/cloud/gke_multi_cloud/#{version.to_s.downcase}"

  package_name = Google::Cloud::GkeMultiCloud
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::GkeMultiCloud.const_get(package_name).const_get(:AttachedClusters)
  service_module.const_get(:Client).new(&block)
end

.attached_clusters_available?(version: :v1) ⇒ boolean

Determines whether the AttachedClusters service is supported by the current client. If true, you can retrieve a client object by calling 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.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (boolean) —

    Whether the service is available.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/google/cloud/gke_multi_cloud.rb', line 96

def self.attached_clusters_available? version: :v1
  require "google/cloud/gke_multi_cloud/#{version.to_s.downcase}"
  package_name = Google::Cloud::GkeMultiCloud
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::GkeMultiCloud.const_get package_name
  return false unless service_module.const_defined? :AttachedClusters
  service_module = service_module.const_get :AttachedClusters
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.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.

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 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.

Parameters:

  • 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.



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/google/cloud/gke_multi_cloud.rb', line 136

def self.aws_clusters version: :v1, &block
  require "google/cloud/gke_multi_cloud/#{version.to_s.downcase}"

  package_name = Google::Cloud::GkeMultiCloud
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::GkeMultiCloud.const_get(package_name).const_get(:AwsClusters)
  service_module.const_get(:Client).new(&block)
end

.aws_clusters_available?(version: :v1) ⇒ boolean

Determines whether the AwsClusters service is supported by the current client. If true, you can retrieve a client object by calling 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.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (boolean) —

    Whether the service is available.



158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/google/cloud/gke_multi_cloud.rb', line 158

def self.aws_clusters_available? version: :v1
  require "google/cloud/gke_multi_cloud/#{version.to_s.downcase}"
  package_name = Google::Cloud::GkeMultiCloud
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::GkeMultiCloud.const_get package_name
  return false unless service_module.const_defined? :AwsClusters
  service_module = service_module.const_get :AwsClusters
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.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.

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 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.

Parameters:

  • 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.



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/google/cloud/gke_multi_cloud.rb', line 198

def self.azure_clusters version: :v1, &block
  require "google/cloud/gke_multi_cloud/#{version.to_s.downcase}"

  package_name = Google::Cloud::GkeMultiCloud
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::GkeMultiCloud.const_get(package_name).const_get(:AzureClusters)
  service_module.const_get(:Client).new(&block)
end

.azure_clusters_available?(version: :v1) ⇒ boolean

Determines whether the AzureClusters service is supported by the current client. If true, you can retrieve a client object by calling 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.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (boolean) —

    Whether the service is available.



220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/google/cloud/gke_multi_cloud.rb', line 220

def self.azure_clusters_available? version: :v1
  require "google/cloud/gke_multi_cloud/#{version.to_s.downcase}"
  package_name = Google::Cloud::GkeMultiCloud
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::GkeMultiCloud.const_get package_name
  return false unless service_module.const_defined? :AzureClusters
  service_module = service_module.const_get :AzureClusters
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.configure {|::Google::Cloud.configure.gke_multi_cloud| ... } ⇒ ::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:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



263
264
265
266
267
 
# File 'lib/google/cloud/gke_multi_cloud.rb', line 263

def self.configure
  yield ::Google::Cloud.configure.gke_multi_cloud if block_given?

  ::Google::Cloud.configure.gke_multi_cloud
end