This repository has been archived by the owner on Oct 3, 2023. It is now read-only.
/
SearchServiceClient.java
421 lines (390 loc) · 16.3 KB
/
SearchServiceClient.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
/*
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.retail.v2;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.retail.v2.stub.SearchServiceStub;
import com.google.cloud.retail.v2.stub.SearchServiceStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Service for search.
*
* <p>This feature is only available for users who have Retail Search enabled. Contact Retail
* Support (retail-search-support{@literal @}google.com) if you are interested in using Retail
* Search.
*
* <p>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:
*
* <pre>{@code
* 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>())
* .build();
* for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* <p>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().
*
* <p>The surface of this class includes several types of Java methods for each of the API's
* methods:
*
* <ol>
* <li>A "flattened" method. With this type of method, the fields of the request type have been
* converted into function parameters. It may be the case that not all fields are available as
* parameters, and not every API method will have a flattened method entry point.
* <li>A "request object" method. This type of method only takes one parameter, a request object,
* which must be constructed before the call. Not every API method will have a request object
* method.
* <li>A "callable" method. This type of method takes no parameters and returns an immutable API
* callable object, which can be used to initiate calls to the service.
* </ol>
*
* <p>See the individual methods for example code.
*
* <p>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.
*
* <p>This class can be customized by passing in a custom instance of SearchServiceSettings to
* create(). For example:
*
* <p>To customize credentials:
*
* <pre>{@code
* SearchServiceSettings searchServiceSettings =
* SearchServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* SearchServiceClient searchServiceClient = SearchServiceClient.create(searchServiceSettings);
* }</pre>
*
* <p>To customize the endpoint:
*
* <pre>{@code
* SearchServiceSettings searchServiceSettings =
* SearchServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* SearchServiceClient searchServiceClient = SearchServiceClient.create(searchServiceSettings);
* }</pre>
*
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class SearchServiceClient implements BackgroundResource {
private final SearchServiceSettings settings;
private final SearchServiceStub stub;
/** Constructs an instance of SearchServiceClient with default settings. */
public static final SearchServiceClient create() throws IOException {
return create(SearchServiceSettings.newBuilder().build());
}
/**
* 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.
*/
public static final SearchServiceClient create(SearchServiceSettings settings)
throws IOException {
return new SearchServiceClient(settings);
}
/**
* Constructs an instance of SearchServiceClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(SearchServiceSettings).
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final SearchServiceClient create(SearchServiceStub stub) {
return new SearchServiceClient(stub);
}
/**
* 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.
*/
protected SearchServiceClient(SearchServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((SearchServiceStubSettings) settings.getStubSettings()).createStub();
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected SearchServiceClient(SearchServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final SearchServiceSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public SearchServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Performs a search.
*
* <p>This feature is only available for users who have Retail Search enabled. Contact Retail
* Support (retail-search-support{@literal @}google.com) if you are interested in using Retail
* Search.
*
* <p>Sample code:
*
* <pre>{@code
* 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>())
* .build();
* for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SearchPagedResponse search(SearchRequest request) {
return searchPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Performs a search.
*
* <p>This feature is only available for users who have Retail Search enabled. Contact Retail
* Support (retail-search-support{@literal @}google.com) if you are interested in using Retail
* Search.
*
* <p>Sample code:
*
* <pre>{@code
* 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>())
* .build();
* ApiFuture<SearchResponse.SearchResult> future =
* searchServiceClient.searchPagedCallable().futureCall(request);
* // Do something.
* for (SearchResponse.SearchResult element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*/
public final UnaryCallable<SearchRequest, SearchPagedResponse> searchPagedCallable() {
return stub.searchPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Performs a search.
*
* <p>This feature is only available for users who have Retail Search enabled. Contact Retail
* Support (retail-search-support{@literal @}google.com) if you are interested in using Retail
* Search.
*
* <p>Sample code:
*
* <pre>{@code
* 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>())
* .build();
* while (true) {
* SearchResponse response = searchServiceClient.searchCallable().call(request);
* for (SearchResponse.SearchResult element : response.getResponsesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }</pre>
*/
public final UnaryCallable<SearchRequest, SearchResponse> searchCallable() {
return stub.searchCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class SearchPagedResponse
extends AbstractPagedListResponse<
SearchRequest,
SearchResponse,
SearchResponse.SearchResult,
SearchPage,
SearchFixedSizeCollection> {
public static ApiFuture<SearchPagedResponse> createAsync(
PageContext<SearchRequest, SearchResponse, SearchResponse.SearchResult> context,
ApiFuture<SearchResponse> futureResponse) {
ApiFuture<SearchPage> futurePage =
SearchPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage, input -> new SearchPagedResponse(input), MoreExecutors.directExecutor());
}
private SearchPagedResponse(SearchPage page) {
super(page, SearchFixedSizeCollection.createEmptyCollection());
}
}
public static class SearchPage
extends AbstractPage<SearchRequest, SearchResponse, SearchResponse.SearchResult, SearchPage> {
private SearchPage(
PageContext<SearchRequest, SearchResponse, SearchResponse.SearchResult> context,
SearchResponse response) {
super(context, response);
}
private static SearchPage createEmptyPage() {
return new SearchPage(null, null);
}
@Override
protected SearchPage createPage(
PageContext<SearchRequest, SearchResponse, SearchResponse.SearchResult> context,
SearchResponse response) {
return new SearchPage(context, response);
}
@Override
public ApiFuture<SearchPage> createPageAsync(
PageContext<SearchRequest, SearchResponse, SearchResponse.SearchResult> context,
ApiFuture<SearchResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class SearchFixedSizeCollection
extends AbstractFixedSizeCollection<
SearchRequest,
SearchResponse,
SearchResponse.SearchResult,
SearchPage,
SearchFixedSizeCollection> {
private SearchFixedSizeCollection(List<SearchPage> pages, int collectionSize) {
super(pages, collectionSize);
}
private static SearchFixedSizeCollection createEmptyCollection() {
return new SearchFixedSizeCollection(null, 0);
}
@Override
protected SearchFixedSizeCollection createCollection(
List<SearchPage> pages, int collectionSize) {
return new SearchFixedSizeCollection(pages, collectionSize);
}
}
}