Google Cloud Trace v1 API - Class TraceService.TraceServiceClient (3.1.0)

public class TraceServiceClient : ClientBase<TraceService.TraceServiceClient>

Reference documentation and code samples for the Google Cloud Trace v1 API class TraceService.TraceServiceClient.

Client for TraceService

Inheritance

Object > ClientBase > ClientBase<TraceService.TraceServiceClient> > TraceService.TraceServiceClient

Namespace

Google.Cloud.Trace.V1

Assembly

Google.Cloud.Trace.V1.dll

Constructors

TraceServiceClient()

protected TraceServiceClient()

Protected parameterless constructor to allow creation of test doubles.

TraceServiceClient(CallInvoker)

public TraceServiceClient(CallInvoker callInvoker)

Creates a new client for TraceService that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

TraceServiceClient(ChannelBase)

public TraceServiceClient(ChannelBase channel)

Creates a new client for TraceService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

TraceServiceClient(ClientBase.ClientBaseConfiguration)

protected TraceServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

GetTrace(GetTraceRequest, CallOptions)

public virtual Trace GetTrace(GetTraceRequest request, CallOptions options)

Gets a single trace by its ID.

Parameters
NameDescription
requestGetTraceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Trace

The response received from the server.

GetTrace(GetTraceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Trace GetTrace(GetTraceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a single trace by its ID.

Parameters
NameDescription
requestGetTraceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Trace

The response received from the server.

GetTraceAsync(GetTraceRequest, CallOptions)

public virtual AsyncUnaryCall<Trace> GetTraceAsync(GetTraceRequest request, CallOptions options)

Gets a single trace by its ID.

Parameters
NameDescription
requestGetTraceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Trace>

The call object.

GetTraceAsync(GetTraceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Trace> GetTraceAsync(GetTraceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a single trace by its ID.

Parameters
NameDescription
requestGetTraceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Trace>

The call object.

ListTraces(ListTracesRequest, CallOptions)

public virtual ListTracesResponse ListTraces(ListTracesRequest request, CallOptions options)

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

Parameters
NameDescription
requestListTracesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListTracesResponse

The response received from the server.

ListTraces(ListTracesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListTracesResponse ListTraces(ListTracesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestListTracesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListTracesResponse

The response received from the server.

ListTracesAsync(ListTracesRequest, CallOptions)

public virtual AsyncUnaryCall<ListTracesResponse> ListTracesAsync(ListTracesRequest request, CallOptions options)

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

Parameters
NameDescription
requestListTracesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListTracesResponse>

The call object.

ListTracesAsync(ListTracesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListTracesResponse> ListTracesAsync(ListTracesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestListTracesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListTracesResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override TraceService.TraceServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
TraceService.TraceServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Trace.V1.TraceService.TraceServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

PatchTraces(PatchTracesRequest, CallOptions)

public virtual Empty PatchTraces(PatchTracesRequest request, CallOptions options)

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.

Parameters
NameDescription
requestPatchTracesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

PatchTraces(PatchTracesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty PatchTraces(PatchTracesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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.

Parameters
NameDescription
requestPatchTracesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

PatchTracesAsync(PatchTracesRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> PatchTracesAsync(PatchTracesRequest request, CallOptions options)

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.

Parameters
NameDescription
requestPatchTracesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

PatchTracesAsync(PatchTracesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> PatchTracesAsync(PatchTracesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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.

Parameters
NameDescription
requestPatchTracesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.