Class: Google::Apis::AppengineV1beta::AppengineService

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

Overview

App Engine Admin API

Provisions and manages developers' App Engine applications.

Examples:

require 'google/apis/appengine_v1beta'

Appengine = Google::Apis::AppengineV1beta # 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_v1beta/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-appengine_v1beta',
        client_version: Google::Apis::AppengineV1beta::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_v1beta/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_v1beta/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::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate', options)
  command.request_representation = Google::Apis::AppengineV1beta::BatchUpdateIngressRulesRequest::Representation
  command.request_object = batch_update_ingress_rules_request_object
  command.response_representation = Google::Apis::AppengineV1beta::BatchUpdateIngressRulesResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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_v1beta/service.rb', line 78

def create_app(application_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/apps', options)
  command.request_representation = Google::Apis::AppengineV1beta::Application::Representation
  command.request_object = application_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/authorizedCertificates', options)
  command.request_representation = Google::Apis::AppengineV1beta::AuthorizedCertificate::Representation
  command.request_object = authorized_certificate_object
  command.response_representation = Google::Apis::AppengineV1beta::AuthorizedCertificate::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/domainMappings', options)
  command.request_representation = Google::Apis::AppengineV1beta::DomainMapping::Representation
  command.request_object = domain_mapping_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/firewall/ingressRules', options)
  command.request_representation = Google::Apis::AppengineV1beta::FirewallRule::Representation
  command.request_object = firewall_rule_object
  command.response_representation = Google::Apis::AppengineV1beta::FirewallRule::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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



1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1233

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, 'v1beta/apps/{appsId}/services/{servicesId}/versions', options)
  command.request_representation = Google::Apis::AppengineV1beta::Version::Representation
  command.request_object = version_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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



1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1834

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates', options)
  command.request_representation = Google::Apis::AppengineV1beta::AuthorizedCertificate::Representation
  command.request_object = authorized_certificate_object
  command.response_representation = Google::Apis::AppengineV1beta::AuthorizedCertificate::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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



2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2101

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings', options)
  command.request_representation = Google::Apis::AppengineV1beta::DomainMapping::Representation
  command.request_object = domain_mapping_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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



1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1524

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, 'v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug', options)
  command.request_representation = Google::Apis::AppengineV1beta::DebugInstanceRequest::Representation
  command.request_object = debug_instance_request_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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

#debug_project_location_application_service_version_instance(projects_id, locations_id, applications_id, services_id, versions_id, instances_id, debug_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta::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:

  • projects_id (String) —

    Part of name. Required. Name of the resource requested. Example: apps/myapp/ services/default/versions/v1/instances/instance-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.

  • instances_id (String) —

    Part of name. See documentation of projectsId.

  • debug_instance_request_object (Google::Apis::AppengineV1beta::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



2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2602

def debug_project_location_application_service_version_instance(projects_id, locations_id, applications_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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug', options)
  command.request_representation = Google::Apis::AppengineV1beta::DebugInstanceRequest::Representation
  command.request_object = debug_instance_request_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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.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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Empty::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/domainMappings/{domainMappingsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Empty::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1070

def delete_app_service(apps_id, services_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta/apps/{appsId}/services/{servicesId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1271

def delete_app_service_version(apps_id, services_id, versions_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1575

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, 'v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1875

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Empty::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2144

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



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

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2418

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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

#delete_project_location_application_service_version_instance(projects_id, locations_id, applications_id, services_id, versions_id, instances_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta::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:

  • projects_id (String) —

    Part of name. Required. Name of the resource requested. Example: apps/myapp/ services/default/versions/v1/instances/instance-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.

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



2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2659

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

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



1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1309

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, 'v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}:exportAppImage', options)
  command.request_representation = Google::Apis::AppengineV1beta::ExportAppImageRequest::Representation
  command.request_object = export_app_image_request_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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



2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2462

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}:exportAppImage', options)
  command.request_representation = Google::Apis::AppengineV1beta::ExportAppImageRequest::Representation
  command.request_object = export_app_image_request_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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) —

    Optional. 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_v1beta/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, 'v1beta/apps/{appsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Application::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::AuthorizedCertificate::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/domainMappings/{domainMappingsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::DomainMapping::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::FirewallRule::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/locations/{locationsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Location::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



987
988
989
990
991
992
993
994
995
996
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 987

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

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

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



1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1106

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

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

    Optional. Options to include extra data

  • 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



1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1353

def get_app_service_version(apps_id, services_id, versions_id, include_extra_data: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Version::Representation
  command.response_class = Google::Apis::AppengineV1beta::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['includeExtraData'] = include_extra_data unless include_extra_data.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::AppengineV1beta::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



1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1615

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, 'v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Instance::Representation
  command.response_class = Google::Apis::AppengineV1beta::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(projects_id, locations_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta::Location

Gets information about a location.

Parameters:

  • projects_id (String) —

    Part of name. Resource name for the location.

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



1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1695

def get_project_location(projects_id, locations_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/projects/{projectsId}/locations/{locationsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Location::Representation
  command.response_class = Google::Apis::AppengineV1beta::Location
  command.params['projectsId'] = projects_id unless projects_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_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::AppengineV1beta::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



1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1917

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::AuthorizedCertificate::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2184

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::DomainMapping::Representation
  command.response_class = Google::Apis::AppengineV1beta::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

#get_project_location_operation(projects_id, locations_id, operations_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta::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:

  • projects_id (String) —

    Part of name. The name of the operation resource.

  • locations_id (String) —

    Part of name. See documentation of projectsId.

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



2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2699

def get_project_location_operation(projects_id, locations_id, operations_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}', options)
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::Operation
  command.params['projectsId'] = projects_id unless projects_id.nil?
  command.params['locationsId'] = locations_id unless locations_id.nil?
  command.params['operationsId'] = operations_id unless operations_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_app_authorized_certificates(apps_id, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/authorizedCertificates', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListAuthorizedCertificatesResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/authorizedDomains', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListAuthorizedDomainsResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/domainMappings', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListDomainMappingsResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/firewall/ingressRules', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListIngressRulesResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::ListLocationsResponse

Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/project, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

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



950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 950

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, 'v1beta/apps/{appsId}/locations', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListLocationsResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1033

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, 'v1beta/apps/{appsId}/operations', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListOperationsResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}:listRuntimes', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListRuntimesResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1659

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, 'v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListInstancesResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1396

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, 'v1beta/apps/{appsId}/services/{servicesId}/versions', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListVersionsResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1143

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, 'v1beta/apps/{appsId}/services', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListServicesResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1962

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListAuthorizedCertificatesResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2056

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListAuthorizedDomainsResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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



2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2226

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListDomainMappingsResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::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

#list_project_location_operations(projects_id, locations_id, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • projects_id (String) —

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

  • locations_id (String) —

    Part of name. See documentation of projectsId.

  • 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



2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2748

def list_project_location_operations(projects_id, locations_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, 'v1beta/projects/{projectsId}/locations/{locationsId}/operations', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListOperationsResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::ListOperationsResponse
  command.params['projectsId'] = projects_id unless projects_id.nil?
  command.params['locationsId'] = locations_id unless locations_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_project_locations(projects_id, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta::ListLocationsResponse

Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/project, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

Parameters:

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



1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1748

def list_project_locations(projects_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, 'v1beta/projects/{projectsId}/locations', options)
  command.response_representation = Google::Apis::AppengineV1beta::ListLocationsResponse::Representation
  command.response_class = Google::Apis::AppengineV1beta::ListLocationsResponse
  command.params['projectsId'] = projects_id unless projects_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

#patch_app(apps_id, application_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}', options)
  command.request_representation = Google::Apis::AppengineV1beta::Application::Representation
  command.request_object = application_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}', options)
  command.request_representation = Google::Apis::AppengineV1beta::AuthorizedCertificate::Representation
  command.request_object = authorized_certificate_object
  command.response_representation = Google::Apis::AppengineV1beta::AuthorizedCertificate::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/domainMappings/{domainMappingsId}', options)
  command.request_representation = Google::Apis::AppengineV1beta::DomainMapping::Representation
  command.request_object = domain_mapping_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}', options)
  command.request_representation = Google::Apis::AppengineV1beta::FirewallRule::Representation
  command.request_object = firewall_rule_object
  command.response_representation = Google::Apis::AppengineV1beta::FirewallRule::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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/v1beta/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/ rest/v1beta/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/ v1beta/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



1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1194

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, 'v1beta/apps/{appsId}/services/{servicesId}', options)
  command.request_representation = Google::Apis::AppengineV1beta::Service::Representation
  command.request_object = service_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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/v1beta/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/v1beta/apps.services.versions#Version.FIELDS. automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google. com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions# Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings. max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/ rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling. standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/ docs/admin-api/reference/rest/v1beta/apps.services.versions# StandardSchedulerSettings) automaticScaling.standard_scheduler_settings. target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/ reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization ( https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/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/v1beta/apps.services.versions#Version.FIELDS. serving_status) manual_scaling.instances (https://cloud.google.com/appengine/ docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling) Flexible environment serving_status (https://cloud.google.com/appengine/docs/ admin-api/reference/rest/v1beta/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/v1beta/apps.services.versions#Version.FIELDS. automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google. com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions# Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec ( https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps. services.versions#Version.FIELDS.automatic_scaling) automatic_scaling. cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/ admin-api/reference/rest/v1beta/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/ v1beta/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::AppengineV1beta::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



1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1476

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, 'v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}', options)
  command.request_representation = Google::Apis::AppengineV1beta::Version::Representation
  command.request_object = version_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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



1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 1793

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}', options)
  command.request_representation = Google::Apis::AppengineV1beta::Application::Representation
  command.request_object = application_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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



2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2011

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}', options)
  command.request_representation = Google::Apis::AppengineV1beta::AuthorizedCertificate::Representation
  command.request_object = authorized_certificate_object
  command.response_representation = Google::Apis::AppengineV1beta::AuthorizedCertificate::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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



2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2273

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}', options)
  command.request_representation = Google::Apis::AppengineV1beta::DomainMapping::Representation
  command.request_object = domain_mapping_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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/v1beta/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/ rest/v1beta/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/ v1beta/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



2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2372

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}', options)
  command.request_representation = Google::Apis::AppengineV1beta::Service::Representation
  command.request_object = service_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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/v1beta/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/v1beta/apps.services.versions#Version.FIELDS. automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google. com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions# Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings. max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/ rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling. standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/ docs/admin-api/reference/rest/v1beta/apps.services.versions# StandardSchedulerSettings) automaticScaling.standard_scheduler_settings. target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/ reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization ( https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/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/v1beta/apps.services.versions#Version.FIELDS. serving_status) manual_scaling.instances (https://cloud.google.com/appengine/ docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling) Flexible environment serving_status (https://cloud.google.com/appengine/docs/ admin-api/reference/rest/v1beta/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/v1beta/apps.services.versions#Version.FIELDS. automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google. com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions# Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec ( https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps. services.versions#Version.FIELDS.automatic_scaling) automatic_scaling. cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/ admin-api/reference/rest/v1beta/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/ v1beta/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::AppengineV1beta::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



2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
 
# File 'lib/google/apis/appengine_v1beta/service.rb', line 2548

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, 'v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}', options)
  command.request_representation = Google::Apis::AppengineV1beta::Version::Representation
  command.request_object = version_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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::AppengineV1beta::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::AppengineV1beta::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_v1beta/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, 'v1beta/apps/{appsId}:repair', options)
  command.request_representation = Google::Apis::AppengineV1beta::RepairApplicationRequest::Representation
  command.request_object = repair_application_request_object
  command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation
  command.response_class = Google::Apis::AppengineV1beta::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