| 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)
.addAllDataStoreSpecs(new ArrayList<SearchRequest.DataStoreSpec>())
.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().
| 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.
Callable method variants take no parameters and return 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 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.
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)
.addAllDataStoreSpecs(new ArrayList<SearchRequest.DataStoreSpec>())
.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 | SearchRequestThe 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)
.addAllDataStoreSpecs(new ArrayList<SearchRequest.DataStoreSpec>())
.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)
.addAllDataStoreSpecs(new ArrayList<SearchRequest.DataStoreSpec>())
.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()