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

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

Overview

App Engine Admin API

Provisions and manages developers' App Engine applications.

Examples:

require 'google/apis/appengine_v1'

Appengine = Google::Apis::AppengineV1 # Alias the module
service = Appengine::AppengineService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://appengine.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AppengineService

Returns a new instance of AppengineService.



47
48
49
50
51
52
 
# File 'lib/google/apis/appengine_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-appengine_v1',
        client_version: Google::Apis::AppengineV1::GEM_VERSION)
  @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.



40
41
42
 
# File 'lib/google/apis/appengine_v1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

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

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.



45
46
47
 
# File 'lib/google/apis/appengine_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#batch_update_ingress_rules(apps_id, batch_update_ingress_rules_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::BatchUpdateIngressRulesResponse

Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.

Parameters:

  • apps_id (String) —

    Part of name. Name of the Firewall collection to set. Example: apps/myapp/ firewall/ingressRules.

  • batch_update_ingress_rules_request_object (Google::Apis::AppengineV1::BatchUpdateIngressRulesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/google/apis/appengine_v1/service.rb', line 673

def batch_update_ingress_rules(apps_id, batch_update_ingress_rules_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/apps/{appsId}/firewall/ingressRules:batchUpdate', options)
  command.request_representation = Google::Apis::AppengineV1::BatchUpdateIngressRulesRequest::Representation
  command.request_object = batch_update_ingress_rules_request_object
  command.response_representation = Google::Apis::AppengineV1::BatchUpdateIngressRulesResponse::Representation
  command.response_class = Google::Apis::AppengineV1::BatchUpdateIngressRulesResponse
  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(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/standard/python/console/).

Parameters:

  • application_object (Google::Apis::AppengineV1::Application) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/apis/appengine_v1/service.rb', line 78

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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, override_strategy: 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)
  • override_strategy (String) (defaults to: nil) —

    Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/google/apis/appengine_v1/service.rb', line 487

def create_app_domain_mapping(apps_id, domain_mapping_object = nil, override_strategy: 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['overrideStrategy'] = override_strategy unless override_strategy.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_firewall_ingress_rule(apps_id, firewall_rule_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::FirewallRule

Creates a firewall rule for the application.

Parameters:

  • apps_id (String) —

    Part of parent. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.

  • firewall_rule_object (Google::Apis::AppengineV1::FirewallRule) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



707
708
709
710
711
712
713
714
715
716
717
 
# File 'lib/google/apis/appengine_v1/service.rb', line 707

def create_app_firewall_ingress_rule(apps_id, firewall_rule_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/apps/{appsId}/firewall/ingressRules', options)
  command.request_representation = Google::Apis::AppengineV1::FirewallRule::Representation
  command.request_object = firewall_rule_object
  command.response_representation = Google::Apis::AppengineV1::FirewallRule::Representation
  command.response_class = Google::Apis::AppengineV1::FirewallRule
  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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1200

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1448

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



294
295
296
297
298
299
300
301
302
303
 
# File 'lib/google/apis/appengine_v1/service.rb', line 294

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



524
525
526
527
528
529
530
531
532
533
 
# File 'lib/google/apis/appengine_v1/service.rb', line 524

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

Deletes the specified firewall rule.

Parameters:

  • apps_id (String) —

    Part of name. Name of the Firewall resource to delete. Example: apps/myapp/ firewall/ingressRules/100.

  • ingress_rules_id (String) —

    Part of name. See documentation of appsId.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



742
743
744
745
746
747
748
749
750
751
 
# File 'lib/google/apis/appengine_v1/service.rb', line 742

def delete_app_firewall_ingress_rule(apps_id, ingress_rules_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}', 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['ingressRulesId'] = ingress_rules_id unless ingress_rules_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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1041

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1238

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.The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment (https://cloud.google.com/ appengine/docs/standard/python/how-instances-are-managed) | flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how- instances-are-managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services. versions.patch (https://cloud.google.com/appengine/docs/admin-api/reference/ rest/v1/apps.services.versions/patch) method.

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1499

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, include_extra_data: nil, 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.

  • include_extra_data (String) (defaults to: nil) —

    Options to include extra data

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/google/apis/appengine_v1/service.rb', line 111

def get_app(apps_id, include_extra_data: nil, 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['includeExtraData'] = include_extra_data unless include_extra_data.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) (defaults to: nil) —

    Controls the set of fields returned in the GET response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

Gets the specified firewall rule.

Parameters:

  • apps_id (String) —

    Part of name. Name of the Firewall resource to retrieve. Example: apps/myapp/ firewall/ingressRules/100.

  • ingress_rules_id (String) —

    Part of name. See documentation of appsId.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def get_app_firewall_ingress_rule(apps_id, ingress_rules_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}', options)
  command.response_representation = Google::Apis::AppengineV1::FirewallRule::Representation
  command.response_class = Google::Apis::AppengineV1::FirewallRule
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['ingressRulesId'] = ingress_rules_id unless ingress_rules_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

Gets information about a location.

Parameters:

  • apps_id (String) —

    Part of name. Resource name for the location.

  • locations_id (String) —

    Part of name. See documentation of appsId.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



890
891
892
893
894
895
896
897
898
899
 
# File 'lib/google/apis/appengine_v1/service.rb', line 890

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



967
968
969
970
971
972
973
974
975
976
 
# File 'lib/google/apis/appengine_v1/service.rb', line 967

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1075

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) (defaults to: nil) —

    Controls the set of fields returned in the Get response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1278

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1539

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) (defaults to: nil) —

    Maximum results to return per page.

  • page_token (String) (defaults to: nil) —

    Continuation token for fetching the next page of results.

  • view (String) (defaults to: nil) —

    Controls the set of fields returned in the LIST response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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) (defaults to: nil) —

    Maximum results to return per page.

  • page_token (String) (defaults to: nil) —

    Continuation token for fetching the next page of results.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/google/apis/appengine_v1/service.rb', line 449

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) (defaults to: nil) —

    Maximum results to return per page.

  • page_token (String) (defaults to: nil) —

    Continuation token for fetching the next page of results.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/google/apis/appengine_v1/service.rb', line 593

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

Lists the firewall rules of an application.

Parameters:

  • apps_id (String) —

    Part of parent. Name of the Firewall collection to retrieve. Example: apps/ myapp/firewall/ingressRules.

  • matching_address (String) (defaults to: nil) —

    A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.

  • page_size (Fixnum) (defaults to: nil) —

    Maximum results to return per page.

  • page_token (String) (defaults to: nil) —

    Continuation token for fetching the next page of results.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/apis/appengine_v1/service.rb', line 815

def list_app_firewall_ingress_rules(apps_id, matching_address: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/apps/{appsId}/firewall/ingressRules', options)
  command.response_representation = Google::Apis::AppengineV1::ListIngressRulesResponse::Representation
  command.response_class = Google::Apis::AppengineV1::ListIngressRulesResponse
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.query['matchingAddress'] = matching_address unless matching_address.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) (defaults to: nil) —

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of results to return. If not set, the service selects a default.

  • page_token (String) (defaults to: nil) —

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



931
932
933
934
935
936
937
938
939
940
941
942
 
# File 'lib/google/apis/appengine_v1/service.rb', line 931

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.

Parameters:

  • apps_id (String) —

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

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1005

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

Lists all the available runtimes for the application.

Parameters:

  • apps_id (String) —

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

  • environment (String) (defaults to: nil) —

    Optional. The environment of the Application.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def list_app_runtimes(apps_id, environment: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/apps/{appsId}:listRuntimes', options)
  command.response_representation = Google::Apis::AppengineV1::ListRuntimesResponse::Representation
  command.response_class = Google::Apis::AppengineV1::ListRuntimesResponse
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.query['environment'] = environment unless environment.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) (defaults to: nil) —

    Maximum results to return per page.

  • page_token (String) (defaults to: nil) —

    Continuation token for fetching the next page of results.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1583

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) (defaults to: nil) —

    Maximum results to return per page.

  • page_token (String) (defaults to: nil) —

    Continuation token for fetching the next page of results.

  • view (String) (defaults to: nil) —

    Controls the set of fields returned in the List response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1320

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) (defaults to: nil) —

    Maximum results to return per page.

  • page_token (String) (defaults to: nil) —

    Continuation token for fetching the next page of results.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1110

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

#list_project_location_application_authorized_domains(projects_id, locations_id, applications_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:

  • projects_id (String) —

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

  • locations_id (String) —

    Part of parent. See documentation of projectsId.

  • applications_id (String) —

    Part of parent. See documentation of projectsId.

  • page_size (Fixnum) (defaults to: nil) —

    Maximum results to return per page.

  • page_token (String) (defaults to: nil) —

    Continuation token for fetching the next page of results.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1625

def list_project_location_application_authorized_domains(projects_id, locations_id, applications_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains', options)
  command.response_representation = Google::Apis::AppengineV1::ListAuthorizedDomainsResponse::Representation
  command.response_class = Google::Apis::AppengineV1::ListAuthorizedDomainsResponse
  command.params['projectsId'] = projects_id unless projects_id.nil?
  command.params['locationsId'] = locations_id unless locations_id.nil?
  command.params['applicationsId'] = applications_id unless applications_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. iap - Identity-Aware Proxy properties 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) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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) (defaults to: nil) —

    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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/google/apis/appengine_v1/service.rb', line 411

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) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/google/apis/appengine_v1/service.rb', line 634

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_firewall_ingress_rule(apps_id, ingress_rules_id, firewall_rule_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::FirewallRule

Updates the specified firewall rule.

Parameters:

  • apps_id (String) —

    Part of name. Name of the Firewall resource to update. Example: apps/myapp/ firewall/ingressRules/100.

  • ingress_rules_id (String) —

    Part of name. See documentation of appsId.

  • firewall_rule_object (Google::Apis::AppengineV1::FirewallRule) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def patch_app_firewall_ingress_rule(apps_id, ingress_rules_id, firewall_rule_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}', options)
  command.request_representation = Google::Apis::AppengineV1::FirewallRule::Representation
  command.request_object = firewall_rule_object
  command.response_representation = Google::Apis::AppengineV1::FirewallRule::Representation
  command.response_class = Google::Apis::AppengineV1::FirewallRule
  command.params['appsId'] = apps_id unless apps_id.nil?
  command.params['ingressRulesId'] = ingress_rules_id unless ingress_rules_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) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1161

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:Standard environment instance_class (https://cloud.google.com/ appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version. FIELDS.instance_class)automatic scaling in the 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) automatic_scaling.max_idle_instances (https://cloud.google. com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version. FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings. max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/ rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling. standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/ docs/admin-api/reference/rest/v1/apps.services.versions# StandardSchedulerSettings) automaticScaling.standard_scheduler_settings. target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/ reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization ( https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps. services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/ docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS. serving_status) manual_scaling.instances (https://cloud.google.com/appengine/ docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/ reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) automatic scaling in the flexible environment: automatic_scaling. min_total_instances (https://cloud.google.com/appengine/docs/admin-api/ reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/ admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS. automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud. google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions# Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization. target_utilization (https://cloud.google.com/appengine/docs/admin-api/ reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) manual scaling in the flexible environment: manual_scaling.instances (https:// cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services. versions#manualscaling)

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) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1400

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. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud. google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params= %7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D% 7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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