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

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

Overview

REST 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

#ca_pool_path, #crypto_key_version_path, #subnetwork_path, #topic_path

Constructor Details

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

Create a new ClusterManager REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the ClusterManager client.

Yield Parameters:



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

def initialize
  # 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.nil? ||
                           (@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 = ::Google::Cloud::Container::V1::ClusterManager::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @cluster_manager_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
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::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 64

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

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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
  call_metadata = @config.rpcs.cancel_operation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.cancel_operation.timeout,
                         metadata:     call_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.cancel_operation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 3559

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
  call_metadata = @config.rpcs.check_autopilot_compatibility.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.check_autopilot_compatibility.timeout,
                         metadata:     call_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.check_autopilot_compatibility request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3097
3098
3099
3100
3101
3102
3103
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
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 3097

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
  call_metadata = @config.rpcs.complete_ip_rotation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.complete_ip_rotation.timeout,
                         metadata:     call_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.complete_ip_rotation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 2524

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
  call_metadata = @config.rpcs.complete_node_pool_upgrade.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.complete_node_pool_upgrade.timeout,
                         metadata:     call_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.complete_node_pool_upgrade request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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:



183
184
185
186
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 183

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

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 516

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
  call_metadata = @config.rpcs.create_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_cluster.timeout,
                         metadata:     call_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.create_cluster request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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
  call_metadata = @config.rpcs.create_node_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_node_pool.timeout,
                         metadata:     call_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.create_node_pool request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
1660
1661
1662
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 1629

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
  call_metadata = @config.rpcs.delete_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_cluster.timeout,
                         metadata:     call_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.delete_cluster request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 2443

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
  call_metadata = @config.rpcs.delete_node_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_node_pool.timeout,
                         metadata:     call_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.delete_node_pool request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#fetch_cluster_upgrade_info(request, options = nil) ⇒ ::Google::Cloud::Container::V1::ClusterUpgradeInfo #fetch_cluster_upgrade_info(name: nil, version: nil) ⇒ ::Google::Cloud::Container::V1::ClusterUpgradeInfo

Fetch upgrade information 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::Rest::Client.new

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

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

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

Overloads:

  • #fetch_cluster_upgrade_info(request, options = nil) ⇒ ::Google::Cloud::Container::V1::ClusterUpgradeInfo

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

    Parameters:

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

  • #fetch_cluster_upgrade_info(name: nil, version: nil) ⇒ ::Google::Cloud::Container::V1::ClusterUpgradeInfo

    Pass arguments to fetch_cluster_upgrade_info 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) —

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

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

      API request version that initiates this operation.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 3641

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

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

  # 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
  call_metadata = @config.rpcs.fetch_cluster_upgrade_info.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.fetch_cluster_upgrade_info.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.fetch_cluster_upgrade_info.retry_policy

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

  @cluster_manager_stub.fetch_cluster_upgrade_info request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#fetch_node_pool_upgrade_info(request, options = nil) ⇒ ::Google::Cloud::Container::V1::NodePoolUpgradeInfo #fetch_node_pool_upgrade_info(name: nil, version: nil) ⇒ ::Google::Cloud::Container::V1::NodePoolUpgradeInfo

Fetch upgrade information of a specific 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::Rest::Client.new

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

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

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

Overloads:

  • #fetch_node_pool_upgrade_info(request, options = nil) ⇒ ::Google::Cloud::Container::V1::NodePoolUpgradeInfo

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

    Parameters:

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

  • #fetch_node_pool_upgrade_info(name: nil, version: nil) ⇒ ::Google::Cloud::Container::V1::NodePoolUpgradeInfo

    Pass arguments to fetch_node_pool_upgrade_info 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) —

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

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

      API request version that initiates this operation.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 3724

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

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

  # 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
  call_metadata = @config.rpcs.fetch_node_pool_upgrade_info.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.fetch_node_pool_upgrade_info.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.fetch_node_pool_upgrade_info.retry_policy

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

  @cluster_manager_stub.fetch_node_pool_upgrade_info request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 412

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
  call_metadata = @config.rpcs.get_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_cluster.timeout,
                         metadata:     call_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.get_cluster request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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.

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

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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
  call_metadata = @config.rpcs.get_json_web_keys.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_json_web_keys.timeout,
                         metadata:     call_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.get_json_web_keys request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 2254

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
  call_metadata = @config.rpcs.get_node_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_node_pool.timeout,
                         metadata:     call_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.get_node_pool request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1809
1810
1811
1812
1813
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
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 1809

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
  call_metadata = @config.rpcs.get_operation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_operation.timeout,
                         metadata:     call_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.get_operation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 1988

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
  call_metadata = @config.rpcs.get_server_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_server_config.timeout,
                         metadata:     call_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.get_server_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 321

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
  call_metadata = @config.rpcs.list_clusters.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_clusters.timeout,
                         metadata:     call_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.list_clusters request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 2159

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
  call_metadata = @config.rpcs.list_node_pools.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_node_pools.timeout,
                         metadata:     call_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.list_node_pools request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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
  call_metadata = @config.rpcs.list_operations.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_operations.timeout,
                         metadata:     call_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.list_operations request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_usable_subnetworks(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Container::V1::UsableSubnetwork> #list_usable_subnetworks(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::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::Rest::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::Rest::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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 3477

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
  call_metadata = @config.rpcs.list_usable_subnetworks.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_usable_subnetworks.timeout,
                         metadata:     call_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.list_usable_subnetworks request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @cluster_manager_stub, :list_usable_subnetworks, "subnetworks", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


260
261
262
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 260

def logger
  @cluster_manager_stub.logger
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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 2623

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
  call_metadata = @config.rpcs.rollback_node_pool_upgrade.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.rollback_node_pool_upgrade.timeout,
                         metadata:     call_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.rollback_node_pool_upgrade request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 1229

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
  call_metadata = @config.rpcs.set_addons_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_addons_config.timeout,
                         metadata:     call_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.set_addons_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 2820

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
  call_metadata = @config.rpcs.set_labels.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_labels.timeout,
                         metadata:     call_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.set_labels request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
2944
2945
2946
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 2913

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
  call_metadata = @config.rpcs.set_legacy_abac.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_legacy_abac.timeout,
                         metadata:     call_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.set_legacy_abac request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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

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

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 1331

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
  call_metadata = @config.rpcs.set_locations.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_locations.timeout,
                         metadata:     call_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.set_locations request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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
  call_metadata = @config.rpcs.set_logging_service.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_logging_service.timeout,
                         metadata:     call_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.set_logging_service request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 3381

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
  call_metadata = @config.rpcs.set_maintenance_policy.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_maintenance_policy.timeout,
                         metadata:     call_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.set_maintenance_policy request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 1530

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
  call_metadata = @config.rpcs.set_master_auth.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_master_auth.timeout,
                         metadata:     call_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.set_master_auth request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 1135

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
  call_metadata = @config.rpcs.set_monitoring_service.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_monitoring_service.timeout,
                         metadata:     call_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.set_monitoring_service request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 3289

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
  call_metadata = @config.rpcs.set_network_policy.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_network_policy.timeout,
                         metadata:     call_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.set_network_policy request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 929

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
  call_metadata = @config.rpcs.set_node_pool_autoscaling.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_node_pool_autoscaling.timeout,
                         metadata:     call_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.set_node_pool_autoscaling request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 2720

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
  call_metadata = @config.rpcs.set_node_pool_management.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_node_pool_management.timeout,
                         metadata:     call_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.set_node_pool_management request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3196
3197
3198
3199
3200
3201
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
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 3196

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
  call_metadata = @config.rpcs.set_node_pool_size.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_node_pool_size.timeout,
                         metadata:     call_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.set_node_pool_size request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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
  call_metadata = @config.rpcs.start_ip_rotation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.start_ip_rotation.timeout,
                         metadata:     call_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.start_ip_rotation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


193
194
195
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 193

def universe_domain
  @cluster_manager_stub.universe_domain
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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
639
640
641
642
 
# File 'lib/google/cloud/container/v1/cluster_manager/rest/client.rb', line 609

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
  call_metadata = @config.rpcs.update_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_cluster.timeout,
                         metadata:     call_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.update_cluster request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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
  call_metadata = @config.rpcs.update_master.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_master.timeout,
                         metadata:     call_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.update_master request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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, image: nil, image_project: 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, accelerators: nil, machine_type: nil, disk_type: nil, disk_size_gb: nil, resource_manager_tags: nil, containerd_config: nil, queued_provisioning: nil, storage_pools: nil, max_run_duration: nil, flex_start: nil, boot_disk: nil, node_drain_config: nil, consolidation_delay: nil, taint_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::Rest::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, image: nil, image_project: 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, accelerators: nil, machine_type: nil, disk_type: nil, disk_size_gb: nil, resource_manager_tags: nil, containerd_config: nil, queued_provisioning: nil, storage_pools: nil, max_run_duration: nil, flex_start: nil, boot_disk: nil, node_drain_config: nil, consolidation_delay: nil, taint_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/*.

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

      The desired name of the image name to use for this node. This is used to create clusters using a custom image.

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

      The project containing the desired image to use for this node pool. This is used to create clusters using a custom image.

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

      Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as tags, labels, taints, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes.

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

    • accelerators (::Array<::Google::Cloud::Container::V1::AcceleratorConfig, ::Hash>) (defaults to: nil) —

      A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.

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

      Optional. The desired Google Compute Engine machine type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.

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

      Optional. The desired disk type (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type.

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

      Optional. The desired disk size for nodes in the node pool specified in GB. The smallest allowed disk size is 10GB. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size.

    • resource_manager_tags (::Google::Cloud::Container::V1::ResourceManagerTags, ::Hash) (defaults to: nil) —

      Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values.

    • containerd_config (::Google::Cloud::Container::V1::ContainerdConfig, ::Hash) (defaults to: nil) —

      The desired containerd config for nodes in the node pool. Initiates an upgrade operation that recreates the nodes with the new config.

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

      Specifies the configuration of queued provisioning.

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

      List of Storage Pools where boot disks are provisioned. Existing Storage Pools will be replaced with storage-pools.

    • max_run_duration (::Google::Protobuf::Duration, ::Hash) (defaults to: nil) —

      The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.

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

      Flex Start flag for enabling Flex Start VM.

    • boot_disk (::Google::Cloud::Container::V1::BootDisk, ::Hash) (defaults to: nil) —

      The desired boot disk config for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified boot disk config.

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

      The desired node drain configuration for nodes in the node pool.

    • consolidation_delay (::Google::Protobuf::Duration, ::Hash) (defaults to: nil) —

      Consolidation delay defines duration after which the Cluster Autoscaler can scale down underutilized nodes. If not set, nodes are scaled down by default behavior, i.e. according to the chosen autoscaling profile.

    • taint_config (::Google::Cloud::Container::V1::TaintConfig, ::Hash) (defaults to: nil) —

      The taint configuration for the node pool.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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
  call_metadata = @config.rpcs.update_node_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_node_pool.timeout,
                         metadata:     call_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.update_node_pool request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end