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

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

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



90
91
92
93
94
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
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 90

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: 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 = Gem.loaded_specs['google-cloud-container'].version.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 = self.class::SERVICE_ADDRESS
  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
  )
  @get_cluster = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:get_cluster),
    defaults["get_cluster"],
    exception_transformer: exception_transformer
  )
  @create_cluster = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:create_cluster),
    defaults["create_cluster"],
    exception_transformer: exception_transformer
  )
  @update_cluster = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:update_cluster),
    defaults["update_cluster"],
    exception_transformer: exception_transformer
  )
  @update_node_pool = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:update_node_pool),
    defaults["update_node_pool"],
    exception_transformer: exception_transformer
  )
  @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
  )
  @set_logging_service = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_logging_service),
    defaults["set_logging_service"],
    exception_transformer: exception_transformer
  )
  @set_monitoring_service = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_monitoring_service),
    defaults["set_monitoring_service"],
    exception_transformer: exception_transformer
  )
  @set_addons_config = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_addons_config),
    defaults["set_addons_config"],
    exception_transformer: exception_transformer
  )
  @set_locations = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_locations),
    defaults["set_locations"],
    exception_transformer: exception_transformer
  )
  @update_master = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:update_master),
    defaults["update_master"],
    exception_transformer: exception_transformer
  )
  @set_master_auth = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_master_auth),
    defaults["set_master_auth"],
    exception_transformer: exception_transformer
  )
  @delete_cluster = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:delete_cluster),
    defaults["delete_cluster"],
    exception_transformer: exception_transformer
  )
  @list_operations = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:list_operations),
    defaults["list_operations"],
    exception_transformer: exception_transformer
  )
  @get_operation = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:get_operation),
    defaults["get_operation"],
    exception_transformer: exception_transformer
  )
  @cancel_operation = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:cancel_operation),
    defaults["cancel_operation"],
    exception_transformer: exception_transformer
  )
  @get_server_config = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:get_server_config),
    defaults["get_server_config"],
    exception_transformer: exception_transformer
  )
  @list_node_pools = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:list_node_pools),
    defaults["list_node_pools"],
    exception_transformer: exception_transformer
  )
  @get_node_pool = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:get_node_pool),
    defaults["get_node_pool"],
    exception_transformer: exception_transformer
  )
  @create_node_pool = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:create_node_pool),
    defaults["create_node_pool"],
    exception_transformer: exception_transformer
  )
  @delete_node_pool = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:delete_node_pool),
    defaults["delete_node_pool"],
    exception_transformer: exception_transformer
  )
  @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
  )
  @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
  )
  @set_labels = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_labels),
    defaults["set_labels"],
    exception_transformer: exception_transformer
  )
  @set_legacy_abac = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_legacy_abac),
    defaults["set_legacy_abac"],
    exception_transformer: exception_transformer
  )
  @start_ip_rotation = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:start_ip_rotation),
    defaults["start_ip_rotation"],
    exception_transformer: exception_transformer
  )
  @complete_ip_rotation = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:complete_ip_rotation),
    defaults["complete_ip_rotation"],
    exception_transformer: exception_transformer
  )
  @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
  )
  @set_network_policy = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_network_policy),
    defaults["set_network_policy"],
    exception_transformer: exception_transformer
  )
  @set_maintenance_policy = Google::Gax.create_api_call(
    @cluster_manager_stub.method(:set_maintenance_policy),
    defaults["set_maintenance_policy"],
    exception_transformer: exception_transformer
  )
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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

    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.



1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1357

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

    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.



2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 2062

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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 (Google::Container::V1::Cluster | Hash) —

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

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



479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 479

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

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

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

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



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

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

    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.



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

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

  • node_pool_id (String) —

    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.



1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1660

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

    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.



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 408

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

  • node_pool_id (String) —

    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.



1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1527

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

    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.



1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1302

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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.



1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1408

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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.



353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 353

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

    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.



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1463

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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.



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

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

  • node_pool_id (String) —

    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.



1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1727

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

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

    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.

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



911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 911

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

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

    The labels to set for that cluster.

  • label_fingerprint (String) —

    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.

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



1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1876

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

  • enabled (true, false) —

    Whether ABAC authorization will be enabled in the cluster.

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



1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1942

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

  • locations (Array<String>) —

    The desired list of Google Compute Engine locations 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.

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



981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 981

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

  • logging_service (String) —

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



776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 776

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)

Parameters:

  • project_id (String) —

    The Google Developers Console project ID or project number.

  • zone (String) —

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

  • cluster_id (String) —

    The name of the cluster to update.

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

    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.



2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 2264

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

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

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

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

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

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



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1127

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

  • monitoring_service (String) —

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

    • "monitoring.googleapis.com" - the Google Cloud Monitoring service
    • "none" - no metrics will be exported from the cluster
  • 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.



844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 844

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

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

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

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



2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 2199

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

  • node_pool_id (String) —

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

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

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

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



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

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

  • node_pool_id (String) —

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

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

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

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



1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1800

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

  • node_pool_id (String) —

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

  • node_count (Integer) —

    The desired node count for the pool.

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



2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 2131

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

    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.



2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 2003

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

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

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

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



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 543

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

  • master_version (String) —

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



1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
 
# File 'lib/google/cloud/container/v1/cluster_manager_client.rb', line 1054

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)

Parameters:

  • project_id (String) —

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

  • zone (String) —

    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) —

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

  • node_pool_id (String) —

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

  • node_version (String) —

    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) —

    The desired image type for the node pool.

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



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

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