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



680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/google/apis/appengine_v1/service.rb', line 680

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. Required. 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



262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/google/apis/appengine_v1/service.rb', line 262

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. Required. 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



493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/google/apis/appengine_v1/service.rb', line 493

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. Required. 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



714
715
716
717
718
719
720
721
722
723
724
 
# File 'lib/google/apis/appengine_v1/service.rb', line 714

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. Required. 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



1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1221

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

#create_project_location_application_authorized_certificate(projects_id, locations_id, applications_id, authorized_certificate_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::AuthorizedCertificate

Uploads the specified SSL certificate.

Parameters:

  • projects_id (String) —

    Part of parent. Required. 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.

  • 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



1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1730

def create_project_location_application_authorized_certificate(projects_id, locations_id, applications_id, authorized_certificate_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/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['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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

  • projects_id (String) —

    Part of parent. Required. 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.

  • 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



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1997

def create_project_location_application_domain_mapping(projects_id, locations_id, applications_id, domain_mapping_object = nil, override_strategy: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/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['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['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

#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. Required. 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



1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1509

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. Required. 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



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

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. Required. 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



530
531
532
533
534
535
536
537
538
539
 
# File 'lib/google/apis/appengine_v1/service.rb', line 530

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



749
750
751
752
753
754
755
756
757
758
 
# File 'lib/google/apis/appengine_v1/service.rb', line 749

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. Required. 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



1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1061

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. Required. 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



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

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. Required. 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



1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1560

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

#delete_project_location_application_authorized_certificate(projects_id, locations_id, applications_id, authorized_certificates_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Empty

Deletes the specified SSL certificate.

Parameters:

  • projects_id (String) —

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

  • locations_id (String) —

    Part of name. See documentation of projectsId.

  • applications_id (String) —

    Part of name. See documentation of projectsId.

  • authorized_certificates_id (String) —

    Part of name. See documentation of projectsId.

  • 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



1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1771

def delete_project_location_application_authorized_certificate(projects_id, locations_id, applications_id, authorized_certificates_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}', options)
  command.response_representation = Google::Apis::AppengineV1::Empty::Representation
  command.response_class = Google::Apis::AppengineV1::Empty
  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.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_project_location_application_domain_mapping(projects_id, locations_id, applications_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:

  • projects_id (String) —

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

  • locations_id (String) —

    Part of name. See documentation of projectsId.

  • applications_id (String) —

    Part of name. See documentation of projectsId.

  • domain_mappings_id (String) —

    Part of name. See documentation of projectsId.

  • 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



2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
 
# File 'lib/google/apis/appengine_v1/service.rb', line 2040

def delete_project_location_application_domain_mapping(projects_id, locations_id, applications_id, domain_mappings_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}', options)
  command.response_representation = Google::Apis::AppengineV1::Operation::Representation
  command.response_class = Google::Apis::AppengineV1::Operation
  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.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_project_location_application_service(projects_id, locations_id, applications_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:

  • projects_id (String) —

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

  • locations_id (String) —

    Part of name. See documentation of projectsId.

  • applications_id (String) —

    Part of name. See documentation of projectsId.

  • services_id (String) —

    Part of name. See documentation of projectsId.

  • 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



2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
 
# File 'lib/google/apis/appengine_v1/service.rb', line 2212

def delete_project_location_application_service(projects_id, locations_id, applications_id, services_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}', options)
  command.response_representation = Google::Apis::AppengineV1::Operation::Representation
  command.response_class = Google::Apis::AppengineV1::Operation
  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.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_project_location_application_service_version(projects_id, locations_id, applications_id, services_id, versions_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Operation

Deletes an existing Version resource.

Parameters:

  • projects_id (String) —

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

  • locations_id (String) —

    Part of name. See documentation of projectsId.

  • applications_id (String) —

    Part of name. See documentation of projectsId.

  • services_id (String) —

    Part of name. See documentation of projectsId.

  • versions_id (String) —

    Part of name. See documentation of projectsId.

  • 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



2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
 
# File 'lib/google/apis/appengine_v1/service.rb', line 2314

def delete_project_location_application_service_version(projects_id, locations_id, applications_id, services_id, versions_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}', options)
  command.response_representation = Google::Apis::AppengineV1::Operation::Representation
  command.response_class = Google::Apis::AppengineV1::Operation
  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.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

#export_app_service_version_app_image(apps_id, services_id, versions_id, export_app_image_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Operation

Exports a user image to Artifact Registry.

Parameters:

  • apps_id (String) —

    Part of name. Required. Name of the App Engine version resource. Format: apps/app/services/service/versions/version

  • services_id (String) —

    Part of name. See documentation of appsId.

  • versions_id (String) —

    Part of name. See documentation of appsId.

  • export_app_image_request_object (Google::Apis::AppengineV1::ExportAppImageRequest) (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



1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1297

def export_app_service_version_app_image(apps_id, services_id, versions_id, export_app_image_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}:exportAppImage', options)
  command.request_representation = Google::Apis::AppengineV1::ExportAppImageRequest::Representation
  command.request_object = export_app_image_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.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_application_service_version_app_image(projects_id, locations_id, applications_id, services_id, versions_id, export_app_image_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::Operation

Exports a user image to Artifact Registry.

Parameters:

  • projects_id (String) —

    Part of name. Required. Name of the App Engine version resource. Format: apps/app/services/service/versions/version

  • locations_id (String) —

    Part of name. See documentation of projectsId.

  • applications_id (String) —

    Part of name. See documentation of projectsId.

  • services_id (String) —

    Part of name. See documentation of projectsId.

  • versions_id (String) —

    Part of name. See documentation of projectsId.

  • export_app_image_request_object (Google::Apis::AppengineV1::ExportAppImageRequest) (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



2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
 
# File 'lib/google/apis/appengine_v1/service.rb', line 2358

def export_project_location_application_service_version_app_image(projects_id, locations_id, applications_id, services_id, versions_id, export_app_image_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}:exportAppImage', options)
  command.request_representation = Google::Apis::AppengineV1::ExportAppImageRequest::Representation
  command.request_object = export_app_image_request_object
  command.response_representation = Google::Apis::AppengineV1::Operation::Representation
  command.response_class = Google::Apis::AppengineV1::Operation
  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.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

#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. Required. 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



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

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. Required. 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



333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/google/apis/appengine_v1/service.rb', line 333

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. Required. 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



564
565
566
567
568
569
570
571
572
573
 
# File 'lib/google/apis/appengine_v1/service.rb', line 564

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



783
784
785
786
787
788
789
790
791
792
 
# File 'lib/google/apis/appengine_v1/service.rb', line 783

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



897
898
899
900
901
902
903
904
905
906
 
# File 'lib/google/apis/appengine_v1/service.rb', line 897

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



978
979
980
981
982
983
984
985
986
987
 
# File 'lib/google/apis/appengine_v1/service.rb', line 978

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. Required. 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



1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1095

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. Required. 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



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1339

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. Required. 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



1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1600

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

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

  • projects_id (String) —

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

  • locations_id (String) —

    Part of name. See documentation of projectsId.

  • applications_id (String) —

    Part of name. See documentation of projectsId.

  • authorized_certificates_id (String) —

    Part of name. See documentation of projectsId.

  • 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



1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1813

def get_project_location_application_authorized_certificate(projects_id, locations_id, applications_id, authorized_certificates_id, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}', options)
  command.response_representation = Google::Apis::AppengineV1::AuthorizedCertificate::Representation
  command.response_class = Google::Apis::AppengineV1::AuthorizedCertificate
  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.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_project_location_application_domain_mapping(projects_id, locations_id, applications_id, domain_mappings_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1::DomainMapping

Gets the specified domain mapping.

Parameters:

  • projects_id (String) —

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

  • locations_id (String) —

    Part of name. See documentation of projectsId.

  • applications_id (String) —

    Part of name. See documentation of projectsId.

  • domain_mappings_id (String) —

    Part of name. See documentation of projectsId.

  • 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



2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
 
# File 'lib/google/apis/appengine_v1/service.rb', line 2080

def get_project_location_application_domain_mapping(projects_id, locations_id, applications_id, domain_mappings_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}', options)
  command.response_representation = Google::Apis::AppengineV1::DomainMapping::Representation
  command.response_class = Google::Apis::AppengineV1::DomainMapping
  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.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

#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. Required. 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



372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/google/apis/appengine_v1/service.rb', line 372

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. Required. 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



454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/google/apis/appengine_v1/service.rb', line 454

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. Required. 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



600
601
602
603
604
605
606
607
608
609
610
 
# File 'lib/google/apis/appengine_v1/service.rb', line 600

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



822
823
824
825
826
827
828
829
830
831
832
833
 
# File 'lib/google/apis/appengine_v1/service.rb', line 822

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

  • extra_location_types (Array<String>, String) (defaults to: nil) —

    Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

  • 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



941
942
943
944
945
946
947
948
949
950
951
952
953
 
# File 'lib/google/apis/appengine_v1/service.rb', line 941

def list_app_locations(apps_id, extra_location_types: nil, 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['extraLocationTypes'] = extra_location_types unless extra_location_types.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, return_partial_success: 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.

  • return_partial_success (Boolean) (defaults to: nil) —

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • 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



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1024

def list_app_operations(apps_id, filter: nil, page_size: nil, page_token: nil, return_partial_success: 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['returnPartialSuccess'] = return_partial_success unless return_partial_success.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



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

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. Required. 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



1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1644

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. Required. 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



1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1381

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. Required. 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



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

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

  • projects_id (String) —

    Part of parent. Required. 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.

  • 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



1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1858

def list_project_location_application_authorized_certificates(projects_id, locations_id, applications_id, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates', options)
  command.response_representation = Google::Apis::AppengineV1::ListAuthorizedCertificatesResponse::Representation
  command.response_class = Google::Apis::AppengineV1::ListAuthorizedCertificatesResponse
  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['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_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. Required. 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



1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1952

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

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

  • projects_id (String) —

    Part of parent. Required. 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



2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
 
# File 'lib/google/apis/appengine_v1/service.rb', line 2122

def list_project_location_application_domain_mappings(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}/domainMappings', options)
  command.response_representation = Google::Apis::AppengineV1::ListDomainMappingsResponse::Representation
  command.response_class = Google::Apis::AppengineV1::ListDomainMappingsResponse
  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. Required. 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



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

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. Required. 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



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/google/apis/appengine_v1/service.rb', line 415

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. Required. 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



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

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



861
862
863
864
865
866
867
868
869
870
871
872
873
 
# File 'lib/google/apis/appengine_v1/service.rb', line 861

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. Required. 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



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1182

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. Required. 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



1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1461

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

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

  • projects_id (String) —

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

  • locations_id (String) —

    Part of name. See documentation of projectsId.

  • applications_id (String) —

    Part of name. See documentation of projectsId.

  • 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



1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1689

def patch_project_location_application(projects_id, locations_id, applications_id, application_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}', 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['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['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_project_location_application_authorized_certificate(projects_id, locations_id, applications_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:

  • projects_id (String) —

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

  • locations_id (String) —

    Part of name. See documentation of projectsId.

  • applications_id (String) —

    Part of name. See documentation of projectsId.

  • authorized_certificates_id (String) —

    Part of name. See documentation of projectsId.

  • 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



1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
 
# File 'lib/google/apis/appengine_v1/service.rb', line 1907

def patch_project_location_application_authorized_certificate(projects_id, locations_id, applications_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/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/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['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.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_project_location_application_domain_mapping(projects_id, locations_id, applications_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:

  • projects_id (String) —

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

  • locations_id (String) —

    Part of name. See documentation of projectsId.

  • applications_id (String) —

    Part of name. See documentation of projectsId.

  • domain_mappings_id (String) —

    Part of name. See documentation of projectsId.

  • 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



2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
 
# File 'lib/google/apis/appengine_v1/service.rb', line 2169

def patch_project_location_application_domain_mapping(projects_id, locations_id, applications_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/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/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['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.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_project_location_application_service(projects_id, locations_id, applications_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:

  • projects_id (String) —

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

  • locations_id (String) —

    Part of name. See documentation of projectsId.

  • applications_id (String) —

    Part of name. See documentation of projectsId.

  • services_id (String) —

    Part of name. See documentation of projectsId.

  • 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



2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
 
# File 'lib/google/apis/appengine_v1/service.rb', line 2268

def patch_project_location_application_service(projects_id, locations_id, applications_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/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/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['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.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_project_location_application_service_version(projects_id, locations_id, applications_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:

  • projects_id (String) —

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

  • locations_id (String) —

    Part of name. See documentation of projectsId.

  • applications_id (String) —

    Part of name. See documentation of projectsId.

  • services_id (String) —

    Part of name. See documentation of projectsId.

  • versions_id (String) —

    Part of name. See documentation of projectsId.

  • 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



2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
 
# File 'lib/google/apis/appengine_v1/service.rb', line 2444

def patch_project_location_application_service_version(projects_id, locations_id, applications_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/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/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['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.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. Required. 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



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

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