Class ApplicationsClient (2.55.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.78.0 (latest)
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 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.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.4
- 2.2.0
- 2.1.10
- 0.2.0
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().
| Method | Description | Method Variants |
|---|---|---|
GetApplication |
Gets information about an application. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateApplication |
Creates an App Engine application for a Google Cloud Platform project. Required fields:
For more information about App Engine applications, see Managing Projects, Applications, and Billing. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateApplication |
Updates the specified Application resource. You can update the following fields:
|
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RepairApplication |
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. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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.
Static Methods
create()
publicstaticfinalApplicationsClientcreate()Constructs an instance of ApplicationsClient with default settings.
| Returns | |
|---|---|
| Type | Description |
ApplicationsClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
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 |
settings |
ApplicationsSettings |
| Returns | |
|---|---|
| Type | Description |
ApplicationsClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
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 |
stub |
ApplicationsStub |
| Returns | |
|---|---|
| Type | Description |
ApplicationsClient |
|
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 |
settings |
ApplicationsSettings |
ApplicationsClient(ApplicationsStub stub)
protectedApplicationsClient(ApplicationsStubstub)| Parameter | |
|---|---|
| Name | Description |
stub |
ApplicationsStub |
Methods
awaitTermination(long duration, TimeUnit unit)
publicbooleanawaitTermination(longduration,TimeUnitunit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
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 |
OperationFuture<Application,OperationMetadataV1> |
|
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 |
UnaryCallable<CreateApplicationRequest,Operation> |
|
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 |
OperationCallable<CreateApplicationRequest,Application,OperationMetadataV1> |
|
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 |
Application |
|
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: |
| Returns | |
|---|---|
| Type | Description |
Application |
|
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 |
UnaryCallable<GetApplicationRequest,Application> |
|
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 |
OperationsClient |
|
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 |
OperationsClient |
|
getSettings()
publicfinalApplicationsSettingsgetSettings()| Returns | |
|---|---|
| Type | Description |
ApplicationsSettings |
|
getStub()
publicApplicationsStubgetStub()| Returns | |
|---|---|
| Type | Description |
ApplicationsStub |
|
isShutdown()
publicbooleanisShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
publicbooleanisTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
OperationFuture<Application,OperationMetadataV1> |
|
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 |
UnaryCallable<RepairApplicationRequest,Operation> |
|
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 |
OperationCallable<RepairApplicationRequest,Application,OperationMetadataV1> |
|
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 |
OperationFuture<Application,OperationMetadataV1> |
|
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 |
UnaryCallable<UpdateApplicationRequest,Operation> |
|
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 |
OperationCallable<UpdateApplicationRequest,Application,OperationMetadataV1> |
|