TraceServiceClient (Google Cloud Trace 2.54.0 API)

java.lang.Object
- com.google.cloud.trace.v1.TraceServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class TraceServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: This file describes an API for collecting and viewing traces and spans within a trace. A Trace is a collection of spans corresponding to a single operation or set of operations for an application. A span is an individual timed event which forms a node of the trace tree. Spans for a single trace may span multiple services.

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 (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "projectId-894832108";
   String traceId = "traceId-1067401920";
   Trace response = traceServiceClient.getTrace(projectId, traceId);
 }

Note: close() needs to be called on the TraceServiceClient 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
ListTraces	Returns of a list of traces that match the specified filter conditions.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listTraces(ListTracesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listTraces(String projectId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listTracesPagedCallable() listTracesCallable()
GetTrace	Gets a single trace by its ID.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getTrace(GetTraceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getTrace(String projectId, String traceId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getTraceCallable()
PatchTraces	Sends new traces to Stackdriver Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created.	Request object method variants only take one parameter, a request object, which must be constructed before the call. patchTraces(PatchTracesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. patchTraces(String projectId, Traces traces) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. patchTracesCallable()

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 TraceServiceSettings 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
 TraceServiceSettings traceServiceSettings =
     TraceServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TraceServiceClient traceServiceClient = TraceServiceClient.create(traceServiceSettings);

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
 TraceServiceSettings traceServiceSettings =
     TraceServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TraceServiceClient traceServiceClient = TraceServiceClient.create(traceServiceSettings);

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
 TraceServiceSettings traceServiceSettings = TraceServiceSettings.newHttpJsonBuilder().build();
 TraceServiceClient traceServiceClient = TraceServiceClient.create(traceServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TraceServiceClient.ListTracesFixedSizeCollection`
`static class`	`TraceServiceClient.ListTracesPage`
`static class`	`TraceServiceClient.ListTracesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TraceServiceClient(TraceServiceSettings settings)` Constructs an instance of TraceServiceClient, using the given settings.
`protected`	`TraceServiceClient(TraceServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static TraceServiceClient`	`create()` Constructs an instance of TraceServiceClient with default settings.
`static TraceServiceClient`	`create(TraceServiceSettings settings)` Constructs an instance of TraceServiceClient, using the given settings.
`static TraceServiceClient`	`create(TraceServiceStub stub)` Constructs an instance of TraceServiceClient, using the given stub for making calls.
`TraceServiceSettings`	`getSettings()`
`TraceServiceStub`	`getStub()`
`Trace`	`getTrace(GetTraceRequest request)` Gets a single trace by its ID.
`Trace`	`getTrace(String projectId, String traceId)` Gets a single trace by its ID.
`com.google.api.gax.rpc.UnaryCallable<GetTraceRequest,Trace>`	`getTraceCallable()` Gets a single trace by its ID.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`TraceServiceClient.ListTracesPagedResponse`	`listTraces(ListTracesRequest request)` Returns of a list of traces that match the specified filter conditions.
`TraceServiceClient.ListTracesPagedResponse`	`listTraces(String projectId)` Returns of a list of traces that match the specified filter conditions.
`com.google.api.gax.rpc.UnaryCallable<ListTracesRequest,ListTracesResponse>`	`listTracesCallable()` Returns of a list of traces that match the specified filter conditions.
`com.google.api.gax.rpc.UnaryCallable<ListTracesRequest,TraceServiceClient.ListTracesPagedResponse>`	`listTracesPagedCallable()` Returns of a list of traces that match the specified filter conditions.
`void`	`patchTraces(PatchTracesRequest request)` Sends new traces to Stackdriver Trace or updates existing traces.
`void`	`patchTraces(String projectId, Traces traces)` Sends new traces to Stackdriver Trace or updates existing traces.
`com.google.api.gax.rpc.UnaryCallable<PatchTracesRequest,com.google.protobuf.Empty>`	`patchTracesCallable()` Sends new traces to Stackdriver Trace or updates existing traces.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

Constructor Detail
- TraceServiceClient
```
protected TraceServiceClient(TraceServiceSettings settings)
                      throws IOException
```
  Constructs an instance of TraceServiceClient, 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
- TraceServiceClient
```
protected TraceServiceClient(TraceServiceStub stub)
```

Method Detail

create

public static final TraceServiceClient create()
                                       throws IOException

Constructs an instance of TraceServiceClient with default settings.

Throws:: IOException

create
```
public static final TraceServiceClient create(TraceServiceSettings settings)
                                       throws IOException
```
Constructs an instance of TraceServiceClient, 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 TraceServiceClient create(TraceServiceStub stub)
```
Constructs an instance of TraceServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(TraceServiceSettings).

getSettings

public final TraceServiceSettings getSettings()

getStub
```
public TraceServiceStub getStub()
```

listTraces

public final TraceServiceClient.ListTracesPagedResponse listTraces(String projectId)

Returns of a list of traces that match the specified filter conditions.

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 (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "projectId-894832108";
   for (Trace element : traceServiceClient.listTraces(projectId).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: projectId - Required. ID of the Cloud project where the trace data is stored.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listTraces

public final TraceServiceClient.ListTracesPagedResponse listTraces(ListTracesRequest request)

Returns of a list of traces that match the specified filter conditions.

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 (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   ListTracesRequest request =
       ListTracesRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Trace element : traceServiceClient.listTraces(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: 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

listTracesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTracesRequest,TraceServiceClient.ListTracesPagedResponse> listTracesPagedCallable()

Returns of a list of traces that match the specified filter conditions.

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 (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   ListTracesRequest request =
       ListTracesRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Trace> future = traceServiceClient.listTracesPagedCallable().futureCall(request);
   // Do something.
   for (Trace element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listTracesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTracesRequest,ListTracesResponse> listTracesCallable()

Returns of a list of traces that match the specified filter conditions.

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 (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   ListTracesRequest request =
       ListTracesRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListTracesResponse response = traceServiceClient.listTracesCallable().call(request);
     for (Trace element : response.getTracesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getTrace

public final Trace getTrace(String projectId,
                            String traceId)

Gets a single trace by its ID.

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 (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "projectId-894832108";
   String traceId = "traceId-1067401920";
   Trace response = traceServiceClient.getTrace(projectId, traceId);
 }

Parameters:: projectId - Required. ID of the Cloud project where the trace data is stored.; traceId - Required. ID of the trace to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getTrace

public final Trace getTrace(GetTraceRequest request)

Gets a single trace by its ID.

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 (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   GetTraceRequest request =
       GetTraceRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setTraceId("traceId-1067401920")
           .build();
   Trace response = traceServiceClient.getTrace(request);
 }

Parameters:: 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

getTraceCallable

public final com.google.api.gax.rpc.UnaryCallable<GetTraceRequest,Trace> getTraceCallable()

Gets a single trace by its ID.

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 (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   GetTraceRequest request =
       GetTraceRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setTraceId("traceId-1067401920")
           .build();
   ApiFuture<Trace> future = traceServiceClient.getTraceCallable().futureCall(request);
   // Do something.
   Trace response = future.get();
 }

patchTraces

public final void patchTraces(String projectId,
                              Traces traces)

Sends new traces to Stackdriver Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created.

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 (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "projectId-894832108";
   Traces traces = Traces.newBuilder().build();
   traceServiceClient.patchTraces(projectId, traces);
 }

Parameters:: projectId - Required. ID of the Cloud project where the trace data is stored.; traces - Required. The body of the message.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

patchTraces

public final void patchTraces(PatchTracesRequest request)

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 (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   PatchTracesRequest request =
       PatchTracesRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setTraces(Traces.newBuilder().build())
           .build();
   traceServiceClient.patchTraces(request);
 }

Parameters:: 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

patchTracesCallable

public final com.google.api.gax.rpc.UnaryCallable<PatchTracesRequest,com.google.protobuf.Empty> patchTracesCallable()

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 (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   PatchTracesRequest request =
       PatchTracesRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setTraces(Traces.newBuilder().build())
           .build();
   ApiFuture<Empty> future = traceServiceClient.patchTracesCallable().futureCall(request);
   // Do something.
   future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class TraceServiceClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TraceServiceClient

TraceServiceClient

Method Detail

create

create

create

getSettings

getStub

listTraces

listTraces

listTracesPagedCallable

listTracesCallable

getTrace

getTrace

getTraceCallable

patchTraces

patchTraces

patchTracesCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination