com.google.cloud.retail.v2beta.SearchServiceClient

All Implemented Interfaces:: BackgroundResource, AutoCloseable

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

Service Description: Service for search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

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()
           .setPlacement("placement1792938725")
           .setBranch(
               BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]").toString())
           .setQuery("query107944136")
           .setVisitorId("visitorId1880545833")
           .setUserInfo(UserInfo.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOffset(-1019779949)
           .setFilter("filter-1274492040")
           .setCanonicalFilter("canonicalFilter-722283124")
           .setOrderBy("orderBy-1207110587")
           .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
           .setDynamicFacetSpec(SearchRequest.DynamicFacetSpec.newBuilder().build())
           .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
           .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
           .addAllVariantRollupKeys(new ArrayList<String>())
           .addAllPageCategories(new ArrayList<String>())
           .setPersonalizationSpec(SearchRequest.PersonalizationSpec.newBuilder().build())
           .putAllLabels(new HashMap<String, String>())
           .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
           .setEntity("entity-1298275357")
           .setConversationalSearchSpec(
               SearchRequest.ConversationalSearchSpec.newBuilder().build())
           .setTileNavigationSpec(SearchRequest.TileNavigationSpec.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setRegionCode("regionCode-1991004415")
           .setPlaceId("placeId-494224254")
           .putAllUserAttributes(new HashMap<String, StringList>())
           .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. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.	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.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

SearchServiceClient.SearchFixedSizeCollection

static class

SearchServiceClient.SearchPage

static class

SearchServiceClient.SearchPagedResponse
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

SearchServiceClient(SearchServiceSettings settings)

Constructs an instance of SearchServiceClient, using the given settings.

protected

SearchServiceClient(SearchServiceStub stub)
Method Summary

Modifier and Type

Method

Description

boolean

awaitTermination(long duration, TimeUnit unit)

final void

close()

static final SearchServiceClient

create()

Constructs an instance of SearchServiceClient with default settings.

static final SearchServiceClient

create(SearchServiceSettings settings)

Constructs an instance of SearchServiceClient, using the given settings.

static final SearchServiceClient

create(SearchServiceStub stub)

Constructs an instance of SearchServiceClient, using the given stub for making calls.

final SearchServiceSettings

getSettings()

SearchServiceStub

getStub()

boolean

isShutdown()

boolean

isTerminated()

final SearchServiceClient.SearchPagedResponse

search(SearchRequest request)

Performs a search.

final UnaryCallable<SearchRequest,SearchResponse>

searchCallable()

Performs a search.

final UnaryCallable<SearchRequest,SearchServiceClient.SearchPagedResponse>

searchPagedCallable()

Performs a search.

void

shutdown()

void

shutdownNow()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- SearchServiceClient
  
  protected SearchServiceClient(SearchServiceSettings settings) throws IOException
  
  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.
  
  Throws:
  
  IOException
- SearchServiceClient
  
  protected SearchServiceClient(SearchServiceStub stub)

Method Details

create

public static final SearchServiceClient create() throws IOException

Constructs an instance of SearchServiceClient with default settings.

Throws:

IOException
create

public static final SearchServiceClient create(SearchServiceSettings settings) throws IOException

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.

Throws:

IOException
create

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

public final SearchServiceSettings getSettings()
getStub

public SearchServiceStub getStub()

search

public final SearchServiceClient.SearchPagedResponse search(SearchRequest request)

Performs a search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

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()
           .setPlacement("placement1792938725")
           .setBranch(
               BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]").toString())
           .setQuery("query107944136")
           .setVisitorId("visitorId1880545833")
           .setUserInfo(UserInfo.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOffset(-1019779949)
           .setFilter("filter-1274492040")
           .setCanonicalFilter("canonicalFilter-722283124")
           .setOrderBy("orderBy-1207110587")
           .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
           .setDynamicFacetSpec(SearchRequest.DynamicFacetSpec.newBuilder().build())
           .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
           .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
           .addAllVariantRollupKeys(new ArrayList<String>())
           .addAllPageCategories(new ArrayList<String>())
           .setPersonalizationSpec(SearchRequest.PersonalizationSpec.newBuilder().build())
           .putAllLabels(new HashMap<String, String>())
           .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
           .setEntity("entity-1298275357")
           .setConversationalSearchSpec(
               SearchRequest.ConversationalSearchSpec.newBuilder().build())
           .setTileNavigationSpec(SearchRequest.TileNavigationSpec.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setRegionCode("regionCode-1991004415")
           .setPlaceId("placeId-494224254")
           .putAllUserAttributes(new HashMap<String, StringList>())
           .build();
   for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

searchPagedCallable

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

Performs a search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

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()
           .setPlacement("placement1792938725")
           .setBranch(
               BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]").toString())
           .setQuery("query107944136")
           .setVisitorId("visitorId1880545833")
           .setUserInfo(UserInfo.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOffset(-1019779949)
           .setFilter("filter-1274492040")
           .setCanonicalFilter("canonicalFilter-722283124")
           .setOrderBy("orderBy-1207110587")
           .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
           .setDynamicFacetSpec(SearchRequest.DynamicFacetSpec.newBuilder().build())
           .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
           .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
           .addAllVariantRollupKeys(new ArrayList<String>())
           .addAllPageCategories(new ArrayList<String>())
           .setPersonalizationSpec(SearchRequest.PersonalizationSpec.newBuilder().build())
           .putAllLabels(new HashMap<String, String>())
           .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
           .setEntity("entity-1298275357")
           .setConversationalSearchSpec(
               SearchRequest.ConversationalSearchSpec.newBuilder().build())
           .setTileNavigationSpec(SearchRequest.TileNavigationSpec.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setRegionCode("regionCode-1991004415")
           .setPlaceId("placeId-494224254")
           .putAllUserAttributes(new HashMap<String, StringList>())
           .build();
   ApiFuture<SearchResponse.SearchResult> future =
       searchServiceClient.searchPagedCallable().futureCall(request);
   // Do something.
   for (SearchResponse.SearchResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

searchCallable

public final UnaryCallable<SearchRequest,SearchResponse> searchCallable()

Performs a search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

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()
           .setPlacement("placement1792938725")
           .setBranch(
               BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]").toString())
           .setQuery("query107944136")
           .setVisitorId("visitorId1880545833")
           .setUserInfo(UserInfo.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOffset(-1019779949)
           .setFilter("filter-1274492040")
           .setCanonicalFilter("canonicalFilter-722283124")
           .setOrderBy("orderBy-1207110587")
           .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
           .setDynamicFacetSpec(SearchRequest.DynamicFacetSpec.newBuilder().build())
           .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
           .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
           .addAllVariantRollupKeys(new ArrayList<String>())
           .addAllPageCategories(new ArrayList<String>())
           .setPersonalizationSpec(SearchRequest.PersonalizationSpec.newBuilder().build())
           .putAllLabels(new HashMap<String, String>())
           .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
           .setEntity("entity-1298275357")
           .setConversationalSearchSpec(
               SearchRequest.ConversationalSearchSpec.newBuilder().build())
           .setTileNavigationSpec(SearchRequest.TileNavigationSpec.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setRegionCode("regionCode-1991004415")
           .setPlaceId("placeId-494224254")
           .putAllUserAttributes(new HashMap<String, StringList>())
           .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;
     }
   }
 }

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

Class SearchServiceClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

SearchServiceClient

SearchServiceClient

Method Details

create

create

create

getSettings

getStub

search

searchPagedCallable

searchCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination