Class: Google::Cloud::Container::V1::ClusterManagerClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/container/v1/cluster_manager_client.rb

Overview

Google Kubernetes Engine Cluster Manager v1

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"container.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform"
].freeze

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ ClusterManagerClient

Returns a new instance of ClusterManagerClient.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) (defaults to: ALL_SCOPES) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: {}) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) (defaults to: DEFAULT_TIMEOUT) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) (defaults to: nil) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • service_address (String) (defaults to: nil) —

    Override for the service hostname, or nil to leave as the default.

  • service_port (Integer) (defaults to: nil) —

    Override for the service port, or nil to leave as the default.

  • exception_transformer (Proc) (defaults to: nil) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 104

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    service_address: nil,
    service_port: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/container/v1/cluster_service_services_pb"

  credentials ||= Google::Cloud::Container::V1::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Container::V1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Google::Cloud::Container::VERSION

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
    headers[:"x-goog-user-project"] = credentials.quota_project_id
  end
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "cluster_manager_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.container.v1.ClusterManager",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = service_address || self.class::SERVICE_ADDRESS
  port = service_port || self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @cluster_manager_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Container::V1::ClusterManager::Stub.method(:new)
  )

  @list_clusters = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:list_clusters),
    defaults["list_clusters"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_cluster = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:get_cluster),
    defaults["get_cluster"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @create_cluster = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:create_cluster),
    defaults["create_cluster"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @update_cluster = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:update_cluster),
    defaults["update_cluster"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @update_node_pool = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:update_node_pool),
    defaults["update_node_pool"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @set_node_pool_autoscaling = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_node_pool_autoscaling),
    defaults["set_node_pool_autoscaling"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @set_logging_service = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_logging_service),
    defaults["set_logging_service"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @set_monitoring_service = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_monitoring_service),
    defaults["set_monitoring_service"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @set_addons_config = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_addons_config),
    defaults["set_addons_config"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @set_locations = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_locations),
    defaults["set_locations"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @update_master = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:update_master),
    defaults["update_master"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @set_master_auth = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_master_auth),
    defaults["set_master_auth"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @delete_cluster = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:delete_cluster),
    defaults["delete_cluster"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_operations = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:list_operations),
    defaults["list_operations"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_operation = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:get_operation),
    defaults["get_operation"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @cancel_operation = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:cancel_operation),
    defaults["cancel_operation"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @get_server_config = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:get_server_config),
    defaults["get_server_config"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_node_pools = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:list_node_pools),
    defaults["list_node_pools"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_node_pool = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:get_node_pool),
    defaults["get_node_pool"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @create_node_pool = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:create_node_pool),
    defaults["create_node_pool"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @delete_node_pool = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:delete_node_pool),
    defaults["delete_node_pool"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @rollback_node_pool_upgrade = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:rollback_node_pool_upgrade),
    defaults["rollback_node_pool_upgrade"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @set_node_pool_management = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_node_pool_management),
    defaults["set_node_pool_management"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @set_labels = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_labels),
    defaults["set_labels"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @set_legacy_abac = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_legacy_abac),
    defaults["set_legacy_abac"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @start_ip_rotation = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:start_ip_rotation),
    defaults["start_ip_rotation"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @complete_ip_rotation = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:complete_ip_rotation),
    defaults["complete_ip_rotation"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @set_node_pool_size = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_node_pool_size),
    defaults["set_node_pool_size"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @set_network_policy = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_network_policy),
    defaults["set_network_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @set_maintenance_policy = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_maintenance_policy),
    defaults["set_maintenance_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_usable_subnetworks = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:list_usable_subnetworks),
    defaults["list_usable_subnetworks"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
end

Instance Method Details

#cancel_operation(project_id: nil, zone: nil, operation_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Object

Cancels the specified operation.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)
cluster_manager_client.cancel_operation

Parameters:

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.

  • operation_id (String) (defaults to: nil) —

    Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects//locations//operations/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1336

def cancel_operation \
    project_id: nil,
    zone: nil,
    operation_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    operation_id: operation_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::CancelOperationRequest)
  @cancel_operation.call(req, options, &block)
  nil
end

#complete_ip_rotation(project_id: nil, zone: nil, cluster_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Completes master IP rotation.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)
response = cluster_manager_client.complete_ip_rotation

Parameters:

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1933

def complete_ip_rotation \
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::CompleteIPRotationRequest)
  @complete_ip_rotation.call(req, options, &block)
end

#create_cluster(cluster, project_id: nil, zone: nil, parent: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances.

By default, the cluster is created in the project's default network.

One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster.

Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `cluster`:
cluster = {}
response = cluster_manager_client.create_cluster(cluster)

Parameters:

  • cluster (Google::Container::V1::Cluster | Hash) —

    Required. A cluster resource A hash of the same form as Google::Container::V1::Cluster can also be provided.

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

  • parent (String) (defaults to: nil) —

    The parent (project and location) where the cluster will be created. Specified in the format 'projects//locations/'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 576

def create_cluster \
    cluster,
    project_id: nil,
    zone: nil,
    parent: nil,
    options: nil,
    &block
  req = {
    cluster: cluster,
    project_id: project_id,
    zone: zone,
    parent: parent
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::CreateClusterRequest)
  @create_cluster.call(req, options, &block)
end

#create_node_pool(node_pool, project_id: nil, zone: nil, cluster_id: nil, parent: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Creates a node pool for a cluster.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `node_pool`:
node_pool = {}
response = cluster_manager_client.create_node_pool(node_pool)

Parameters:

  • node_pool (Google::Container::V1::NodePool | Hash) —

    Required. The node pool to create. A hash of the same form as Google::Container::V1::NodePool can also be provided.

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.

  • parent (String) (defaults to: nil) —

    The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1537

def create_node_pool \
    node_pool,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    parent: nil,
    options: nil,
    &block
  req = {
    node_pool: node_pool,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    parent: parent
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::CreateNodePoolRequest)
  @create_node_pool.call(req, options, &block)
end

#delete_cluster(project_id: nil, zone: nil, cluster_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Deletes the cluster, including the Kubernetes endpoint and all worker nodes.

Firewalls and routes that were configured during cluster creation are also deleted.

Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)
response = cluster_manager_client.delete_cluster

Parameters:

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1199

def delete_cluster \
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::DeleteClusterRequest)
  @delete_cluster.call(req, options, &block)
end

#delete_node_pool(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Deletes a node pool from a cluster.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)
response = cluster_manager_client.delete_node_pool

Parameters:

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

  • node_pool_id (String) (defaults to: nil) —

    Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format 'projects//locations//clusters//nodePools/'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1591

def delete_node_pool \
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    node_pool_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    node_pool_id: node_pool_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::DeleteNodePoolRequest)
  @delete_node_pool.call(req, options, &block)
end

#get_cluster(project_id: nil, zone: nil, cluster_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Cluster

Gets the details of a specific cluster.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)
response = cluster_manager_client.get_cluster

Parameters:

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 511

def get_cluster \
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::GetClusterRequest)
  @get_cluster.call(req, options, &block)
end

#get_node_pool(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::NodePool

Retrieves the requested node pool.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)
response = cluster_manager_client.get_node_pool

Parameters:

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

  • node_pool_id (String) (defaults to: nil) —

    Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format 'projects//locations//clusters//nodePools/'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1479

def get_node_pool \
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    node_pool_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    node_pool_id: node_pool_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::GetNodePoolRequest)
  @get_node_pool.call(req, options, &block)
end

#get_operation(project_id: nil, zone: nil, operation_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Gets the specified operation.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)
response = cluster_manager_client.get_operation

Parameters:

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • operation_id (String) (defaults to: nil) —

    Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, operation id) of the operation to get. Specified in the format 'projects//locations//operations/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1290

def get_operation \
    project_id: nil,
    zone: nil,
    operation_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    operation_id: operation_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::GetOperationRequest)
  @get_operation.call(req, options, &block)
end

#get_server_config(project_id: nil, zone: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::ServerConfig

Returns configuration info about the Google Kubernetes Engine service.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)
response = cluster_manager_client.get_server_config

Parameters:

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone to return operations for. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project and location) of the server config to get, specified in the format 'projects//locations/'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1381

def get_server_config \
    project_id: nil,
    zone: nil,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::GetServerConfigRequest)
  @get_server_config.call(req, options, &block)
end

#list_clusters(project_id: nil, zone: nil, parent: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::ListClustersResponse

Lists all clusters owned by a project in either the specified zone or all zones.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)
response = cluster_manager_client.list_clusters

Parameters:

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field.

  • parent (String) (defaults to: nil) —

    The parent (project and location) where the clusters will be listed. Specified in the format 'projects//locations/'. Location "-" matches all zones and all regions.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 465

def list_clusters \
    project_id: nil,
    zone: nil,
    parent: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    parent: parent
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::ListClustersRequest)
  @list_clusters.call(req, options, &block)
end

#list_node_pools(project_id: nil, zone: nil, cluster_id: nil, parent: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::ListNodePoolsResponse

Lists the node pools for a cluster.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)
response = cluster_manager_client.list_node_pools

Parameters:

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.

  • parent (String) (defaults to: nil) —

    The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1427

def list_node_pools \
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    parent: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    parent: parent
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::ListNodePoolsRequest)
  @list_node_pools.call(req, options, &block)
end

#list_operations(project_id: nil, zone: nil, parent: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::ListOperationsResponse

Lists all operations in a project in a specific zone or all zones.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)
response = cluster_manager_client.list_operations

Parameters:

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone to return operations for, or - for all zones. This field has been deprecated and replaced by the parent field.

  • parent (String) (defaults to: nil) —

    The parent (project and location) where the operations will be listed. Specified in the format 'projects//locations/'. Location "-" matches all zones and all regions.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1244

def list_operations \
    project_id: nil,
    zone: nil,
    parent: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    parent: parent
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::ListOperationsRequest)
  @list_operations.call(req, options, &block)
end

#list_usable_subnetworks(parent: nil, filter: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Container::V1::UsableSubnetwork>

Lists subnetworks that are usable for creating clusters in a project.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# Iterate over all results.
cluster_manager_client.list_usable_subnetworks.each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
cluster_manager_client.list_usable_subnetworks.each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) (defaults to: nil) —

    The parent project where subnetworks are usable. Specified in the format 'projects/*'.

  • filter (String) (defaults to: nil) —

    Filtering currently only supports equality on the networkProjectId and must be in the form: "networkProjectId=[PROJECTID]", where networkProjectId is the project which owns the listed subnetworks. This defaults to the parent project ID.

  • page_size (Integer) (defaults to: nil) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Container::V1::UsableSubnetwork>) —

    An enumerable of Google::Container::V1::UsableSubnetwork instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 2179

def list_usable_subnetworks \
    parent: nil,
    filter: nil,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    filter: filter,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::ListUsableSubnetworksRequest)
  @list_usable_subnetworks.call(req, options, &block)
end

#rollback_node_pool_upgrade(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)
response = cluster_manager_client.rollback_node_pool_upgrade

Parameters:

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.

  • node_pool_id (String) (defaults to: nil) —

    Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format 'projects//locations//clusters//nodePools/'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1646

def rollback_node_pool_upgrade \
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    node_pool_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    node_pool_id: node_pool_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::RollbackNodePoolUpgradeRequest)
  @rollback_node_pool_upgrade.call(req, options, &block)
end

#set_addons_config(addons_config, project_id: nil, zone: nil, cluster_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Sets the addons for a specific cluster.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `addons_config`:
addons_config = {}
response = cluster_manager_client.set_addons_config(addons_config)

Parameters:

  • addons_config (Google::Container::V1::AddonsConfig | Hash) —

    Required. The desired configurations for the various addons available to run in the cluster. A hash of the same form as Google::Container::V1::AddonsConfig can also be provided.

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster) of the cluster to set addons. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 950

def set_addons_config \
    addons_config,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    addons_config: addons_config,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::SetAddonsConfigRequest)
  @set_addons_config.call(req, options, &block)
end

#set_labels(resource_labels, label_fingerprint, project_id: nil, zone: nil, cluster_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Sets labels on a cluster.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `resource_labels`:
resource_labels = {}

# TODO: Initialize `label_fingerprint`:
label_fingerprint = ''
response = cluster_manager_client.set_labels(resource_labels, label_fingerprint)

Parameters:

  • resource_labels (Hash{String => String}) —

    Required. The labels to set for that cluster.

  • label_fingerprint (String) —

    Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster id) of the cluster to set labels. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1774

def set_labels \
    resource_labels,
    label_fingerprint,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    resource_labels: resource_labels,
    label_fingerprint: label_fingerprint,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::SetLabelsRequest)
  @set_labels.call(req, options, &block)
end

#set_legacy_abac(enabled, project_id: nil, zone: nil, cluster_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Enables or disables the ABAC authorization mechanism on a cluster.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `enabled`:
enabled = false
response = cluster_manager_client.set_legacy_abac(enabled)

Parameters:

  • enabled (true, false) —

    Required. Whether ABAC authorization will be enabled in the cluster.

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1831

def set_legacy_abac \
    enabled,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    enabled: enabled,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::SetLegacyAbacRequest)
  @set_legacy_abac.call(req, options, &block)
end

#set_locations(locations, project_id: nil, zone: nil, cluster_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Sets the locations for a specific cluster.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `locations`:
locations = []
response = cluster_manager_client.set_locations(locations)

Parameters:

  • locations (Array<String>) —

    Required. The desired list of Google Compute Engine zones in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed.

    This list must always include the cluster's primary zone.

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1011

def set_locations \
    locations,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    locations: locations,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::SetLocationsRequest)
  @set_locations.call(req, options, &block)
end

#set_logging_service(logging_service, project_id: nil, zone: nil, cluster_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Sets the logging service for a specific cluster.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `logging_service`:
logging_service = ''
response = cluster_manager_client.set_logging_service(logging_service)

Parameters:

  • logging_service (String) —

    Required. The logging service the cluster should use to write metrics. Currently available options:

    • "logging.googleapis.com" - the Google Cloud Logging service
    • "none" - no metrics will be exported from the cluster
  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster) of the cluster to set logging. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 831

def set_logging_service \
    logging_service,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    logging_service: logging_service,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::SetLoggingServiceRequest)
  @set_logging_service.call(req, options, &block)
end

#set_maintenance_policy(project_id, zone, cluster_id, maintenance_policy, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Sets the maintenance policy for a cluster.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `project_id`:
project_id = ''

# TODO: Initialize `zone`:
zone = ''

# TODO: Initialize `cluster_id`:
cluster_id = ''

# TODO: Initialize `maintenance_policy`:
maintenance_policy = {}
response = cluster_manager_client.set_maintenance_policy(project_id, zone, cluster_id, maintenance_policy)

Parameters:

  • project_id (String) —

    Required. The Google Developers Console project ID or project number.

  • zone (String) —

    Required. The name of the Google Compute Engine zone in which the cluster resides.

  • cluster_id (String) —

    Required. The name of the cluster to update.

  • maintenance_policy (Google::Container::V1::MaintenancePolicy | Hash) —

    Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. A hash of the same form as Google::Container::V1::MaintenancePolicy can also be provided.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 2114

def set_maintenance_policy \
    project_id,
    zone,
    cluster_id,
    maintenance_policy,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    maintenance_policy: maintenance_policy,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::SetMaintenancePolicyRequest)
  @set_maintenance_policy.call(req, options, &block)
end

#set_master_auth(action, update, project_id: nil, zone: nil, cluster_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `action`:
action = :UNKNOWN

# TODO: Initialize `update`:
update = {}
response = cluster_manager_client.set_master_auth(action, update)

Parameters:

  • action (Google::Container::V1::SetMasterAuthRequest::Action) —

    Required. The exact form of action to be taken on the master auth.

  • update (Google::Container::V1::MasterAuth | Hash) —

    Required. A description of the update. A hash of the same form as Google::Container::V1::MasterAuth can also be provided.

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster) of the cluster to set auth. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1139

def set_master_auth \
    action,
    update,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    action: action,
    update: update,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::SetMasterAuthRequest)
  @set_master_auth.call(req, options, &block)
end

#set_monitoring_service(monitoring_service, project_id: nil, zone: nil, cluster_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Sets the monitoring service for a specific cluster.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `monitoring_service`:
monitoring_service = ''
response = cluster_manager_client.set_monitoring_service(monitoring_service)

Parameters:

  • monitoring_service (String) —

    Required. The monitoring service the cluster should use to write metrics. Currently available options:

    • "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model
    • "monitoring.googleapis.com" - the Google Cloud Monitoring service
    • "none" - no metrics will be exported from the cluster
  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster) of the cluster to set monitoring. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 892

def set_monitoring_service \
    monitoring_service,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    monitoring_service: monitoring_service,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::SetMonitoringServiceRequest)
  @set_monitoring_service.call(req, options, &block)
end

#set_network_policy(network_policy, project_id: nil, zone: nil, cluster_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Enables or disables Network Policy for a cluster.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `network_policy`:
network_policy = {}
response = cluster_manager_client.set_network_policy(network_policy)

Parameters:

  • network_policy (Google::Container::V1::NetworkPolicy | Hash) —

    Required. Configuration options for the NetworkPolicy feature. A hash of the same form as Google::Container::V1::NetworkPolicy can also be provided.

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 2049

def set_network_policy \
    network_policy,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    network_policy: network_policy,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::SetNetworkPolicyRequest)
  @set_network_policy.call(req, options, &block)
end

#set_node_pool_autoscaling(autoscaling, project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Sets the autoscaling settings for the specified node pool.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `autoscaling`:
autoscaling = {}
response = cluster_manager_client.set_node_pool_autoscaling(autoscaling)

Parameters:

  • autoscaling (Google::Container::V1::NodePoolAutoscaling | Hash) —

    Required. Autoscaling configuration for the node pool. A hash of the same form as Google::Container::V1::NodePoolAutoscaling can also be provided.

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

  • node_pool_id (String) (defaults to: nil) —

    Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format 'projects//locations//clusters//nodePools/'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 770

def set_node_pool_autoscaling \
    autoscaling,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    node_pool_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    autoscaling: autoscaling,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    node_pool_id: node_pool_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::SetNodePoolAutoscalingRequest)
  @set_node_pool_autoscaling.call(req, options, &block)
end

#set_node_pool_management(management, project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Sets the NodeManagement options for a node pool.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `management`:
management = {}
response = cluster_manager_client.set_node_pool_management(management)

Parameters:

  • management (Google::Container::V1::NodeManagement | Hash) —

    Required. NodeManagement configuration for the node pool. A hash of the same form as Google::Container::V1::NodeManagement can also be provided.

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

  • node_pool_id (String) (defaults to: nil) —

    Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format 'projects//locations//clusters//nodePools/'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1707

def set_node_pool_management \
    management,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    node_pool_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    management: management,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    node_pool_id: node_pool_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::SetNodePoolManagementRequest)
  @set_node_pool_management.call(req, options, &block)
end

#set_node_pool_size(node_count, project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Sets the size for a specific node pool.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `node_count`:
node_count = 0
response = cluster_manager_client.set_node_pool_size(node_count)

Parameters:

  • node_count (Integer) —

    Required. The desired node count for the pool.

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

  • node_pool_id (String) (defaults to: nil) —

    Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format 'projects//locations//clusters//nodePools/'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1990

def set_node_pool_size \
    node_count,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    node_pool_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    node_count: node_count,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    node_pool_id: node_pool_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::SetNodePoolSizeRequest)
  @set_node_pool_size.call(req, options, &block)
end

#start_ip_rotation(project_id: nil, zone: nil, cluster_id: nil, name: nil, rotate_credentials: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Starts master IP rotation.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)
response = cluster_manager_client.start_ip_rotation

Parameters:

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects//locations//clusters/*'.

  • rotate_credentials (true, false) (defaults to: nil) —

    Whether to rotate credentials during IP rotation.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1883

def start_ip_rotation \
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    name: nil,
    rotate_credentials: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    name: name,
    rotate_credentials: rotate_credentials
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::StartIPRotationRequest)
  @start_ip_rotation.call(req, options, &block)
end

#update_cluster(update, project_id: nil, zone: nil, cluster_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Updates the settings of a specific cluster.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `update`:
update = {}
response = cluster_manager_client.update_cluster(update)

Parameters:

  • update (Google::Container::V1::ClusterUpdate | Hash) —

    Required. A description of the update. A hash of the same form as Google::Container::V1::ClusterUpdate can also be provided.

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster) of the cluster to update. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 631

def update_cluster \
    update,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    update: update,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::UpdateClusterRequest)
  @update_cluster.call(req, options, &block)
end

#update_master(master_version, project_id: nil, zone: nil, cluster_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Updates the master for a specific cluster.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `master_version`:
master_version = ''
response = cluster_manager_client.update_master(master_version)

Parameters:

  • master_version (String) —

    Required. The Kubernetes version to change the master to.

    Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

    • "latest": picks the highest valid Kubernetes version
    • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
    • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
    • "1.X.Y-gke.N": picks an explicit Kubernetes version
    • "-": picks the default Kubernetes version
  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster) of the cluster to update. Specified in the format 'projects//locations//clusters/*'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1075

def update_master \
    master_version,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    master_version: master_version,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::UpdateMasterRequest)
  @update_master.call(req, options, &block)
end

#update_node_pool(node_version, image_type, project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Updates the version and/or image type for the specified node pool.

Examples:

require "google/cloud/container"

cluster_manager_client = Google::Cloud::Container.new(version: :v1)

# TODO: Initialize `node_version`:
node_version = ''

# TODO: Initialize `image_type`:
image_type = ''
response = cluster_manager_client.update_node_pool(node_version, image_type)

Parameters:

  • node_version (String) —

    Required. The Kubernetes version to change the nodes to (typically an upgrade).

    Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

    • "latest": picks the highest valid Kubernetes version
    • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
    • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
    • "1.X.Y-gke.N": picks an explicit Kubernetes version
    • "-": picks the Kubernetes master version
  • image_type (String) —

    Required. The desired image type for the node pool.

  • project_id (String) (defaults to: nil) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

  • zone (String) (defaults to: nil) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

  • cluster_id (String) (defaults to: nil) —

    Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

  • node_pool_id (String) (defaults to: nil) —

    Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.

  • name (String) (defaults to: nil) —

    The name (project, location, cluster, node pool) of the node pool to update. Specified in the format 'projects//locations//clusters//nodePools/'.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 705

def update_node_pool \
    node_version,
    image_type,
    project_id: nil,
    zone: nil,
    cluster_id: nil,
    node_pool_id: nil,
    name: nil,
    options: nil,
    &block
  req = {
    node_version: node_version,
    image_type: image_type,
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    node_pool_id: node_pool_id,
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Container::V1::UpdateNodePoolRequest)
  @update_node_pool.call(req, options, &block)
end