Class ApplicationsClient (2.8.0)

publicclass ApplicationsClientimplementsBackgroundResource

Service Description: Manages App Engine applications.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(ApplicationsClientapplicationsClient=ApplicationsClient.create()){
Stringname="name3373707";
Applicationresponse=applicationsClient.getApplication(name);
}

Note: close() needs to be called on the ApplicationsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ApplicationsSettings to create(). For example:

To customize credentials:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ApplicationsSettingsapplicationsSettings=
ApplicationsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ApplicationsClientapplicationsClient=ApplicationsClient.create(applicationsSettings);

To customize the endpoint:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ApplicationsSettingsapplicationsSettings=
ApplicationsSettings.newBuilder().setEndpoint(myEndpoint).build();
ApplicationsClientapplicationsClient=ApplicationsClient.create(applicationsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ApplicationsSettingsapplicationsSettings=ApplicationsSettings.newHttpJsonBuilder().build();
ApplicationsClientapplicationsClient=ApplicationsClient.create(applicationsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > ApplicationsClient

Implements

BackgroundResource

Static Methods

create()

publicstaticfinalApplicationsClientcreate()

Constructs an instance of ApplicationsClient with default settings.

Returns
Type Description
Exceptions
Type Description

create(ApplicationsSettings settings)

publicstaticfinalApplicationsClientcreate(ApplicationsSettingssettings)

Constructs an instance of ApplicationsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
Returns
Type Description
Exceptions
Type Description

create(ApplicationsStub stub)

publicstaticfinalApplicationsClientcreate(ApplicationsStubstub)

Constructs an instance of ApplicationsClient, using the given stub for making calls. This is for advanced usage - prefer using create(ApplicationsSettings).

Parameter
Name Description
Returns
Type Description

Constructors

ApplicationsClient(ApplicationsSettings settings)

protectedApplicationsClient(ApplicationsSettingssettings)

Constructs an instance of ApplicationsClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description

ApplicationsClient(ApplicationsStub stub)

protectedApplicationsClient(ApplicationsStubstub)
Parameter
Name Description

Methods

awaitTermination(long duration, TimeUnit unit)

publicbooleanawaitTermination(longduration,TimeUnitunit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
Exceptions
Type Description

close()

publicfinalvoidclose()

createApplicationAsync(CreateApplicationRequest request)

publicfinalOperationFuture<Application,OperationMetadataV1>createApplicationAsync(CreateApplicationRequestrequest)

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.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(ApplicationsClientapplicationsClient=ApplicationsClient.create()){
CreateApplicationRequestrequest=
CreateApplicationRequest.newBuilder()
.setApplication(Application.newBuilder().build())
.build();
Applicationresponse=applicationsClient.createApplicationAsync(request).get();
}
Parameter
Name Description
request CreateApplicationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description

createApplicationCallable()

publicfinalUnaryCallable<CreateApplicationRequest,Operation>createApplicationCallable()

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.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(ApplicationsClientapplicationsClient=ApplicationsClient.create()){
CreateApplicationRequestrequest=
CreateApplicationRequest.newBuilder()
.setApplication(Application.newBuilder().build())
.build();
ApiFuture<Operation>future=
applicationsClient.createApplicationCallable().futureCall(request);
// Do something.
Operationresponse=future.get();
}
Returns
Type Description

createApplicationOperationCallable()

publicfinalOperationCallable<CreateApplicationRequest,Application,OperationMetadataV1>createApplicationOperationCallable()

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.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(ApplicationsClientapplicationsClient=ApplicationsClient.create()){
CreateApplicationRequestrequest=
CreateApplicationRequest.newBuilder()
.setApplication(Application.newBuilder().build())
.build();
OperationFuture<Application,OperationMetadataV1>future=
applicationsClient.createApplicationOperationCallable().futureCall(request);
// Do something.
Applicationresponse=future.get();
}
Returns
Type Description

getApplication(GetApplicationRequest request)

publicfinalApplicationgetApplication(GetApplicationRequestrequest)

Gets information about an application.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(ApplicationsClientapplicationsClient=ApplicationsClient.create()){
GetApplicationRequestrequest=
GetApplicationRequest.newBuilder().setName("name3373707").build();
Applicationresponse=applicationsClient.getApplication(request);
}
Parameter
Name Description
request GetApplicationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description

getApplication(String name)

publicfinalApplicationgetApplication(Stringname)

Gets information about an application.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(ApplicationsClientapplicationsClient=ApplicationsClient.create()){
Stringname="name3373707";
Applicationresponse=applicationsClient.getApplication(name);
}
Parameter
Name Description
name String

Name of the Application resource to get. Example: apps/myapp.

Returns
Type Description

getApplicationCallable()

publicfinalUnaryCallable<GetApplicationRequest,Application>getApplicationCallable()

Gets information about an application.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(ApplicationsClientapplicationsClient=ApplicationsClient.create()){
GetApplicationRequestrequest=
GetApplicationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Application>future=
applicationsClient.getApplicationCallable().futureCall(request);
// Do something.
Applicationresponse=future.get();
}
Returns
Type Description

getHttpJsonOperationsClient()

publicfinalOperationsClientgetHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description

getOperationsClient()

publicfinalOperationsClientgetOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description

getSettings()

publicfinalApplicationsSettingsgetSettings()
Returns
Type Description

getStub()

publicApplicationsStubgetStub()
Returns
Type Description

isShutdown()

publicbooleanisShutdown()
Returns
Type Description

isTerminated()

publicbooleanisTerminated()
Returns
Type Description

repairApplicationAsync(RepairApplicationRequest request)

publicfinalOperationFuture<Application,OperationMetadataV1>repairApplicationAsync(RepairApplicationRequestrequest)

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.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(ApplicationsClientapplicationsClient=ApplicationsClient.create()){
RepairApplicationRequestrequest=
RepairApplicationRequest.newBuilder().setName("name3373707").build();
Applicationresponse=applicationsClient.repairApplicationAsync(request).get();
}
Parameter
Name Description
request RepairApplicationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description

repairApplicationCallable()

publicfinalUnaryCallable<RepairApplicationRequest,Operation>repairApplicationCallable()

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.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(ApplicationsClientapplicationsClient=ApplicationsClient.create()){
RepairApplicationRequestrequest=
RepairApplicationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Operation>future=
applicationsClient.repairApplicationCallable().futureCall(request);
// Do something.
Operationresponse=future.get();
}
Returns
Type Description

repairApplicationOperationCallable()

publicfinalOperationCallable<RepairApplicationRequest,Application,OperationMetadataV1>repairApplicationOperationCallable()

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.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(ApplicationsClientapplicationsClient=ApplicationsClient.create()){
RepairApplicationRequestrequest=
RepairApplicationRequest.newBuilder().setName("name3373707").build();
OperationFuture<Application,OperationMetadataV1>future=
applicationsClient.repairApplicationOperationCallable().futureCall(request);
// Do something.
Applicationresponse=future.get();
}
Returns
Type Description

shutdown()

publicvoidshutdown()

shutdownNow()

publicvoidshutdownNow()

updateApplicationAsync(UpdateApplicationRequest request)

publicfinalOperationFuture<Application,OperationMetadataV1>updateApplicationAsync(UpdateApplicationRequestrequest)

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.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(ApplicationsClientapplicationsClient=ApplicationsClient.create()){
UpdateApplicationRequestrequest=
UpdateApplicationRequest.newBuilder()
.setName("name3373707")
.setApplication(Application.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Applicationresponse=applicationsClient.updateApplicationAsync(request).get();
}
Parameter
Name Description
request UpdateApplicationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description

updateApplicationCallable()

publicfinalUnaryCallable<UpdateApplicationRequest,Operation>updateApplicationCallable()

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.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(ApplicationsClientapplicationsClient=ApplicationsClient.create()){
UpdateApplicationRequestrequest=
UpdateApplicationRequest.newBuilder()
.setName("name3373707")
.setApplication(Application.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Operation>future=
applicationsClient.updateApplicationCallable().futureCall(request);
// Do something.
Operationresponse=future.get();
}
Returns
Type Description

updateApplicationOperationCallable()

publicfinalOperationCallable<UpdateApplicationRequest,Application,OperationMetadataV1>updateApplicationOperationCallable()

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.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(ApplicationsClientapplicationsClient=ApplicationsClient.create()){
UpdateApplicationRequestrequest=
UpdateApplicationRequest.newBuilder()
.setName("name3373707")
.setApplication(Application.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
OperationFuture<Application,OperationMetadataV1>future=
applicationsClient.updateApplicationOperationCallable().futureCall(request);
// Do something.
Applicationresponse=future.get();
}
Returns
Type Description

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.