com.google.cloud.trace.v1

Class TraceServiceClient

java.lang.Object

com.google.cloud.trace.v1.TraceServiceClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class TraceServiceClient
extends Object
implements 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:

 
 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "";
   Traces traces = Traces.newBuilder().build();
   traceServiceClient.patchTraces(projectId, traces);
 }
 
 

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

The surface of this class includes several types of Java methods for each of the API's methods:

1. 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.
2. 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.
3. 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.

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:

 
 TraceServiceSettings traceServiceSettings =
     TraceServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TraceServiceClient traceServiceClient =
     TraceServiceClient.create(traceServiceSettings);
 
 

To customize the endpoint:

 
 TraceServiceSettings traceServiceSettings =
     TraceServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TraceServiceClient traceServiceClient =
     TraceServiceClient.create(traceServiceSettings);
 
 

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

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()
com.google.devtools.cloudtrace.v1.Trace	getTrace(com.google.devtools.cloudtrace.v1.GetTraceRequest request) Gets a single trace by its ID.
com.google.devtools.cloudtrace.v1.Trace	getTrace(String projectId, String traceId) Gets a single trace by its ID.
UnaryCallable<com.google.devtools.cloudtrace.v1.GetTraceRequest,com.google.devtools.cloudtrace.v1.Trace>	getTraceCallable() Gets a single trace by its ID.
boolean	isShutdown()
boolean	isTerminated()
TraceServiceClient.ListTracesPagedResponse	listTraces(com.google.devtools.cloudtrace.v1.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.
UnaryCallable<com.google.devtools.cloudtrace.v1.ListTracesRequest,com.google.devtools.cloudtrace.v1.ListTracesResponse>	listTracesCallable() Returns of a list of traces that match the specified filter conditions.
UnaryCallable<com.google.devtools.cloudtrace.v1.ListTracesRequest,TraceServiceClient.ListTracesPagedResponse>	listTracesPagedCallable() Returns of a list of traces that match the specified filter conditions.
void	patchTraces(com.google.devtools.cloudtrace.v1.PatchTracesRequest request) Sends new traces to Stackdriver Trace or updates existing traces.
void	patchTraces(String projectId, com.google.devtools.cloudtrace.v1.Traces traces) Sends new traces to Stackdriver Trace or updates existing traces.
UnaryCallable<com.google.devtools.cloudtrace.v1.PatchTracesRequest,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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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 to use TraceServiceSettings}.

getSettings

public final TraceServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public TraceServiceStub getStub()

patchTraces

public final void patchTraces(String projectId,
                              com.google.devtools.cloudtrace.v1.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:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "";
   Traces traces = Traces.newBuilder().build();
   traceServiceClient.patchTraces(projectId, traces);
 }
 

Parameters:

projectId - ID of the Cloud project where the trace data is stored.

traces - The body of the message.

Throws:

ApiException - if the remote call fails

patchTraces

public final void patchTraces(com.google.devtools.cloudtrace.v1.PatchTracesRequest request)

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:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "";
   Traces traces = Traces.newBuilder().build();
   PatchTracesRequest request = PatchTracesRequest.newBuilder()
     .setProjectId(projectId)
     .setTraces(traces)
     .build();
   traceServiceClient.patchTraces(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

patchTracesCallable

public final UnaryCallable<com.google.devtools.cloudtrace.v1.PatchTracesRequest,Empty> patchTracesCallable()

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:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "";
   Traces traces = Traces.newBuilder().build();
   PatchTracesRequest request = PatchTracesRequest.newBuilder()
     .setProjectId(projectId)
     .setTraces(traces)
     .build();
   ApiFuture<Void> future = traceServiceClient.patchTracesCallable().futureCall(request);
   // Do something
   future.get();
 }
 

getTrace

public final com.google.devtools.cloudtrace.v1.Trace getTrace(String projectId,
                                                              String traceId)

Gets a single trace by its ID.

Sample code:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "";
   String traceId = "";
   Trace response = traceServiceClient.getTrace(projectId, traceId);
 }
 

Parameters:

projectId - ID of the Cloud project where the trace data is stored.

traceId - ID of the trace to return.

Throws:

ApiException - if the remote call fails

getTrace

public final com.google.devtools.cloudtrace.v1.Trace getTrace(com.google.devtools.cloudtrace.v1.GetTraceRequest request)

Gets a single trace by its ID.

Sample code:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "";
   String traceId = "";
   GetTraceRequest request = GetTraceRequest.newBuilder()
     .setProjectId(projectId)
     .setTraceId(traceId)
     .build();
   Trace response = traceServiceClient.getTrace(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

getTraceCallable

public final UnaryCallable<com.google.devtools.cloudtrace.v1.GetTraceRequest,com.google.devtools.cloudtrace.v1.Trace> getTraceCallable()

Gets a single trace by its ID.

Sample code:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "";
   String traceId = "";
   GetTraceRequest request = GetTraceRequest.newBuilder()
     .setProjectId(projectId)
     .setTraceId(traceId)
     .build();
   ApiFuture<Trace> future = traceServiceClient.getTraceCallable().futureCall(request);
   // Do something
   Trace response = future.get();
 }
 

listTraces

public final TraceServiceClient.ListTracesPagedResponse listTraces(String projectId)

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

Sample code:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "";
   for (Trace element : traceServiceClient.listTraces(projectId).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

projectId - ID of the Cloud project where the trace data is stored.

Throws:

ApiException - if the remote call fails

listTraces

public final TraceServiceClient.ListTracesPagedResponse listTraces(com.google.devtools.cloudtrace.v1.ListTracesRequest request)

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

Sample code:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "";
   ListTracesRequest request = ListTracesRequest.newBuilder()
     .setProjectId(projectId)
     .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:

ApiException - if the remote call fails

listTracesPagedCallable

public final UnaryCallable<com.google.devtools.cloudtrace.v1.ListTracesRequest,TraceServiceClient.ListTracesPagedResponse> listTracesPagedCallable()

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

Sample code:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "";
   ListTracesRequest request = ListTracesRequest.newBuilder()
     .setProjectId(projectId)
     .build();
   ApiFuture<ListTracesPagedResponse> future = traceServiceClient.listTracesPagedCallable().futureCall(request);
   // Do something
   for (Trace element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listTracesCallable

public final UnaryCallable<com.google.devtools.cloudtrace.v1.ListTracesRequest,com.google.devtools.cloudtrace.v1.ListTracesResponse> listTracesCallable()

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

Sample code:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String projectId = "";
   ListTracesRequest request = ListTracesRequest.newBuilder()
     .setProjectId(projectId)
     .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;
     }
   }
 }
 

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