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

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

Overview

Google App Engine Admin API

The Google 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

Constructor Details

#initializeAppengineService

Returns a new instance of AppengineService.



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

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

Instance Attribute Details

#keyString

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

Returns:

  • (String)

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



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

def key
  @key
end

#quota_userString

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

Returns:

  • (String)

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



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

def quota_user
  @quota_user
end

Instance Method Details

#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 new code and resource files to a version.

Parameters:

  • apps_id (String)

    Part of name. Name of the resource to update. For 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) (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:



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

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

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

Deletes a module and all enclosed versions.

Parameters:

  • apps_id (String)

    Part of name. Name of the resource requested. For example: "apps/myapp/ modules/default".

  • modules_id (String)

    Part of name. See documentation of appsId.

  • 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/appengine_v1beta4/service.rb', line 110

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. For 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) (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:



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

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

#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. For example: "apps/myapp".

  • ensure_resources_exist (Boolean) (defaults to: nil)

    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) (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:



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

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_module(apps_id, modules_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta4::Module

Gets the current configuration of the module.

Parameters:

  • apps_id (String)

    Part of name. Name of the resource requested. For example: "apps/myapp/ modules/default".

  • modules_id (String)

    Part of name. See documentation of appsId.

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



144
145
146
147
148
149
150
151
152
153
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 144

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 application deployment information.

Parameters:

  • apps_id (String)

    Part of name. Name of the resource requested. For 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) (defaults to: nil)

    Controls the set of fields returned in the Get response.

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



336
337
338
339
340
341
342
343
344
345
346
347
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 336

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



415
416
417
418
419
420
421
422
423
424
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 415

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_module_versions(apps_id, modules_id, view: nil, page_size: nil, page_token: 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. For example: "apps/myapp/ modules/default".

  • modules_id (String)

    Part of name. See documentation of appsId.

  • view (String) (defaults to: nil)

    Controls the set of fields returned in the List response.

  • page_size (Fixnum) (defaults to: nil)

    Maximum results to return per page.

  • page_token (String) (defaults to: nil)

    Continuation token for fetching the next page of results.

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



378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 378

def list_app_module_versions(apps_id, modules_id, view: nil, 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', 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['view'] = view unless view.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_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. For example: "apps/myapp".

  • page_size (Fixnum) (defaults to: nil)

    Maximum results to return per page.

  • page_token (String) (defaults to: nil)

    Continuation token for fetching the next page of results.

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



179
180
181
182
183
184
185
186
187
188
189
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 179

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 below allows API services to override the binding to use different resource name schemes, such as users/*/operations.

Parameters:

  • apps_id (String)

    Part of name. The name of the operation collection.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

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



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

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_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. For 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) (defaults to: nil)

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

  • migrate_traffic (Boolean) (defaults to: nil)

    Whether to use Traffic Migration to shift traffic gradually. Traffic can only be migrated from a single version to another single version.

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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
# File 'generated/google/apis/appengine_v1beta4/service.rb', line 220

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