Class AppPlatformClient (0.9.0)

GitHub RepositoryProduct ReferenceRPC Documentation

Service Description: Service describing handlers for resources

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]");
   Application response = appPlatformClient.getApplication(name);
 }
 

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

Methods
Method Description Method Variants

ListApplications

Lists Applications in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listApplications(ListApplicationsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listApplications(LocationName parent)

  • listApplications(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listApplicationsPagedCallable()

  • listApplicationsCallable()

GetApplication

Gets details of a single Application.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getApplication(GetApplicationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getApplication(ApplicationName name)

  • getApplication(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getApplicationCallable()

CreateApplication

Creates a new Application in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createApplicationAsync(CreateApplicationRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createApplicationAsync(LocationName parent, Application application)

  • createApplicationAsync(String parent, Application application)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createApplicationOperationCallable()

  • createApplicationCallable()

UpdateApplication

Updates the parameters of a single Application.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateApplicationAsync(UpdateApplicationRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateApplicationAsync(Application application, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateApplicationOperationCallable()

  • updateApplicationCallable()

DeleteApplication

Deletes a single Application.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteApplicationAsync(DeleteApplicationRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteApplicationAsync(ApplicationName name)

  • deleteApplicationAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteApplicationOperationCallable()

  • deleteApplicationCallable()

DeployApplication

Deploys a single Application.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deployApplicationAsync(DeployApplicationRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deployApplicationAsync(ApplicationName name)

  • deployApplicationAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deployApplicationOperationCallable()

  • deployApplicationCallable()

UndeployApplication

Undeploys a single Application.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • undeployApplicationAsync(UndeployApplicationRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • undeployApplicationAsync(ApplicationName name)

  • undeployApplicationAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • undeployApplicationOperationCallable()

  • undeployApplicationCallable()

AddApplicationStreamInput

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • addApplicationStreamInputAsync(AddApplicationStreamInputRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • addApplicationStreamInputAsync(ApplicationName name)

  • addApplicationStreamInputAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • addApplicationStreamInputOperationCallable()

  • addApplicationStreamInputCallable()

RemoveApplicationStreamInput

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • removeApplicationStreamInputAsync(RemoveApplicationStreamInputRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • removeApplicationStreamInputAsync(ApplicationName name)

  • removeApplicationStreamInputAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • removeApplicationStreamInputOperationCallable()

  • removeApplicationStreamInputCallable()

UpdateApplicationStreamInput

Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed. For CreateOrUpdate behavior, set allow_missing to true.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateApplicationStreamInputAsync(UpdateApplicationStreamInputRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateApplicationStreamInputAsync(ApplicationName name)

  • updateApplicationStreamInputAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateApplicationStreamInputOperationCallable()

  • updateApplicationStreamInputCallable()

ListInstances

Lists Instances in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listInstances(ListInstancesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listInstances(ApplicationName parent)

  • listInstances(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listInstancesPagedCallable()

  • listInstancesCallable()

GetInstance

Gets details of a single Instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getInstance(GetInstanceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getInstance(InstanceName name)

  • getInstance(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getInstanceCallable()

CreateApplicationInstances

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createApplicationInstancesAsync(CreateApplicationInstancesRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createApplicationInstancesAsync(ApplicationName name)

  • createApplicationInstancesAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createApplicationInstancesOperationCallable()

  • createApplicationInstancesCallable()

DeleteApplicationInstances

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteApplicationInstancesAsync(DeleteApplicationInstancesRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteApplicationInstancesAsync(ApplicationName name)

  • deleteApplicationInstancesAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteApplicationInstancesOperationCallable()

  • deleteApplicationInstancesCallable()

UpdateApplicationInstances

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateApplicationInstancesAsync(UpdateApplicationInstancesRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateApplicationInstancesAsync(ApplicationName name, List<UpdateApplicationInstancesRequest.UpdateApplicationInstance> applicationInstances)

  • updateApplicationInstancesAsync(String name, List<UpdateApplicationInstancesRequest.UpdateApplicationInstance> applicationInstances)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateApplicationInstancesOperationCallable()

  • updateApplicationInstancesCallable()

ListDrafts

Lists Drafts in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listDrafts(ListDraftsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listDrafts(ApplicationName parent)

  • listDrafts(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listDraftsPagedCallable()

  • listDraftsCallable()

GetDraft

Gets details of a single Draft.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDraft(GetDraftRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDraft(DraftName name)

  • getDraft(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDraftCallable()

CreateDraft

Creates a new Draft in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createDraftAsync(CreateDraftRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createDraftAsync(ApplicationName parent, Draft draft, String draftId)

  • createDraftAsync(String parent, Draft draft, String draftId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createDraftOperationCallable()

  • createDraftCallable()

UpdateDraft

Updates the parameters of a single Draft.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateDraftAsync(UpdateDraftRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateDraftAsync(Draft draft, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateDraftOperationCallable()

  • updateDraftCallable()

DeleteDraft

Deletes a single Draft.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteDraftAsync(DeleteDraftRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteDraftAsync(DraftName name)

  • deleteDraftAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteDraftOperationCallable()

  • deleteDraftCallable()

ListProcessors

Lists Processors in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listProcessors(ListProcessorsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listProcessors(LocationName parent)

  • listProcessors(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listProcessorsPagedCallable()

  • listProcessorsCallable()

ListPrebuiltProcessors

ListPrebuiltProcessors is a custom pass-through verb that Lists Prebuilt Processors.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listPrebuiltProcessors(ListPrebuiltProcessorsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listPrebuiltProcessors(LocationName parent)

  • listPrebuiltProcessors(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPrebuiltProcessorsCallable()

GetProcessor

Gets details of a single Processor.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getProcessor(GetProcessorRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getProcessor(ProcessorName name)

  • getProcessor(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getProcessorCallable()

CreateProcessor

Creates a new Processor in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createProcessorAsync(CreateProcessorRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createProcessorAsync(LocationName parent, Processor processor, String processorId)

  • createProcessorAsync(String parent, Processor processor, String processorId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createProcessorOperationCallable()

  • createProcessorCallable()

UpdateProcessor

Updates the parameters of a single Processor.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateProcessorAsync(UpdateProcessorRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateProcessorAsync(Processor processor, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateProcessorOperationCallable()

  • updateProcessorCallable()

DeleteProcessor

Deletes a single Processor.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteProcessorAsync(DeleteProcessorRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteProcessorAsync(ProcessorName name)

  • deleteProcessorAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteProcessorOperationCallable()

  • deleteProcessorCallable()

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 AppPlatformSettings 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
 AppPlatformSettings appPlatformSettings =
     AppPlatformSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AppPlatformClient appPlatformClient = AppPlatformClient.create(appPlatformSettings);
 

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
 AppPlatformSettings appPlatformSettings =
     AppPlatformSettings.newBuilder().setEndpoint(myEndpoint).build();
 AppPlatformClient appPlatformClient = AppPlatformClient.create(appPlatformSettings);
 

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
 AppPlatformSettings appPlatformSettings = AppPlatformSettings.newHttpJsonBuilder().build();
 AppPlatformClient appPlatformClient = AppPlatformClient.create(appPlatformSettings);
 

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

Inheritance

java.lang.Object > AppPlatformClient

Static Methods

create()

public static final AppPlatformClient create()

Constructs an instance of AppPlatformClient with default settings.

Returns
Type Description
AppPlatformClient
Exceptions
Type Description
IOException

create(AppPlatformSettings settings)

public static final AppPlatformClient create(AppPlatformSettings settings)

Constructs an instance of AppPlatformClient, 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 AppPlatformSettings
Returns
Type Description
AppPlatformClient
Exceptions
Type Description
IOException

create(AppPlatformStub stub)

public static final AppPlatformClient create(AppPlatformStub stub)

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

Parameter
Name Description
stub AppPlatformStub
Returns
Type Description
AppPlatformClient

Constructors

AppPlatformClient(AppPlatformSettings settings)

protected AppPlatformClient(AppPlatformSettings settings)

Constructs an instance of AppPlatformClient, 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 AppPlatformSettings

AppPlatformClient(AppPlatformStub stub)

protected AppPlatformClient(AppPlatformStub stub)
Parameter
Name Description
stub AppPlatformStub

Methods

addApplicationStreamInputAsync(AddApplicationStreamInputRequest request)

public final OperationFuture<AddApplicationStreamInputResponse,OperationMetadata> addApplicationStreamInputAsync(AddApplicationStreamInputRequest request)

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   AddApplicationStreamInputRequest request =
       AddApplicationStreamInputRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllApplicationStreamInputs(new ArrayList<ApplicationStreamInput>())
           .setRequestId("requestId693933066")
           .build();
   AddApplicationStreamInputResponse response =
       appPlatformClient.addApplicationStreamInputAsync(request).get();
 }
 
Parameter
Name Description
request AddApplicationStreamInputRequest

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

Returns
Type Description
OperationFuture<AddApplicationStreamInputResponse,OperationMetadata>

addApplicationStreamInputAsync(ApplicationName name)

public final OperationFuture<AddApplicationStreamInputResponse,OperationMetadata> addApplicationStreamInputAsync(ApplicationName name)

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]");
   AddApplicationStreamInputResponse response =
       appPlatformClient.addApplicationStreamInputAsync(name).get();
 }
 
Parameter
Name Description
name ApplicationName

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

Returns
Type Description
OperationFuture<AddApplicationStreamInputResponse,OperationMetadata>

addApplicationStreamInputAsync(String name)

public final OperationFuture<AddApplicationStreamInputResponse,OperationMetadata> addApplicationStreamInputAsync(String name)

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString();
   AddApplicationStreamInputResponse response =
       appPlatformClient.addApplicationStreamInputAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

Returns
Type Description
OperationFuture<AddApplicationStreamInputResponse,OperationMetadata>

addApplicationStreamInputCallable()

public final UnaryCallable<AddApplicationStreamInputRequest,Operation> addApplicationStreamInputCallable()

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   AddApplicationStreamInputRequest request =
       AddApplicationStreamInputRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllApplicationStreamInputs(new ArrayList<ApplicationStreamInput>())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       appPlatformClient.addApplicationStreamInputCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<AddApplicationStreamInputRequest,Operation>

addApplicationStreamInputOperationCallable()

public final OperationCallable<AddApplicationStreamInputRequest,AddApplicationStreamInputResponse,OperationMetadata> addApplicationStreamInputOperationCallable()

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   AddApplicationStreamInputRequest request =
       AddApplicationStreamInputRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllApplicationStreamInputs(new ArrayList<ApplicationStreamInput>())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<AddApplicationStreamInputResponse, OperationMetadata> future =
       appPlatformClient.addApplicationStreamInputOperationCallable().futureCall(request);
   // Do something.
   AddApplicationStreamInputResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<AddApplicationStreamInputRequest,AddApplicationStreamInputResponse,OperationMetadata>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createApplicationAsync(CreateApplicationRequest request)

public final OperationFuture<Application,OperationMetadata> createApplicationAsync(CreateApplicationRequest request)

Creates a new Application in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   CreateApplicationRequest request =
       CreateApplicationRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setApplicationId("applicationId-1011352949")
           .setApplication(Application.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Application response = appPlatformClient.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,OperationMetadata>

createApplicationAsync(LocationName parent, Application application)

public final OperationFuture<Application,OperationMetadata> createApplicationAsync(LocationName parent, Application application)

Creates a new Application in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Application application = Application.newBuilder().build();
   Application response = appPlatformClient.createApplicationAsync(parent, application).get();
 }
 
Parameters
Name Description
parent LocationName

Required. Value for parent.

application Application

Required. The resource being created.

Returns
Type Description
OperationFuture<Application,OperationMetadata>

createApplicationAsync(String parent, Application application)

public final OperationFuture<Application,OperationMetadata> createApplicationAsync(String parent, Application application)

Creates a new Application in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Application application = Application.newBuilder().build();
   Application response = appPlatformClient.createApplicationAsync(parent, application).get();
 }
 
Parameters
Name Description
parent String

Required. Value for parent.

application Application

Required. The resource being created.

Returns
Type Description
OperationFuture<Application,OperationMetadata>

createApplicationCallable()

public final UnaryCallable<CreateApplicationRequest,Operation> createApplicationCallable()

Creates a new Application in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   CreateApplicationRequest request =
       CreateApplicationRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setApplicationId("applicationId-1011352949")
           .setApplication(Application.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       appPlatformClient.createApplicationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateApplicationRequest,Operation>

createApplicationInstancesAsync(ApplicationName name)

public final OperationFuture<CreateApplicationInstancesResponse,OperationMetadata> createApplicationInstancesAsync(ApplicationName name)

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]");
   CreateApplicationInstancesResponse response =
       appPlatformClient.createApplicationInstancesAsync(name).get();
 }
 
Parameter
Name Description
name ApplicationName

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

Returns
Type Description
OperationFuture<CreateApplicationInstancesResponse,OperationMetadata>

createApplicationInstancesAsync(CreateApplicationInstancesRequest request)

public final OperationFuture<CreateApplicationInstancesResponse,OperationMetadata> createApplicationInstancesAsync(CreateApplicationInstancesRequest request)

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   CreateApplicationInstancesRequest request =
       CreateApplicationInstancesRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllApplicationInstances(new ArrayList<ApplicationInstance>())
           .setRequestId("requestId693933066")
           .build();
   CreateApplicationInstancesResponse response =
       appPlatformClient.createApplicationInstancesAsync(request).get();
 }
 
Parameter
Name Description
request CreateApplicationInstancesRequest

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

Returns
Type Description
OperationFuture<CreateApplicationInstancesResponse,OperationMetadata>

createApplicationInstancesAsync(String name)

public final OperationFuture<CreateApplicationInstancesResponse,OperationMetadata> createApplicationInstancesAsync(String name)

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString();
   CreateApplicationInstancesResponse response =
       appPlatformClient.createApplicationInstancesAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

Returns
Type Description
OperationFuture<CreateApplicationInstancesResponse,OperationMetadata>

createApplicationInstancesCallable()

public final UnaryCallable<CreateApplicationInstancesRequest,Operation> createApplicationInstancesCallable()

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   CreateApplicationInstancesRequest request =
       CreateApplicationInstancesRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllApplicationInstances(new ArrayList<ApplicationInstance>())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       appPlatformClient.createApplicationInstancesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateApplicationInstancesRequest,Operation>

createApplicationInstancesOperationCallable()

public final OperationCallable<CreateApplicationInstancesRequest,CreateApplicationInstancesResponse,OperationMetadata> createApplicationInstancesOperationCallable()

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   CreateApplicationInstancesRequest request =
       CreateApplicationInstancesRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllApplicationInstances(new ArrayList<ApplicationInstance>())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<CreateApplicationInstancesResponse, OperationMetadata> future =
       appPlatformClient.createApplicationInstancesOperationCallable().futureCall(request);
   // Do something.
   CreateApplicationInstancesResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateApplicationInstancesRequest,CreateApplicationInstancesResponse,OperationMetadata>

createApplicationOperationCallable()

public final OperationCallable<CreateApplicationRequest,Application,OperationMetadata> createApplicationOperationCallable()

Creates a new Application in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   CreateApplicationRequest request =
       CreateApplicationRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setApplicationId("applicationId-1011352949")
           .setApplication(Application.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Application, OperationMetadata> future =
       appPlatformClient.createApplicationOperationCallable().futureCall(request);
   // Do something.
   Application response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateApplicationRequest,Application,OperationMetadata>

createDraftAsync(ApplicationName parent, Draft draft, String draftId)

public final OperationFuture<Draft,OperationMetadata> createDraftAsync(ApplicationName parent, Draft draft, String draftId)

Creates a new Draft in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ApplicationName parent = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]");
   Draft draft = Draft.newBuilder().build();
   String draftId = "draftId1912512156";
   Draft response = appPlatformClient.createDraftAsync(parent, draft, draftId).get();
 }
 
Parameters
Name Description
parent ApplicationName

Required. Value for parent.

draft Draft

Required. The resource being created.

draftId String

Required. Id of the requesting object.

Returns
Type Description
OperationFuture<Draft,OperationMetadata>

createDraftAsync(CreateDraftRequest request)

public final OperationFuture<Draft,OperationMetadata> createDraftAsync(CreateDraftRequest request)

Creates a new Draft in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   CreateDraftRequest request =
       CreateDraftRequest.newBuilder()
           .setParent(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setDraftId("draftId1912512156")
           .setDraft(Draft.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Draft response = appPlatformClient.createDraftAsync(request).get();
 }
 
Parameter
Name Description
request CreateDraftRequest

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

Returns
Type Description
OperationFuture<Draft,OperationMetadata>

createDraftAsync(String parent, Draft draft, String draftId)

public final OperationFuture<Draft,OperationMetadata> createDraftAsync(String parent, Draft draft, String draftId)

Creates a new Draft in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String parent = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString();
   Draft draft = Draft.newBuilder().build();
   String draftId = "draftId1912512156";
   Draft response = appPlatformClient.createDraftAsync(parent, draft, draftId).get();
 }
 
Parameters
Name Description
parent String

Required. Value for parent.

draft Draft

Required. The resource being created.

draftId String

Required. Id of the requesting object.

Returns
Type Description
OperationFuture<Draft,OperationMetadata>

createDraftCallable()

public final UnaryCallable<CreateDraftRequest,Operation> createDraftCallable()

Creates a new Draft in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   CreateDraftRequest request =
       CreateDraftRequest.newBuilder()
           .setParent(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setDraftId("draftId1912512156")
           .setDraft(Draft.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = appPlatformClient.createDraftCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateDraftRequest,Operation>

createDraftOperationCallable()

public final OperationCallable<CreateDraftRequest,Draft,OperationMetadata> createDraftOperationCallable()

Creates a new Draft in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   CreateDraftRequest request =
       CreateDraftRequest.newBuilder()
           .setParent(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setDraftId("draftId1912512156")
           .setDraft(Draft.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Draft, OperationMetadata> future =
       appPlatformClient.createDraftOperationCallable().futureCall(request);
   // Do something.
   Draft response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateDraftRequest,Draft,OperationMetadata>

createProcessorAsync(CreateProcessorRequest request)

public final OperationFuture<Processor,OperationMetadata> createProcessorAsync(CreateProcessorRequest request)

Creates a new Processor in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   CreateProcessorRequest request =
       CreateProcessorRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProcessorId("processorId203323725")
           .setProcessor(Processor.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Processor response = appPlatformClient.createProcessorAsync(request).get();
 }
 
Parameter
Name Description
request CreateProcessorRequest

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

Returns
Type Description
OperationFuture<Processor,OperationMetadata>

createProcessorAsync(LocationName parent, Processor processor, String processorId)

public final OperationFuture<Processor,OperationMetadata> createProcessorAsync(LocationName parent, Processor processor, String processorId)

Creates a new Processor in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Processor processor = Processor.newBuilder().build();
   String processorId = "processorId203323725";
   Processor response =
       appPlatformClient.createProcessorAsync(parent, processor, processorId).get();
 }
 
Parameters
Name Description
parent LocationName

Required. Value for parent.

processor Processor

Required. The resource being created.

processorId String

Required. Id of the requesting object.

Returns
Type Description
OperationFuture<Processor,OperationMetadata>

createProcessorAsync(String parent, Processor processor, String processorId)

public final OperationFuture<Processor,OperationMetadata> createProcessorAsync(String parent, Processor processor, String processorId)

Creates a new Processor in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Processor processor = Processor.newBuilder().build();
   String processorId = "processorId203323725";
   Processor response =
       appPlatformClient.createProcessorAsync(parent, processor, processorId).get();
 }
 
Parameters
Name Description
parent String

Required. Value for parent.

processor Processor

Required. The resource being created.

processorId String

Required. Id of the requesting object.

Returns
Type Description
OperationFuture<Processor,OperationMetadata>

createProcessorCallable()

public final UnaryCallable<CreateProcessorRequest,Operation> createProcessorCallable()

Creates a new Processor in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   CreateProcessorRequest request =
       CreateProcessorRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProcessorId("processorId203323725")
           .setProcessor(Processor.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = appPlatformClient.createProcessorCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateProcessorRequest,Operation>

createProcessorOperationCallable()

public final OperationCallable<CreateProcessorRequest,Processor,OperationMetadata> createProcessorOperationCallable()

Creates a new Processor in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   CreateProcessorRequest request =
       CreateProcessorRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProcessorId("processorId203323725")
           .setProcessor(Processor.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Processor, OperationMetadata> future =
       appPlatformClient.createProcessorOperationCallable().futureCall(request);
   // Do something.
   Processor response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateProcessorRequest,Processor,OperationMetadata>

deleteApplicationAsync(ApplicationName name)

public final OperationFuture<Empty,OperationMetadata> deleteApplicationAsync(ApplicationName name)

Deletes a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]");
   appPlatformClient.deleteApplicationAsync(name).get();
 }
 
Parameter
Name Description
name ApplicationName

Required. Name of the resource.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteApplicationAsync(DeleteApplicationRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteApplicationAsync(DeleteApplicationRequest request)

Deletes a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeleteApplicationRequest request =
       DeleteApplicationRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setRequestId("requestId693933066")
           .setForce(true)
           .build();
   appPlatformClient.deleteApplicationAsync(request).get();
 }
 
Parameter
Name Description
request DeleteApplicationRequest

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteApplicationAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteApplicationAsync(String name)

Deletes a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString();
   appPlatformClient.deleteApplicationAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteApplicationCallable()

public final UnaryCallable<DeleteApplicationRequest,Operation> deleteApplicationCallable()

Deletes a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeleteApplicationRequest request =
       DeleteApplicationRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setRequestId("requestId693933066")
           .setForce(true)
           .build();
   ApiFuture<Operation> future =
       appPlatformClient.deleteApplicationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteApplicationRequest,Operation>

deleteApplicationInstancesAsync(ApplicationName name)

public final OperationFuture<Instance,OperationMetadata> deleteApplicationInstancesAsync(ApplicationName name)

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]");
   Instance response = appPlatformClient.deleteApplicationInstancesAsync(name).get();
 }
 
Parameter
Name Description
name ApplicationName

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

deleteApplicationInstancesAsync(DeleteApplicationInstancesRequest request)

public final OperationFuture<Instance,OperationMetadata> deleteApplicationInstancesAsync(DeleteApplicationInstancesRequest request)

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeleteApplicationInstancesRequest request =
       DeleteApplicationInstancesRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllInstanceIds(new ArrayList<String>())
           .setRequestId("requestId693933066")
           .build();
   Instance response = appPlatformClient.deleteApplicationInstancesAsync(request).get();
 }
 
Parameter
Name Description
request DeleteApplicationInstancesRequest

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

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

deleteApplicationInstancesAsync(String name)

public final OperationFuture<Instance,OperationMetadata> deleteApplicationInstancesAsync(String name)

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString();
   Instance response = appPlatformClient.deleteApplicationInstancesAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

deleteApplicationInstancesCallable()

public final UnaryCallable<DeleteApplicationInstancesRequest,Operation> deleteApplicationInstancesCallable()

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeleteApplicationInstancesRequest request =
       DeleteApplicationInstancesRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllInstanceIds(new ArrayList<String>())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       appPlatformClient.deleteApplicationInstancesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteApplicationInstancesRequest,Operation>

deleteApplicationInstancesOperationCallable()

public final OperationCallable<DeleteApplicationInstancesRequest,Instance,OperationMetadata> deleteApplicationInstancesOperationCallable()

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeleteApplicationInstancesRequest request =
       DeleteApplicationInstancesRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllInstanceIds(new ArrayList<String>())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Instance, OperationMetadata> future =
       appPlatformClient.deleteApplicationInstancesOperationCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteApplicationInstancesRequest,Instance,OperationMetadata>

deleteApplicationOperationCallable()

public final OperationCallable<DeleteApplicationRequest,Empty,OperationMetadata> deleteApplicationOperationCallable()

Deletes a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeleteApplicationRequest request =
       DeleteApplicationRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setRequestId("requestId693933066")
           .setForce(true)
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       appPlatformClient.deleteApplicationOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteApplicationRequest,Empty,OperationMetadata>

deleteDraftAsync(DeleteDraftRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteDraftAsync(DeleteDraftRequest request)

Deletes a single Draft.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeleteDraftRequest request =
       DeleteDraftRequest.newBuilder()
           .setName(
               DraftName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]", "[DRAFT]").toString())
           .setRequestId("requestId693933066")
           .build();
   appPlatformClient.deleteDraftAsync(request).get();
 }
 
Parameter
Name Description
request DeleteDraftRequest

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteDraftAsync(DraftName name)

public final OperationFuture<Empty,OperationMetadata> deleteDraftAsync(DraftName name)

Deletes a single Draft.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DraftName name = DraftName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]", "[DRAFT]");
   appPlatformClient.deleteDraftAsync(name).get();
 }
 
Parameter
Name Description
name DraftName

Required. Name of the resource.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteDraftAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteDraftAsync(String name)

Deletes a single Draft.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name = DraftName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]", "[DRAFT]").toString();
   appPlatformClient.deleteDraftAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteDraftCallable()

public final UnaryCallable<DeleteDraftRequest,Operation> deleteDraftCallable()

Deletes a single Draft.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeleteDraftRequest request =
       DeleteDraftRequest.newBuilder()
           .setName(
               DraftName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]", "[DRAFT]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = appPlatformClient.deleteDraftCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteDraftRequest,Operation>

deleteDraftOperationCallable()

public final OperationCallable<DeleteDraftRequest,Empty,OperationMetadata> deleteDraftOperationCallable()

Deletes a single Draft.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeleteDraftRequest request =
       DeleteDraftRequest.newBuilder()
           .setName(
               DraftName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]", "[DRAFT]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       appPlatformClient.deleteDraftOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteDraftRequest,Empty,OperationMetadata>

deleteProcessorAsync(DeleteProcessorRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteProcessorAsync(DeleteProcessorRequest request)

Deletes a single Processor.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeleteProcessorRequest request =
       DeleteProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setRequestId("requestId693933066")
           .build();
   appPlatformClient.deleteProcessorAsync(request).get();
 }
 
Parameter
Name Description
request DeleteProcessorRequest

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteProcessorAsync(ProcessorName name)

public final OperationFuture<Empty,OperationMetadata> deleteProcessorAsync(ProcessorName name)

Deletes a single Processor.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ProcessorName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
   appPlatformClient.deleteProcessorAsync(name).get();
 }
 
Parameter
Name Description
name ProcessorName

Required. Name of the resource

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteProcessorAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteProcessorAsync(String name)

Deletes a single Processor.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
   appPlatformClient.deleteProcessorAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. Name of the resource

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteProcessorCallable()

public final UnaryCallable<DeleteProcessorRequest,Operation> deleteProcessorCallable()

Deletes a single Processor.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeleteProcessorRequest request =
       DeleteProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = appPlatformClient.deleteProcessorCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteProcessorRequest,Operation>

deleteProcessorOperationCallable()

public final OperationCallable<DeleteProcessorRequest,Empty,OperationMetadata> deleteProcessorOperationCallable()

Deletes a single Processor.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeleteProcessorRequest request =
       DeleteProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       appPlatformClient.deleteProcessorOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteProcessorRequest,Empty,OperationMetadata>

deployApplicationAsync(ApplicationName name)

public final OperationFuture<DeployApplicationResponse,OperationMetadata> deployApplicationAsync(ApplicationName name)

Deploys a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]");
   DeployApplicationResponse response = appPlatformClient.deployApplicationAsync(name).get();
 }
 
Parameter
Name Description
name ApplicationName

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

Returns
Type Description
OperationFuture<DeployApplicationResponse,OperationMetadata>

deployApplicationAsync(DeployApplicationRequest request)

public final OperationFuture<DeployApplicationResponse,OperationMetadata> deployApplicationAsync(DeployApplicationRequest request)

Deploys a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeployApplicationRequest request =
       DeployApplicationRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .setEnableMonitoring(true)
           .build();
   DeployApplicationResponse response = appPlatformClient.deployApplicationAsync(request).get();
 }
 
Parameter
Name Description
request DeployApplicationRequest

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

Returns
Type Description
OperationFuture<DeployApplicationResponse,OperationMetadata>

deployApplicationAsync(String name)

public final OperationFuture<DeployApplicationResponse,OperationMetadata> deployApplicationAsync(String name)

Deploys a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString();
   DeployApplicationResponse response = appPlatformClient.deployApplicationAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

Returns
Type Description
OperationFuture<DeployApplicationResponse,OperationMetadata>

deployApplicationCallable()

public final UnaryCallable<DeployApplicationRequest,Operation> deployApplicationCallable()

Deploys a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeployApplicationRequest request =
       DeployApplicationRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .setEnableMonitoring(true)
           .build();
   ApiFuture<Operation> future =
       appPlatformClient.deployApplicationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<DeployApplicationRequest,Operation>

deployApplicationOperationCallable()

public final OperationCallable<DeployApplicationRequest,DeployApplicationResponse,OperationMetadata> deployApplicationOperationCallable()

Deploys a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DeployApplicationRequest request =
       DeployApplicationRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .setEnableMonitoring(true)
           .build();
   OperationFuture<DeployApplicationResponse, OperationMetadata> future =
       appPlatformClient.deployApplicationOperationCallable().futureCall(request);
   // Do something.
   DeployApplicationResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<DeployApplicationRequest,DeployApplicationResponse,OperationMetadata>

getApplication(ApplicationName name)

public final Application getApplication(ApplicationName name)

Gets details of a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]");
   Application response = appPlatformClient.getApplication(name);
 }
 
Parameter
Name Description
name ApplicationName

Required. Name of the resource.

Returns
Type Description
Application

getApplication(GetApplicationRequest request)

public final Application getApplication(GetApplicationRequest request)

Gets details of a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   GetApplicationRequest request =
       GetApplicationRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .build();
   Application response = appPlatformClient.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)

public final Application getApplication(String name)

Gets details of a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString();
   Application response = appPlatformClient.getApplication(name);
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
Application

getApplicationCallable()

public final UnaryCallable<GetApplicationRequest,Application> getApplicationCallable()

Gets details of a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   GetApplicationRequest request =
       GetApplicationRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .build();
   ApiFuture<Application> future =
       appPlatformClient.getApplicationCallable().futureCall(request);
   // Do something.
   Application response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetApplicationRequest,Application>

getDraft(DraftName name)

public final Draft getDraft(DraftName name)

Gets details of a single Draft.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   DraftName name = DraftName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]", "[DRAFT]");
   Draft response = appPlatformClient.getDraft(name);
 }
 
Parameter
Name Description
name DraftName

Required. Name of the resource.

Returns
Type Description
Draft

getDraft(GetDraftRequest request)

public final Draft getDraft(GetDraftRequest request)

Gets details of a single Draft.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   GetDraftRequest request =
       GetDraftRequest.newBuilder()
           .setName(
               DraftName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]", "[DRAFT]").toString())
           .build();
   Draft response = appPlatformClient.getDraft(request);
 }
 
Parameter
Name Description
request GetDraftRequest

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

Returns
Type Description
Draft

getDraft(String name)

public final Draft getDraft(String name)

Gets details of a single Draft.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name = DraftName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]", "[DRAFT]").toString();
   Draft response = appPlatformClient.getDraft(name);
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
Draft

getDraftCallable()

public final UnaryCallable<GetDraftRequest,Draft> getDraftCallable()

Gets details of a single Draft.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   GetDraftRequest request =
       GetDraftRequest.newBuilder()
           .setName(
               DraftName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]", "[DRAFT]").toString())
           .build();
   ApiFuture<Draft> future = appPlatformClient.getDraftCallable().futureCall(request);
   // Do something.
   Draft response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetDraftRequest,Draft>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

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

getInstance(GetInstanceRequest request)

public final Instance getInstance(GetInstanceRequest request)

Gets details of a single Instance.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(
               InstanceName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]", "[INSTANCE]")
                   .toString())
           .build();
   Instance response = appPlatformClient.getInstance(request);
 }
 
Parameter
Name Description
request GetInstanceRequest

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

Returns
Type Description
Instance

getInstance(InstanceName name)

public final Instance getInstance(InstanceName name)

Gets details of a single Instance.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]", "[INSTANCE]");
   Instance response = appPlatformClient.getInstance(name);
 }
 
Parameter
Name Description
name InstanceName

Required. Name of the resource.

Returns
Type Description
Instance

getInstance(String name)

public final Instance getInstance(String name)

Gets details of a single Instance.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name =
       InstanceName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]", "[INSTANCE]").toString();
   Instance response = appPlatformClient.getInstance(name);
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
Instance

getInstanceCallable()

public final UnaryCallable<GetInstanceRequest,Instance> getInstanceCallable()

Gets details of a single Instance.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(
               InstanceName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]", "[INSTANCE]")
                   .toString())
           .build();
   ApiFuture<Instance> future = appPlatformClient.getInstanceCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetInstanceRequest,Instance>

getOperationsClient()

public final OperationsClient getOperationsClient()

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

getProcessor(GetProcessorRequest request)

public final Processor getProcessor(GetProcessorRequest request)

Gets details of a single Processor.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   GetProcessorRequest request =
       GetProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .build();
   Processor response = appPlatformClient.getProcessor(request);
 }
 
Parameter
Name Description
request GetProcessorRequest

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

Returns
Type Description
Processor

getProcessor(ProcessorName name)

public final Processor getProcessor(ProcessorName name)

Gets details of a single Processor.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ProcessorName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
   Processor response = appPlatformClient.getProcessor(name);
 }
 
Parameter
Name Description
name ProcessorName

Required. Name of the resource.

Returns
Type Description
Processor

getProcessor(String name)

public final Processor getProcessor(String name)

Gets details of a single Processor.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
   Processor response = appPlatformClient.getProcessor(name);
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
Processor

getProcessorCallable()

public final UnaryCallable<GetProcessorRequest,Processor> getProcessorCallable()

Gets details of a single Processor.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   GetProcessorRequest request =
       GetProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .build();
   ApiFuture<Processor> future = appPlatformClient.getProcessorCallable().futureCall(request);
   // Do something.
   Processor response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetProcessorRequest,Processor>

getSettings()

public final AppPlatformSettings getSettings()
Returns
Type Description
AppPlatformSettings

getStub()

public AppPlatformStub getStub()
Returns
Type Description
AppPlatformStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listApplications(ListApplicationsRequest request)

public final AppPlatformClient.ListApplicationsPagedResponse listApplications(ListApplicationsRequest request)

Lists Applications in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ListApplicationsRequest request =
       ListApplicationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Application element : appPlatformClient.listApplications(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListApplicationsRequest

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

Returns
Type Description
AppPlatformClient.ListApplicationsPagedResponse

listApplications(LocationName parent)

public final AppPlatformClient.ListApplicationsPagedResponse listApplications(LocationName parent)

Lists Applications in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Application element : appPlatformClient.listApplications(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. Parent value for ListApplicationsRequest.

Returns
Type Description
AppPlatformClient.ListApplicationsPagedResponse

listApplications(String parent)

public final AppPlatformClient.ListApplicationsPagedResponse listApplications(String parent)

Lists Applications in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Application element : appPlatformClient.listApplications(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListApplicationsRequest.

Returns
Type Description
AppPlatformClient.ListApplicationsPagedResponse

listApplicationsCallable()

public final UnaryCallable<ListApplicationsRequest,ListApplicationsResponse> listApplicationsCallable()

Lists Applications in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ListApplicationsRequest request =
       ListApplicationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListApplicationsResponse response =
         appPlatformClient.listApplicationsCallable().call(request);
     for (Application element : response.getApplicationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListApplicationsRequest,ListApplicationsResponse>

listApplicationsPagedCallable()

public final UnaryCallable<ListApplicationsRequest,AppPlatformClient.ListApplicationsPagedResponse> listApplicationsPagedCallable()

Lists Applications in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ListApplicationsRequest request =
       ListApplicationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Application> future =
       appPlatformClient.listApplicationsPagedCallable().futureCall(request);
   // Do something.
   for (Application element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListApplicationsRequest,ListApplicationsPagedResponse>

listDrafts(ApplicationName parent)

public final AppPlatformClient.ListDraftsPagedResponse listDrafts(ApplicationName parent)

Lists Drafts in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ApplicationName parent = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]");
   for (Draft element : appPlatformClient.listDrafts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent ApplicationName

Required. Parent value for ListDraftsRequest.

Returns
Type Description
AppPlatformClient.ListDraftsPagedResponse

listDrafts(ListDraftsRequest request)

public final AppPlatformClient.ListDraftsPagedResponse listDrafts(ListDraftsRequest request)

Lists Drafts in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ListDraftsRequest request =
       ListDraftsRequest.newBuilder()
           .setParent(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Draft element : appPlatformClient.listDrafts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListDraftsRequest

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

Returns
Type Description
AppPlatformClient.ListDraftsPagedResponse

listDrafts(String parent)

public final AppPlatformClient.ListDraftsPagedResponse listDrafts(String parent)

Lists Drafts in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String parent = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString();
   for (Draft element : appPlatformClient.listDrafts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListDraftsRequest.

Returns
Type Description
AppPlatformClient.ListDraftsPagedResponse

listDraftsCallable()

public final UnaryCallable<ListDraftsRequest,ListDraftsResponse> listDraftsCallable()

Lists Drafts in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ListDraftsRequest request =
       ListDraftsRequest.newBuilder()
           .setParent(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListDraftsResponse response = appPlatformClient.listDraftsCallable().call(request);
     for (Draft element : response.getDraftsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListDraftsRequest,ListDraftsResponse>

listDraftsPagedCallable()

public final UnaryCallable<ListDraftsRequest,AppPlatformClient.ListDraftsPagedResponse> listDraftsPagedCallable()

Lists Drafts in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ListDraftsRequest request =
       ListDraftsRequest.newBuilder()
           .setParent(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Draft> future = appPlatformClient.listDraftsPagedCallable().futureCall(request);
   // Do something.
   for (Draft element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListDraftsRequest,ListDraftsPagedResponse>

listInstances(ApplicationName parent)

public final AppPlatformClient.ListInstancesPagedResponse listInstances(ApplicationName parent)

Lists Instances in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ApplicationName parent = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]");
   for (Instance element : appPlatformClient.listInstances(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent ApplicationName

Required. Parent value for ListInstancesRequest.

Returns
Type Description
AppPlatformClient.ListInstancesPagedResponse

listInstances(ListInstancesRequest request)

public final AppPlatformClient.ListInstancesPagedResponse listInstances(ListInstancesRequest request)

Lists Instances in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Instance element : appPlatformClient.listInstances(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListInstancesRequest

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

Returns
Type Description
AppPlatformClient.ListInstancesPagedResponse

listInstances(String parent)

public final AppPlatformClient.ListInstancesPagedResponse listInstances(String parent)

Lists Instances in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String parent = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString();
   for (Instance element : appPlatformClient.listInstances(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListInstancesRequest.

Returns
Type Description
AppPlatformClient.ListInstancesPagedResponse

listInstancesCallable()

public final UnaryCallable<ListInstancesRequest,ListInstancesResponse> listInstancesCallable()

Lists Instances in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListInstancesResponse response = appPlatformClient.listInstancesCallable().call(request);
     for (Instance element : response.getInstancesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListInstancesRequest,ListInstancesResponse>

listInstancesPagedCallable()

public final UnaryCallable<ListInstancesRequest,AppPlatformClient.ListInstancesPagedResponse> listInstancesPagedCallable()

Lists Instances in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Instance> future =
       appPlatformClient.listInstancesPagedCallable().futureCall(request);
   // Do something.
   for (Instance element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListInstancesRequest,ListInstancesPagedResponse>

listPrebuiltProcessors(ListPrebuiltProcessorsRequest request)

public final ListPrebuiltProcessorsResponse listPrebuiltProcessors(ListPrebuiltProcessorsRequest request)

ListPrebuiltProcessors is a custom pass-through verb that Lists Prebuilt Processors.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ListPrebuiltProcessorsRequest request =
       ListPrebuiltProcessorsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ListPrebuiltProcessorsResponse response = appPlatformClient.listPrebuiltProcessors(request);
 }
 
Parameter
Name Description
request ListPrebuiltProcessorsRequest

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

Returns
Type Description
ListPrebuiltProcessorsResponse

listPrebuiltProcessors(LocationName parent)

public final ListPrebuiltProcessorsResponse listPrebuiltProcessors(LocationName parent)

ListPrebuiltProcessors is a custom pass-through verb that Lists Prebuilt Processors.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListPrebuiltProcessorsResponse response = appPlatformClient.listPrebuiltProcessors(parent);
 }
 
Parameter
Name Description
parent LocationName

Required. Parent path.

Returns
Type Description
ListPrebuiltProcessorsResponse

listPrebuiltProcessors(String parent)

public final ListPrebuiltProcessorsResponse listPrebuiltProcessors(String parent)

ListPrebuiltProcessors is a custom pass-through verb that Lists Prebuilt Processors.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ListPrebuiltProcessorsResponse response = appPlatformClient.listPrebuiltProcessors(parent);
 }
 
Parameter
Name Description
parent String

Required. Parent path.

Returns
Type Description
ListPrebuiltProcessorsResponse

listPrebuiltProcessorsCallable()

public final UnaryCallable<ListPrebuiltProcessorsRequest,ListPrebuiltProcessorsResponse> listPrebuiltProcessorsCallable()

ListPrebuiltProcessors is a custom pass-through verb that Lists Prebuilt Processors.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ListPrebuiltProcessorsRequest request =
       ListPrebuiltProcessorsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<ListPrebuiltProcessorsResponse> future =
       appPlatformClient.listPrebuiltProcessorsCallable().futureCall(request);
   // Do something.
   ListPrebuiltProcessorsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ListPrebuiltProcessorsRequest,ListPrebuiltProcessorsResponse>

listProcessors(ListProcessorsRequest request)

public final AppPlatformClient.ListProcessorsPagedResponse listProcessors(ListProcessorsRequest request)

Lists Processors in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ListProcessorsRequest request =
       ListProcessorsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Processor element : appPlatformClient.listProcessors(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListProcessorsRequest

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

Returns
Type Description
AppPlatformClient.ListProcessorsPagedResponse

listProcessors(LocationName parent)

public final AppPlatformClient.ListProcessorsPagedResponse listProcessors(LocationName parent)

Lists Processors in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Processor element : appPlatformClient.listProcessors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. Parent value for ListProcessorsRequest.

Returns
Type Description
AppPlatformClient.ListProcessorsPagedResponse

listProcessors(String parent)

public final AppPlatformClient.ListProcessorsPagedResponse listProcessors(String parent)

Lists Processors in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Processor element : appPlatformClient.listProcessors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListProcessorsRequest.

Returns
Type Description
AppPlatformClient.ListProcessorsPagedResponse

listProcessorsCallable()

public final UnaryCallable<ListProcessorsRequest,ListProcessorsResponse> listProcessorsCallable()

Lists Processors in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ListProcessorsRequest request =
       ListProcessorsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListProcessorsResponse response = appPlatformClient.listProcessorsCallable().call(request);
     for (Processor element : response.getProcessorsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListProcessorsRequest,ListProcessorsResponse>

listProcessorsPagedCallable()

public final UnaryCallable<ListProcessorsRequest,AppPlatformClient.ListProcessorsPagedResponse> listProcessorsPagedCallable()

Lists Processors in a given project and location.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ListProcessorsRequest request =
       ListProcessorsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Processor> future =
       appPlatformClient.listProcessorsPagedCallable().futureCall(request);
   // Do something.
   for (Processor element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListProcessorsRequest,ListProcessorsPagedResponse>

removeApplicationStreamInputAsync(ApplicationName name)

public final OperationFuture<RemoveApplicationStreamInputResponse,OperationMetadata> removeApplicationStreamInputAsync(ApplicationName name)

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]");
   RemoveApplicationStreamInputResponse response =
       appPlatformClient.removeApplicationStreamInputAsync(name).get();
 }
 
Parameter
Name Description
name ApplicationName

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

Returns
Type Description
OperationFuture<RemoveApplicationStreamInputResponse,OperationMetadata>

removeApplicationStreamInputAsync(RemoveApplicationStreamInputRequest request)

public final OperationFuture<RemoveApplicationStreamInputResponse,OperationMetadata> removeApplicationStreamInputAsync(RemoveApplicationStreamInputRequest request)

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   RemoveApplicationStreamInputRequest request =
       RemoveApplicationStreamInputRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllTargetStreamInputs(
               new ArrayList<RemoveApplicationStreamInputRequest.TargetStreamInput>())
           .setRequestId("requestId693933066")
           .build();
   RemoveApplicationStreamInputResponse response =
       appPlatformClient.removeApplicationStreamInputAsync(request).get();
 }
 
Parameter
Name Description
request RemoveApplicationStreamInputRequest

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

Returns
Type Description
OperationFuture<RemoveApplicationStreamInputResponse,OperationMetadata>

removeApplicationStreamInputAsync(String name)

public final OperationFuture<RemoveApplicationStreamInputResponse,OperationMetadata> removeApplicationStreamInputAsync(String name)

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString();
   RemoveApplicationStreamInputResponse response =
       appPlatformClient.removeApplicationStreamInputAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

Returns
Type Description
OperationFuture<RemoveApplicationStreamInputResponse,OperationMetadata>

removeApplicationStreamInputCallable()

public final UnaryCallable<RemoveApplicationStreamInputRequest,Operation> removeApplicationStreamInputCallable()

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   RemoveApplicationStreamInputRequest request =
       RemoveApplicationStreamInputRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllTargetStreamInputs(
               new ArrayList<RemoveApplicationStreamInputRequest.TargetStreamInput>())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       appPlatformClient.removeApplicationStreamInputCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<RemoveApplicationStreamInputRequest,Operation>

removeApplicationStreamInputOperationCallable()

public final OperationCallable<RemoveApplicationStreamInputRequest,RemoveApplicationStreamInputResponse,OperationMetadata> removeApplicationStreamInputOperationCallable()

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   RemoveApplicationStreamInputRequest request =
       RemoveApplicationStreamInputRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllTargetStreamInputs(
               new ArrayList<RemoveApplicationStreamInputRequest.TargetStreamInput>())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<RemoveApplicationStreamInputResponse, OperationMetadata> future =
       appPlatformClient.removeApplicationStreamInputOperationCallable().futureCall(request);
   // Do something.
   RemoveApplicationStreamInputResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<RemoveApplicationStreamInputRequest,RemoveApplicationStreamInputResponse,OperationMetadata>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

undeployApplicationAsync(ApplicationName name)

public final OperationFuture<UndeployApplicationResponse,OperationMetadata> undeployApplicationAsync(ApplicationName name)

Undeploys a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]");
   UndeployApplicationResponse response = appPlatformClient.undeployApplicationAsync(name).get();
 }
 
Parameter
Name Description
name ApplicationName

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

Returns
Type Description
OperationFuture<UndeployApplicationResponse,OperationMetadata>

undeployApplicationAsync(UndeployApplicationRequest request)

public final OperationFuture<UndeployApplicationResponse,OperationMetadata> undeployApplicationAsync(UndeployApplicationRequest request)

Undeploys a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UndeployApplicationRequest request =
       UndeployApplicationRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setRequestId("requestId693933066")
           .build();
   UndeployApplicationResponse response =
       appPlatformClient.undeployApplicationAsync(request).get();
 }
 
Parameter
Name Description
request UndeployApplicationRequest

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

Returns
Type Description
OperationFuture<UndeployApplicationResponse,OperationMetadata>

undeployApplicationAsync(String name)

public final OperationFuture<UndeployApplicationResponse,OperationMetadata> undeployApplicationAsync(String name)

Undeploys a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString();
   UndeployApplicationResponse response = appPlatformClient.undeployApplicationAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

Returns
Type Description
OperationFuture<UndeployApplicationResponse,OperationMetadata>

undeployApplicationCallable()

public final UnaryCallable<UndeployApplicationRequest,Operation> undeployApplicationCallable()

Undeploys a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UndeployApplicationRequest request =
       UndeployApplicationRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       appPlatformClient.undeployApplicationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UndeployApplicationRequest,Operation>

undeployApplicationOperationCallable()

public final OperationCallable<UndeployApplicationRequest,UndeployApplicationResponse,OperationMetadata> undeployApplicationOperationCallable()

Undeploys a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UndeployApplicationRequest request =
       UndeployApplicationRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<UndeployApplicationResponse, OperationMetadata> future =
       appPlatformClient.undeployApplicationOperationCallable().futureCall(request);
   // Do something.
   UndeployApplicationResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<UndeployApplicationRequest,UndeployApplicationResponse,OperationMetadata>

updateApplicationAsync(Application application, FieldMask updateMask)

public final OperationFuture<Application,OperationMetadata> updateApplicationAsync(Application application, FieldMask updateMask)

Updates the parameters of a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   Application application = Application.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Application response =
       appPlatformClient.updateApplicationAsync(application, updateMask).get();
 }
 
Parameters
Name Description
application Application

Required. The resource being updated.

updateMask FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the Application resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type Description
OperationFuture<Application,OperationMetadata>

updateApplicationAsync(UpdateApplicationRequest request)

public final OperationFuture<Application,OperationMetadata> updateApplicationAsync(UpdateApplicationRequest request)

Updates the parameters of a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateApplicationRequest request =
       UpdateApplicationRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setApplication(Application.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Application response = appPlatformClient.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,OperationMetadata>

updateApplicationCallable()

public final UnaryCallable<UpdateApplicationRequest,Operation> updateApplicationCallable()

Updates the parameters of a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateApplicationRequest request =
       UpdateApplicationRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setApplication(Application.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       appPlatformClient.updateApplicationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateApplicationRequest,Operation>

updateApplicationInstancesAsync(ApplicationName name, List<UpdateApplicationInstancesRequest.UpdateApplicationInstance> applicationInstances)

public final OperationFuture<UpdateApplicationInstancesResponse,OperationMetadata> updateApplicationInstancesAsync(ApplicationName name, List<UpdateApplicationInstancesRequest.UpdateApplicationInstance> applicationInstances)

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]");
   List<UpdateApplicationInstancesRequest.UpdateApplicationInstance> applicationInstances =
       new ArrayList<>();
   UpdateApplicationInstancesResponse response =
       appPlatformClient.updateApplicationInstancesAsync(name, applicationInstances).get();
 }
 
Parameters
Name Description
name ApplicationName

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

applicationInstances List<UpdateApplicationInstance>
Returns
Type Description
OperationFuture<UpdateApplicationInstancesResponse,OperationMetadata>

updateApplicationInstancesAsync(UpdateApplicationInstancesRequest request)

public final OperationFuture<UpdateApplicationInstancesResponse,OperationMetadata> updateApplicationInstancesAsync(UpdateApplicationInstancesRequest request)

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateApplicationInstancesRequest request =
       UpdateApplicationInstancesRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllApplicationInstances(
               new ArrayList<UpdateApplicationInstancesRequest.UpdateApplicationInstance>())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .build();
   UpdateApplicationInstancesResponse response =
       appPlatformClient.updateApplicationInstancesAsync(request).get();
 }
 
Parameter
Name Description
request UpdateApplicationInstancesRequest

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

Returns
Type Description
OperationFuture<UpdateApplicationInstancesResponse,OperationMetadata>

updateApplicationInstancesAsync(String name, List<UpdateApplicationInstancesRequest.UpdateApplicationInstance> applicationInstances)

public final OperationFuture<UpdateApplicationInstancesResponse,OperationMetadata> updateApplicationInstancesAsync(String name, List<UpdateApplicationInstancesRequest.UpdateApplicationInstance> applicationInstances)

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString();
   List<UpdateApplicationInstancesRequest.UpdateApplicationInstance> applicationInstances =
       new ArrayList<>();
   UpdateApplicationInstancesResponse response =
       appPlatformClient.updateApplicationInstancesAsync(name, applicationInstances).get();
 }
 
Parameters
Name Description
name String

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

applicationInstances List<UpdateApplicationInstance>
Returns
Type Description
OperationFuture<UpdateApplicationInstancesResponse,OperationMetadata>

updateApplicationInstancesCallable()

public final UnaryCallable<UpdateApplicationInstancesRequest,Operation> updateApplicationInstancesCallable()

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateApplicationInstancesRequest request =
       UpdateApplicationInstancesRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllApplicationInstances(
               new ArrayList<UpdateApplicationInstancesRequest.UpdateApplicationInstance>())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .build();
   ApiFuture<Operation> future =
       appPlatformClient.updateApplicationInstancesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateApplicationInstancesRequest,Operation>

updateApplicationInstancesOperationCallable()

public final OperationCallable<UpdateApplicationInstancesRequest,UpdateApplicationInstancesResponse,OperationMetadata> updateApplicationInstancesOperationCallable()

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateApplicationInstancesRequest request =
       UpdateApplicationInstancesRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllApplicationInstances(
               new ArrayList<UpdateApplicationInstancesRequest.UpdateApplicationInstance>())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .build();
   OperationFuture<UpdateApplicationInstancesResponse, OperationMetadata> future =
       appPlatformClient.updateApplicationInstancesOperationCallable().futureCall(request);
   // Do something.
   UpdateApplicationInstancesResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateApplicationInstancesRequest,UpdateApplicationInstancesResponse,OperationMetadata>

updateApplicationOperationCallable()

public final OperationCallable<UpdateApplicationRequest,Application,OperationMetadata> updateApplicationOperationCallable()

Updates the parameters of a single 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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateApplicationRequest request =
       UpdateApplicationRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setApplication(Application.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Application, OperationMetadata> future =
       appPlatformClient.updateApplicationOperationCallable().futureCall(request);
   // Do something.
   Application response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateApplicationRequest,Application,OperationMetadata>

updateApplicationStreamInputAsync(ApplicationName name)

public final OperationFuture<UpdateApplicationStreamInputResponse,OperationMetadata> updateApplicationStreamInputAsync(ApplicationName name)

Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed. For CreateOrUpdate behavior, set allow_missing to true.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]");
   UpdateApplicationStreamInputResponse response =
       appPlatformClient.updateApplicationStreamInputAsync(name).get();
 }
 
Parameter
Name Description
name ApplicationName

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

Returns
Type Description
OperationFuture<UpdateApplicationStreamInputResponse,OperationMetadata>

updateApplicationStreamInputAsync(UpdateApplicationStreamInputRequest request)

public final OperationFuture<UpdateApplicationStreamInputResponse,OperationMetadata> updateApplicationStreamInputAsync(UpdateApplicationStreamInputRequest request)

Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed. For CreateOrUpdate behavior, set allow_missing to true.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateApplicationStreamInputRequest request =
       UpdateApplicationStreamInputRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllApplicationStreamInputs(new ArrayList<ApplicationStreamInput>())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .build();
   UpdateApplicationStreamInputResponse response =
       appPlatformClient.updateApplicationStreamInputAsync(request).get();
 }
 
Parameter
Name Description
request UpdateApplicationStreamInputRequest

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

Returns
Type Description
OperationFuture<UpdateApplicationStreamInputResponse,OperationMetadata>

updateApplicationStreamInputAsync(String name)

public final OperationFuture<UpdateApplicationStreamInputResponse,OperationMetadata> updateApplicationStreamInputAsync(String name)

Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed. For CreateOrUpdate behavior, set allow_missing to true.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   String name = ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString();
   UpdateApplicationStreamInputResponse response =
       appPlatformClient.updateApplicationStreamInputAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

Returns
Type Description
OperationFuture<UpdateApplicationStreamInputResponse,OperationMetadata>

updateApplicationStreamInputCallable()

public final UnaryCallable<UpdateApplicationStreamInputRequest,Operation> updateApplicationStreamInputCallable()

Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed. For CreateOrUpdate behavior, set allow_missing to true.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateApplicationStreamInputRequest request =
       UpdateApplicationStreamInputRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllApplicationStreamInputs(new ArrayList<ApplicationStreamInput>())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .build();
   ApiFuture<Operation> future =
       appPlatformClient.updateApplicationStreamInputCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateApplicationStreamInputRequest,Operation>

updateApplicationStreamInputOperationCallable()

public final OperationCallable<UpdateApplicationStreamInputRequest,UpdateApplicationStreamInputResponse,OperationMetadata> updateApplicationStreamInputOperationCallable()

Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed. For CreateOrUpdate behavior, set allow_missing to true.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateApplicationStreamInputRequest request =
       UpdateApplicationStreamInputRequest.newBuilder()
           .setName(ApplicationName.of("[PROJECT]", "[LOCATION]", "[APPLICATION]").toString())
           .addAllApplicationStreamInputs(new ArrayList<ApplicationStreamInput>())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .build();
   OperationFuture<UpdateApplicationStreamInputResponse, OperationMetadata> future =
       appPlatformClient.updateApplicationStreamInputOperationCallable().futureCall(request);
   // Do something.
   UpdateApplicationStreamInputResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateApplicationStreamInputRequest,UpdateApplicationStreamInputResponse,OperationMetadata>

updateDraftAsync(Draft draft, FieldMask updateMask)

public final OperationFuture<Draft,OperationMetadata> updateDraftAsync(Draft draft, FieldMask updateMask)

Updates the parameters of a single Draft.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   Draft draft = Draft.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Draft response = appPlatformClient.updateDraftAsync(draft, updateMask).get();
 }
 
Parameters
Name Description
draft Draft

Required. The resource being updated.

updateMask FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the Draft resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type Description
OperationFuture<Draft,OperationMetadata>

updateDraftAsync(UpdateDraftRequest request)

public final OperationFuture<Draft,OperationMetadata> updateDraftAsync(UpdateDraftRequest request)

Updates the parameters of a single Draft.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateDraftRequest request =
       UpdateDraftRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setDraft(Draft.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .build();
   Draft response = appPlatformClient.updateDraftAsync(request).get();
 }
 
Parameter
Name Description
request UpdateDraftRequest

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

Returns
Type Description
OperationFuture<Draft,OperationMetadata>

updateDraftCallable()

public final UnaryCallable<UpdateDraftRequest,Operation> updateDraftCallable()

Updates the parameters of a single Draft.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateDraftRequest request =
       UpdateDraftRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setDraft(Draft.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .build();
   ApiFuture<Operation> future = appPlatformClient.updateDraftCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateDraftRequest,Operation>

updateDraftOperationCallable()

public final OperationCallable<UpdateDraftRequest,Draft,OperationMetadata> updateDraftOperationCallable()

Updates the parameters of a single Draft.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateDraftRequest request =
       UpdateDraftRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setDraft(Draft.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .build();
   OperationFuture<Draft, OperationMetadata> future =
       appPlatformClient.updateDraftOperationCallable().futureCall(request);
   // Do something.
   Draft response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateDraftRequest,Draft,OperationMetadata>

updateProcessorAsync(Processor processor, FieldMask updateMask)

public final OperationFuture<Processor,OperationMetadata> updateProcessorAsync(Processor processor, FieldMask updateMask)

Updates the parameters of a single Processor.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   Processor processor = Processor.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Processor response = appPlatformClient.updateProcessorAsync(processor, updateMask).get();
 }
 
Parameters
Name Description
processor Processor

Required. The resource being updated.

updateMask FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the Processor resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type Description
OperationFuture<Processor,OperationMetadata>

updateProcessorAsync(UpdateProcessorRequest request)

public final OperationFuture<Processor,OperationMetadata> updateProcessorAsync(UpdateProcessorRequest request)

Updates the parameters of a single Processor.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateProcessorRequest request =
       UpdateProcessorRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setProcessor(Processor.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Processor response = appPlatformClient.updateProcessorAsync(request).get();
 }
 
Parameter
Name Description
request UpdateProcessorRequest

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

Returns
Type Description
OperationFuture<Processor,OperationMetadata>

updateProcessorCallable()

public final UnaryCallable<UpdateProcessorRequest,Operation> updateProcessorCallable()

Updates the parameters of a single Processor.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateProcessorRequest request =
       UpdateProcessorRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setProcessor(Processor.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = appPlatformClient.updateProcessorCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateProcessorRequest,Operation>

updateProcessorOperationCallable()

public final OperationCallable<UpdateProcessorRequest,Processor,OperationMetadata> updateProcessorOperationCallable()

Updates the parameters of a single Processor.

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 (AppPlatformClient appPlatformClient = AppPlatformClient.create()) {
   UpdateProcessorRequest request =
       UpdateProcessorRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setProcessor(Processor.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Processor, OperationMetadata> future =
       appPlatformClient.updateProcessorOperationCallable().futureCall(request);
   // Do something.
   Processor response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateProcessorRequest,Processor,OperationMetadata>