com.google.cloud.talent.v4beta1

Class CompletionClient

java.lang.Object

com.google.cloud.talent.v4beta1.CompletionClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class CompletionClient
extends Object
implements BackgroundResource

Service Description: A service handles auto completion.

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 (CompletionClient completionClient = CompletionClient.create()) {
   CompleteQueryRequest request =
       CompleteQueryRequest.newBuilder()
           .setParent(TenantName.of("[PROJECT]", "[TENANT]").toString())
           .setQuery("query107944136")
           .addAllLanguageCodes(new ArrayList<String>())
           .setPageSize(883849137)
           .setCompany(
               CompanyName.ofProjectTenantCompanyName("[PROJECT]", "[TENANT]", "[COMPANY]")
                   .toString())
           .build();
   CompleteQueryResponse response = completionClient.completeQuery(request);
 }
 

Note: close() needs to be called on the CompletionClient 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 CompletionSettings 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
 CompletionSettings completionSettings =
     CompletionSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CompletionClient completionClient = CompletionClient.create(completionSettings);
 

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
 CompletionSettings completionSettings =
     CompletionSettings.newBuilder().setEndpoint(myEndpoint).build();
 CompletionClient completionClient = CompletionClient.create(completionSettings);
 

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
 CompletionSettings completionSettings =
     CompletionSettings.newBuilder()
         .setTransportChannelProvider(
             CompletionSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 CompletionClient completionClient = CompletionClient.create(completionSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompletionClient(CompletionSettings settings) Constructs an instance of CompletionClient, using the given settings.
protected	CompletionClient(CompletionStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
CompleteQueryResponse	completeQuery(CompleteQueryRequest request) Completes the specified prefix with keyword suggestions.
UnaryCallable<CompleteQueryRequest,CompleteQueryResponse>	completeQueryCallable() Completes the specified prefix with keyword suggestions.
static CompletionClient	create() Constructs an instance of CompletionClient with default settings.
static CompletionClient	create(CompletionSettings settings) Constructs an instance of CompletionClient, using the given settings.
static CompletionClient	create(CompletionStub stub) Constructs an instance of CompletionClient, using the given stub for making calls.
CompletionSettings	getSettings()
CompletionStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

CompletionClient

protected CompletionClient(CompletionSettings settings)
                    throws IOException

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

CompletionClient

protected CompletionClient(CompletionStub stub)

Method Detail

create

public static final CompletionClient create()
                                     throws IOException

Constructs an instance of CompletionClient with default settings.

Throws:

IOException

create

public static final CompletionClient create(CompletionSettings settings)
                                     throws IOException

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

public static final CompletionClient create(CompletionStub stub)

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

getSettings

public final CompletionSettings getSettings()

getStub

public CompletionStub getStub()

completeQuery

public final CompleteQueryResponse completeQuery(CompleteQueryRequest request)

Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.

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 (CompletionClient completionClient = CompletionClient.create()) {
   CompleteQueryRequest request =
       CompleteQueryRequest.newBuilder()
           .setParent(TenantName.of("[PROJECT]", "[TENANT]").toString())
           .setQuery("query107944136")
           .addAllLanguageCodes(new ArrayList<String>())
           .setPageSize(883849137)
           .setCompany(
               CompanyName.ofProjectTenantCompanyName("[PROJECT]", "[TENANT]", "[COMPANY]")
                   .toString())
           .build();
   CompleteQueryResponse response = completionClient.completeQuery(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

completeQueryCallable

public final UnaryCallable<CompleteQueryRequest,CompleteQueryResponse> completeQueryCallable()

Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.

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 (CompletionClient completionClient = CompletionClient.create()) {
   CompleteQueryRequest request =
       CompleteQueryRequest.newBuilder()
           .setParent(TenantName.of("[PROJECT]", "[TENANT]").toString())
           .setQuery("query107944136")
           .addAllLanguageCodes(new ArrayList<String>())
           .setPageSize(883849137)
           .setCompany(
               CompanyName.ofProjectTenantCompanyName("[PROJECT]", "[TENANT]", "[COMPANY]")
                   .toString())
           .build();
   ApiFuture<CompleteQueryResponse> future =
       completionClient.completeQueryCallable().futureCall(request);
   // Do something.
   CompleteQueryResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

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

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException