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:



862
863
864
865
866
867
868
869
870
871
872
# File 'generated/google/apis/container_v1beta1/service.rb', line 862

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:



1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'generated/google/apis/container_v1beta1/service.rb', line 1919

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:



1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
# File 'generated/google/apis/container_v1beta1/service.rb', line 1034

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:



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'generated/google/apis/container_v1beta1/service.rb', line 1085

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:



611
612
613
614
615
616
617
618
619
620
621
# File 'generated/google/apis/container_v1beta1/service.rb', line 611

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:



1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
# File 'generated/google/apis/container_v1beta1/service.rb', line 1630

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:



659
660
661
662
663
664
665
666
667
668
669
670
671
# File 'generated/google/apis/container_v1beta1/service.rb', line 659

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:



1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
# File 'generated/google/apis/container_v1beta1/service.rb', line 1680

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:



1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
# File 'generated/google/apis/container_v1beta1/service.rb', line 1137

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:



709
710
711
712
713
714
715
716
717
718
719
720
721
# File 'generated/google/apis/container_v1beta1/service.rb', line 709

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:



907
908
909
910
911
912
913
914
915
916
917
918
# File 'generated/google/apis/container_v1beta1/service.rb', line 907

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:



1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
# File 'generated/google/apis/container_v1beta1/service.rb', line 1730

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:



991
992
993
994
995
996
997
998
999
1000
1001
# File 'generated/google/apis/container_v1beta1/service.rb', line 991

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:



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
# File 'generated/google/apis/container_v1beta1/service.rb', line 1183

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:



1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
# File 'generated/google/apis/container_v1beta1/service.rb', line 1966

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:



1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'generated/google/apis/container_v1beta1/service.rb', line 1227

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:



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

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:



950
951
952
953
954
955
956
957
958
959
960
# File 'generated/google/apis/container_v1beta1/service.rb', line 950

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:



1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'generated/google/apis/container_v1beta1/service.rb', line 1777

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:



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
# File 'generated/google/apis/container_v1beta1/service.rb', line 1273

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:



2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
# File 'generated/google/apis/container_v1beta1/service.rb', line 2009

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

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

Sets the logging service 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.

  • cluster_id (String)

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

  • set_logging_service_request_object (Google::Apis::ContainerV1beta1::SetLoggingServiceRequest) (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:



1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
# File 'generated/google/apis/container_v1beta1/service.rb', line 1315

def logging_project_zone_cluster(project_id, zone, cluster_id, set_logging_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging', options)
  command.request_representation = Google::Apis::ContainerV1beta1::SetLoggingServiceRequest::Representation
  command.request_object = set_logging_service_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

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



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
# File 'generated/google/apis/container_v1beta1/service.rb', line 1360

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:



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

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:



1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
# File 'generated/google/apis/container_v1beta1/service.rb', line 1825

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_cluster_logging_service(name, set_logging_service_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1beta1::Operation

Sets the logging service of a specific cluster.

Parameters:

  • name (String)

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

  • set_logging_service_request_object (Google::Apis::ContainerV1beta1::SetLoggingServiceRequest) (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:



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

def set_cluster_logging_service(name, set_logging_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+name}:setLogging', options)
  command.request_representation = Google::Apis::ContainerV1beta1::SetLoggingServiceRequest::Representation
  command.request_object = set_logging_service_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:



403
404
405
406
407
408
409
410
411
412
413
# File 'generated/google/apis/container_v1beta1/service.rb', line 403

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:



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

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:



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



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

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:



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

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:



1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
# File 'generated/google/apis/container_v1beta1/service.rb', line 1402

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:



1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
# File 'generated/google/apis/container_v1beta1/service.rb', line 1450

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:



1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
# File 'generated/google/apis/container_v1beta1/service.rb', line 1495

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:



1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
# File 'generated/google/apis/container_v1beta1/service.rb', line 1874

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:



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

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:



1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
# File 'generated/google/apis/container_v1beta1/service.rb', line 1540

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:



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

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:



1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
# File 'generated/google/apis/container_v1beta1/service.rb', line 1585

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