Class: Google::Apis::AppengineV1beta4::AppengineService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/appengine_v1beta4/service.rb

Overview

App Engine Admin API

The App Engine Admin API enables developers to provision and manage their App Engine applications.

Examples:

require 'google/apis/appengine_v1beta4'

Appengine = Google::Apis::AppengineV1beta4 # Alias the module
service = Appengine::AppengineService.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 ⇒ AppengineService

Returns a new instance of AppengineService



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

def initialize
  super('https://appengine.googleapis.com/', '')
  @batch_path = 'batch'
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/appengine_v1beta4/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/appengine_v1beta4/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#create_app(application_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Operation

Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing ( https://cloud.google.com/appengine/docs/python/console/).

Parameters:

  • application_object (Google::Apis::AppengineV1beta4::Application) (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:



76
77
78
79
80
81
82
83
84
85
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 76

def create_app(application_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta4/apps', options)
  command.request_representation = Google::Apis::AppengineV1beta4::Application::Representation
  command.request_object = application_object
  command.response_representation = Google::Apis::AppengineV1beta4::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Operation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_app_module_version(apps_id, modules_id, version_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Operation

Deploys code and resource files to a new version.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource to update. Example: apps/myapp/modules/ default.

  • modules_id (String) —

    Part of name. See documentation of appsId.

  • version_object (Google::Apis::AppengineV1beta4::Version) (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:



420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 420

def create_app_module_version(apps_id, modules_id, version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta4/apps/{appsId}/modules/{modulesId}/versions', options)
  command.request_representation = Google::Apis::AppengineV1beta4::Version::Representation
  command.request_object = version_object
  command.response_representation = Google::Apis::AppengineV1beta4::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['modulesId'] = modules_id unless modules_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

#debug_instance(apps_id, modules_id, versions_id, instances_id, debug_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Operation

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource requested. Example: apps/myapp/modules/ default/versions/v1/instances/instance-1.

  • modules_id (String) —

    Part of name. See documentation of appsId.

  • versions_id (String) —

    Part of name. See documentation of appsId.

  • instances_id (String) —

    Part of name. See documentation of appsId.

  • debug_instance_request_object (Google::Apis::AppengineV1beta4::DebugInstanceRequest) (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:



647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 647

def debug_instance(apps_id, modules_id, versions_id, instances_id, debug_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug', options)
  command.request_representation = Google::Apis::AppengineV1beta4::DebugInstanceRequest::Representation
  command.request_object = debug_instance_request_object
  command.response_representation = Google::Apis::AppengineV1beta4::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['modulesId'] = modules_id unless modules_id.nil?
  command.params['versionsId'] = versions_id unless versions_id.nil?
  command.params['instancesId'] = instances_id unless instances_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_app_module(apps_id, modules_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Operation

Deletes the specified module and all enclosed versions.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource requested. Example: apps/myapp/modules/ default.

  • modules_id (String) —

    Part of name. See documentation of appsId.

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



261
262
263
264
265
266
267
268
269
270
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 261

def delete_app_module(apps_id, modules_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta4/apps/{appsId}/modules/{modulesId}', options)
  command.response_representation = Google::Apis::AppengineV1beta4::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['modulesId'] = modules_id unless modules_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_app_module_version(apps_id, modules_id, versions_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Operation

Deletes an existing version.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource requested. Example: apps/myapp/modules/ default/versions/v1.

  • modules_id (String) —

    Part of name. See documentation of appsId.

  • versions_id (String) —

    Part of name. See documentation of appsId.

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



458
459
460
461
462
463
464
465
466
467
468
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 458

def delete_app_module_version(apps_id, modules_id, versions_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta4::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['modulesId'] = modules_id unless modules_id.nil?
  command.params['versionsId'] = versions_id unless versions_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_app_module_version_instance(apps_id, modules_id, versions_id, instances_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Operation

Stops a running instance.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource requested. Example: apps/myapp/modules/ default/versions/v1/instances/instance-1.

  • modules_id (String) —

    Part of name. See documentation of appsId.

  • versions_id (String) —

    Part of name. See documentation of appsId.

  • instances_id (String) —

    Part of name. See documentation of appsId.

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



689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 689

def delete_app_module_version_instance(apps_id, modules_id, versions_id, instances_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}', options)
  command.response_representation = Google::Apis::AppengineV1beta4::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['modulesId'] = modules_id unless modules_id.nil?
  command.params['versionsId'] = versions_id unless versions_id.nil?
  command.params['instancesId'] = instances_id unless instances_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_app(apps_id, ensure_resources_exist: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Application

Gets information about an application.

Parameters:

  • apps_id (String) —

    Part of name. Name of the application to get. Example: apps/myapp.

  • ensure_resources_exist (Boolean) —

    Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.

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



113
114
115
116
117
118
119
120
121
122
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 113

def get_app(apps_id, ensure_resources_exist: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta4/apps/{appsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta4::Application::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Application
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.query['ensureResourcesExist'] = ensure_resources_exist unless ensure_resources_exist.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_app_location(apps_id, locations_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Location

Gets information about a location.

Parameters:

  • apps_id (String) —

    Part of name. Resource name for the location.

  • locations_id (String) —

    Part of name. See documentation of appsId.

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



188
189
190
191
192
193
194
195
196
197
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 188

def get_app_location(apps_id, locations_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta4/apps/{appsId}/locations/{locationsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta4::Location::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Location
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['locationsId'] = locations_id unless locations_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_app_module(apps_id, modules_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Module

Gets the current configuration of the specified module.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource requested. Example: apps/myapp/modules/ default.

  • modules_id (String) —

    Part of name. See documentation of appsId.

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



295
296
297
298
299
300
301
302
303
304
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 295

def get_app_module(apps_id, modules_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta4/apps/{appsId}/modules/{modulesId}', options)
  command.response_representation = Google::Apis::AppengineV1beta4::Module::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Module
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['modulesId'] = modules_id unless modules_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_app_module_version(apps_id, modules_id, versions_id, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Version

Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource requested. Example: apps/myapp/modules/ default/versions/v1.

  • modules_id (String) —

    Part of name. See documentation of appsId.

  • versions_id (String) —

    Part of name. See documentation of appsId.

  • view (String) —

    Controls the set of fields returned in the Get response.

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



498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 498

def get_app_module_version(apps_id, modules_id, versions_id, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta4::Version::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Version
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['modulesId'] = modules_id unless modules_id.nil?
  command.params['versionsId'] = versions_id unless versions_id.nil?
  command.query['view'] = view unless view.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_app_module_version_instance(apps_id, modules_id, versions_id, instances_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Instance

Gets instance information.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource requested. Example: apps/myapp/modules/ default/versions/v1/instances/instance-1.

  • modules_id (String) —

    Part of name. See documentation of appsId.

  • versions_id (String) —

    Part of name. See documentation of appsId.

  • instances_id (String) —

    Part of name. See documentation of appsId.

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



729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 729

def get_app_module_version_instance(apps_id, modules_id, versions_id, instances_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}', options)
  command.response_representation = Google::Apis::AppengineV1beta4::Instance::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Instance
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['modulesId'] = modules_id unless modules_id.nil?
  command.params['versionsId'] = versions_id unless versions_id.nil?
  command.params['instancesId'] = instances_id unless instances_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_app_operation(apps_id, operations_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • apps_id (String) —

    Part of name. The name of the operation resource.

  • operations_id (String) —

    Part of name. See documentation of appsId.

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



810
811
812
813
814
815
816
817
818
819
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 810

def get_app_operation(apps_id, operations_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta4/apps/{appsId}/operations/{operationsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta4::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['operationsId'] = operations_id unless operations_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_app_locations(apps_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::ListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • apps_id (String) —

    Part of name. The resource that owns the locations collection, if applicable.

  • filter (String) —

    The standard list filter.

  • page_size (Fixnum) —

    The standard list page size.

  • page_token (String) —

    The standard list page token.

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



225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 225

def list_app_locations(apps_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta4/apps/{appsId}/locations', options)
  command.response_representation = Google::Apis::AppengineV1beta4::ListLocationsResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta4::ListLocationsResponse
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#list_app_module_version_instances(apps_id, modules_id, versions_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::ListInstancesResponse

Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/ monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource requested. Example: apps/myapp/modules/ default/versions/v1.

  • modules_id (String) —

    Part of name. See documentation of appsId.

  • versions_id (String) —

    Part of name. See documentation of appsId.

  • page_size (Fixnum) —

    Maximum results to return per page.

  • page_token (String) —

    Continuation token for fetching the next page of results.

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



773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 773

def list_app_module_version_instances(apps_id, modules_id, versions_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances', options)
  command.response_representation = Google::Apis::AppengineV1beta4::ListInstancesResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta4::ListInstancesResponse
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['modulesId'] = modules_id unless modules_id.nil?
  command.params['versionsId'] = versions_id unless versions_id.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#list_app_module_versions(apps_id, modules_id, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::ListVersionsResponse

Lists the versions of a module.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource requested. Example: apps/myapp/modules/ default.

  • modules_id (String) —

    Part of name. See documentation of appsId.

  • page_size (Fixnum) —

    Maximum results to return per page.

  • page_token (String) —

    Continuation token for fetching the next page of results.

  • view (String) —

    Controls the set of fields returned in the List response.

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



540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 540

def list_app_module_versions(apps_id, modules_id, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta4/apps/{appsId}/modules/{modulesId}/versions', options)
  command.response_representation = Google::Apis::AppengineV1beta4::ListVersionsResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta4::ListVersionsResponse
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['modulesId'] = modules_id unless modules_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.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_app_modules(apps_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::ListModulesResponse

Lists all the modules in the application.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource requested. Example: apps/myapp.

  • page_size (Fixnum) —

    Maximum results to return per page.

  • page_token (String) —

    Continuation token for fetching the next page of results.

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



330
331
332
333
334
335
336
337
338
339
340
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 330

def list_app_modules(apps_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta4/apps/{appsId}/modules', options)
  command.response_representation = Google::Apis::AppengineV1beta4::ListModulesResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta4::ListModulesResponse
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#list_app_operations(apps_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users//operations. To override the binding, API services can add a binding such as "/v1/`name=users/`/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • apps_id (String) —

    Part of name. The name of the operation's parent resource.

  • filter (String) —

    The standard list filter.

  • page_size (Fixnum) —

    The standard list page size.

  • page_token (String) —

    The standard list page token.

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



854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 854

def list_app_operations(apps_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta4/apps/{appsId}/operations', options)
  command.response_representation = Google::Apis::AppengineV1beta4::ListOperationsResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta4::ListOperationsResponse
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#patch_app(apps_id, application_object = nil, mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Operation

Updates the specified Application resource. You can update the following fields: auth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/ v1beta4/apps#Application.FIELDS.auth_domain) default_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/ reference/rest/v1beta4/apps#Application.FIELDS.default_cookie_expiration)

Parameters:

  • apps_id (String) —

    Part of name. Name of the Application resource to update. Example: apps/ myapp.

  • application_object (Google::Apis::AppengineV1beta4::Application) (defaults to: nil)
  • mask (String) —

    Standard field mask for the set of fields to be updated.

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



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 153

def patch_app(apps_id, application_object = nil, mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1beta4/apps/{appsId}', options)
  command.request_representation = Google::Apis::AppengineV1beta4::Application::Representation
  command.request_object = application_object
  command.response_representation = Google::Apis::AppengineV1beta4::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.query['mask'] = mask unless mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_app_module(apps_id, modules_id, module_object = nil, mask: nil, migrate_traffic: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Operation

Updates the configuration of the specified module.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource to update. Example: apps/myapp/modules/ default.

  • modules_id (String) —

    Part of name. See documentation of appsId.

  • module_object (Google::Apis::AppengineV1beta4::Module) (defaults to: nil)
  • mask (String) —

    Standard field mask for the set of fields to be updated.

  • migrate_traffic (Boolean) —

    Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/ admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/ rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/ v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/ appengine/docs/admin-api/migrating-splitting-traffic).

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



381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 381

def patch_app_module(apps_id, modules_id, module_object = nil, mask: nil, migrate_traffic: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1beta4/apps/{appsId}/modules/{modulesId}', options)
  command.request_representation = Google::Apis::AppengineV1beta4::Module::Representation
  command.request_object = module_object
  command.response_representation = Google::Apis::AppengineV1beta4::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['modulesId'] = modules_id unless modules_id.nil?
  command.query['mask'] = mask unless mask.nil?
  command.query['migrateTraffic'] = migrate_traffic unless migrate_traffic.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_app_module_version(apps_id, modules_id, versions_id, version_object = nil, mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Operation

Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/ rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/ rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/ admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS. automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/ admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS. automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource to update. Example: apps/myapp/modules/ default/versions/1.

  • modules_id (String) —

    Part of name. See documentation of appsId.

  • versions_id (String) —

    Part of name. See documentation of appsId.

  • version_object (Google::Apis::AppengineV1beta4::Version) (defaults to: nil)
  • mask (String) —

    Standard field mask for the set of fields to be updated.

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



599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 599

def patch_app_module_version(apps_id, modules_id, versions_id, version_object = nil, mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}', options)
  command.request_representation = Google::Apis::AppengineV1beta4::Version::Representation
  command.request_object = version_object
  command.response_representation = Google::Apis::AppengineV1beta4::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta4::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['modulesId'] = modules_id unless modules_id.nil?
  command.params['versionsId'] = versions_id unless versions_id.nil?
  command.query['mask'] = mask unless mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end