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:



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 211

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
  # Use self-signed JWT if the scope and endpoint are unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.scope == Client.configure.scope &&
                           @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  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
 
# 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.



1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1590

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.



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2561

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:



186
187
188
189
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 186

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.



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 462

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.



1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1980

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.



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1355

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.



2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2063

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.



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 370

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.



1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1815

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.



1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1898

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.



1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1511

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.



1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1666

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.



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 291

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.



2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2955

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.



1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1745

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.



1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1432

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.



2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2887

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.



2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2147

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.



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1003

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.



2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2320

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.



2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2401

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.



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1093

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.



830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 830

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.



2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2807

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.



1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1268

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.



921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 921

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.



2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2727

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.



739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 739

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.



2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2232

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.



2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2646

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.



2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 2482

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.



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 543

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.



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 1183

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.



654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'lib/google/cloud/container/v1beta1/cluster_manager/client.rb', line 654

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