Class: Google::Apis::ContainerV1::ContainerService

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

Overview

Google Container Engine API

Builds and manages clusters that run container-based applications, powered by open source Kubernetes technology.

Examples:

require 'google/apis/container_v1'

Container = Google::Apis::ContainerV1 # 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

Constructor Details

#initialize ⇒ ContainerService

Returns a new instance of ContainerService.



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

def initialize
  super('https://container.googleapis.com/', '')
end

Instance Attribute Details

#key ⇒ String

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_v1/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

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_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#create_cluster(project_id, zone, create_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1::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.

  • zone (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'generated/google/apis/container_v1/service.rb', line 190

def create_cluster(project_id, zone, create_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/projects/{projectId}/zones/{zone}/clusters', options)
  command.request_representation = Google::Apis::ContainerV1::CreateClusterRequest::Representation
  command.request_object = create_cluster_request_object
  command.response_representation = Google::Apis::ContainerV1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1::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_node_pool(project_id, zone, cluster_id, create_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1::Operation

Creates a node pool 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.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'generated/google/apis/container_v1/service.rb', line 392

def create_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, 'v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools', options)
  command.request_representation = Google::Apis::ContainerV1::CreateNodePoolRequest::Representation
  command.request_object = create_node_pool_request_object
  command.response_representation = Google::Apis::ContainerV1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1::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_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1::Operation

Deletes a node pool from 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.

  • node_pool_id (String) —

    The name of the node pool to delete.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'generated/google/apis/container_v1/service.rb', line 434

def delete_project_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}', options)
  command.response_representation = Google::Apis::ContainerV1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1::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

#delete_zone_cluster(project_id, zone, cluster_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1::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.

  • zone (String) —

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

  • cluster_id (String) —

    The name of the cluster to delete.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



274
275
276
277
278
279
280
281
282
283
284
 
# File 'generated/google/apis/container_v1/service.rb', line 274

def delete_zone_cluster(project_id, zone, cluster_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}', options)
  command.response_representation = Google::Apis::ContainerV1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1::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

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

Retrieves the node pool requested.

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.

  • node_pool_id (String) —

    The name of the node pool.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'generated/google/apis/container_v1/service.rb', line 352

def get_project_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}', options)
  command.response_representation = Google::Apis::ContainerV1::NodePool::Representation
  command.response_class = Google::Apis::ContainerV1::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['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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1::ServerConfig

Returns configuration info about the Container Engine service.

Parameters:

  • project_id (String) —

    The Google Developers Console project ID or project number.

  • zone (String) —

    The name of the Google Compute Engine zone to return operations for.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



74
75
76
77
78
79
80
81
82
83
 
# File 'generated/google/apis/container_v1/service.rb', line 74

def get_project_zone_serverconfig(project_id, zone, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/projects/{projectId}/zones/{zone}/serverconfig', options)
  command.response_representation = Google::Apis::ContainerV1::ServerConfig::Representation
  command.response_class = Google::Apis::ContainerV1::ServerConfig
  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

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

Gets the details of a specific 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 retrieve.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



147
148
149
150
151
152
153
154
155
156
157
 
# File 'generated/google/apis/container_v1/service.rb', line 147

def get_zone_cluster(project_id, zone, cluster_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}', options)
  command.response_representation = Google::Apis::ContainerV1::Cluster::Representation
  command.response_class = Google::Apis::ContainerV1::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['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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1::Operation

Gets the specified operation.

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.

  • operation_id (String) —

    The server-assigned name of the operation.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_zone_operation(project_id, zone, operation_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/projects/{projectId}/zones/{zone}/operations/{operationId}', options)
  command.response_representation = Google::Apis::ContainerV1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1::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['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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1::ListNodePoolsResponse

Lists the node pools 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.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



312
313
314
315
316
317
318
319
320
321
322
 
# File 'generated/google/apis/container_v1/service.rb', line 312

def list_project_zone_cluster_node_pools(project_id, zone, cluster_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools', options)
  command.response_representation = Google::Apis::ContainerV1::ListNodePoolsResponse::Representation
  command.response_class = Google::Apis::ContainerV1::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['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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1::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.

  • zone (String) —

    The name of the Google Compute Engine zone in which the cluster resides, or "-" for all zones.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



110
111
112
113
114
115
116
117
118
119
 
# File 'generated/google/apis/container_v1/service.rb', line 110

def list_zone_clusters(project_id, zone, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/projects/{projectId}/zones/{zone}/clusters', options)
  command.response_representation = Google::Apis::ContainerV1::ListClustersResponse::Representation
  command.response_class = Google::Apis::ContainerV1::ListClustersResponse
  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

#list_zone_operations(project_id, zone, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContainerV1::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.

  • zone (String) —

    The name of the Google Compute Engine zone to return operations for, or - for all zones.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



471
472
473
474
475
476
477
478
479
480
 
# File 'generated/google/apis/container_v1/service.rb', line 471

def list_zone_operations(project_id, zone, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/projects/{projectId}/zones/{zone}/operations', options)
  command.response_representation = Google::Apis::ContainerV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::ContainerV1::ListOperationsResponse
  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

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

Updates the settings of a specific 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 upgrade.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'generated/google/apis/container_v1/service.rb', line 230

def update_cluster(project_id, zone, cluster_id, update_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}', options)
  command.request_representation = Google::Apis::ContainerV1::UpdateClusterRequest::Representation
  command.request_object = update_cluster_request_object
  command.response_representation = Google::Apis::ContainerV1::Operation::Representation
  command.response_class = Google::Apis::ContainerV1::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