Class RankServiceClient (0.48.0)

Service Description: Service for ranking text records.

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 (RankServiceClient rankServiceClient = RankServiceClient.create()) {
   RankRequest request =
       RankRequest.newBuilder()
           .setRankingConfig(
               RankingConfigName.of("[PROJECT]", "[LOCATION]", "[RANKING_CONFIG]").toString())
           .setModel("model104069929")
           .setTopN(110545924)
           .setQuery("query107944136")
           .addAllRecords(new ArrayList<RankingRecord>())
           .setIgnoreRecordDetailsInResponse(true)
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   RankResponse response = rankServiceClient.rank(request);
 }

Note: close() needs to be called on the RankServiceClient 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
Rank	Ranks a list of text records based on the given input query.	Request object method variants only take one parameter, a request object, which must be constructed before the call. rank(RankRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. rankCallable()

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 RankServiceSettings 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
 RankServiceSettings rankServiceSettings =
     RankServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RankServiceClient rankServiceClient = RankServiceClient.create(rankServiceSettings);

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
 RankServiceSettings rankServiceSettings =
     RankServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 RankServiceClient rankServiceClient = RankServiceClient.create(rankServiceSettings);

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
 RankServiceSettings rankServiceSettings = RankServiceSettings.newHttpJsonBuilder().build();
 RankServiceClient rankServiceClient = RankServiceClient.create(rankServiceSettings);

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

Inheritance

java.lang.Object > RankServiceClient

Static Methods

create()

public static final RankServiceClient create()

Constructs an instance of RankServiceClient with default settings.

Returns
Type	Description
`RankServiceClient`

Exceptions
Type	Description
`IOException`

create(RankServiceSettings settings)

public static final RankServiceClient create(RankServiceSettings settings)

Constructs an instance of RankServiceClient, 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`	`RankServiceSettings`

Returns
Type	Description
`RankServiceClient`

Exceptions
Type	Description
`IOException`

create(RankServiceStub stub)

public static final RankServiceClient create(RankServiceStub stub)

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

Parameter
Name	Description
`stub`	`RankServiceStub`

Returns
Type	Description
`RankServiceClient`

Constructors

RankServiceClient(RankServiceSettings settings)

protected RankServiceClient(RankServiceSettings settings)

Constructs an instance of RankServiceClient, 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`	`RankServiceSettings`

RankServiceClient(RankServiceStub stub)

protected RankServiceClient(RankServiceStub stub)

Parameter
Name	Description
`stub`	`RankServiceStub`

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

getSettings()

public final RankServiceSettings getSettings()

Returns
Type	Description
`RankServiceSettings`

getStub()

public RankServiceStub getStub()

Returns
Type	Description
`RankServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

rank(RankRequest request)

public final RankResponse rank(RankRequest request)

Ranks a list of text records based on the given input query.

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 (RankServiceClient rankServiceClient = RankServiceClient.create()) {
   RankRequest request =
       RankRequest.newBuilder()
           .setRankingConfig(
               RankingConfigName.of("[PROJECT]", "[LOCATION]", "[RANKING_CONFIG]").toString())
           .setModel("model104069929")
           .setTopN(110545924)
           .setQuery("query107944136")
           .addAllRecords(new ArrayList<RankingRecord>())
           .setIgnoreRecordDetailsInResponse(true)
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   RankResponse response = rankServiceClient.rank(request);
 }

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

Returns
Type	Description
`RankResponse`

rankCallable()

public final UnaryCallable<RankRequest,RankResponse> rankCallable()

Ranks a list of text records based on the given input query.

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 (RankServiceClient rankServiceClient = RankServiceClient.create()) {
   RankRequest request =
       RankRequest.newBuilder()
           .setRankingConfig(
               RankingConfigName.of("[PROJECT]", "[LOCATION]", "[RANKING_CONFIG]").toString())
           .setModel("model104069929")
           .setTopN(110545924)
           .setQuery("query107944136")
           .addAllRecords(new ArrayList<RankingRecord>())
           .setIgnoreRecordDetailsInResponse(true)
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   ApiFuture<RankResponse> future = rankServiceClient.rankCallable().futureCall(request);
   // Do something.
   RankResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<RankRequest,RankResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()