Class SearchServiceClient (0.31.0)

Version 0.31.0

• 0.50.0 (latest)
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

GitHub Repository

Product Reference

Service Description: Service for search.

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 (SearchServiceClient searchServiceClient = SearchServiceClient.create()) {
   SearchRequest request =
       SearchRequest.newBuilder()
           .setServingConfig(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .setBranch(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setQuery("query107944136")
           .setImageQuery(SearchRequest.ImageQuery.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOffset(-1019779949)
           .setFilter("filter-1274492040")
           .setCanonicalFilter("canonicalFilter-722283124")
           .setOrderBy("orderBy-1207110587")
           .setUserInfo(UserInfo.newBuilder().build())
           .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
           .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
           .putAllParams(new HashMap<String, Value>())
           .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
           .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
           .setUserPseudoId("userPseudoId-1155274652")
           .setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
           .setEmbeddingSpec(SearchRequest.EmbeddingSpec.newBuilder().build())
           .setRankingExpression("rankingExpression2110320494")
           .setSafeSearch(true)
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Note: close() needs to be called on the SearchServiceClient 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
Search	Performs a search.	Request object method variants only take one parameter, a request object, which must be constructed before the call. search(SearchRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. searchPagedCallable() searchCallable()

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 SearchServiceSettings 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
 SearchServiceSettings searchServiceSettings =
     SearchServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SearchServiceClient searchServiceClient = SearchServiceClient.create(searchServiceSettings);
 

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
 SearchServiceSettings searchServiceSettings =
     SearchServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SearchServiceClient searchServiceClient = SearchServiceClient.create(searchServiceSettings);
 

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
 SearchServiceSettings searchServiceSettings =
     SearchServiceSettings.newHttpJsonBuilder().build();
 SearchServiceClient searchServiceClient = SearchServiceClient.create(searchServiceSettings);
 

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

Inheritance

java.lang.Object > SearchServiceClient

Static Methods

create()

public static final SearchServiceClient create()

Constructs an instance of SearchServiceClient with default settings.

Returns
Type	Description
SearchServiceClient

Exceptions
Type	Description
IOException

create(SearchServiceSettings settings)

public static final SearchServiceClient create(SearchServiceSettings settings)

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

Returns
Type	Description
SearchServiceClient

Exceptions
Type	Description
IOException

create(SearchServiceStub stub)

public static final SearchServiceClient create(SearchServiceStub stub)

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

Parameter
Name	Description
stub	SearchServiceStub

Returns
Type	Description
SearchServiceClient

Constructors

SearchServiceClient(SearchServiceSettings settings)

protected SearchServiceClient(SearchServiceSettings settings)

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

SearchServiceClient(SearchServiceStub stub)

protected SearchServiceClient(SearchServiceStub stub)

Parameter
Name	Description
stub	SearchServiceStub

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

Returns
Type	Description
SearchServiceSettings

getStub()

public SearchServiceStub getStub()

Returns
Type	Description
SearchServiceStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

search(SearchRequest request)

public final SearchServiceClient.SearchPagedResponse search(SearchRequest request)

Performs a search.

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 (SearchServiceClient searchServiceClient = SearchServiceClient.create()) {
   SearchRequest request =
       SearchRequest.newBuilder()
           .setServingConfig(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .setBranch(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setQuery("query107944136")
           .setImageQuery(SearchRequest.ImageQuery.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOffset(-1019779949)
           .setFilter("filter-1274492040")
           .setCanonicalFilter("canonicalFilter-722283124")
           .setOrderBy("orderBy-1207110587")
           .setUserInfo(UserInfo.newBuilder().build())
           .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
           .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
           .putAllParams(new HashMap<String, Value>())
           .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
           .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
           .setUserPseudoId("userPseudoId-1155274652")
           .setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
           .setEmbeddingSpec(SearchRequest.EmbeddingSpec.newBuilder().build())
           .setRankingExpression("rankingExpression2110320494")
           .setSafeSearch(true)
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
SearchServiceClient.SearchPagedResponse

searchCallable()

public final UnaryCallable<SearchRequest,SearchResponse> searchCallable()

Performs a search.

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 (SearchServiceClient searchServiceClient = SearchServiceClient.create()) {
   SearchRequest request =
       SearchRequest.newBuilder()
           .setServingConfig(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .setBranch(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setQuery("query107944136")
           .setImageQuery(SearchRequest.ImageQuery.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOffset(-1019779949)
           .setFilter("filter-1274492040")
           .setCanonicalFilter("canonicalFilter-722283124")
           .setOrderBy("orderBy-1207110587")
           .setUserInfo(UserInfo.newBuilder().build())
           .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
           .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
           .putAllParams(new HashMap<String, Value>())
           .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
           .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
           .setUserPseudoId("userPseudoId-1155274652")
           .setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
           .setEmbeddingSpec(SearchRequest.EmbeddingSpec.newBuilder().build())
           .setRankingExpression("rankingExpression2110320494")
           .setSafeSearch(true)
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   while (true) {
     SearchResponse response = searchServiceClient.searchCallable().call(request);
     for (SearchResponse.SearchResult element : response.getResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<SearchRequest,SearchResponse>

searchPagedCallable()

public final UnaryCallable<SearchRequest,SearchServiceClient.SearchPagedResponse> searchPagedCallable()

Performs a search.

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 (SearchServiceClient searchServiceClient = SearchServiceClient.create()) {
   SearchRequest request =
       SearchRequest.newBuilder()
           .setServingConfig(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .setBranch(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setQuery("query107944136")
           .setImageQuery(SearchRequest.ImageQuery.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOffset(-1019779949)
           .setFilter("filter-1274492040")
           .setCanonicalFilter("canonicalFilter-722283124")
           .setOrderBy("orderBy-1207110587")
           .setUserInfo(UserInfo.newBuilder().build())
           .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
           .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
           .putAllParams(new HashMap<String, Value>())
           .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
           .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
           .setUserPseudoId("userPseudoId-1155274652")
           .setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
           .setEmbeddingSpec(SearchRequest.EmbeddingSpec.newBuilder().build())
           .setRankingExpression("rankingExpression2110320494")
           .setSafeSearch(true)
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   ApiFuture<SearchResponse.SearchResult> future =
       searchServiceClient.searchPagedCallable().futureCall(request);
   // Do something.
   for (SearchResponse.SearchResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<SearchRequest,SearchPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()