Class: Google::Apis::AppengineV1::AppengineService

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

Overview

Google App Engine Admin API

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

Examples:

require 'google/apis/appengine_v1'

Appengine = Google::Apis::AppengineV1 # 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_v1/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_v1/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

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



44
45
46
 
# File 'generated/google/apis/appengine_v1/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::AppengineV1::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::AppengineV1::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:



183
184
185
186
187
188
189
190
191
192
 
# File 'generated/google/apis/appengine_v1/service.rb', line 183

def create_app(application_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/apps', options)
  command.request_representation = Google::Apis::AppengineV1::Application::Representation
  command.request_object = application_object
  command.response_representation = Google::Apis::AppengineV1::Operation::Representation
  command.response_class = Google::Apis::AppengineV1::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_service_version(apps_id, services_id, version_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Operation

Deploys code and resource files to a new version.

Parameters:

  • apps_id (String) —

    Part of parent. Name of the parent resource to create this version under. Example: apps/myapp/services/default.

  • services_id (String) —

    Part of parent. See documentation of appsId.

  • version_object (Google::Apis::AppengineV1::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:



557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'generated/google/apis/appengine_v1/service.rb', line 557

def create_app_service_version(apps_id, services_id, version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/apps/{appsId}/services/{servicesId}/versions', options)
  command.request_representation = Google::Apis::AppengineV1::Version::Representation
  command.request_object = version_object
  command.response_representation = Google::Apis::AppengineV1::Operation::Representation
  command.response_class = Google::Apis::AppengineV1::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['servicesId'] = services_id unless services_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, services_id, versions_id, instances_id, debug_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::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/services/ default/versions/v1/instances/instance-1.

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



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

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

Deletes the specified service and all enclosed versions.

Parameters:

  • apps_id (String) —

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

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



217
218
219
220
221
222
223
224
225
226
 
# File 'generated/google/apis/appengine_v1/service.rb', line 217

def delete_app_service(apps_id, services_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/apps/{appsId}/services/{servicesId}', options)
  command.response_representation = Google::Apis::AppengineV1::Operation::Representation
  command.response_class = Google::Apis::AppengineV1::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['servicesId'] = services_id unless services_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_service_version(apps_id, services_id, versions_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Operation

Deletes an existing Version resource.

Parameters:

  • apps_id (String) —

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

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



377
378
379
380
381
382
383
384
385
386
387
 
# File 'generated/google/apis/appengine_v1/service.rb', line 377

def delete_app_service_version(apps_id, services_id, versions_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}', options)
  command.response_representation = Google::Apis::AppengineV1::Operation::Representation
  command.response_class = Google::Apis::AppengineV1::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['servicesId'] = services_id unless services_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_service_version_instance(apps_id, services_id, versions_id, instances_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Operation

Stops a running instance.

Parameters:

  • apps_id (String) —

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

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



597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'generated/google/apis/appengine_v1/service.rb', line 597

def delete_app_service_version_instance(apps_id, services_id, versions_id, instances_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}', options)
  command.response_representation = Google::Apis::AppengineV1::Operation::Representation
  command.response_class = Google::Apis::AppengineV1::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['servicesId'] = services_id unless services_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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Application

Gets information about an application.

Parameters:

  • apps_id (String) —

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

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



107
108
109
110
111
112
113
114
115
 
# File 'generated/google/apis/appengine_v1/service.rb', line 107

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

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



880
881
882
883
884
885
886
887
888
889
 
# File 'generated/google/apis/appengine_v1/service.rb', line 880

def get_app_location(apps_id, locations_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/apps/{appsId}/locations/{locationsId}', options)
  command.response_representation = Google::Apis::AppengineV1::Location::Representation
  command.response_class = Google::Apis::AppengineV1::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_operation(apps_id, operations_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::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:



808
809
810
811
812
813
814
815
816
817
 
# File 'generated/google/apis/appengine_v1/service.rb', line 808

def get_app_operation(apps_id, operations_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/apps/{appsId}/operations/{operationsId}', options)
  command.response_representation = Google::Apis::AppengineV1::Operation::Representation
  command.response_class = Google::Apis::AppengineV1::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

#get_app_service(apps_id, services_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Service

Gets the current configuration of the specified service.

Parameters:

  • apps_id (String) —

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

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



287
288
289
290
291
292
293
294
295
296
 
# File 'generated/google/apis/appengine_v1/service.rb', line 287

def get_app_service(apps_id, services_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/apps/{appsId}/services/{servicesId}', options)
  command.response_representation = Google::Apis::AppengineV1::Service::Representation
  command.response_class = Google::Apis::AppengineV1::Service
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['servicesId'] = services_id unless services_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_service_version(apps_id, services_id, versions_id, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::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/services/ default/versions/v1.

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



460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'generated/google/apis/appengine_v1/service.rb', line 460

def get_app_service_version(apps_id, services_id, versions_id, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}', options)
  command.response_representation = Google::Apis::AppengineV1::Version::Representation
  command.response_class = Google::Apis::AppengineV1::Version
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['servicesId'] = services_id unless services_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_service_version_instance(apps_id, services_id, versions_id, instances_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Instance

Gets instance information.

Parameters:

  • apps_id (String) —

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

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



682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'generated/google/apis/appengine_v1/service.rb', line 682

def get_app_service_version_instance(apps_id, services_id, versions_id, instances_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}', options)
  command.response_representation = Google::Apis::AppengineV1::Instance::Representation
  command.response_class = Google::Apis::AppengineV1::Instance
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['servicesId'] = services_id unless services_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

#list_app_locations(apps_id, filter: nil, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::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_token (String) —

    The standard list page token.

  • page_size (Fixnum) —

    The standard list page size.

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



845
846
847
848
849
850
851
852
853
854
855
856
 
# File 'generated/google/apis/appengine_v1/service.rb', line 845

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

  • page_size (Fixnum) —

    The standard list page size.

  • filter (String) —

    The standard list filter.

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



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

def list_app_operations(apps_id, page_size: nil, filter: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/apps/{appsId}/operations', options)
  command.response_representation = Google::Apis::AppengineV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::AppengineV1::ListOperationsResponse
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['filter'] = filter unless filter.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_service_version_instances(apps_id, services_id, versions_id, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::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 parent. Name of the parent Version resource. Example: apps/myapp/ services/default/versions/v1.

  • services_id (String) —

    Part of parent. See documentation of appsId.

  • versions_id (String) —

    Part of parent. See documentation of appsId.

  • page_token (String) —

    Continuation token for fetching the next page of results.

  • page_size (Fixnum) —

    Maximum results to return per page.

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



641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'generated/google/apis/appengine_v1/service.rb', line 641

def list_app_service_version_instances(apps_id, services_id, versions_id, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances', options)
  command.response_representation = Google::Apis::AppengineV1::ListInstancesResponse::Representation
  command.response_class = Google::Apis::AppengineV1::ListInstancesResponse
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['servicesId'] = services_id unless services_id.nil?
  command.params['versionsId'] = versions_id unless versions_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.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_service_versions(apps_id, services_id, page_token: nil, page_size: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::ListVersionsResponse

Lists the versions of a service.

Parameters:

  • apps_id (String) —

    Part of parent. Name of the parent Service resource. Example: apps/myapp/ services/default.

  • services_id (String) —

    Part of parent. See documentation of appsId.

  • page_token (String) —

    Continuation token for fetching the next page of results.

  • page_size (Fixnum) —

    Maximum results to return per page.

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



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

def list_app_service_versions(apps_id, services_id, page_token: nil, page_size: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/apps/{appsId}/services/{servicesId}/versions', options)
  command.response_representation = Google::Apis::AppengineV1::ListVersionsResponse::Representation
  command.response_class = Google::Apis::AppengineV1::ListVersionsResponse
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['servicesId'] = services_id unless services_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.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_services(apps_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::ListServicesResponse

Lists all the services in the application.

Parameters:

  • apps_id (String) —

    Part of parent. Name of the parent Application resource. 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:



252
253
254
255
256
257
258
259
260
261
262
 
# File 'generated/google/apis/appengine_v1/service.rb', line 252

def list_app_services(apps_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/apps/{appsId}/services', options)
  command.response_representation = Google::Apis::AppengineV1::ListServicesResponse::Representation
  command.response_class = Google::Apis::AppengineV1::ListServicesResponse
  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

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

Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.

Parameters:

  • apps_id (String) —

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

  • application_object (Google::Apis::AppengineV1::Application) (defaults to: nil)
  • update_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:



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

def patch_app(apps_id, application_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/apps/{appsId}', options)
  command.request_representation = Google::Apis::AppengineV1::Application::Representation
  command.request_object = application_object
  command.response_representation = Google::Apis::AppengineV1::Operation::Representation
  command.response_class = Google::Apis::AppengineV1::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.query['updateMask'] = update_mask unless update_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_service(apps_id, services_id, service_object = nil, update_mask: nil, migrate_traffic: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Operation

Updates the configuration of the specified service.

Parameters:

  • apps_id (String) —

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

  • services_id (String) —

    Part of name. See documentation of appsId.

  • service_object (Google::Apis::AppengineV1::Service) (defaults to: nil)
  • update_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/v1/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/ rest/v1/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps. services#shardby) field in the Service 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:



337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'generated/google/apis/appengine_v1/service.rb', line 337

def patch_app_service(apps_id, services_id, service_object = nil, update_mask: nil, migrate_traffic: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/apps/{appsId}/services/{servicesId}', options)
  command.request_representation = Google::Apis::AppengineV1::Service::Representation
  command.request_object = service_object
  command.response_representation = Google::Apis::AppengineV1::Operation::Representation
  command.response_class = Google::Apis::AppengineV1::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['servicesId'] = services_id unless services_id.nil?
  command.query['updateMask'] = update_mask unless update_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_service_version(apps_id, services_id, versions_id, version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::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/v1/apps.services.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/v1/apps.services.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/v1/apps.services.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/v1/apps.services.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/services/ default/versions/1.

  • services_id (String) —

    Part of name. See documentation of appsId.

  • versions_id (String) —

    Part of name. See documentation of appsId.

  • version_object (Google::Apis::AppengineV1::Version) (defaults to: nil)
  • update_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:



518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'generated/google/apis/appengine_v1/service.rb', line 518

def patch_app_service_version(apps_id, services_id, versions_id, version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}', options)
  command.request_representation = Google::Apis::AppengineV1::Version::Representation
  command.request_object = version_object
  command.response_representation = Google::Apis::AppengineV1::Operation::Representation
  command.response_class = Google::Apis::AppengineV1::Operation
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['servicesId'] = services_id unless services_id.nil?
  command.params['versionsId'] = versions_id unless versions_id.nil?
  command.query['updateMask'] = update_mask unless update_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

#repair_application(apps_id, repair_application_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Operation

Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.

Parameters:

  • apps_id (String) —

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

  • repair_application_request_object (Google::Apis::AppengineV1::RepairApplicationRequest) (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:



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

def repair_application(apps_id, repair_application_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/apps/{appsId}:repair', options)
  command.request_representation = Google::Apis::AppengineV1::RepairApplicationRequest::Representation
  command.request_object = repair_application_request_object
  command.response_representation = Google::Apis::AppengineV1::Operation::Representation
  command.response_class = Google::Apis::AppengineV1::Operation
  command.params['appsId'] = apps_id unless apps_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