Class: Google::Apis::ContainerV1beta1::ContainerService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/container_v1beta1/service.rb

Overview

Google Container Engine API

The Google Container Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology.

Examples:

require 'google/apis/container_v1beta1'

Container = Google::Apis::ContainerV1beta1 # Alias the module
service = Container::ContainerService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initializeContainerService

Returns a new instance of ContainerService



46
47
48
49
# File 'generated/google/apis/container_v1beta1/service.rb', line 46

def initialize
  super('https://container.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



39
40
41
# File 'generated/google/apis/container_v1beta1/service.rb', line 39

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



44
45
46
# File 'generated/google/apis/container_v1beta1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#cancel_project_location_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Empty

Cancels the specified operation.

Parameters:

  • name (String)

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

  • cancel_operation_request_object (Google::Apis::ContainerV1beta1::CancelOperationRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



828
829
830
831
832
833
834
835
836
837
838
# File 'generated/google/apis/container_v1beta1/service.rb', line 828

def cancel_project_location_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.request_representation = Google::Apis::ContainerV1beta1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Empty::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_zone_operation(project_id, zone, operation_id, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Empty

Cancels the specified operation.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the operation resides. This field is deprecated, use name instead.

  • operation_id (String)

    The server-assigned name of the operation. This field is deprecated, use name instead.

  • cancel_operation_request_object (Google::Apis::ContainerV1beta1::CancelOperationRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
# File 'generated/google/apis/container_v1beta1/service.rb', line 1841

def cancel_project_zone_operation(project_id, zone, operation_id, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel', options)
  command.request_representation = Google::Apis::ContainerV1beta1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Empty::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Empty
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['operationId'] = operation_id unless operation_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#complete_project_location_cluster_ip_rotation(name, complete_ip_rotation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Completes master IP rotation.

Parameters:

  • name (String)

    The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects//locations//clusters/*'.

  • complete_ip_rotation_request_object (Google::Apis::ContainerV1beta1::CompleteIpRotationRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



115
116
117
118
119
120
121
122
123
124
125
# File 'generated/google/apis/container_v1beta1/service.rb', line 115

def complete_project_location_cluster_ip_rotation(name, complete_ip_rotation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+name}:completeIpRotation', options)
  command.request_representation = Google::Apis::ContainerV1beta1::CompleteIpRotationRequest::Representation
  command.request_object = complete_ip_rotation_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#complete_project_zone_cluster_ip_rotation(project_id, zone, cluster_id, complete_ip_rotation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Completes master IP rotation.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • cluster_id (String)

    The name of the cluster. This field is deprecated, use name instead.

  • complete_ip_rotation_request_object (Google::Apis::ContainerV1beta1::CompleteIpRotationRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
# File 'generated/google/apis/container_v1beta1/service.rb', line 1000

def complete_project_zone_cluster_ip_rotation(project_id, zone, cluster_id, complete_ip_rotation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation', options)
  command.request_representation = Google::Apis::ContainerV1beta1::CompleteIpRotationRequest::Representation
  command.request_object = complete_ip_rotation_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_cluster(project_id, zone, create_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's default network. One firewall is added for the cluster. After cluster creation, the cluster creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use parent instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use parent instead.

  • create_cluster_request_object (Google::Apis::ContainerV1beta1::CreateClusterRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
# File 'generated/google/apis/container_v1beta1/service.rb', line 1051

def create_cluster(project_id, zone, create_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters', options)
  command.request_representation = Google::Apis::ContainerV1beta1::CreateClusterRequest::Representation
  command.request_object = create_cluster_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_cluster(parent, create_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's default network. One firewall is added for the cluster. After cluster creation, the cluster creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.

Parameters:

  • parent (String)

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

  • create_cluster_request_object (Google::Apis::ContainerV1beta1::CreateClusterRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



158
159
160
161
162
163
164
165
166
167
168
# File 'generated/google/apis/container_v1beta1/service.rb', line 158

def create_project_location_cluster(parent, create_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+parent}/clusters', options)
  command.request_representation = Google::Apis::ContainerV1beta1::CreateClusterRequest::Representation
  command.request_object = create_cluster_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_cluster_node_pool(parent, create_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Creates a node pool for a cluster.

Parameters:

  • parent (String)

    The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects//locations//clusters//nodePools/'.

  • create_node_pool_request_object (Google::Apis::ContainerV1beta1::CreateNodePoolRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



577
578
579
580
581
582
583
584
585
586
587
# File 'generated/google/apis/container_v1beta1/service.rb', line 577

def create_project_location_cluster_node_pool(parent, create_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+parent}/nodePools', options)
  command.request_representation = Google::Apis::ContainerV1beta1::CreateNodePoolRequest::Representation
  command.request_object = create_node_pool_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_zone_cluster_node_pool(project_id, zone, cluster_id, create_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Creates a node pool for a cluster.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use parent instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use parent instead.

  • cluster_id (String)

    The name of the cluster. This field is deprecated, use parent instead.

  • create_node_pool_request_object (Google::Apis::ContainerV1beta1::CreateNodePoolRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
# File 'generated/google/apis/container_v1beta1/service.rb', line 1552

def create_project_zone_cluster_node_pool(project_id, zone, cluster_id, create_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools', options)
  command.request_representation = Google::Apis::ContainerV1beta1::CreateNodePoolRequest::Representation
  command.request_object = create_node_pool_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_cluster(name, cluster_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster (e.g. load balancer resources) will not be deleted if they weren't present at the initial create time.

Parameters:

  • name (String)

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

  • cluster_id (String)

    The name of the cluster to delete. This field is deprecated, use name instead.

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



209
210
211
212
213
214
215
216
217
218
219
220
# File 'generated/google/apis/container_v1beta1/service.rb', line 209

def delete_project_location_cluster(name, cluster_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['zone'] = zone unless zone.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_cluster_node_pool(name, cluster_id: nil, node_pool_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Deletes a node pool from a cluster.

Parameters:

  • name (String)

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

  • cluster_id (String)

    The name of the cluster. This field is deprecated, use name instead.

  • node_pool_id (String)

    The name of the node pool to delete. This field is deprecated, use name instead.

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



625
626
627
628
629
630
631
632
633
634
635
636
637
# File 'generated/google/apis/container_v1beta1/service.rb', line 625

def delete_project_location_cluster_node_pool(name, cluster_id: nil, node_pool_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['nodePoolId'] = node_pool_id unless node_pool_id.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['zone'] = zone unless zone.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Deletes a node pool from a cluster.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • cluster_id (String)

    The name of the cluster. This field is deprecated, use name instead.

  • node_pool_id (String)

    The name of the node pool to delete. This field is deprecated, use name instead.

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'generated/google/apis/container_v1beta1/service.rb', line 1602

def delete_project_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}', options)
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.params['nodePoolId'] = node_pool_id unless node_pool_id.nil?
  command.query['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_zone_cluster(project_id, zone, cluster_id, name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster (e.g. load balancer resources) will not be deleted if they weren't present at the initial create time.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • cluster_id (String)

    The name of the cluster to delete. This field is deprecated, use name instead.

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
# File 'generated/google/apis/container_v1beta1/service.rb', line 1103

def delete_zone_cluster(project_id, zone, cluster_id, name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}', options)
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_cluster(name, cluster_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Cluster

Gets the details of a specific cluster.

Parameters:

  • name (String)

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

  • cluster_id (String)

    The name of the cluster to retrieve. This field is deprecated, use name instead.

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



255
256
257
258
259
260
261
262
263
264
265
266
# File 'generated/google/apis/container_v1beta1/service.rb', line 255

def get_project_location_cluster(name, cluster_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ContainerV1beta1::Cluster::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Cluster
  command.params['name'] = name unless name.nil?
  command.query['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['zone'] = zone unless zone.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_cluster_node_pool(name, cluster_id: nil, node_pool_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::NodePool

Retrieves the node pool requested.

Parameters:

  • name (String)

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

  • cluster_id (String)

    The name of the cluster. This field is deprecated, use name instead.

  • node_pool_id (String)

    The name of the node pool. This field is deprecated, use name instead.

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



675
676
677
678
679
680
681
682
683
684
685
686
687
# File 'generated/google/apis/container_v1beta1/service.rb', line 675

def get_project_location_cluster_node_pool(name, cluster_id: nil, node_pool_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ContainerV1beta1::NodePool::Representation
  command.response_class = Google::Apis::ContainerV1beta1::NodePool
  command.params['name'] = name unless name.nil?
  command.query['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['nodePoolId'] = node_pool_id unless node_pool_id.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['zone'] = zone unless zone.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, operation_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Gets the specified operation.

Parameters:

  • name (String)

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

  • operation_id (String)

    The server-assigned name of the operation. This field is deprecated, use name instead.

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



873
874
875
876
877
878
879
880
881
882
883
884
# File 'generated/google/apis/container_v1beta1/service.rb', line 873

def get_project_location_operation(name, operation_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['operationId'] = operation_id unless operation_id.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['zone'] = zone unless zone.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_server_config(name, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::ServerConfig

Returns configuration info about the Container Engine service.

Parameters:

  • name (String)

    The name (project and location) of the server config to get Specified in the format 'projects//locations/'.

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone to return operations for. This field is deprecated, use name instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



80
81
82
83
84
85
86
87
88
89
90
# File 'generated/google/apis/container_v1beta1/service.rb', line 80

def get_project_location_server_config(name, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+name}/serverConfig', options)
  command.response_representation = Google::Apis::ContainerV1beta1::ServerConfig::Representation
  command.response_class = Google::Apis::ContainerV1beta1::ServerConfig
  command.params['name'] = name unless name.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['zone'] = zone unless zone.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::NodePool

Retrieves the node pool requested.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • cluster_id (String)

    The name of the cluster. This field is deprecated, use name instead.

  • node_pool_id (String)

    The name of the node pool. This field is deprecated, use name instead.

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
# File 'generated/google/apis/container_v1beta1/service.rb', line 1652

def get_project_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}', options)
  command.response_representation = Google::Apis::ContainerV1beta1::NodePool::Representation
  command.response_class = Google::Apis::ContainerV1beta1::NodePool
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.params['nodePoolId'] = node_pool_id unless node_pool_id.nil?
  command.query['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_zone_serverconfig(project_id, zone, name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::ServerConfig

Returns configuration info about the Container Engine service.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone to return operations for. This field is deprecated, use name instead.

  • name (String)

    The name (project and location) of the server config to get Specified in the format 'projects//locations/'.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



957
958
959
960
961
962
963
964
965
966
967
# File 'generated/google/apis/container_v1beta1/service.rb', line 957

def get_project_zone_serverconfig(project_id, zone, name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/projects/{projectId}/zones/{zone}/serverconfig', options)
  command.response_representation = Google::Apis::ContainerV1beta1::ServerConfig::Representation
  command.response_class = Google::Apis::ContainerV1beta1::ServerConfig
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.query['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_zone_cluster(project_id, zone, cluster_id, name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Cluster

Gets the details of a specific cluster.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • cluster_id (String)

    The name of the cluster to retrieve. This field is deprecated, use name instead.

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'generated/google/apis/container_v1beta1/service.rb', line 1149

def get_zone_cluster(project_id, zone, cluster_id, name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}', options)
  command.response_representation = Google::Apis::ContainerV1beta1::Cluster::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Cluster
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_zone_operation(project_id, zone, operation_id, name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Gets the specified operation.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • operation_id (String)

    The server-assigned name of the operation. This field is deprecated, use name instead.

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
# File 'generated/google/apis/container_v1beta1/service.rb', line 1888

def get_zone_operation(project_id, zone, operation_id, name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}', options)
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['operationId'] = operation_id unless operation_id.nil?
  command.query['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#legacy_project_zone_cluster_abac(project_id, zone, cluster_id, set_legacy_abac_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Enables or disables the ABAC authorization mechanism on a cluster.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • cluster_id (String)

    The name of the cluster to update. This field is deprecated, use name instead.

  • set_legacy_abac_request_object (Google::Apis::ContainerV1beta1::SetLegacyAbacRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
# File 'generated/google/apis/container_v1beta1/service.rb', line 1193

def legacy_project_zone_cluster_abac(project_id, zone, cluster_id, set_legacy_abac_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac', options)
  command.request_representation = Google::Apis::ContainerV1beta1::SetLegacyAbacRequest::Representation
  command.request_object = set_legacy_abac_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_cluster_node_pools(parent, cluster_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::ListNodePoolsResponse

Lists the node pools for a cluster.

Parameters:

  • parent (String)

    The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects//locations//clusters/*'.

  • cluster_id (String)

    The name of the cluster. This field is deprecated, use parent instead.

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use parent instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use parent instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



722
723
724
725
726
727
728
729
730
731
732
733
# File 'generated/google/apis/container_v1beta1/service.rb', line 722

def list_project_location_cluster_node_pools(parent, cluster_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+parent}/nodePools', options)
  command.response_representation = Google::Apis::ContainerV1beta1::ListNodePoolsResponse::Representation
  command.response_class = Google::Apis::ContainerV1beta1::ListNodePoolsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['zone'] = zone unless zone.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_clusters(parent, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::ListClustersResponse

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

Parameters:

  • parent (String)

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

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use parent instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides, or "-" for all zones. This field is deprecated, use parent instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



300
301
302
303
304
305
306
307
308
309
310
# File 'generated/google/apis/container_v1beta1/service.rb', line 300

def list_project_location_clusters(parent, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+parent}/clusters', options)
  command.response_representation = Google::Apis::ContainerV1beta1::ListClustersResponse::Representation
  command.response_class = Google::Apis::ContainerV1beta1::ListClustersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['zone'] = zone unless zone.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(parent, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::ListOperationsResponse

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

Parameters:

  • parent (String)

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

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use parent instead.

  • zone (String)

    The name of the Google Compute Engine zone to return operations for, or - for all zones. This field is deprecated, use parent instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



916
917
918
919
920
921
922
923
924
925
926
# File 'generated/google/apis/container_v1beta1/service.rb', line 916

def list_project_location_operations(parent, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+parent}/operations', options)
  command.response_representation = Google::Apis::ContainerV1beta1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::ContainerV1beta1::ListOperationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['zone'] = zone unless zone.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_zone_cluster_node_pools(project_id, zone, cluster_id, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::ListNodePoolsResponse

Lists the node pools for a cluster.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use parent instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use parent instead.

  • cluster_id (String)

    The name of the cluster. This field is deprecated, use parent instead.

  • parent (String)

    The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects//locations//clusters/*'.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
# File 'generated/google/apis/container_v1beta1/service.rb', line 1699

def list_project_zone_cluster_node_pools(project_id, zone, cluster_id, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools', options)
  command.response_representation = Google::Apis::ContainerV1beta1::ListNodePoolsResponse::Representation
  command.response_class = Google::Apis::ContainerV1beta1::ListNodePoolsResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_zone_clusters(project_id, zone, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::ListClustersResponse

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

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use parent instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides, or "-" for all zones. This field is deprecated, use parent instead.

  • parent (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
# File 'generated/google/apis/container_v1beta1/service.rb', line 1239

def list_zone_clusters(project_id, zone, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/projects/{projectId}/zones/{zone}/clusters', options)
  command.response_representation = Google::Apis::ContainerV1beta1::ListClustersResponse::Representation
  command.response_class = Google::Apis::ContainerV1beta1::ListClustersResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_zone_operations(project_id, zone, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::ListOperationsResponse

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

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use parent instead.

  • zone (String)

    The name of the Google Compute Engine zone to return operations for, or - for all zones. This field is deprecated, use parent instead.

  • parent (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
# File 'generated/google/apis/container_v1beta1/service.rb', line 1931

def list_zone_operations(project_id, zone, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/projects/{projectId}/zones/{zone}/operations', options)
  command.response_representation = Google::Apis::ContainerV1beta1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::ContainerV1beta1::ListOperationsResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#resource_project_zone_cluster_labels(project_id, zone, cluster_id, set_labels_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Sets labels on a cluster.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • cluster_id (String)

    The name of the cluster. This field is deprecated, use name instead.

  • set_labels_request_object (Google::Apis::ContainerV1beta1::SetLabelsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
# File 'generated/google/apis/container_v1beta1/service.rb', line 1282

def resource_project_zone_cluster_labels(project_id, zone, cluster_id, set_labels_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels', options)
  command.request_representation = Google::Apis::ContainerV1beta1::SetLabelsRequest::Representation
  command.request_object = set_labels_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rollback_project_location_cluster_node_pool(name, rollback_node_pool_upgrade_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Roll back the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.

Parameters:

  • name (String)

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

  • rollback_node_pool_upgrade_request_object (Google::Apis::ContainerV1beta1::RollbackNodePoolUpgradeRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



759
760
761
762
763
764
765
766
767
768
769
# File 'generated/google/apis/container_v1beta1/service.rb', line 759

def rollback_project_location_cluster_node_pool(name, rollback_node_pool_upgrade_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+name}:rollback', options)
  command.request_representation = Google::Apis::ContainerV1beta1::RollbackNodePoolUpgradeRequest::Representation
  command.request_object = rollback_node_pool_upgrade_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rollback_project_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, rollback_node_pool_upgrade_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Roll back the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • cluster_id (String)

    The name of the cluster to rollback. This field is deprecated, use name instead.

  • node_pool_id (String)

    The name of the node pool to rollback. This field is deprecated, use name instead.

  • rollback_node_pool_upgrade_request_object (Google::Apis::ContainerV1beta1::RollbackNodePoolUpgradeRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
# File 'generated/google/apis/container_v1beta1/service.rb', line 1747

def rollback_project_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, rollback_node_pool_upgrade_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback', options)
  command.request_representation = Google::Apis::ContainerV1beta1::RollbackNodePoolUpgradeRequest::Representation
  command.request_object = rollback_node_pool_upgrade_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.params['nodePoolId'] = node_pool_id unless node_pool_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_cluster_legacy_abac(name, set_legacy_abac_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Enables or disables the ABAC authorization mechanism on a cluster.

Parameters:

  • name (String)

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

  • set_legacy_abac_request_object (Google::Apis::ContainerV1beta1::SetLegacyAbacRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



334
335
336
337
338
339
340
341
342
343
344
# File 'generated/google/apis/container_v1beta1/service.rb', line 334

def set_cluster_legacy_abac(name, set_legacy_abac_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+name}:setLegacyAbac', options)
  command.request_representation = Google::Apis::ContainerV1beta1::SetLegacyAbacRequest::Representation
  command.request_object = set_legacy_abac_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_cluster_maintenance_policy(name, set_maintenance_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Sets the maintenance policy for a cluster.

Parameters:

  • name (String)

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

  • set_maintenance_policy_request_object (Google::Apis::ContainerV1beta1::SetMaintenancePolicyRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



369
370
371
372
373
374
375
376
377
378
379
# File 'generated/google/apis/container_v1beta1/service.rb', line 369

def set_project_location_cluster_maintenance_policy(name, set_maintenance_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+name}:setMaintenancePolicy', options)
  command.request_representation = Google::Apis::ContainerV1beta1::SetMaintenancePolicyRequest::Representation
  command.request_object = set_maintenance_policy_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_cluster_master_auth(name, set_master_auth_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Used to set master auth materials. Currently supports :- Changing the admin password of a specific cluster. This can be either via password generation or explicitly set. Modify basic_auth.csv and reset the K8S API server.

Parameters:

  • name (String)

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

  • set_master_auth_request_object (Google::Apis::ContainerV1beta1::SetMasterAuthRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



406
407
408
409
410
411
412
413
414
415
416
# File 'generated/google/apis/container_v1beta1/service.rb', line 406

def set_project_location_cluster_master_auth(name, set_master_auth_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+name}:setMasterAuth', options)
  command.request_representation = Google::Apis::ContainerV1beta1::SetMasterAuthRequest::Representation
  command.request_object = set_master_auth_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_cluster_network_policy(name, set_network_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Enables/Disables Network Policy for a cluster.

Parameters:

  • name (String)

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

  • set_network_policy_request_object (Google::Apis::ContainerV1beta1::SetNetworkPolicyRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



441
442
443
444
445
446
447
448
449
450
451
# File 'generated/google/apis/container_v1beta1/service.rb', line 441

def set_project_location_cluster_network_policy(name, set_network_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+name}:setNetworkPolicy', options)
  command.request_representation = Google::Apis::ContainerV1beta1::SetNetworkPolicyRequest::Representation
  command.request_object = set_network_policy_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_cluster_node_pool_management(name, set_node_pool_management_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Sets the NodeManagement options for a node pool.

Parameters:

  • name (String)

    The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format 'projects//locations//clusters//nodePools/'.

  • set_node_pool_management_request_object (Google::Apis::ContainerV1beta1::SetNodePoolManagementRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



794
795
796
797
798
799
800
801
802
803
804
# File 'generated/google/apis/container_v1beta1/service.rb', line 794

def set_project_location_cluster_node_pool_management(name, set_node_pool_management_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+name}:setManagement', options)
  command.request_representation = Google::Apis::ContainerV1beta1::SetNodePoolManagementRequest::Representation
  command.request_object = set_node_pool_management_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_cluster_resource_labels(name, set_labels_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Sets labels on a cluster.

Parameters:

  • name (String)

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

  • set_labels_request_object (Google::Apis::ContainerV1beta1::SetLabelsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



475
476
477
478
479
480
481
482
483
484
485
# File 'generated/google/apis/container_v1beta1/service.rb', line 475

def set_project_location_cluster_resource_labels(name, set_labels_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+name}:setResourceLabels', options)
  command.request_representation = Google::Apis::ContainerV1beta1::SetLabelsRequest::Representation
  command.request_object = set_labels_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_zone_cluster_maintenance_policy(project_id, zone, cluster_id, set_maintenance_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Sets the maintenance policy for a cluster.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number.

  • zone (String)

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

  • cluster_id (String)

    The name of the cluster to update.

  • set_maintenance_policy_request_object (Google::Apis::ContainerV1beta1::SetMaintenancePolicyRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'generated/google/apis/container_v1beta1/service.rb', line 1324

def set_project_zone_cluster_maintenance_policy(project_id, zone, cluster_id, set_maintenance_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy', options)
  command.request_representation = Google::Apis::ContainerV1beta1::SetMaintenancePolicyRequest::Representation
  command.request_object = set_maintenance_policy_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_zone_cluster_master_auth(project_id, zone, cluster_id, set_master_auth_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Used to set master auth materials. Currently supports :- Changing the admin password of a specific cluster. This can be either via password generation or explicitly set. Modify basic_auth.csv and reset the K8S API server.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • cluster_id (String)

    The name of the cluster to upgrade. This field is deprecated, use name instead.

  • set_master_auth_request_object (Google::Apis::ContainerV1beta1::SetMasterAuthRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
# File 'generated/google/apis/container_v1beta1/service.rb', line 1372

def set_project_zone_cluster_master_auth(project_id, zone, cluster_id, set_master_auth_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth', options)
  command.request_representation = Google::Apis::ContainerV1beta1::SetMasterAuthRequest::Representation
  command.request_object = set_master_auth_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_zone_cluster_network_policy(project_id, zone, cluster_id, set_network_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Enables/Disables Network Policy for a cluster.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • cluster_id (String)

    The name of the cluster. This field is deprecated, use name instead.

  • set_network_policy_request_object (Google::Apis::ContainerV1beta1::SetNetworkPolicyRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
# File 'generated/google/apis/container_v1beta1/service.rb', line 1417

def set_project_zone_cluster_network_policy(project_id, zone, cluster_id, set_network_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy', options)
  command.request_representation = Google::Apis::ContainerV1beta1::SetNetworkPolicyRequest::Representation
  command.request_object = set_network_policy_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_zone_cluster_node_pool_management(project_id, zone, cluster_id, node_pool_id, set_node_pool_management_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Sets the NodeManagement options for a node pool.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • cluster_id (String)

    The name of the cluster to update. This field is deprecated, use name instead.

  • node_pool_id (String)

    The name of the node pool to update. This field is deprecated, use name instead.

  • set_node_pool_management_request_object (Google::Apis::ContainerV1beta1::SetNodePoolManagementRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
# File 'generated/google/apis/container_v1beta1/service.rb', line 1796

def set_project_zone_cluster_node_pool_management(project_id, zone, cluster_id, node_pool_id, set_node_pool_management_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement', options)
  command.request_representation = Google::Apis::ContainerV1beta1::SetNodePoolManagementRequest::Representation
  command.request_object = set_node_pool_management_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.params['nodePoolId'] = node_pool_id unless node_pool_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#start_project_location_cluster_ip_rotation(name, start_ip_rotation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Start master IP rotation.

Parameters:

  • name (String)

    The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects//locations//clusters/*'.

  • start_ip_rotation_request_object (Google::Apis::ContainerV1beta1::StartIpRotationRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



509
510
511
512
513
514
515
516
517
518
519
# File 'generated/google/apis/container_v1beta1/service.rb', line 509

def start_project_location_cluster_ip_rotation(name, start_ip_rotation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+name}:startIpRotation', options)
  command.request_representation = Google::Apis::ContainerV1beta1::StartIpRotationRequest::Representation
  command.request_object = start_ip_rotation_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#start_project_zone_cluster_ip_rotation(project_id, zone, cluster_id, start_ip_rotation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Start master IP rotation.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • cluster_id (String)

    The name of the cluster. This field is deprecated, use name instead.

  • start_ip_rotation_request_object (Google::Apis::ContainerV1beta1::StartIpRotationRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
# File 'generated/google/apis/container_v1beta1/service.rb', line 1462

def start_project_zone_cluster_ip_rotation(project_id, zone, cluster_id, start_ip_rotation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation', options)
  command.request_representation = Google::Apis::ContainerV1beta1::StartIpRotationRequest::Representation
  command.request_object = start_ip_rotation_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_cluster(name, update_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Updates the settings of a specific cluster.

Parameters:

  • name (String)

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

  • update_cluster_request_object (Google::Apis::ContainerV1beta1::UpdateClusterRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



543
544
545
546
547
548
549
550
551
552
553
# File 'generated/google/apis/container_v1beta1/service.rb', line 543

def update_project_location_cluster(name, update_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::ContainerV1beta1::UpdateClusterRequest::Representation
  command.request_object = update_cluster_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_zone_cluster(project_id, zone, cluster_id, update_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Updates the settings of a specific cluster.

Parameters:

  • project_id (String)

    The Google Developers Console project ID or project number. This field is deprecated, use name instead.

  • zone (String)

    The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use name instead.

  • cluster_id (String)

    The name of the cluster to upgrade. This field is deprecated, use name instead.

  • update_cluster_request_object (Google::Apis::ContainerV1beta1::UpdateClusterRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
# File 'generated/google/apis/container_v1beta1/service.rb', line 1507

def update_project_zone_cluster(project_id, zone, cluster_id, update_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}', options)
  command.request_representation = Google::Apis::ContainerV1beta1::UpdateClusterRequest::Representation
  command.request_object = update_cluster_request_object
  command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1beta1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end