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 



95
96
97
98
99
100
101
102
103
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
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 95

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 }
  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,
      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
  )
end

Instance Method Details

#cancel_operation(project_id, zone, operation_id, 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)

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

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

# TODO: Initialize `operation_id`:
operation_id = ''
cluster_manager_client.cancel_operation(project_id, zone, operation_id)

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.



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1454

def cancel_operation \
    project_id,
    zone,
    operation_id,
    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, zone, cluster_id, 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)

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

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

# TODO: Initialize `cluster_id`:
cluster_id = ''
response = cluster_manager_client.complete_ip_rotation(project_id, zone, cluster_id)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 2159

def complete_ip_rotation \
    project_id,
    zone,
    cluster_id,
    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(project_id, zone, cluster, 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 cluster 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 is being used by the 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`:
cluster = {}
response = cluster_manager_client.create_cluster(project_id, zone, cluster)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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 \
    project_id,
    zone,
    cluster,
    parent: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster: cluster,
    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(project_id, zone, cluster_id, node_pool, 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 `project_id`:
project_id = ''

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

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1691

def create_node_pool \
    project_id,
    zone,
    cluster_id,
    node_pool,
    parent: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    node_pool: node_pool,
    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, zone, cluster_id, 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 (e.g. load balancer resources) will not be deleted if they weren't present at the initial create time.

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 = ''
response = cluster_manager_client.delete_cluster(project_id, zone, cluster_id)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



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

def delete_cluster \
    project_id,
    zone,
    cluster_id,
    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, zone, cluster_id, node_pool_id, 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)

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

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

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

# TODO: Initialize `node_pool_id`:
node_pool_id = ''
response = cluster_manager_client.delete_node_pool(project_id, zone, cluster_id, node_pool_id)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1757

def delete_node_pool \
    project_id,
    zone,
    cluster_id,
    node_pool_id,
    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, zone, cluster_id, 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)

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

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

# TODO: Initialize `cluster_id`:
cluster_id = ''
response = cluster_manager_client.get_cluster(project_id, zone, cluster_id)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 505

def get_cluster \
    project_id,
    zone,
    cluster_id,
    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, zone, cluster_id, node_pool_id, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::NodePool

Retrieves the node pool requested.

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 `node_pool_id`:
node_pool_id = ''
response = cluster_manager_client.get_node_pool(project_id, zone, cluster_id, node_pool_id)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1624

def get_node_pool \
    project_id,
    zone,
    cluster_id,
    node_pool_id,
    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, zone, operation_id, 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)

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

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

# TODO: Initialize `operation_id`:
operation_id = ''
response = cluster_manager_client.get_operation(project_id, zone, operation_id)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1399

def get_operation \
    project_id,
    zone,
    operation_id,
    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, zone, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::ServerConfig

Returns configuration info about the Kubernetes Engine service.

Examples:

require "google/cloud/container"

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

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

# TODO: Initialize `zone`:
zone = ''
response = cluster_manager_client.get_server_config(project_id, zone)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1505

def get_server_config \
    project_id,
    zone,
    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, zone, 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)

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

# TODO: Initialize `zone`:
zone = ''
response = cluster_manager_client.list_clusters(project_id, zone)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 450

def list_clusters \
    project_id,
    zone,
    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, zone, cluster_id, 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)

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

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

# TODO: Initialize `cluster_id`:
cluster_id = ''
response = cluster_manager_client.list_node_pools(project_id, zone, cluster_id)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1560

def list_node_pools \
    project_id,
    zone,
    cluster_id,
    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, zone, 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)

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

# TODO: Initialize `zone`:
zone = ''
response = cluster_manager_client.list_operations(project_id, zone)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1344

def list_operations \
    project_id,
    zone,
    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

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

Roll back the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.

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 `node_pool_id`:
node_pool_id = ''
response = cluster_manager_client.rollback_node_pool_upgrade(project_id, zone, cluster_id, node_pool_id)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1824

def rollback_node_pool_upgrade \
    project_id,
    zone,
    cluster_id,
    node_pool_id,
    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(project_id, zone, cluster_id, addons_config, 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 `project_id`:
project_id = ''

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

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



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

def set_addons_config \
    project_id,
    zone,
    cluster_id,
    addons_config,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    addons_config: addons_config,
    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(project_id, zone, cluster_id, resource_labels, label_fingerprint, 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 `project_id`:
project_id = ''

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

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

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1973

def set_labels \
    project_id,
    zone,
    cluster_id,
    resource_labels,
    label_fingerprint,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    resource_labels: resource_labels,
    label_fingerprint: label_fingerprint,
    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(project_id, zone, cluster_id, enabled, 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 `project_id`:
project_id = ''

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

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

# TODO: Initialize `enabled`:
enabled = false
response = cluster_manager_client.set_legacy_abac(project_id, zone, cluster_id, enabled)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 2039

def set_legacy_abac \
    project_id,
    zone,
    cluster_id,
    enabled,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    enabled: enabled,
    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(project_id, zone, cluster_id, locations, 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 `project_id`:
project_id = ''

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

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

# TODO: Initialize `locations`:
locations = []
response = cluster_manager_client.set_locations(project_id, zone, cluster_id, locations)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



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

def set_locations \
    project_id,
    zone,
    cluster_id,
    locations,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    locations: locations,
    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(project_id, zone, cluster_id, logging_service, 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 `project_id`:
project_id = ''

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

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

# TODO: Initialize `logging_service`:
logging_service = ''
response = cluster_manager_client.set_logging_service(project_id, zone, cluster_id, logging_service)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 873

def set_logging_service \
    project_id,
    zone,
    cluster_id,
    logging_service,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    logging_service: logging_service,
    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)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 2361

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(project_id, zone, cluster_id, action, update, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Used to set master auth materials. Currently supports :- Changing the admin password for a specific cluster. This can be either via password generation or explicitly set the password.

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 `action`:
action = :UNKNOWN

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1224

def set_master_auth \
    project_id,
    zone,
    cluster_id,
    action,
    update,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    action: action,
    update: update,
    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(project_id, zone, cluster_id, monitoring_service, 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 `project_id`:
project_id = ''

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

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

# TODO: Initialize `monitoring_service`:
monitoring_service = ''
response = cluster_manager_client.set_monitoring_service(project_id, zone, cluster_id, monitoring_service)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 941

def set_monitoring_service \
    project_id,
    zone,
    cluster_id,
    monitoring_service,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    monitoring_service: monitoring_service,
    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(project_id, zone, cluster_id, network_policy, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Enables/Disables Network 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 `network_policy`:
network_policy = {}
response = cluster_manager_client.set_network_policy(project_id, zone, cluster_id, network_policy)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 2296

def set_network_policy \
    project_id,
    zone,
    cluster_id,
    network_policy,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    network_policy: network_policy,
    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(project_id, zone, cluster_id, node_pool_id, autoscaling, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Sets the autoscaling settings for a specific node pool.

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 `node_pool_id`:
node_pool_id = ''

# TODO: Initialize `autoscaling`:
autoscaling = {}
response = cluster_manager_client.set_node_pool_autoscaling(project_id, zone, cluster_id, node_pool_id, autoscaling)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 803

def set_node_pool_autoscaling \
    project_id,
    zone,
    cluster_id,
    node_pool_id,
    autoscaling,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    node_pool_id: node_pool_id,
    autoscaling: autoscaling,
    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(project_id, zone, cluster_id, node_pool_id, management, 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 `project_id`:
project_id = ''

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

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

# TODO: Initialize `node_pool_id`:
node_pool_id = ''

# TODO: Initialize `management`:
management = {}
response = cluster_manager_client.set_node_pool_management(project_id, zone, cluster_id, node_pool_id, management)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1897

def set_node_pool_management \
    project_id,
    zone,
    cluster_id,
    node_pool_id,
    management,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    node_pool_id: node_pool_id,
    management: management,
    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(project_id, zone, cluster_id, node_pool_id, node_count, 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 `project_id`:
project_id = ''

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

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

# TODO: Initialize `node_pool_id`:
node_pool_id = ''

# TODO: Initialize `node_count`:
node_count = 0
response = cluster_manager_client.set_node_pool_size(project_id, zone, cluster_id, node_pool_id, node_count)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 2228

def set_node_pool_size \
    project_id,
    zone,
    cluster_id,
    node_pool_id,
    node_count,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    node_pool_id: node_pool_id,
    node_count: node_count,
    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, zone, cluster_id, name: nil, rotate_credentials: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

Start master IP rotation.

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 = ''
response = cluster_manager_client.start_ip_rotation(project_id, zone, cluster_id)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 2100

def start_ip_rotation \
    project_id,
    zone,
    cluster_id,
    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(project_id, zone, cluster_id, update, 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 `project_id`:
project_id = ''

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

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 640

def update_cluster \
    project_id,
    zone,
    cluster_id,
    update,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    update: update,
    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(project_id, zone, cluster_id, master_version, 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 `project_id`:
project_id = ''

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

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

# TODO: Initialize `master_version`:
master_version = ''
response = cluster_manager_client.update_master(project_id, zone, cluster_id, master_version)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1151

def update_master \
    project_id,
    zone,
    cluster_id,
    master_version,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    master_version: master_version,
    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(project_id, zone, cluster_id, node_pool_id, node_version, image_type, name: nil, options: nil) {|result, operation| ... } ⇒ Google::Container::V1::Operation

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

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 `node_pool_id`:
node_pool_id = ''

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 726

def update_node_pool \
    project_id,
    zone,
    cluster_id,
    node_pool_id,
    node_version,
    image_type,
    name: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    zone: zone,
    cluster_id: cluster_id,
    node_pool_id: node_pool_id,
    node_version: node_version,
    image_type: image_type,
    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