/
BookshopClient.golden
287 lines (268 loc) · 10.8 KB
/
BookshopClient.golden
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
package com.google.bookshop.v1beta1;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.bookshop.v1beta1.stub.BookshopStub;
import com.google.bookshop.v1beta1.stub.BookshopStubSettings;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* 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
* // 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 (BookshopClient bookshopClient = BookshopClient.create()) {
* int booksCount = 1618425911;
* List<Book> books = new ArrayList<>();
* Book response = bookshopClient.getBook(booksCount, books);
* }
* }</pre>
*
* <p>Note: close() needs to be called on the BookshopClient object to clean up resources such as
* threads. In the example above, try-with-resources is used, which automatically calls close().
*
* <table>
* <tr>
* <th>Method</th>
* <th>Description</th>
* <th>Method Variants</th>
* <tr>
* <td>GetBook</td>
* <td><p> </td>
* <td>
* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
* <ul>
* <li>getBook(GetBookRequest request)
* </ul>
* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>
* <ul>
* <li>getBook(int booksCount, List<Book> books)
* <li>getBook(String booksList, List<Book> books)
* </ul>
* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
* <ul>
* <li>getBookCallable()
* </ul>
* </td>
* </tr>
* </tr>
* </table>
*
* <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 BookshopSettings to create().
* For example:
*
* <p>To customize credentials:
*
* <pre>{@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
* BookshopSettings bookshopSettings =
* BookshopSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* BookshopClient bookshopClient = BookshopClient.create(bookshopSettings);
* }</pre>
*
* <p>To customize the endpoint:
*
* <pre>{@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
* BookshopSettings bookshopSettings =
* BookshopSettings.newBuilder().setEndpoint(myEndpoint).build();
* BookshopClient bookshopClient = BookshopClient.create(bookshopSettings);
* }</pre>
*
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class BookshopClient implements BackgroundResource {
private final BookshopSettings settings;
private final BookshopStub stub;
/** Constructs an instance of BookshopClient with default settings. */
public static final BookshopClient create() throws IOException {
return create(BookshopSettings.newBuilder().build());
}
/**
* Constructs an instance of BookshopClient, 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 BookshopClient create(BookshopSettings settings) throws IOException {
return new BookshopClient(settings);
}
/**
* Constructs an instance of BookshopClient, using the given stub for making calls. This is for
* advanced usage - prefer using create(BookshopSettings).
*/
public static final BookshopClient create(BookshopStub stub) {
return new BookshopClient(stub);
}
/**
* Constructs an instance of BookshopClient, 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 BookshopClient(BookshopSettings settings) throws IOException {
this.settings = settings;
this.stub = ((BookshopStubSettings) settings.getStubSettings()).createStub();
}
protected BookshopClient(BookshopStub stub) {
this.settings = null;
this.stub = stub;
}
public final BookshopSettings getSettings() {
return settings;
}
public BookshopStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sample code:
*
* <pre>{@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 (BookshopClient bookshopClient = BookshopClient.create()) {
* int booksCount = 1618425911;
* List<Book> books = new ArrayList<>();
* Book response = bookshopClient.getBook(booksCount, books);
* }
* }</pre>
*
* @param booksCount
* @param books
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Book getBook(int booksCount, List<Book> books) {
GetBookRequest request =
GetBookRequest.newBuilder().setBooksCount(booksCount).addAllBooks(books).build();
return getBook(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sample code:
*
* <pre>{@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 (BookshopClient bookshopClient = BookshopClient.create()) {
* String booksList = "booksList2-1119589686";
* List<Book> books = new ArrayList<>();
* Book response = bookshopClient.getBook(booksList, books);
* }
* }</pre>
*
* @param booksList
* @param books
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Book getBook(String booksList, List<Book> books) {
GetBookRequest request =
GetBookRequest.newBuilder().setBooksList(booksList).addAllBooks(books).build();
return getBook(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sample code:
*
* <pre>{@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 (BookshopClient bookshopClient = BookshopClient.create()) {
* GetBookRequest request =
* GetBookRequest.newBuilder()
* .setBooksCount1(1618425911)
* .setBooksList2("booksList2-1119589686")
* .addAllBooks3(new ArrayList<Book>())
* .build();
* Book response = bookshopClient.getBook(request);
* }
* }</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 Book getBook(GetBookRequest request) {
return getBookCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sample code:
*
* <pre>{@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 (BookshopClient bookshopClient = BookshopClient.create()) {
* GetBookRequest request =
* GetBookRequest.newBuilder()
* .setBooksCount1(1618425911)
* .setBooksList2("booksList2-1119589686")
* .addAllBooks3(new ArrayList<Book>())
* .build();
* ApiFuture<Book> future = bookshopClient.getBookCallable().futureCall(request);
* // Do something.
* Book response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetBookRequest, Book> getBookCallable() {
return stub.getBookCallable();
}
@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);
}
}