Class CompletionClient (2.53.0)

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()
           .setTenant(TenantName.of("[PROJECT]", "[TENANT]").toString())
           .setQuery("query107944136")
           .addAllLanguageCodes(new ArrayList<String>())
           .setPageSize(883849137)
           .setCompany(CompanyName.of("[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().

Methods
Method	Description	Method Variants
CompleteQuery	Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.	Request object method variants only take one parameter, a request object, which must be constructed before the call. completeQuery(CompleteQueryRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. completeQueryCallable()

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.newHttpJsonBuilder().build();
 CompletionClient completionClient = CompletionClient.create(completionSettings);

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

Inheritance

java.lang.Object > CompletionClient

Static Methods

create()

public static final CompletionClient create()

Constructs an instance of CompletionClient with default settings.

Returns
Type	Description
`CompletionClient`

Exceptions
Type	Description
`IOException`

create(CompletionSettings settings)

public static final CompletionClient create(CompletionSettings settings)

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.

Parameter
Name	Description
`settings`	`CompletionSettings`

Returns
Type	Description
`CompletionClient`

Exceptions
Type	Description
`IOException`

create(CompletionStub stub)

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).

Parameter
Name	Description
`stub`	`CompletionStub`

Returns
Type	Description
`CompletionClient`

Constructors

CompletionClient(CompletionSettings settings)

protected CompletionClient(CompletionSettings settings)

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.

Parameter
Name	Description
`settings`	`CompletionSettings`

CompletionClient(CompletionStub stub)

protected CompletionClient(CompletionStub stub)

Parameter
Name	Description
`stub`	`CompletionStub`

Methods

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()

completeQuery(CompleteQueryRequest request)

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

Parameter
Name	Description
`request`	`CompleteQueryRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CompleteQueryResponse`

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

Returns
Type	Description
`UnaryCallable<CompleteQueryRequest,CompleteQueryResponse>`

getSettings()

public final CompletionSettings getSettings()

Returns
Type	Description
`CompletionSettings`

getStub()

public CompletionStub getStub()

Returns
Type	Description
`CompletionStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()