51
51
* <p>This class provides the ability to make remote calls to the backing service through method
52
52
* calls that map to API methods. Sample code to get started:
53
53
*
54
+ * <pre>{@code
55
+ * try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
56
+ * String projectId = "projectId-894832108";
57
+ * String traceId = "traceId-1067401920";
58
+ * Trace response = traceServiceClient.getTrace(projectId, traceId);
59
+ * }
60
+ * }</pre>
61
+ *
54
62
* <p>Note: close() needs to be called on the TraceServiceClient object to clean up resources such
55
63
* as threads. In the example above, try-with-resources is used, which automatically calls close().
56
64
*
@@ -153,6 +161,17 @@ public TraceServiceStub getStub() {
153
161
/**
154
162
* Returns of a list of traces that match the specified filter conditions.
155
163
*
164
+ * <p>Sample code:
165
+ *
166
+ * <pre>{@code
167
+ * try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
168
+ * String projectId = "projectId-894832108";
169
+ * for (Trace element : traceServiceClient.listTraces(projectId).iterateAll()) {
170
+ * // doThingsWith(element);
171
+ * }
172
+ * }
173
+ * }</pre>
174
+ *
156
175
* @param projectId Required. ID of the Cloud project where the trace data is stored.
157
176
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
158
177
*/
@@ -165,6 +184,26 @@ public final ListTracesPagedResponse listTraces(String projectId) {
165
184
/**
166
185
* Returns of a list of traces that match the specified filter conditions.
167
186
*
187
+ * <p>Sample code:
188
+ *
189
+ * <pre>{@code
190
+ * try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
191
+ * ListTracesRequest request =
192
+ * ListTracesRequest.newBuilder()
193
+ * .setProjectId("projectId-894832108")
194
+ * .setPageSize(883849137)
195
+ * .setPageToken("pageToken873572522")
196
+ * .setStartTime(Timestamp.newBuilder().build())
197
+ * .setEndTime(Timestamp.newBuilder().build())
198
+ * .setFilter("filter-1274492040")
199
+ * .setOrderBy("orderBy-1207110587")
200
+ * .build();
201
+ * for (Trace element : traceServiceClient.listTraces(request).iterateAll()) {
202
+ * // doThingsWith(element);
203
+ * }
204
+ * }
205
+ * }</pre>
206
+ *
168
207
* @param request The request object containing all of the parameters for the API call.
169
208
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
170
209
*/
@@ -177,6 +216,26 @@ public final ListTracesPagedResponse listTraces(ListTracesRequest request) {
177
216
* Returns of a list of traces that match the specified filter conditions.
178
217
*
179
218
* <p>Sample code:
219
+ *
220
+ * <pre>{@code
221
+ * try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
222
+ * ListTracesRequest request =
223
+ * ListTracesRequest.newBuilder()
224
+ * .setProjectId("projectId-894832108")
225
+ * .setPageSize(883849137)
226
+ * .setPageToken("pageToken873572522")
227
+ * .setStartTime(Timestamp.newBuilder().build())
228
+ * .setEndTime(Timestamp.newBuilder().build())
229
+ * .setFilter("filter-1274492040")
230
+ * .setOrderBy("orderBy-1207110587")
231
+ * .build();
232
+ * ApiFuture<Trace> future = traceServiceClient.listTracesPagedCallable().futureCall(request);
233
+ * // Do something.
234
+ * for (Trace element : future.get().iterateAll()) {
235
+ * // doThingsWith(element);
236
+ * }
237
+ * }
238
+ * }</pre>
180
239
*/
181
240
public final UnaryCallable <ListTracesRequest , ListTracesPagedResponse > listTracesPagedCallable () {
182
241
return stub .listTracesPagedCallable ();
@@ -187,6 +246,23 @@ public final UnaryCallable<ListTracesRequest, ListTracesPagedResponse> listTrace
187
246
* Returns of a list of traces that match the specified filter conditions.
188
247
*
189
248
* <p>Sample code:
249
+ *
250
+ * <pre>{@code
251
+ * try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
252
+ * while (true) {
253
+ * ListTracesResponse response = traceServiceClient.listTracesCallable().call(request);
254
+ * for (Trace element : response.getResponsesList()) {
255
+ * // doThingsWith(element);
256
+ * }
257
+ * String nextPageToken = response.getNextPageToken();
258
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
259
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
260
+ * } else {
261
+ * break;
262
+ * }
263
+ * }
264
+ * }
265
+ * }</pre>
190
266
*/
191
267
public final UnaryCallable <ListTracesRequest , ListTracesResponse > listTracesCallable () {
192
268
return stub .listTracesCallable ();
@@ -196,6 +272,16 @@ public final UnaryCallable<ListTracesRequest, ListTracesResponse> listTracesCall
196
272
/**
197
273
* Gets a single trace by its ID.
198
274
*
275
+ * <p>Sample code:
276
+ *
277
+ * <pre>{@code
278
+ * try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
279
+ * String projectId = "projectId-894832108";
280
+ * String traceId = "traceId-1067401920";
281
+ * Trace response = traceServiceClient.getTrace(projectId, traceId);
282
+ * }
283
+ * }</pre>
284
+ *
199
285
* @param projectId Required. ID of the Cloud project where the trace data is stored.
200
286
* @param traceId Required. ID of the trace to return.
201
287
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -210,6 +296,19 @@ public final Trace getTrace(String projectId, String traceId) {
210
296
/**
211
297
* Gets a single trace by its ID.
212
298
*
299
+ * <p>Sample code:
300
+ *
301
+ * <pre>{@code
302
+ * try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
303
+ * GetTraceRequest request =
304
+ * GetTraceRequest.newBuilder()
305
+ * .setProjectId("projectId-894832108")
306
+ * .setTraceId("traceId-1067401920")
307
+ * .build();
308
+ * Trace response = traceServiceClient.getTrace(request);
309
+ * }
310
+ * }</pre>
311
+ *
213
312
* @param request The request object containing all of the parameters for the API call.
214
313
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
215
314
*/
@@ -222,6 +321,19 @@ public final Trace getTrace(GetTraceRequest request) {
222
321
* Gets a single trace by its ID.
223
322
*
224
323
* <p>Sample code:
324
+ *
325
+ * <pre>{@code
326
+ * try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
327
+ * GetTraceRequest request =
328
+ * GetTraceRequest.newBuilder()
329
+ * .setProjectId("projectId-894832108")
330
+ * .setTraceId("traceId-1067401920")
331
+ * .build();
332
+ * ApiFuture<Trace> future = traceServiceClient.getTraceCallable().futureCall(request);
333
+ * // Do something.
334
+ * Trace response = future.get();
335
+ * }
336
+ * }</pre>
225
337
*/
226
338
public final UnaryCallable <GetTraceRequest , Trace > getTraceCallable () {
227
339
return stub .getTraceCallable ();
@@ -234,6 +346,16 @@ public final UnaryCallable<GetTraceRequest, Trace> getTraceCallable() {
234
346
* overwritten by the provided values, and any new fields provided are merged with the existing
235
347
* trace data. If the ID does not match, a new trace is created.
236
348
*
349
+ * <p>Sample code:
350
+ *
351
+ * <pre>{@code
352
+ * try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
353
+ * String projectId = "projectId-894832108";
354
+ * Traces traces = Traces.newBuilder().build();
355
+ * traceServiceClient.patchTraces(projectId, traces);
356
+ * }
357
+ * }</pre>
358
+ *
237
359
* @param projectId Required. ID of the Cloud project where the trace data is stored.
238
360
* @param traces Required. The body of the message.
239
361
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -251,6 +373,19 @@ public final void patchTraces(String projectId, Traces traces) {
251
373
* overwritten by the provided values, and any new fields provided are merged with the existing
252
374
* trace data. If the ID does not match, a new trace is created.
253
375
*
376
+ * <p>Sample code:
377
+ *
378
+ * <pre>{@code
379
+ * try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
380
+ * PatchTracesRequest request =
381
+ * PatchTracesRequest.newBuilder()
382
+ * .setProjectId("projectId-894832108")
383
+ * .setTraces(Traces.newBuilder().build())
384
+ * .build();
385
+ * traceServiceClient.patchTraces(request);
386
+ * }
387
+ * }</pre>
388
+ *
254
389
* @param request The request object containing all of the parameters for the API call.
255
390
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
256
391
*/
@@ -266,6 +401,19 @@ public final void patchTraces(PatchTracesRequest request) {
266
401
* trace data. If the ID does not match, a new trace is created.
267
402
*
268
403
* <p>Sample code:
404
+ *
405
+ * <pre>{@code
406
+ * try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
407
+ * PatchTracesRequest request =
408
+ * PatchTracesRequest.newBuilder()
409
+ * .setProjectId("projectId-894832108")
410
+ * .setTraces(Traces.newBuilder().build())
411
+ * .build();
412
+ * ApiFuture<Empty> future = traceServiceClient.patchTracesCallable().futureCall(request);
413
+ * // Do something.
414
+ * future.get();
415
+ * }
416
+ * }</pre>
269
417
*/
270
418
public final UnaryCallable <PatchTracesRequest , Empty > patchTracesCallable () {
271
419
return stub .patchTracesCallable ();
0 commit comments