Class: Google::Apis::ReplicapoolupdaterV1beta1::ReplicapoolupdaterService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/replicapoolupdater_v1beta1/service.rb

Overview

Google Compute Engine Instance Group Updater API

[Deprecated. Please use compute.instanceGroupManagers.update method. replicapoolupdater API will be disabled after December 30th, 2016] Updates groups of Compute Engine instances.

Examples:

require 'google/apis/replicapoolupdater_v1beta1'

Replicapoolupdater = Google::Apis::ReplicapoolupdaterV1beta1 # Alias the module
service = Replicapoolupdater::ReplicapoolupdaterService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

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

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ ReplicapoolupdaterService

Returns a new instance of ReplicapoolupdaterService



53
54
55
56
 
# File 'generated/google/apis/replicapoolupdater_v1beta1/service.rb', line 53

def initialize
  super('https://www.googleapis.com/', 'replicapoolupdater/v1beta1/projects/')
  @batch_path = 'batch/replicapoolupdater/v1beta1'
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.



40
41
42
 
# File 'generated/google/apis/replicapoolupdater_v1beta1/service.rb', line 40

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. Overrides userIp if both are provided.

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. Overrides userIp if both are provided.



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

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



51
52
53
 
# File 'generated/google/apis/replicapoolupdater_v1beta1/service.rb', line 51

def user_ip
  @user_ip
end

Instance Method Details

#cancel_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ReplicapoolupdaterV1beta1::Operation

Cancels an update. The update must be PAUSED before it can be cancelled. This has no effect if the update is already CANCELLED.

Parameters:

  • project (String) —

    The Google Developers Console project name.

  • zone (String) —

    The name of the zone in which the update's target resides.

  • rolling_update (String) —

    The name of the update.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'generated/google/apis/replicapoolupdater_v1beta1/service.rb', line 87

def cancel_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/zones/{zone}/rollingUpdates/{rollingUpdate}/cancel', options)
  command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::Operation::Representation
  command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::Operation
  command.params['project'] = project unless project.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['rollingUpdate'] = rolling_update unless rolling_update.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate

Returns information about an update.

Parameters:

  • project (String) —

    The Google Developers Console project name.

  • zone (String) —

    The name of the zone in which the update's target resides.

  • rolling_update (String) —

    The name of the update.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'generated/google/apis/replicapoolupdater_v1beta1/service.rb', line 128

def get_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/zones/{zone}/rollingUpdates/{rollingUpdate}', options)
  command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Representation
  command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate
  command.params['project'] = project unless project.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['rollingUpdate'] = rolling_update unless rolling_update.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_zone_operation(project, zone, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ReplicapoolupdaterV1beta1::Operation

Retrieves the specified zone-specific operation resource.

Parameters:

  • project (String) —

    Name of the project scoping this request.

  • zone (String) —

    Name of the zone scoping this request.

  • operation (String) —

    Name of the operation resource to return.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_zone_operation(project, zone, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/zones/{zone}/operations/{operation}', options)
  command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::Operation::Representation
  command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::Operation
  command.params['project'] = project unless project.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['operation'] = operation unless operation.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_rolling_update(project, zone, rolling_update_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ReplicapoolupdaterV1beta1::Operation

Inserts and starts a new update.

Parameters:

  • project (String) —

    The Google Developers Console project name.

  • zone (String) —

    The name of the zone in which the update's target resides.

  • rolling_update_object (Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate) (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'generated/google/apis/replicapoolupdater_v1beta1/service.rb', line 168

def insert_rolling_update(project, zone, rolling_update_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/zones/{zone}/rollingUpdates', options)
  command.request_representation = Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Representation
  command.request_object = rolling_update_object
  command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::Operation::Representation
  command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::Operation
  command.params['project'] = project unless project.nil?
  command.params['zone'] = zone unless zone.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_instance_updates(project, zone, rolling_update, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ReplicapoolupdaterV1beta1::InstanceUpdateList

Lists the current status for each instance within a given update.

Parameters:

  • project (String) —

    The Google Developers Console project name.

  • zone (String) —

    The name of the zone in which the update's target resides.

  • rolling_update (String) —

    The name of the update.

  • filter (String) —

    Optional. Filter expression for filtering listed resources.

  • max_results (Fixnum) —

    Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.

  • page_token (String) —

    Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'generated/google/apis/replicapoolupdater_v1beta1/service.rb', line 268

def list_instance_updates(project, zone, rolling_update, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/zones/{zone}/rollingUpdates/{rollingUpdate}/instanceUpdates', options)
  command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::InstanceUpdateList::Representation
  command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::InstanceUpdateList
  command.params['project'] = project unless project.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['rollingUpdate'] = rolling_update unless rolling_update.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_rolling_updates(project, zone, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdateList

Lists recent updates for a given managed instance group, in reverse chronological order and paginated format.

Parameters:

  • project (String) —

    The Google Developers Console project name.

  • zone (String) —

    The name of the zone in which the update's target resides.

  • filter (String) —

    Optional. Filter expression for filtering listed resources.

  • max_results (Fixnum) —

    Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.

  • page_token (String) —

    Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'generated/google/apis/replicapoolupdater_v1beta1/service.rb', line 217

def list_rolling_updates(project, zone, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/zones/{zone}/rollingUpdates', options)
  command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdateList::Representation
  command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdateList
  command.params['project'] = project unless project.nil?
  command.params['zone'] = zone unless zone.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_zone_operations(project, zone, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ReplicapoolupdaterV1beta1::OperationList

Retrieves the list of Operation resources contained within the specified zone.

Parameters:

  • project (String) —

    Name of the project scoping this request.

  • zone (String) —

    Name of the zone scoping this request.

  • filter (String) —

    Optional. Filter expression for filtering listed resources.

  • max_results (Fixnum) —

    Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.

  • page_token (String) —

    Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'generated/google/apis/replicapoolupdater_v1beta1/service.rb', line 485

def list_zone_operations(project, zone, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/zones/{zone}/operations', options)
  command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::OperationList::Representation
  command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::OperationList
  command.params['project'] = project unless project.nil?
  command.params['zone'] = zone unless zone.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#pause_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ReplicapoolupdaterV1beta1::Operation

Pauses the update in state from ROLLING_FORWARD or ROLLING_BACK. Has no effect if invoked when the state of the update is PAUSED.

Parameters:

  • project (String) —

    The Google Developers Console project name.

  • zone (String) —

    The name of the zone in which the update's target resides.

  • rolling_update (String) —

    The name of the update.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def pause_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/zones/{zone}/rollingUpdates/{rollingUpdate}/pause', options)
  command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::Operation::Representation
  command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::Operation
  command.params['project'] = project unless project.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['rollingUpdate'] = rolling_update unless rolling_update.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#resume_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ReplicapoolupdaterV1beta1::Operation

Continues an update in PAUSED state. Has no effect if invoked when the state of the update is ROLLED_OUT.

Parameters:

  • project (String) —

    The Google Developers Console project name.

  • zone (String) —

    The name of the zone in which the update's target resides.

  • rolling_update (String) —

    The name of the update.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'generated/google/apis/replicapoolupdater_v1beta1/service.rb', line 355

def resume_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/zones/{zone}/rollingUpdates/{rollingUpdate}/resume', options)
  command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::Operation::Representation
  command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::Operation
  command.params['project'] = project unless project.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['rollingUpdate'] = rolling_update unless rolling_update.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#rollback_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ReplicapoolupdaterV1beta1::Operation

Rolls back the update in state from ROLLING_FORWARD or PAUSED. Has no effect if invoked when the state of the update is ROLLED_BACK.

Parameters:

  • project (String) —

    The Google Developers Console project name.

  • zone (String) —

    The name of the zone in which the update's target resides.

  • rolling_update (String) —

    The name of the update.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'generated/google/apis/replicapoolupdater_v1beta1/service.rb', line 397

def rollback_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/zones/{zone}/rollingUpdates/{rollingUpdate}/rollback', options)
  command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::Operation::Representation
  command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::Operation
  command.params['project'] = project unless project.nil?
  command.params['zone'] = zone unless zone.nil?
  command.params['rollingUpdate'] = rolling_update unless rolling_update.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end