Class ApplicationsClient (2.29.0)

Version 2.29.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

Manages App Engine applications.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

ApplicationsClient(ApplicationsClient const &)

Copy and move support

Parameter
Name	Description
	ApplicationsClient const &

ApplicationsClient(ApplicationsClient &&)

Copy and move support

Parameter
Name	Description
	ApplicationsClient &&

ApplicationsClient(std::shared_ptr< ApplicationsConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< ApplicationsConnection >
opts	Options

Operators

operator=(ApplicationsClient const &)

Copy and move support

Parameter
Name	Description
	ApplicationsClient const &

Returns
Type	Description
ApplicationsClient &

operator=(ApplicationsClient &&)

Copy and move support

Parameter
Name	Description
	ApplicationsClient &&

Returns
Type	Description
ApplicationsClient &

Functions

GetApplication(std::string const &, Options)

Gets information about an application.

Parameters
Name	Description
name	std::string const & Name of the Application resource to get. Example: apps/myapp.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::appengine::v1::Application >	the result of the RPC. The response message type (google.appengine.v1.Application) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetApplication(google::appengine::v1::GetApplicationRequest const &, Options)

Gets information about an application.

Parameters
Name	Description
request	google::appengine::v1::GetApplicationRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.appengine.v1.GetApplicationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::appengine::v1::Application >	the result of the RPC. The response message type (google.appengine.v1.Application) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateApplication(google::appengine::v1::CreateApplicationRequest const &, Options)

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.

Parameters
Name	Description
request	google::appengine::v1::CreateApplicationRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.appengine.v1.CreateApplicationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::appengine::v1::Application > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.appengine.v1.Application proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateApplication(NoAwaitTag, google::appengine::v1::CreateApplicationRequest const &, Options)

Creates an App Engine application for a Google Cloud Platform project.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::appengine::v1::CreateApplicationRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateApplication(google::longrunning::Operation const &, Options)

Creates an App Engine application for a Google Cloud Platform project.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::appengine::v1::Application > >

UpdateApplication(google::appengine::v1::UpdateApplicationRequest const &, Options)

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
Name	Description
request	google::appengine::v1::UpdateApplicationRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.appengine.v1.UpdateApplicationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::appengine::v1::Application > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.appengine.v1.Application proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateApplication(NoAwaitTag, google::appengine::v1::UpdateApplicationRequest const &, Options)

Updates the specified Application resource.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::appengine::v1::UpdateApplicationRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

UpdateApplication(google::longrunning::Operation const &, Options)

Updates the specified Application resource.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::appengine::v1::Application > >

RepairApplication(google::appengine::v1::RepairApplicationRequest const &, Options)

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
Name	Description
request	google::appengine::v1::RepairApplicationRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.appengine.v1.RepairApplicationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::appengine::v1::Application > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.appengine.v1.Application proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RepairApplication(NoAwaitTag, google::appengine::v1::RepairApplicationRequest const &, Options)

Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::appengine::v1::RepairApplicationRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

RepairApplication(google::longrunning::Operation const &, Options)

Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::appengine::v1::Application > >