Class: Google::Cloud::Container::V1beta1::ClusterManager::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/container/v1beta1/cluster_manager/client.rb

Overview

Client for the ClusterManager service.

Google Kubernetes Engine Cluster Manager v1beta1

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#topic_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new ClusterManager client object.

Examples

To create a new ClusterManager client with the default configuration:

client = ::Google::Cloud::Container::V1beta1::ClusterManager::Client.new

To create a new ClusterManager client with a custom configuration:

client = ::Google::Cloud::Container::V1beta1::ClusterManager::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the ClusterManager client.

Yield Parameters:



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
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 244

def initialize
  # 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 "gapic/grpc"
  require "google/container/v1beta1/cluster_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  credentials ||= Credentials.default scope: @config.scope
  if credentials.is_a?(String) || credentials.is_a?(Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @cluster_manager_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Container::V1beta1::ClusterManager::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the ClusterManager Client class.

See Configuration for a description of the configuration fields.

Example

To modify the configuration for all ClusterManager clients:

::Google::Cloud::Container::V1beta1::ClusterManager::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
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
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 57

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Container", "V1beta1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const&.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.list_clusters.timeout = 20.0
    default_config.rpcs.list_clusters.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [14, 4]
    }

    default_config.rpcs.get_cluster.timeout = 20.0
    default_config.rpcs.get_cluster.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [14, 4]
    }

    default_config.rpcs.create_cluster.timeout = 45.0

    default_config.rpcs.update_cluster.timeout = 45.0

    default_config.rpcs.update_node_pool.timeout = 45.0

    default_config.rpcs.set_node_pool_autoscaling.timeout = 45.0

    default_config.rpcs.set_logging_service.timeout = 45.0

    default_config.rpcs.set_monitoring_service.timeout = 45.0

    default_config.rpcs.set_addons_config.timeout = 45.0

    default_config.rpcs.set_locations.timeout = 45.0

    default_config.rpcs.update_master.timeout = 45.0

    default_config.rpcs.set_master_auth.timeout = 45.0

    default_config.rpcs.delete_cluster.timeout = 20.0
    default_config.rpcs.delete_cluster.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [14, 4]
    }

    default_config.rpcs.list_operations.timeout = 20.0
    default_config.rpcs.list_operations.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [14, 4]
    }

    default_config.rpcs.get_operation.timeout = 20.0
    default_config.rpcs.get_operation.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [14, 4]
    }

    default_config.rpcs.cancel_operation.timeout = 45.0

    default_config.rpcs.get_server_config.timeout = 20.0
    default_config.rpcs.get_server_config.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [14, 4]
    }

    default_config.rpcs.list_node_pools.timeout = 20.0
    default_config.rpcs.list_node_pools.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [14, 4]
    }

    default_config.rpcs.get_node_pool.timeout = 20.0
    default_config.rpcs.get_node_pool.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [14, 4]
    }

    default_config.rpcs.create_node_pool.timeout = 45.0

    default_config.rpcs.delete_node_pool.timeout = 20.0
    default_config.rpcs.delete_node_pool.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [14, 4]
    }

    default_config.rpcs.rollback_node_pool_upgrade.timeout = 45.0

    default_config.rpcs.set_node_pool_management.timeout = 45.0

    default_config.rpcs.set_labels.timeout = 45.0

    default_config.rpcs.set_legacy_abac.timeout = 45.0

    default_config.rpcs.start_ip_rotation.timeout = 45.0

    default_config.rpcs.complete_ip_rotation.timeout = 45.0

    default_config.rpcs.set_node_pool_size.timeout = 45.0

    default_config.rpcs.set_network_policy.timeout = 45.0

    default_config.rpcs.set_maintenance_policy.timeout = 45.0

    default_config.rpcs.list_usable_subnetworks.timeout = 20.0
    default_config.rpcs.list_usable_subnetworks.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [14, 4]
    }

    default_config.rpcs.list_locations.timeout = 20.0
    default_config.rpcs.list_locations.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#cancel_operation(request, options = nil) ⇒ ::Google::Protobuf::Empty #cancel_operation(project_id: nil, zone: nil, operation_id: nil, name: nil) ⇒ ::Google::Protobuf::Empty

Cancels the specified operation.

Overloads:

  • #cancel_operation(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to cancel_operation via a request object, either of type Google::Cloud::Container::V1beta1::CancelOperationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::CancelOperationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #cancel_operation(project_id: nil, zone: nil, operation_id: nil, name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to cancel_operation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

      Required. 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/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1617

def cancel_operation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::CancelOperationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.cancel_operation.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.cancel_operation.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.cancel_operation.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#complete_ip_rotation(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #complete_ip_rotation(project_id: nil, zone: nil, cluster_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Completes master IP rotation.

Overloads:

  • #complete_ip_rotation(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to complete_ip_rotation via a request object, either of type Google::Cloud::Container::V1beta1::CompleteIPRotationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::CompleteIPRotationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #complete_ip_rotation(project_id: nil, zone: nil, cluster_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to complete_ip_rotation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

      Required. 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/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2588

def complete_ip_rotation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::CompleteIPRotationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.complete_ip_rotation.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.complete_ip_rotation.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.complete_ip_rotation.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :complete_ip_rotation, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the ClusterManager Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



219
220
221
222
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 219

def configure
  yield @config if block_given?
  @config
end

#create_cluster(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #create_cluster(project_id: nil, zone: nil, cluster: nil, parent: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

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

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

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

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

Overloads:

  • #create_cluster(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to create_cluster via a request object, either of type Google::Cloud::Container::V1beta1::CreateClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::CreateClusterRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #create_cluster(project_id: nil, zone: nil, cluster: nil, parent: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to create_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

      Required. 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::Cloud::Container::V1beta1::Cluster, ::Hash) (defaults to: nil) —

      Required. A cluster resource

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 489

def create_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::CreateClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_cluster.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_cluster.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :create_cluster, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_node_pool(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #create_node_pool(project_id: nil, zone: nil, cluster_id: nil, node_pool: nil, parent: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Creates a node pool for a cluster.

Overloads:

  • #create_node_pool(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to create_node_pool via a request object, either of type Google::Cloud::Container::V1beta1::CreateNodePoolRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::CreateNodePoolRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #create_node_pool(project_id: nil, zone: nil, cluster_id: nil, node_pool: nil, parent: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to create_node_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

    • node_pool (::Google::Cloud::Container::V1beta1::NodePool, ::Hash) (defaults to: nil) —

      Required. The node pool to create.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2007

def create_node_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::CreateNodePoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_node_pool.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_node_pool.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_node_pool.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :create_node_pool, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_cluster(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #delete_cluster(project_id: nil, zone: nil, cluster_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

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

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

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

Overloads:

  • #delete_cluster(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to delete_cluster via a request object, either of type DeleteClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::DeleteClusterRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #delete_cluster(project_id: nil, zone: nil, cluster_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to delete_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

      Required. 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/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1382

def delete_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::DeleteClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_cluster.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_cluster.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :delete_cluster, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_node_pool(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #delete_node_pool(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Deletes a node pool from a cluster.

Overloads:

  • #delete_node_pool(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to delete_node_pool via a request object, either of type DeleteNodePoolRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::DeleteNodePoolRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #delete_node_pool(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to delete_node_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

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

      Required. 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/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2090

def delete_node_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::DeleteNodePoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_node_pool.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_node_pool.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_node_pool.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :delete_node_pool, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_cluster(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Cluster #get_cluster(project_id: nil, zone: nil, cluster_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Cluster

Gets the details for a specific cluster.

Overloads:

  • #get_cluster(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Cluster

    Pass arguments to get_cluster via a request object, either of type GetClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::GetClusterRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #get_cluster(project_id: nil, zone: nil, cluster_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Cluster

    Pass arguments to get_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

      Required. 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/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 397

def get_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::GetClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_cluster.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_cluster.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :get_cluster, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_json_web_keys(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::GetJSONWebKeysResponse #get_json_web_keys(parent: nil) ⇒ ::Google::Cloud::Container::V1beta1::GetJSONWebKeysResponse

Gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all clusters.

Overloads:

  • #get_json_web_keys(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::GetJSONWebKeysResponse

    Pass arguments to get_json_web_keys via a request object, either of type GetJSONWebKeysRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::GetJSONWebKeysRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #get_json_web_keys(parent: nil) ⇒ ::Google::Cloud::Container::V1beta1::GetJSONWebKeysResponse

    Pass arguments to get_json_web_keys via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      The cluster (project, location, cluster id) to get keys for. Specified in the format projects/*/locations/*/clusters/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1842

def get_json_web_keys request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::GetJSONWebKeysRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_json_web_keys.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_json_web_keys.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_json_web_keys.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :get_json_web_keys, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_node_pool(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::NodePool #get_node_pool(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::NodePool

Retrieves the requested node pool.

Overloads:

  • #get_node_pool(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::NodePool

    Pass arguments to get_node_pool via a request object, either of type GetNodePoolRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::GetNodePoolRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #get_node_pool(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::NodePool

    Pass arguments to get_node_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

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

      Required. 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/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1925

def get_node_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::GetNodePoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_node_pool.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_node_pool.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_node_pool.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :get_node_pool, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_operation(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #get_operation(project_id: nil, zone: nil, operation_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Gets the specified operation.

Overloads:

  • #get_operation(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to get_operation via a request object, either of type GetOperationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::GetOperationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #get_operation(project_id: nil, zone: nil, operation_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to get_operation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

      Required. 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/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1538

def get_operation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::GetOperationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_operation.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_operation.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_operation.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :get_operation, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_server_config(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::ServerConfig #get_server_config(project_id: nil, zone: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::ServerConfig

Returns configuration info about the Google Kubernetes Engine service.

Overloads:

  • #get_server_config(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::ServerConfig

    Pass arguments to get_server_config via a request object, either of type GetServerConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::GetServerConfigRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #get_server_config(project_id: nil, zone: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::ServerConfig

    Pass arguments to get_server_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

      Required. 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/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1693

def get_server_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::GetServerConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_server_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_server_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_server_config.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :get_server_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_clusters(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::ListClustersResponse #list_clusters(project_id: nil, zone: nil, parent: nil) ⇒ ::Google::Cloud::Container::V1beta1::ListClustersResponse

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

Overloads:

  • #list_clusters(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::ListClustersResponse

    Pass arguments to list_clusters via a request object, either of type ListClustersRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::ListClustersRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #list_clusters(project_id: nil, zone: nil, parent: nil) ⇒ ::Google::Cloud::Container::V1beta1::ListClustersResponse

    Pass arguments to list_clusters via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



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
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 318

def list_clusters request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::ListClustersRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_clusters.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_clusters.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_clusters.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :list_clusters, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_locations(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::ListLocationsResponse #list_locations(parent: nil) ⇒ ::Google::Cloud::Container::V1beta1::ListLocationsResponse

Fetches locations that offer Google Kubernetes Engine.

Overloads:

  • #list_locations(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::ListLocationsResponse

    Pass arguments to list_locations via a request object, either of type ListLocationsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::ListLocationsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #list_locations(parent: nil) ⇒ ::Google::Cloud::Container::V1beta1::ListLocationsResponse

    Pass arguments to list_locations via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. Contains the name of the resource requested. Specified in the format projects/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2982

def list_locations request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::ListLocationsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_locations.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_locations.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_locations.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :list_locations, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_node_pools(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::ListNodePoolsResponse #list_node_pools(project_id: nil, zone: nil, cluster_id: nil, parent: nil) ⇒ ::Google::Cloud::Container::V1beta1::ListNodePoolsResponse

Lists the node pools for a cluster.

Overloads:

  • #list_node_pools(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::ListNodePoolsResponse

    Pass arguments to list_node_pools via a request object, either of type ListNodePoolsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::ListNodePoolsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #list_node_pools(project_id: nil, zone: nil, cluster_id: nil, parent: nil) ⇒ ::Google::Cloud::Container::V1beta1::ListNodePoolsResponse

    Pass arguments to list_node_pools via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

      Required. 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/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1772

def list_node_pools request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::ListNodePoolsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_node_pools.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_node_pools.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_node_pools.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :list_node_pools, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_operations(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::ListOperationsResponse #list_operations(project_id: nil, zone: nil, parent: nil) ⇒ ::Google::Cloud::Container::V1beta1::ListOperationsResponse

Lists all operations in a project in the specified zone or all zones.

Overloads:

  • #list_operations(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::ListOperationsResponse

    Pass arguments to list_operations via a request object, either of type ListOperationsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::ListOperationsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #list_operations(project_id: nil, zone: nil, parent: nil) ⇒ ::Google::Cloud::Container::V1beta1::ListOperationsResponse

    Pass arguments to list_operations via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1459

def list_operations request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::ListOperationsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_operations.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_operations.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_operations.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :list_operations, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_usable_subnetworks(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Container::V1beta1::UsableSubnetwork> #list_usable_subnetworks(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Container::V1beta1::UsableSubnetwork>

Lists subnetworks that can be used for creating clusters in a project.

Overloads:

  • #list_usable_subnetworks(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Container::V1beta1::UsableSubnetwork>

    Pass arguments to list_usable_subnetworks via a request object, either of type ListUsableSubnetworksRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::ListUsableSubnetworksRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #list_usable_subnetworks(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Container::V1beta1::UsableSubnetwork>

    Pass arguments to list_usable_subnetworks via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

      The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

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

      Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2914

def list_usable_subnetworks request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::ListUsableSubnetworksRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_usable_subnetworks.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_usable_subnetworks.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_usable_subnetworks.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :list_usable_subnetworks, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @cluster_manager_stub, :list_usable_subnetworks, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#rollback_node_pool_upgrade(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #rollback_node_pool_upgrade(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

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

Overloads:

  • #rollback_node_pool_upgrade(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to rollback_node_pool_upgrade via a request object, either of type RollbackNodePoolUpgradeRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::RollbackNodePoolUpgradeRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #rollback_node_pool_upgrade(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to rollback_node_pool_upgrade via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

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

      Required. 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/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2174

def rollback_node_pool_upgrade request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::RollbackNodePoolUpgradeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.rollback_node_pool_upgrade.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.rollback_node_pool_upgrade.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.rollback_node_pool_upgrade.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :rollback_node_pool_upgrade, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_addons_config(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #set_addons_config(project_id: nil, zone: nil, cluster_id: nil, addons_config: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Sets the addons for a specific cluster.

Overloads:

  • #set_addons_config(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_addons_config via a request object, either of type SetAddonsConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::SetAddonsConfigRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #set_addons_config(project_id: nil, zone: nil, cluster_id: nil, addons_config: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_addons_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

    • addons_config (::Google::Cloud::Container::V1beta1::AddonsConfig, ::Hash) (defaults to: nil) —

      Required. The desired configurations for the various addons available to run in the cluster.

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1030

def set_addons_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::SetAddonsConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_addons_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_addons_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_addons_config.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :set_addons_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_labels(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #set_labels(project_id: nil, zone: nil, cluster_id: nil, resource_labels: nil, label_fingerprint: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Sets labels on a cluster.

Overloads:

  • #set_labels(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_labels via a request object, either of type SetLabelsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::SetLabelsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #set_labels(project_id: nil, zone: nil, cluster_id: nil, resource_labels: nil, label_fingerprint: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_labels via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

    • resource_labels (::Hash{::String => ::String}) (defaults to: nil) —

      Required. The labels to set for that cluster.

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

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2347

def set_labels request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::SetLabelsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_labels.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_labels.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_labels.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :set_labels, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_legacy_abac(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #set_legacy_abac(project_id: nil, zone: nil, cluster_id: nil, enabled: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Enables or disables the ABAC authorization mechanism on a cluster.

Overloads:

  • #set_legacy_abac(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_legacy_abac via a request object, either of type SetLegacyAbacRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::SetLegacyAbacRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #set_legacy_abac(project_id: nil, zone: nil, cluster_id: nil, enabled: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_legacy_abac via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

    • enabled (::Boolean) (defaults to: nil) —

      Required. 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/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2428

def set_legacy_abac request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::SetLegacyAbacRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_legacy_abac.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_legacy_abac.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_legacy_abac.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :set_legacy_abac, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_locations(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #set_locations(project_id: nil, zone: nil, cluster_id: nil, locations: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Sets the locations for a specific cluster. Deprecated. Use projects.locations.clusters.update instead.

Overloads:

  • #set_locations(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_locations via a request object, either of type SetLocationsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::SetLocationsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #set_locations(project_id: nil, zone: nil, cluster_id: nil, locations: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_locations via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

    • locations (::Array<::String>) (defaults to: nil) —

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

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1120

def set_locations request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::SetLocationsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_locations.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_locations.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_locations.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :set_locations, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_logging_service(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #set_logging_service(project_id: nil, zone: nil, cluster_id: nil, logging_service: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Sets the logging service for a specific cluster.

Overloads:

  • #set_logging_service(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_logging_service via a request object, either of type SetLoggingServiceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::SetLoggingServiceRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #set_logging_service(project_id: nil, zone: nil, cluster_id: nil, logging_service: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_logging_service via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

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

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

      • logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model
      • logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15).
      • none - no logs will be exported from the cluster.

      If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 857

def set_logging_service request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::SetLoggingServiceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_logging_service.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_logging_service.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_logging_service.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :set_logging_service, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_maintenance_policy(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #set_maintenance_policy(project_id: nil, zone: nil, cluster_id: nil, maintenance_policy: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Sets the maintenance policy for a cluster.

Overloads:

  • #set_maintenance_policy(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_maintenance_policy via a request object, either of type SetMaintenancePolicyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::SetMaintenancePolicyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #set_maintenance_policy(project_id: nil, zone: nil, cluster_id: nil, maintenance_policy: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_maintenance_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

      Required. The name of the cluster to update.

    • maintenance_policy (::Google::Cloud::Container::V1beta1::MaintenancePolicy, ::Hash) (defaults to: nil) —

      Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2834

def set_maintenance_policy request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::SetMaintenancePolicyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_maintenance_policy.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_maintenance_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_maintenance_policy.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :set_maintenance_policy, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_master_auth(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #set_master_auth(project_id: nil, zone: nil, cluster_id: nil, action: nil, update: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

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

Overloads:

  • #set_master_auth(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_master_auth via a request object, either of type SetMasterAuthRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::SetMasterAuthRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #set_master_auth(project_id: nil, zone: nil, cluster_id: nil, action: nil, update: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_master_auth via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

    • action (::Google::Cloud::Container::V1beta1::SetMasterAuthRequest::Action) (defaults to: nil) —

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

    • update (::Google::Cloud::Container::V1beta1::MasterAuth, ::Hash) (defaults to: nil) —

      Required. A description of the update.

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1295

def set_master_auth request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::SetMasterAuthRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_master_auth.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_master_auth.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_master_auth.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :set_master_auth, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_monitoring_service(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #set_monitoring_service(project_id: nil, zone: nil, cluster_id: nil, monitoring_service: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Sets the monitoring service for a specific cluster.

Overloads:

  • #set_monitoring_service(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_monitoring_service via a request object, either of type SetMonitoringServiceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::SetMonitoringServiceRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #set_monitoring_service(project_id: nil, zone: nil, cluster_id: nil, monitoring_service: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_monitoring_service via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

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

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

      • "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
      • monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).
      • none - No metrics will be exported from the cluster.

      If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 948

def set_monitoring_service request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::SetMonitoringServiceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_monitoring_service.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_monitoring_service.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_monitoring_service.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :set_monitoring_service, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_network_policy(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #set_network_policy(project_id: nil, zone: nil, cluster_id: nil, network_policy: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Enables or disables Network Policy for a cluster.

Overloads:

  • #set_network_policy(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_network_policy via a request object, either of type SetNetworkPolicyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::SetNetworkPolicyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #set_network_policy(project_id: nil, zone: nil, cluster_id: nil, network_policy: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_network_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

    • network_policy (::Google::Cloud::Container::V1beta1::NetworkPolicy, ::Hash) (defaults to: nil) —

      Required. Configuration options for the NetworkPolicy feature.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2754

def set_network_policy request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::SetNetworkPolicyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_network_policy.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_network_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_network_policy.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :set_network_policy, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_node_pool_autoscaling(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #set_node_pool_autoscaling(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, autoscaling: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Sets the autoscaling settings of a specific node pool.

Overloads:

  • #set_node_pool_autoscaling(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_node_pool_autoscaling via a request object, either of type SetNodePoolAutoscalingRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::SetNodePoolAutoscalingRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #set_node_pool_autoscaling(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, autoscaling: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_node_pool_autoscaling via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

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

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

    • autoscaling (::Google::Cloud::Container::V1beta1::NodePoolAutoscaling, ::Hash) (defaults to: nil) —

      Required. Autoscaling configuration for the node pool.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 766

def set_node_pool_autoscaling request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::SetNodePoolAutoscalingRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_node_pool_autoscaling.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_node_pool_autoscaling.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_node_pool_autoscaling.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :set_node_pool_autoscaling, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_node_pool_management(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #set_node_pool_management(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, management: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Sets the NodeManagement options for a node pool.

Overloads:

  • #set_node_pool_management(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_node_pool_management via a request object, either of type SetNodePoolManagementRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::SetNodePoolManagementRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #set_node_pool_management(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, management: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_node_pool_management via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

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

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

    • management (::Google::Cloud::Container::V1beta1::NodeManagement, ::Hash) (defaults to: nil) —

      Required. NodeManagement configuration for the node pool.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2259

def set_node_pool_management request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::SetNodePoolManagementRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_node_pool_management.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_node_pool_management.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_node_pool_management.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :set_node_pool_management, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_node_pool_size(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #set_node_pool_size(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, node_count: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Sets the size for a specific node pool.

Overloads:

  • #set_node_pool_size(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_node_pool_size via a request object, either of type SetNodePoolSizeRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::SetNodePoolSizeRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #set_node_pool_size(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, node_count: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to set_node_pool_size via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

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

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

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

      Required. 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/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2673

def set_node_pool_size request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::SetNodePoolSizeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_node_pool_size.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_node_pool_size.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_node_pool_size.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :set_node_pool_size, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#start_ip_rotation(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #start_ip_rotation(project_id: nil, zone: nil, cluster_id: nil, name: nil, rotate_credentials: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Starts master IP rotation.

Overloads:

  • #start_ip_rotation(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to start_ip_rotation via a request object, either of type StartIPRotationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::StartIPRotationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #start_ip_rotation(project_id: nil, zone: nil, cluster_id: nil, name: nil, rotate_credentials: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to start_ip_rotation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

      Required. 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 (::Boolean) (defaults to: nil) —

      Whether to rotate credentials during IP rotation.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2509

def start_ip_rotation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::StartIPRotationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.start_ip_rotation.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.start_ip_rotation.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.start_ip_rotation.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :start_ip_rotation, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_cluster(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #update_cluster(project_id: nil, zone: nil, cluster_id: nil, update: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Updates the settings for a specific cluster.

Overloads:

  • #update_cluster(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to update_cluster via a request object, either of type UpdateClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::UpdateClusterRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #update_cluster(project_id: nil, zone: nil, cluster_id: nil, update: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to update_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

    • update (::Google::Cloud::Container::V1beta1::ClusterUpdate, ::Hash) (defaults to: nil) —

      Required. A description of the update.

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 570

def update_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::UpdateClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_cluster.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_cluster.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :update_cluster, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_master(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #update_master(project_id: nil, zone: nil, cluster_id: nil, master_version: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

Updates the master for a specific cluster.

Overloads:

  • #update_master(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to update_master via a request object, either of type UpdateMasterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::UpdateMasterRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #update_master(project_id: nil, zone: nil, cluster_id: nil, master_version: nil, name: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to update_master via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

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

      Required. The Kubernetes version to change the master to.

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1210

def update_master request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::UpdateMasterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_master.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_master.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_master.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :update_master, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_node_pool(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation #update_node_pool(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, node_version: nil, image_type: nil, locations: nil, workload_metadata_config: nil, name: nil, upgrade_settings: nil, linux_node_config: nil, kubelet_config: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

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

Overloads:

  • #update_node_pool(request, options = nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to update_node_pool via a request object, either of type UpdateNodePoolRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1beta1::UpdateNodePoolRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #update_node_pool(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, node_version: nil, image_type: nil, locations: nil, workload_metadata_config: nil, name: nil, upgrade_settings: nil, linux_node_config: nil, kubelet_config: nil) ⇒ ::Google::Cloud::Container::V1beta1::Operation

    Pass arguments to update_node_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

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

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

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

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

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

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

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

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

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

      Required. The desired image type for the node pool.

    • locations (::Array<::String>) (defaults to: nil) —

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

    • workload_metadata_config (::Google::Cloud::Container::V1beta1::WorkloadMetadataConfig, ::Hash) (defaults to: nil) —

      The desired workload metadata config 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/*.

    • upgrade_settings (::Google::Cloud::Container::V1beta1::NodePool::UpgradeSettings, ::Hash) (defaults to: nil) —

      Upgrade settings control disruption and speed of the upgrade.

    • linux_node_config (::Google::Cloud::Container::V1beta1::LinuxNodeConfig, ::Hash) (defaults to: nil) —

      Parameters that can be configured on Linux nodes.

    • kubelet_config (::Google::Cloud::Container::V1beta1::NodeKubeletConfig, ::Hash) (defaults to: nil) —

      Node kubelet configs.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 681

def update_node_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1beta1::UpdateNodePoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_node_pool.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Container::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_node_pool.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_node_pool.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cluster_manager_stub.call_rpc :update_node_pool, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end