Class: Google::Cloud::Container::V1::ClusterManager::Client

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

Overview

Client for the ClusterManager service.

Google Kubernetes Engine Cluster Manager v1

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:


# Create a client using the default configuration
client = ::Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Container::V1::ClusterManager::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the ClusterManager client.

Yield Parameters:



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 196

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/v1/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 endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_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::V1::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.

Examples:


# Modify the configuration for all ClusterManager clients
::Google::Cloud::Container::V1::ClusterManager::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Container", "V1"]
    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
  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.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::CancelOperationRequest.new

# Call the cancel_operation method.
result = client.cancel_operation request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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) —

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

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

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

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

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 1912

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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

#check_autopilot_compatibility(request, options = nil) ⇒ ::Google::Cloud::Container::V1::CheckAutopilotCompatibilityResponse #check_autopilot_compatibility(name: nil) ⇒ ::Google::Cloud::Container::V1::CheckAutopilotCompatibilityResponse

Checks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::CheckAutopilotCompatibilityRequest.new

# Call the check_autopilot_compatibility method.
result = client.check_autopilot_compatibility request

# The returned object is of type Google::Cloud::Container::V1::CheckAutopilotCompatibilityResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 3698

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1::CheckAutopilotCompatibilityRequest

  # 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.check_autopilot_compatibility.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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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.check_autopilot_compatibility.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.check_autopilot_compatibility.retry_policy

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

  @cluster_manager_stub.call_rpc :check_autopilot_compatibility, 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::V1::Operation #complete_ip_rotation(project_id: nil, zone: nil, cluster_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Completes master IP rotation.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::CompleteIPRotationRequest.new

# Call the complete_ip_rotation method.
result = client.complete_ip_rotation request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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

      The name (project, location, cluster name) 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.



3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 3202

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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

#complete_node_pool_upgrade(request, options = nil) ⇒ ::Google::Protobuf::Empty #complete_node_pool_upgrade(name: nil) ⇒ ::Google::Protobuf::Empty

CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::CompleteNodePoolUpgradeRequest.new

# Call the complete_node_pool_upgrade method.
result = client.complete_node_pool_upgrade request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

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

    Pass arguments to complete_node_pool_upgrade via a request object, either of type Google::Cloud::Container::V1::CompleteNodePoolUpgradeRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Container::V1::CompleteNodePoolUpgradeRequest, ::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_node_pool_upgrade(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to complete_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:

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

      The name (project, location, cluster, node pool id) of the node pool to complete 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.



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

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1::CompleteNodePoolUpgradeRequest

  # 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_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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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_node_pool_upgrade.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.complete_node_pool_upgrade.retry_policy

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

  @cluster_manager_stub.call_rpc :complete_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

#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:



175
176
177
178
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 175

def configure
  yield @config if block_given?
  @config
end

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

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

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

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

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

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::CreateClusterRequest.new

# Call the create_cluster method.
result = client.create_cluster request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

    • cluster (::Google::Cloud::Container::V1::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.



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 499

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #create_node_pool(project_id: nil, zone: nil, cluster_id: nil, node_pool: nil, parent: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Creates a node pool for a cluster.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::CreateNodePoolRequest.new

# Call the create_node_pool method.
result = client.create_node_pool request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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

      Required. The node pool to create.

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

      The parent (project, location, cluster name) 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.



2397
2398
2399
2400
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/v1/cluster_manager/client.rb', line 2397

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #delete_cluster(project_id: nil, zone: nil, cluster_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

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

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

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

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::DeleteClusterRequest.new

# Call the delete_cluster method.
result = client.delete_cluster request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 1620

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #delete_node_pool(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Deletes a node pool from a cluster.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::DeleteNodePoolRequest.new

# Call the delete_node_pool method.
result = client.delete_node_pool request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 2499

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Cluster #get_cluster(project_id: nil, zone: nil, cluster_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Cluster

Gets the details of a specific cluster.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::GetClusterRequest.new

# Call the get_cluster method.
result = client.get_cluster request

# The returned object is of type Google::Cloud::Container::V1::Cluster.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 388

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::GetJSONWebKeysResponse #get_json_web_keys(parent: nil) ⇒ ::Google::Cloud::Container::V1::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.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::GetJSONWebKeysRequest.new

# Call the get_json_web_keys method.
result = client.get_json_web_keys request

# The returned object is of type Google::Cloud::Container::V1::GetJSONWebKeysResponse.
p result

Overloads:

  • #get_json_web_keys(request, options = nil) ⇒ ::Google::Cloud::Container::V1::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::V1::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::V1::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 name) 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.



2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 2096

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  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 timeout:      @config.timeout,
                         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::V1::NodePool #get_node_pool(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::NodePool

Retrieves the requested node pool.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::GetNodePoolRequest.new

# Call the get_node_pool method.
result = client.get_node_pool request

# The returned object is of type Google::Cloud::Container::V1::NodePool.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 2296

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #get_operation(project_id: nil, zone: nil, operation_id: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Gets the specified operation.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::GetOperationRequest.new

# Call the get_operation method.
result = client.get_operation request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1814
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
1851
1852
1853
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 1814

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::ServerConfig #get_server_config(project_id: nil, zone: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::ServerConfig

Returns configuration info about the Google Kubernetes Engine service.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::GetServerConfigRequest.new

# Call the get_server_config method.
result = client.get_server_config request

# The returned object is of type Google::Cloud::Container::V1::ServerConfig.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::ListClustersResponse #list_clusters(project_id: nil, zone: nil, parent: nil) ⇒ ::Google::Cloud::Container::V1::ListClustersResponse

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

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::ListClustersRequest.new

# Call the list_clusters method.
result = client.list_clusters request

# The returned object is of type Google::Cloud::Container::V1::ListClustersResponse.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  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 timeout:      @config.timeout,
                         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_node_pools(request, options = nil) ⇒ ::Google::Cloud::Container::V1::ListNodePoolsResponse #list_node_pools(project_id: nil, zone: nil, cluster_id: nil, parent: nil) ⇒ ::Google::Cloud::Container::V1::ListNodePoolsResponse

Lists the node pools for a cluster.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::ListNodePoolsRequest.new

# Call the list_node_pools method.
result = client.list_node_pools request

# The returned object is of type Google::Cloud::Container::V1::ListNodePoolsResponse.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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

      The parent (project, location, cluster name) 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.



2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 2194

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  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 timeout:      @config.timeout,
                         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::V1::ListOperationsResponse #list_operations(project_id: nil, zone: nil, parent: nil) ⇒ ::Google::Cloud::Container::V1::ListOperationsResponse

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

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::ListOperationsRequest.new

# Call the list_operations method.
result = client.list_operations request

# The returned object is of type Google::Cloud::Container::V1::ListOperationsResponse.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 1716

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  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 timeout:      @config.timeout,
                         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::V1::UsableSubnetwork> #list_usable_subnetworks(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Container::V1::UsableSubnetwork>

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

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::ListUsableSubnetworksRequest.new

# Call the list_usable_subnetworks method.
result = client.list_usable_subnetworks request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Container::V1::UsableSubnetwork.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

      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.



3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 3610

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #rollback_node_pool_upgrade(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, name: nil, respect_pdb: nil) ⇒ ::Google::Cloud::Container::V1::Operation

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

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::RollbackNodePoolUpgradeRequest.new

# Call the rollback_node_pool_upgrade method.
result = client.rollback_node_pool_upgrade request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

  • #rollback_node_pool_upgrade(request, options = nil) ⇒ ::Google::Cloud::Container::V1::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::V1::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, respect_pdb: nil) ⇒ ::Google::Cloud::Container::V1::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) —

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

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

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

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

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

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

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

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

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

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

      Option for rollback to ignore the PodDisruptionBudget. Default value is false.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 2693

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #set_addons_config(project_id: nil, zone: nil, cluster_id: nil, addons_config: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Sets the addons for a specific cluster.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::SetAddonsConfigRequest.new

# Call the set_addons_config method.
result = client.set_addons_config request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

    • addons_config (::Google::Cloud::Container::V1::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.



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
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 1190

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #set_labels(project_id: nil, zone: nil, cluster_id: nil, resource_labels: nil, label_fingerprint: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Sets labels on a cluster.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::SetLabelsRequest.new

# Call the set_labels method.
result = client.set_labels request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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



2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 2904

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #set_legacy_abac(project_id: nil, zone: nil, cluster_id: nil, enabled: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Enables or disables the ABAC authorization mechanism on a cluster.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::SetLegacyAbacRequest.new

# Call the set_legacy_abac method.
result = client.set_legacy_abac request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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



3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 3004

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #set_locations(project_id: nil, zone: nil, cluster_id: nil, locations: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Deprecated.

This method is deprecated and may be removed in the next major version update.

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

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::SetLocationsRequest.new

# Call the set_locations method.
result = client.set_locations request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 1301

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #set_logging_service(project_id: nil, zone: nil, cluster_id: nil, logging_service: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Sets the logging service for a specific cluster.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::SetLoggingServiceRequest.new

# Call the set_logging_service method.
result = client.set_logging_service request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 979

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #set_maintenance_policy(project_id: nil, zone: nil, cluster_id: nil, maintenance_policy: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Sets the maintenance policy for a cluster.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::SetMaintenancePolicyRequest.new

# Call the set_maintenance_policy method.
result = client.set_maintenance_policy request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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::V1::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 name) 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.



3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 3507

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #set_master_auth(project_id: nil, zone: nil, cluster_id: nil, action: nil, update: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

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

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::SetMasterAuthRequest.new

# Call the set_master_auth method.
result = client.set_master_auth request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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

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

    • update (::Google::Cloud::Container::V1::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.



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
1547
1548
1549
1550
1551
1552
1553
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 1514

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #set_monitoring_service(project_id: nil, zone: nil, cluster_id: nil, monitoring_service: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Sets the monitoring service for a specific cluster.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::SetMonitoringServiceRequest.new

# Call the set_monitoring_service method.
result = client.set_monitoring_service request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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



1089
1090
1091
1092
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/v1/cluster_manager/client.rb', line 1089

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #set_network_policy(project_id: nil, zone: nil, cluster_id: nil, network_policy: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Enables or disables Network Policy for a cluster.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::SetNetworkPolicyRequest.new

# Call the set_network_policy method.
result = client.set_network_policy request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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

      Required. Configuration options for the NetworkPolicy feature.

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

      The name (project, location, cluster name) 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.



3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 3408

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #set_node_pool_autoscaling(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, autoscaling: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Sets the autoscaling settings for the specified node pool.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::SetNodePoolAutoscalingRequest.new

# Call the set_node_pool_autoscaling method.
result = client.set_node_pool_autoscaling request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

  • #set_node_pool_autoscaling(request, options = nil) ⇒ ::Google::Cloud::Container::V1::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::V1::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::V1::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) —

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

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

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

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

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

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

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

    • autoscaling (::Google::Cloud::Container::V1::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.



869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 869

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #set_node_pool_management(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, management: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Sets the NodeManagement options for a node pool.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::SetNodePoolManagementRequest.new

# Call the set_node_pool_management method.
result = client.set_node_pool_management request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

  • #set_node_pool_management(request, options = nil) ⇒ ::Google::Cloud::Container::V1::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::V1::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::V1::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) —

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

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

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

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

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

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

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

    • management (::Google::Cloud::Container::V1::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.



2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
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
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 2797

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::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::V1::Operation

Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::SetNodePoolSizeRequest.new

# Call the set_node_pool_size method.
result = client.set_node_pool_size request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

  • #set_node_pool_size(request, options = nil) ⇒ ::Google::Cloud::Container::V1::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::V1::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::V1::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) —

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

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

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

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

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

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

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

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



3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 3308

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #start_ip_rotation(project_id: nil, zone: nil, cluster_id: nil, name: nil, rotate_credentials: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Starts master IP rotation.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::StartIPRotationRequest.new

# Call the start_ip_rotation method.
result = client.start_ip_rotation request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

  • #start_ip_rotation(request, options = nil) ⇒ ::Google::Cloud::Container::V1::Operation

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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

      The name (project, location, cluster name) 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.



3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 3104

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #update_cluster(project_id: nil, zone: nil, cluster_id: nil, update: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Updates the settings of a specific cluster.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::UpdateClusterRequest.new

# Call the update_cluster method.
result = client.update_cluster request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

  • #update_cluster(request, options = nil) ⇒ ::Google::Cloud::Container::V1::Operation

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

    • update (::Google::Cloud::Container::V1::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.



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 599

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #update_master(project_id: nil, zone: nil, cluster_id: nil, master_version: nil, name: nil) ⇒ ::Google::Cloud::Container::V1::Operation

Updates the master for a specific cluster.

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::UpdateMasterRequest.new

# Call the update_master method.
result = client.update_master request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

  • #update_master(request, options = nil) ⇒ ::Google::Cloud::Container::V1::Operation

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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::V1::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) —

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

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

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

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

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

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



1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
 
# File 'lib/google/cloud/container/v1/cluster_manager/client.rb', line 1410

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Container::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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::V1::Operation #update_node_pool(project_id: nil, zone: nil, cluster_id: nil, node_pool_id: nil, node_version: nil, image_type: nil, name: nil, locations: nil, workload_metadata_config: nil, upgrade_settings: nil, tags: nil, taints: nil, labels: nil, linux_node_config: nil, kubelet_config: nil, node_network_config: nil, gcfs_config: nil, confidential_nodes: nil, gvnic: nil, etag: nil, fast_socket: nil, logging_config: nil, resource_labels: nil, windows_node_config: nil) ⇒ ::Google::Cloud::Container::V1::Operation

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

Examples:

Basic example

require "google/cloud/container/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Container::V1::ClusterManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Container::V1::UpdateNodePoolRequest.new

# Call the update_node_pool method.
result = client.update_node_pool request

# The returned object is of type Google::Cloud::Container::V1::Operation.
p result

Overloads:

  • #update_node_pool(request, options = nil) ⇒ ::Google::Cloud::Container::V1::Operation

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

    Parameters:

    • request (::Google::Cloud::Container::V1::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, name: nil, locations: nil, workload_metadata_config: nil, upgrade_settings: nil, tags: nil, taints: nil, labels: nil, linux_node_config: nil, kubelet_config: nil, node_network_config: nil, gcfs_config: nil, confidential_nodes: nil, gvnic: nil, etag: nil, fast_socket: nil, logging_config: nil, resource_labels: nil, windows_node_config: nil) ⇒ ::Google::Cloud::Container::V1::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) —

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

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

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

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

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

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

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

    • 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. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.

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

    • 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::V1::WorkloadMetadataConfig, ::Hash) (defaults to: nil) —

      The desired workload metadata config for the node pool.

    • upgrade_settings (::Google::Cloud::Container::V1::NodePool::UpgradeSettings, ::Hash) (defaults to: nil) —

      Upgrade settings control disruption and speed of the upgrade.

    • tags (::Google::Cloud::Container::V1::NetworkTags, ::Hash) (defaults to: nil) —

      The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be replaced with the provided tags.

    • taints (::Google::Cloud::Container::V1::NodeTaints, ::Hash) (defaults to: nil) —

      The desired node taints to be applied to all nodes in the node pool. If this field is not present, the taints will not be changed. Otherwise, the existing node taints will be replaced with the provided taints.

    • labels (::Google::Cloud::Container::V1::NodeLabels, ::Hash) (defaults to: nil) —

      The desired node labels to be applied to all nodes in the node pool. If this field is not present, the labels will not be changed. Otherwise, the existing node labels will be replaced with the provided labels.

    • linux_node_config (::Google::Cloud::Container::V1::LinuxNodeConfig, ::Hash) (defaults to: nil) —

      Parameters that can be configured on Linux nodes.

    • kubelet_config (::Google::Cloud::Container::V1::NodeKubeletConfig, ::Hash) (defaults to: nil) —

      Node kubelet configs.

    • node_network_config (::Google::Cloud::Container::V1::NodeNetworkConfig, ::Hash) (defaults to: nil) —

      Node network config.

    • gcfs_config (::Google::Cloud::Container::V1::GcfsConfig, ::Hash) (defaults to: nil) —

      GCFS config.

    • confidential_nodes (::Google::Cloud::Container::V1::ConfidentialNodes, ::Hash) (defaults to: nil) —

      Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.

    • gvnic (::Google::Cloud::Container::V1::VirtualNIC, ::Hash) (defaults to: nil) —

      Enable or disable gvnic on the node pool.

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

      The current etag of the node pool. If an etag is provided and does not match the current etag of the node pool, update will be blocked and an ABORTED error will be returned.

    • fast_socket (::Google::Cloud::Container::V1::FastSocket, ::Hash) (defaults to: nil) —

      Enable or disable NCCL fast socket for the node pool.

    • logging_config (::Google::Cloud::Container::V1::NodePoolLoggingConfig, ::Hash) (defaults to: nil) —

      Logging configuration.

    • resource_labels (::Google::Cloud::Container::V1::ResourceLabels, ::Hash) (defaults to: nil) —

      The resource labels for the node pool to use to annotate any related Google Compute Engine resources.

    • windows_node_config (::Google::Cloud::Container::V1::WindowsNodeConfig, ::Hash) (defaults to: nil) —

      Parameters that can be configured on Windows nodes.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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

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::V1::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::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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 timeout:      @config.timeout,
                         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