Class: Google::Apis::AppengineV1alpha::AppengineService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::AppengineV1alpha::AppengineService
- Defined in:
- generated/google/apis/appengine_v1alpha/service.rb
Overview
App Engine Admin API
The App Engine Admin API enables developers to provision and manage their App Engine applications.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#create_app_authorized_certificate(apps_id, authorized_certificate_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::AuthorizedCertificate
Uploads the specified SSL certificate.
-
#create_app_domain_mapping(apps_id, domain_mapping_object = nil, no_managed_certificate: nil, override_strategy: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::Operation
Maps a domain to an application.
-
#delete_app_authorized_certificate(apps_id, authorized_certificates_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::Empty
Deletes the specified SSL certificate.
-
#delete_app_domain_mapping(apps_id, domain_mappings_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::Operation
Deletes the specified domain mapping.
-
#get_app_authorized_certificate(apps_id, authorized_certificates_id, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::AuthorizedCertificate
Gets the specified SSL certificate.
-
#get_app_domain_mapping(apps_id, domain_mappings_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::DomainMapping
Gets the specified domain mapping.
-
#get_app_location(apps_id, locations_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::Location
Gets information about a location.
-
#get_app_operation(apps_id, operations_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::Operation
Gets the latest state of a long-running operation.
-
#initialize ⇒ AppengineService
constructor
A new instance of AppengineService.
-
#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::AppengineV1alpha::ListAuthorizedCertificatesResponse
Lists all SSL certificates the user is authorized to administer.
-
#list_app_authorized_domains(apps_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::ListAuthorizedDomainsResponse
Lists all domains the user is authorized to administer.
-
#list_app_domain_mappings(apps_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::ListDomainMappingsResponse
Lists the domain mappings on an application.
-
#list_app_locations(apps_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::ListLocationsResponse
Lists information about the supported locations for this service.
-
#list_app_operations(apps_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::ListOperationsResponse
Lists operations that match the specified filter in the request.
-
#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::AppengineV1alpha::AuthorizedCertificate
Updates the specified SSL certificate.
-
#patch_app_domain_mapping(apps_id, domain_mappings_id, domain_mapping_object = nil, no_managed_certificate: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::Operation
Updates the specified domain mapping.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ AppengineService
Returns a new instance of AppengineService
46 47 48 49 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 46 def initialize super('https://appengine.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
39 40 41 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 39 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
44 45 46 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 44 def quota_user @quota_user end |
Instance Method Details
#create_app_authorized_certificate(apps_id, authorized_certificate_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::AuthorizedCertificate
Uploads the specified SSL certificate.
72 73 74 75 76 77 78 79 80 81 82 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 72 def (apps_id, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha/apps/{appsId}/authorizedCertificates', ) command.request_representation = Google::Apis::AppengineV1alpha::AuthorizedCertificate::Representation command.request_object = command.response_representation = Google::Apis::AppengineV1alpha::AuthorizedCertificate::Representation command.response_class = Google::Apis::AppengineV1alpha::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, no_managed_certificate: nil, override_strategy: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::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.
305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 305 def create_app_domain_mapping(apps_id, domain_mapping_object = nil, no_managed_certificate: nil, override_strategy: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha/apps/{appsId}/domainMappings', ) command.request_representation = Google::Apis::AppengineV1alpha::DomainMapping::Representation command.request_object = domain_mapping_object command.response_representation = Google::Apis::AppengineV1alpha::Operation::Representation command.response_class = Google::Apis::AppengineV1alpha::Operation command.params['appsId'] = apps_id unless apps_id.nil? command.query['noManagedCertificate'] = no_managed_certificate unless no_managed_certificate.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 |
#delete_app_authorized_certificate(apps_id, authorized_certificates_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::Empty
Deletes the specified SSL certificate.
107 108 109 110 111 112 113 114 115 116 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 107 def (apps_id, , fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}', ) command.response_representation = Google::Apis::AppengineV1alpha::Empty::Representation command.response_class = Google::Apis::AppengineV1alpha::Empty command.params['appsId'] = apps_id unless apps_id.nil? command.params['authorizedCertificatesId'] = unless .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::AppengineV1alpha::Operation
Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.
343 344 345 346 347 348 349 350 351 352 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 343 def delete_app_domain_mapping(apps_id, domain_mappings_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}', ) command.response_representation = Google::Apis::AppengineV1alpha::Operation::Representation command.response_class = Google::Apis::AppengineV1alpha::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 |
#get_app_authorized_certificate(apps_id, authorized_certificates_id, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::AuthorizedCertificate
Gets the specified SSL certificate.
143 144 145 146 147 148 149 150 151 152 153 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 143 def (apps_id, , view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}', ) command.response_representation = Google::Apis::AppengineV1alpha::AuthorizedCertificate::Representation command.response_class = Google::Apis::AppengineV1alpha::AuthorizedCertificate command.params['appsId'] = apps_id unless apps_id.nil? command.params['authorizedCertificatesId'] = unless .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::AppengineV1alpha::DomainMapping
Gets the specified domain mapping.
377 378 379 380 381 382 383 384 385 386 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 377 def get_app_domain_mapping(apps_id, domain_mappings_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}', ) command.response_representation = Google::Apis::AppengineV1alpha::DomainMapping::Representation command.response_class = Google::Apis::AppengineV1alpha::DomainMapping command.params['appsId'] = apps_id unless apps_id.nil? command.params['domainMappingsId'] = domain_mappings_id unless domain_mappings_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_app_location(apps_id, locations_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::Location
Gets information about a location.
496 497 498 499 500 501 502 503 504 505 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 496 def get_app_location(apps_id, locations_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha/apps/{appsId}/locations/{locationsId}', ) command.response_representation = Google::Apis::AppengineV1alpha::Location::Representation command.response_class = Google::Apis::AppengineV1alpha::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::AppengineV1alpha::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.
569 570 571 572 573 574 575 576 577 578 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 569 def get_app_operation(apps_id, operations_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha/apps/{appsId}/operations/{operationsId}', ) command.response_representation = Google::Apis::AppengineV1alpha::Operation::Representation command.response_class = Google::Apis::AppengineV1alpha::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 |
#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::AppengineV1alpha::ListAuthorizedCertificatesResponse
Lists all SSL certificates the user is authorized to administer.
181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 181 def (apps_id, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha/apps/{appsId}/authorizedCertificates', ) command.response_representation = Google::Apis::AppengineV1alpha::ListAuthorizedCertificatesResponse::Representation command.response_class = Google::Apis::AppengineV1alpha::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::AppengineV1alpha::ListAuthorizedDomainsResponse
Lists all domains the user is authorized to administer.
262 263 264 265 266 267 268 269 270 271 272 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 262 def (apps_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha/apps/{appsId}/authorizedDomains', ) command.response_representation = Google::Apis::AppengineV1alpha::ListAuthorizedDomainsResponse::Representation command.response_class = Google::Apis::AppengineV1alpha::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::AppengineV1alpha::ListDomainMappingsResponse
Lists the domain mappings on an application.
412 413 414 415 416 417 418 419 420 421 422 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 412 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, 'v1alpha/apps/{appsId}/domainMappings', ) command.response_representation = Google::Apis::AppengineV1alpha::ListDomainMappingsResponse::Representation command.response_class = Google::Apis::AppengineV1alpha::ListDomainMappingsResponse command.params['appsId'] = apps_id unless apps_id.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_app_locations(apps_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::ListLocationsResponse
Lists information about the supported locations for this service.
533 534 535 536 537 538 539 540 541 542 543 544 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 533 def list_app_locations(apps_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha/apps/{appsId}/locations', ) command.response_representation = Google::Apis::AppengineV1alpha::ListLocationsResponse::Representation command.response_class = Google::Apis::AppengineV1alpha::ListLocationsResponse command.params['appsId'] = apps_id unless apps_id.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_app_operations(apps_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::ListOperationsResponse
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users//operations. To override the binding, API services can add a binding such as "/v1/`name=users/`/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
613 614 615 616 617 618 619 620 621 622 623 624 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 613 def list_app_operations(apps_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha/apps/{appsId}/operations', ) command.response_representation = Google::Apis::AppengineV1alpha::ListOperationsResponse::Representation command.response_class = Google::Apis::AppengineV1alpha::ListOperationsResponse command.params['appsId'] = apps_id unless apps_id.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#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::AppengineV1alpha::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.
224 225 226 227 228 229 230 231 232 233 234 235 236 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 224 def (apps_id, , = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}', ) command.request_representation = Google::Apis::AppengineV1alpha::AuthorizedCertificate::Representation command.request_object = command.response_representation = Google::Apis::AppengineV1alpha::AuthorizedCertificate::Representation command.response_class = Google::Apis::AppengineV1alpha::AuthorizedCertificate command.params['appsId'] = apps_id unless apps_id.nil? command.params['authorizedCertificatesId'] = unless .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, no_managed_certificate: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppengineV1alpha::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.
459 460 461 462 463 464 465 466 467 468 469 470 471 472 |
# File 'generated/google/apis/appengine_v1alpha/service.rb', line 459 def patch_app_domain_mapping(apps_id, domain_mappings_id, domain_mapping_object = nil, no_managed_certificate: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}', ) command.request_representation = Google::Apis::AppengineV1alpha::DomainMapping::Representation command.request_object = domain_mapping_object command.response_representation = Google::Apis::AppengineV1alpha::Operation::Representation command.response_class = Google::Apis::AppengineV1alpha::Operation command.params['appsId'] = apps_id unless apps_id.nil? command.params['domainMappingsId'] = domain_mappings_id unless domain_mappings_id.nil? command.query['noManagedCertificate'] = no_managed_certificate unless no_managed_certificate.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 |