Reference documentation and code samples for the App Engine Admin V1 API class Google::Cloud::AppEngine::V1::Applications::Rest::Client.
REST client for the Applications service.
Manages App Engine applications.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the Applications Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all Applications clients ::Google::Cloud::AppEngine::V1::Applications::Rest::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the Applications Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_application
def create_application(request, options = nil) -> ::Gapic::Operation
def create_application(application: nil) -> ::Gapic::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 where you want the App Engine application located.
For more information about App Engine applications, see Managing Projects, Applications, and Billing.
def create_application(request, options = nil) -> ::Gapic::Operation
create_application
via a request object, either of type
CreateApplicationRequest or an equivalent Hash.
- request (::Google::Cloud::AppEngine::V1::CreateApplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def create_application(application: nil) -> ::Gapic::Operation
create_application
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- application (::Google::Cloud::AppEngine::V1::Application, ::Hash) — Application configuration.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get_application
def get_application(request, options = nil) -> ::Google::Cloud::AppEngine::V1::Application
def get_application(name: nil) -> ::Google::Cloud::AppEngine::V1::Application
Gets information about an application.
def get_application(request, options = nil) -> ::Google::Cloud::AppEngine::V1::Application
get_application
via a request object, either of type
GetApplicationRequest or an equivalent Hash.
- request (::Google::Cloud::AppEngine::V1::GetApplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_application(name: nil) -> ::Google::Cloud::AppEngine::V1::Application
get_application
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Name of the Application resource to get. Example:
apps/myapp
.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::AppEngine::V1::Application)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#initialize
def initialize() { |config| ... } -> Client
Create a new Applications REST client object.
- (config) — Configure the Applications client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::AppEngine::V1::Applications::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::AppEngine::V1::Applications::Rest::Client.new do |config| config.timeout = 10.0 end
#operations_client
def operations_client() -> ::Google::Cloud::AppEngine::V1::Applications::Rest::Operations
Get the associated client for long-running operations.
#repair_application
def repair_application(request, options = nil) -> ::Gapic::Operation
def repair_application(name: nil) -> ::Gapic::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.
def repair_application(request, options = nil) -> ::Gapic::Operation
repair_application
via a request object, either of type
RepairApplicationRequest or an equivalent Hash.
- request (::Google::Cloud::AppEngine::V1::RepairApplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def repair_application(name: nil) -> ::Gapic::Operation
repair_application
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Name of the application to repair. Example:
apps/myapp
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#update_application
def update_application(request, options = nil) -> ::Gapic::Operation
def update_application(name: nil, application: nil, update_mask: nil) -> ::Gapic::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.
def update_application(request, options = nil) -> ::Gapic::Operation
update_application
via a request object, either of type
UpdateApplicationRequest or an equivalent Hash.
- request (::Google::Cloud::AppEngine::V1::UpdateApplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def update_application(name: nil, application: nil, update_mask: nil) -> ::Gapic::Operation
update_application
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Name of the Application resource to update. Example:
apps/myapp
. - application (::Google::Cloud::AppEngine::V1::Application, ::Hash) — An Application containing the updated resource.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Standard field mask for the set of fields to be updated.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.