com.google.cloud.talent.v4beta1

Class ApplicationServiceClient

java.lang.Object

com.google.cloud.talent.v4beta1.ApplicationServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class ApplicationServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: A service that handles application management, including CRUD and enumeration.

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:

 
 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ProfileName parent = ProfileName.of("[PROJECT]", "[TENANT]", "[PROFILE]");
   Application application = Application.newBuilder().build();
   Application response = applicationServiceClient.createApplication(parent, application);
 }
 
 

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

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

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

See the individual methods for example code.

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

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

To customize credentials:

 
 ApplicationServiceSettings applicationServiceSettings =
     ApplicationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ApplicationServiceClient applicationServiceClient =
     ApplicationServiceClient.create(applicationServiceSettings);
 
 

To customize the endpoint:

 
 ApplicationServiceSettings applicationServiceSettings =
     ApplicationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ApplicationServiceClient applicationServiceClient =
     ApplicationServiceClient.create(applicationServiceSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApplicationServiceClient.ListApplicationsFixedSizeCollection
static class	ApplicationServiceClient.ListApplicationsPage
static class	ApplicationServiceClient.ListApplicationsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApplicationServiceClient(ApplicationServiceSettings settings) Constructs an instance of ApplicationServiceClient, using the given settings.
protected	ApplicationServiceClient(ApplicationServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static ApplicationServiceClient	create() Constructs an instance of ApplicationServiceClient with default settings.
static ApplicationServiceClient	create(ApplicationServiceSettings settings) Constructs an instance of ApplicationServiceClient, using the given settings.
static ApplicationServiceClient	create(ApplicationServiceStub stub) Constructs an instance of ApplicationServiceClient, using the given stub for making calls.
Application	createApplication(CreateApplicationRequest request) Creates a new application entity.
Application	createApplication(ProfileName parent, Application application) Creates a new application entity.
Application	createApplication(String parent, Application application) Creates a new application entity.
com.google.api.gax.rpc.UnaryCallable<CreateApplicationRequest,Application>	createApplicationCallable() Creates a new application entity.
void	deleteApplication(ApplicationName name) Deletes specified application.
void	deleteApplication(DeleteApplicationRequest request) Deletes specified application.
void	deleteApplication(String name) Deletes specified application.
com.google.api.gax.rpc.UnaryCallable<DeleteApplicationRequest,Empty>	deleteApplicationCallable() Deletes specified application.
Application	getApplication(ApplicationName name) Retrieves specified application.
Application	getApplication(GetApplicationRequest request) Retrieves specified application.
Application	getApplication(String name) Retrieves specified application.
com.google.api.gax.rpc.UnaryCallable<GetApplicationRequest,Application>	getApplicationCallable() Retrieves specified application.
ApplicationServiceSettings	getSettings()
ApplicationServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
ApplicationServiceClient.ListApplicationsPagedResponse	listApplications(ListApplicationsRequest request) Lists all applications associated with the profile.
ApplicationServiceClient.ListApplicationsPagedResponse	listApplications(ProfileName parent) Lists all applications associated with the profile.
ApplicationServiceClient.ListApplicationsPagedResponse	listApplications(String parent) Lists all applications associated with the profile.
com.google.api.gax.rpc.UnaryCallable<ListApplicationsRequest,ListApplicationsResponse>	listApplicationsCallable() Lists all applications associated with the profile.
com.google.api.gax.rpc.UnaryCallable<ListApplicationsRequest,ApplicationServiceClient.ListApplicationsPagedResponse>	listApplicationsPagedCallable() Lists all applications associated with the profile.
void	shutdown()
void	shutdownNow()
Application	updateApplication(Application application) Updates specified application.
Application	updateApplication(UpdateApplicationRequest request) Updates specified application.
com.google.api.gax.rpc.UnaryCallable<UpdateApplicationRequest,Application>	updateApplicationCallable() Updates specified application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationServiceClient

protected ApplicationServiceClient(ApplicationServiceSettings settings)
                            throws IOException

Constructs an instance of ApplicationServiceClient, 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.

Throws:

IOException

ApplicationServiceClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected ApplicationServiceClient(ApplicationServiceStub stub)

Method Detail

create

public static final ApplicationServiceClient create()
                                             throws IOException

Constructs an instance of ApplicationServiceClient with default settings.

Throws:

IOException

create

public static final ApplicationServiceClient create(ApplicationServiceSettings settings)
                                             throws IOException

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

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final ApplicationServiceClient create(ApplicationServiceStub stub)

Constructs an instance of ApplicationServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use ApplicationServiceSettings}.

getSettings

public final ApplicationServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public ApplicationServiceStub getStub()

createApplication

public final Application createApplication(ProfileName parent,
                                           Application application)

Creates a new application entity.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ProfileName parent = ProfileName.of("[PROJECT]", "[TENANT]", "[PROFILE]");
   Application application = Application.newBuilder().build();
   Application response = applicationServiceClient.createApplication(parent, application);
 }
 

Parameters:

parent - Required. Resource name of the profile under which the application is created.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".

application - Required. The application to be created.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createApplication

public final Application createApplication(String parent,
                                           Application application)

Creates a new application entity.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ProfileName parent = ProfileName.of("[PROJECT]", "[TENANT]", "[PROFILE]");
   Application application = Application.newBuilder().build();
   Application response = applicationServiceClient.createApplication(parent.toString(), application);
 }
 

Parameters:

parent - Required. Resource name of the profile under which the application is created.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".

application - Required. The application to be created.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createApplication

public final Application createApplication(CreateApplicationRequest request)

Creates a new application entity.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ProfileName parent = ProfileName.of("[PROJECT]", "[TENANT]", "[PROFILE]");
   Application application = Application.newBuilder().build();
   CreateApplicationRequest request = CreateApplicationRequest.newBuilder()
     .setParent(parent.toString())
     .setApplication(application)
     .build();
   Application response = applicationServiceClient.createApplication(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createApplicationCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateApplicationRequest,Application> createApplicationCallable()

Creates a new application entity.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ProfileName parent = ProfileName.of("[PROJECT]", "[TENANT]", "[PROFILE]");
   Application application = Application.newBuilder().build();
   CreateApplicationRequest request = CreateApplicationRequest.newBuilder()
     .setParent(parent.toString())
     .setApplication(application)
     .build();
   ApiFuture<Application> future = applicationServiceClient.createApplicationCallable().futureCall(request);
   // Do something
   Application response = future.get();
 }
 

getApplication

public final Application getApplication(ApplicationName name)

Retrieves specified application.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[TENANT]", "[PROFILE]", "[APPLICATION]");
   Application response = applicationServiceClient.getApplication(name);
 }
 

Parameters:

name - Required. The resource name of the application to be retrieved.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getApplication

public final Application getApplication(String name)

Retrieves specified application.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[TENANT]", "[PROFILE]", "[APPLICATION]");
   Application response = applicationServiceClient.getApplication(name.toString());
 }
 

Parameters:

name - Required. The resource name of the application to be retrieved.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getApplication

public final Application getApplication(GetApplicationRequest request)

Retrieves specified application.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[TENANT]", "[PROFILE]", "[APPLICATION]");
   GetApplicationRequest request = GetApplicationRequest.newBuilder()
     .setName(name.toString())
     .build();
   Application response = applicationServiceClient.getApplication(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getApplicationCallable

public final com.google.api.gax.rpc.UnaryCallable<GetApplicationRequest,Application> getApplicationCallable()

Retrieves specified application.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[TENANT]", "[PROFILE]", "[APPLICATION]");
   GetApplicationRequest request = GetApplicationRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Application> future = applicationServiceClient.getApplicationCallable().futureCall(request);
   // Do something
   Application response = future.get();
 }
 

updateApplication

public final Application updateApplication(Application application)

Updates specified application.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   Application application = Application.newBuilder().build();
   Application response = applicationServiceClient.updateApplication(application);
 }
 

Parameters:

application - Required. The application resource to replace the current resource in the system.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateApplication

public final Application updateApplication(UpdateApplicationRequest request)

Updates specified application.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   Application application = Application.newBuilder().build();
   UpdateApplicationRequest request = UpdateApplicationRequest.newBuilder()
     .setApplication(application)
     .build();
   Application response = applicationServiceClient.updateApplication(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateApplicationCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateApplicationRequest,Application> updateApplicationCallable()

Updates specified application.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   Application application = Application.newBuilder().build();
   UpdateApplicationRequest request = UpdateApplicationRequest.newBuilder()
     .setApplication(application)
     .build();
   ApiFuture<Application> future = applicationServiceClient.updateApplicationCallable().futureCall(request);
   // Do something
   Application response = future.get();
 }
 

deleteApplication

public final void deleteApplication(ApplicationName name)

Deletes specified application.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[TENANT]", "[PROFILE]", "[APPLICATION]");
   applicationServiceClient.deleteApplication(name);
 }
 

Parameters:

name - Required. The resource name of the application to be deleted.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteApplication

public final void deleteApplication(String name)

Deletes specified application.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[TENANT]", "[PROFILE]", "[APPLICATION]");
   applicationServiceClient.deleteApplication(name.toString());
 }
 

Parameters:

name - Required. The resource name of the application to be deleted.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteApplication

public final void deleteApplication(DeleteApplicationRequest request)

Deletes specified application.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[TENANT]", "[PROFILE]", "[APPLICATION]");
   DeleteApplicationRequest request = DeleteApplicationRequest.newBuilder()
     .setName(name.toString())
     .build();
   applicationServiceClient.deleteApplication(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteApplicationCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteApplicationRequest,Empty> deleteApplicationCallable()

Deletes specified application.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ApplicationName name = ApplicationName.of("[PROJECT]", "[TENANT]", "[PROFILE]", "[APPLICATION]");
   DeleteApplicationRequest request = DeleteApplicationRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = applicationServiceClient.deleteApplicationCallable().futureCall(request);
   // Do something
   future.get();
 }
 

listApplications

public final ApplicationServiceClient.ListApplicationsPagedResponse listApplications(ProfileName parent)

Lists all applications associated with the profile.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ProfileName parent = ProfileName.of("[PROJECT]", "[TENANT]", "[PROFILE]");
   for (Application element : applicationServiceClient.listApplications(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. Resource name of the profile under which the application is created.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz".

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listApplications

public final ApplicationServiceClient.ListApplicationsPagedResponse listApplications(String parent)

Lists all applications associated with the profile.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ProfileName parent = ProfileName.of("[PROJECT]", "[TENANT]", "[PROFILE]");
   for (Application element : applicationServiceClient.listApplications(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. Resource name of the profile under which the application is created.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz".

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listApplications

public final ApplicationServiceClient.ListApplicationsPagedResponse listApplications(ListApplicationsRequest request)

Lists all applications associated with the profile.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ProfileName parent = ProfileName.of("[PROJECT]", "[TENANT]", "[PROFILE]");
   ListApplicationsRequest request = ListApplicationsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Application element : applicationServiceClient.listApplications(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listApplicationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListApplicationsRequest,ApplicationServiceClient.ListApplicationsPagedResponse> listApplicationsPagedCallable()

Lists all applications associated with the profile.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ProfileName parent = ProfileName.of("[PROJECT]", "[TENANT]", "[PROFILE]");
   ListApplicationsRequest request = ListApplicationsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListApplicationsPagedResponse> future = applicationServiceClient.listApplicationsPagedCallable().futureCall(request);
   // Do something
   for (Application element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listApplicationsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListApplicationsRequest,ListApplicationsResponse> listApplicationsCallable()

Lists all applications associated with the profile.

Sample code:

 try (ApplicationServiceClient applicationServiceClient = ApplicationServiceClient.create()) {
   ProfileName parent = ProfileName.of("[PROJECT]", "[TENANT]", "[PROFILE]");
   ListApplicationsRequest request = ListApplicationsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListApplicationsResponse response = applicationServiceClient.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;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException