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:



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

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_authorized_certificate(apps_id, authorized_certificate_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::AuthorizedCertificate

Uploads the specified SSL certificate.

Parameters:

  • apps_id (String) —

    Part of parent. Name of the parent Application resource. Example: apps/myapp.

  • authorized_certificate_object (Google::Apis::AppengineV1::AuthorizedCertificate) (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:



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

def create_app_authorized_certificate(apps_id, authorized_certificate_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/apps/{appsId}/authorizedCertificates', options)
  command.request_representation = Google::Apis::AppengineV1::AuthorizedCertificate::Representation
  command.request_object = authorized_certificate_object
  command.response_representation = Google::Apis::AppengineV1::AuthorizedCertificate::Representation
  command.response_class = Google::Apis::AppengineV1::AuthorizedCertificate
  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

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

Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.

Parameters:

  • apps_id (String) —

    Part of parent. Name of the parent Application resource. Example: apps/myapp.

  • domain_mapping_object (Google::Apis::AppengineV1::DomainMapping) (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:



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

def create_app_domain_mapping(apps_id, domain_mapping_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/apps/{appsId}/domainMappings', options)
  command.request_representation = Google::Apis::AppengineV1::DomainMapping::Representation
  command.request_object = domain_mapping_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

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



934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'generated/google/apis/appengine_v1/service.rb', line 934

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:



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'generated/google/apis/appengine_v1/service.rb', line 1177

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_authorized_certificate(apps_id, authorized_certificates_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Empty

Deletes the specified SSL certificate.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource to delete. Example: apps/myapp/ authorizedCertificates/12345.

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



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

def delete_app_authorized_certificate(apps_id, authorized_certificates_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}', options)
  command.response_representation = Google::Apis::AppengineV1::Empty::Representation
  command.response_class = Google::Apis::AppengineV1::Empty
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['authorizedCertificatesId'] = authorized_certificates_id unless authorized_certificates_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_domain_mapping(apps_id, domain_mappings_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Operation

Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource to delete. Example: apps/myapp/ domainMappings/example.com.

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



476
477
478
479
480
481
482
483
484
485
 
# File 'generated/google/apis/appengine_v1/service.rb', line 476

def delete_app_domain_mapping(apps_id, domain_mappings_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/apps/{appsId}/domainMappings/{domainMappingsId}', 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['domainMappingsId'] = domain_mappings_id unless domain_mappings_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:



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

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:



972
973
974
975
976
977
978
979
980
981
982
 
# File 'generated/google/apis/appengine_v1/service.rb', line 972

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:



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
 
# File 'generated/google/apis/appengine_v1/service.rb', line 1219

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_authorized_certificate(apps_id, authorized_certificates_id, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::AuthorizedCertificate

Gets the specified SSL certificate.

Parameters:

  • apps_id (String) —

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

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



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

def get_app_authorized_certificate(apps_id, authorized_certificates_id, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}', options)
  command.response_representation = Google::Apis::AppengineV1::AuthorizedCertificate::Representation
  command.response_class = Google::Apis::AppengineV1::AuthorizedCertificate
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['authorizedCertificatesId'] = authorized_certificates_id unless authorized_certificates_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_domain_mapping(apps_id, domain_mappings_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::DomainMapping

Gets the specified domain mapping.

Parameters:

  • apps_id (String) —

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

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



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

def get_app_domain_mapping(apps_id, domain_mappings_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/apps/{appsId}/domainMappings/{domainMappingsId}', options)
  command.response_representation = Google::Apis::AppengineV1::DomainMapping::Representation
  command.response_class = Google::Apis::AppengineV1::DomainMapping
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['domainMappingsId'] = domain_mappings_id unless domain_mappings_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:



622
623
624
625
626
627
628
629
630
631
 
# File 'generated/google/apis/appengine_v1/service.rb', line 622

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:



695
696
697
698
699
700
701
702
703
704
 
# File 'generated/google/apis/appengine_v1/service.rb', line 695

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:



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

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:



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
 
# File 'generated/google/apis/appengine_v1/service.rb', line 1012

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:



1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'generated/google/apis/appengine_v1/service.rb', line 1259

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_authorized_certificates(apps_id, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::ListAuthorizedCertificatesResponse

Lists all SSL certificates the user is authorized to administer.

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.

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



324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'generated/google/apis/appengine_v1/service.rb', line 324

def list_app_authorized_certificates(apps_id, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/apps/{appsId}/authorizedCertificates', options)
  command.response_representation = Google::Apis::AppengineV1::ListAuthorizedCertificatesResponse::Representation
  command.response_class = Google::Apis::AppengineV1::ListAuthorizedCertificatesResponse
  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['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_authorized_domains(apps_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::ListAuthorizedDomainsResponse

Lists all domains the user is authorized to administer.

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:



405
406
407
408
409
410
411
412
413
414
415
 
# File 'generated/google/apis/appengine_v1/service.rb', line 405

def list_app_authorized_domains(apps_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/apps/{appsId}/authorizedDomains', options)
  command.response_representation = Google::Apis::AppengineV1::ListAuthorizedDomainsResponse::Representation
  command.response_class = Google::Apis::AppengineV1::ListAuthorizedDomainsResponse
  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_domain_mappings(apps_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::ListDomainMappingsResponse

Lists the domain mappings on an 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:



545
546
547
548
549
550
551
552
553
554
555
 
# File 'generated/google/apis/appengine_v1/service.rb', line 545

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



659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'generated/google/apis/appengine_v1/service.rb', line 659

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, '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['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::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 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:



739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'generated/google/apis/appengine_v1/service.rb', line 739

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, '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['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_service_version_instances(apps_id, services_id, versions_id, page_size: nil, page_token: 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_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:



1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'generated/google/apis/appengine_v1/service.rb', line 1303

def list_app_service_version_instances(apps_id, services_id, versions_id, page_size: nil, page_token: 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['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_service_versions(apps_id, services_id, page_size: nil, page_token: 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_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:



1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
 
# File 'generated/google/apis/appengine_v1/service.rb', line 1054

def list_app_service_versions(apps_id, services_id, page_size: nil, page_token: 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['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_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:



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

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_authorized_certificate(apps_id, authorized_certificates_id, authorized_certificate_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::AuthorizedCertificate

Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.

Parameters:

  • apps_id (String) —

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

  • authorized_certificates_id (String) —

    Part of name. See documentation of appsId.

  • authorized_certificate_object (Google::Apis::AppengineV1::AuthorizedCertificate) (defaults to: nil)
  • update_mask (String) —

    Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'generated/google/apis/appengine_v1/service.rb', line 367

def patch_app_authorized_certificate(apps_id, authorized_certificates_id, authorized_certificate_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}', options)
  command.request_representation = Google::Apis::AppengineV1::AuthorizedCertificate::Representation
  command.request_object = authorized_certificate_object
  command.response_representation = Google::Apis::AppengineV1::AuthorizedCertificate::Representation
  command.response_class = Google::Apis::AppengineV1::AuthorizedCertificate
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['authorizedCertificatesId'] = authorized_certificates_id unless authorized_certificates_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_domain_mapping(apps_id, domain_mappings_id, domain_mapping_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Operation

Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.

Parameters:

  • apps_id (String) —

    Part of name. Name of the resource to update. Example: apps/myapp/ domainMappings/example.com.

  • domain_mappings_id (String) —

    Part of name. See documentation of appsId.

  • domain_mapping_object (Google::Apis::AppengineV1::DomainMapping) (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:



586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'generated/google/apis/appengine_v1/service.rb', line 586

def patch_app_domain_mapping(apps_id, domain_mappings_id, domain_mapping_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/apps/{appsId}/domainMappings/{domainMappingsId}', options)
  command.request_representation = Google::Apis::AppengineV1::DomainMapping::Representation
  command.request_object = domain_mapping_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['domainMappingsId'] = domain_mappings_id unless domain_mappings_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, migrate_traffic: nil, update_mask: 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)
  • 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).

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



895
896
897
898
899
900
901
902
903
904
905
906
907
908
 
# File 'generated/google/apis/appengine_v1/service.rb', line 895

def patch_app_service(apps_id, services_id, service_object = nil, migrate_traffic: nil, update_mask: 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['migrateTraffic'] = migrate_traffic unless migrate_traffic.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_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. automatic_scaling.min_total_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 Flexible environment. automatic_scaling.max_total_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 Flexible environment. automatic_scaling.cool_down_period_sec (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 Flexible environment. automatic_scaling.cpu_utilization.target_utilization (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 Flexible 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:



1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'generated/google/apis/appengine_v1/service.rb', line 1129

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:



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

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