# Package Classes (1.20.0)

1.20.0 (latest) 1.19.0 1.18.0 1.17.0 1.16.2 1.15.0 1.14.1 1.13.5 1.12.0 1.11.3 1.10.0 1.9.1 1.8.0 1.7.3 1.6.2 1.5.1 1.4.0 1.3.4 1.2.0 1.1.0 1.0.0 0.24.2 0.23.0 0.22.1 Summary of entries of Classes for cloudtrace.

## Classes

### [TraceServiceAsyncClient](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.services.trace_service.TraceServiceAsyncClient)

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.

### [TraceServiceClient](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.services.trace_service.TraceServiceClient)

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.

### [ListTracesAsyncPager](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.services.trace_service.pagers.ListTracesAsyncPager)

A pager for iterating through `list_traces` requests.

This class thinly wraps an initial
[ListTracesResponse](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.types.ListTracesResponse) object, and
provides an `__aiter__` method to iterate through its
`traces` field.

If there are more pages, the `__aiter__` method will make additional
`ListTraces` requests and continue to iterate
through the `traces` field on the
corresponding responses.

All the usual [ListTracesResponse](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.types.ListTracesResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [ListTracesPager](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.services.trace_service.pagers.ListTracesPager)

A pager for iterating through `list_traces` requests.

This class thinly wraps an initial
[ListTracesResponse](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.types.ListTracesResponse) object, and
provides an `__iter__` method to iterate through its
`traces` field.

If there are more pages, the `__iter__` method will make additional
`ListTraces` requests and continue to iterate
through the `traces` field on the
corresponding responses.

All the usual [ListTracesResponse](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.types.ListTracesResponse)
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [GetTraceRequest](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.types.GetTraceRequest)

The request message for the `GetTrace` method.

### [ListTracesRequest](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.types.ListTracesRequest)

The request message for the `ListTraces` method. All fields are
required unless specified.

### [ViewType](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.types.ListTracesRequest.ViewType)

Type of data returned for traces in the list.

### [ListTracesResponse](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.types.ListTracesResponse)

The response message for the `ListTraces` method.

### [PatchTracesRequest](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.types.PatchTracesRequest)

The request message for the `PatchTraces` method.

### [Trace](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.types.Trace)

A trace describes how long it takes for an application to
perform an operation. It consists of a set of spans, each of
which represent a single timed event within the operation.

### [TraceSpan](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.types.TraceSpan)

A span represents a single timed event within a trace. Spans
can be nested and form a trace tree. Often, a trace contains a
root span that describes the end-to-end latency of an operation
and, optionally, one or more subspans for its suboperations.
Spans do not need to be contiguous. There may be gaps between
spans in a trace.

### [LabelsEntry](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.types.TraceSpan.LabelsEntry)

The abstract base class for a message.

### [SpanKind](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.types.TraceSpan.SpanKind)

Type of span. Can be used to specify additional relationships
between spans in addition to a parent/child relationship.

### [Traces](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.types.Traces)

List of new or updated traces.

### [TraceServiceAsyncClient](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.services.trace_service.TraceServiceAsyncClient)

Service for collecting and viewing traces and spans within a
trace.
A trace is a collection of spans corresponding to a single
operation or a set of operations in an application.

A span is an individual timed event which forms a node of the
trace tree. A single trace can contain spans from multiple
services.

### [TraceServiceClient](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.services.trace_service.TraceServiceClient)

Service for collecting and viewing traces and spans within a
trace.
A trace is a collection of spans corresponding to a single
operation or a set of operations in an application.

A span is an individual timed event which forms a node of the
trace tree. A single trace can contain spans from multiple
services.

### [AttributeValue](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.AttributeValue)

The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute.

This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.

.. _oneof: <https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields>

### [BatchWriteSpansRequest](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.BatchWriteSpansRequest)

The request message for the `BatchWriteSpans` method.

### [Module](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.Module)

Binary module.

### [Span](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.Span)

A span represents a single operation within a trace. Spans
can be nested to form a trace tree. Often, a trace contains a
root span that describes the end-to-end latency, and one or more
subspans for its sub-operations.

A trace can also contain multiple root spans, or none at all.
Spans do not need to be contiguous. There might be
gaps or overlaps between spans in a trace.

### [Attributes](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.Span.Attributes)

A set of attributes as key-value pairs.

### [AttributeMapEntry](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.Span.Attributes.AttributeMapEntry)

The abstract base class for a message.

### [Link](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.Span.Link)

A pointer from the current span to another span in the same
trace or in a different trace. For example, this can be used in
batching operations, where a single batch handler processes
multiple requests from different traces or when the handler
receives a request from a different project.

### [Type](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.Span.Link.Type)

The relationship of the current span relative to the linked
span: child, parent, or unspecified.

### [Links](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.Span.Links)

A collection of links, which are references from this span to
a span in the same or different trace.

### [SpanKind](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.Span.SpanKind)

Type of span. Can be used to specify additional relationships
between spans in addition to a parent/child relationship.

### [TimeEvent](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.Span.TimeEvent)

A time-stamped annotation or message event in the Span.

This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.

.. _oneof: <https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields>

### [Annotation](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.Span.TimeEvent.Annotation)

Text annotation with a set of attributes.

### [MessageEvent](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.Span.TimeEvent.MessageEvent)

An event describing a message sent/received between Spans.

### [Type](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.Span.TimeEvent.MessageEvent.Type)

Indicates whether the message was sent or received.

### [TimeEvents](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.Span.TimeEvents)

A collection of `TimeEvent`\\ s. A `TimeEvent` is a time-stamped
annotation on the span, consisting of either user-supplied key:value
pairs, or details of a message sent/received between Spans.

### [StackTrace](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.StackTrace)

A call stack appearing in a trace.

### [StackFrame](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.StackTrace.StackFrame)

Represents a single stack frame in a stack trace.

### [StackFrames](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.StackTrace.StackFrames)

A collection of stack frames, which can be truncated.

### [TruncatableString](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v2.types.TruncatableString)

Represents a string that might be shortened to a specified
length.

## Modules

### [pagers](https://docs-0cloud-0google-0com.linkedin.net.nz/python/docs/reference/cloudtrace/latest/google.cloud.trace_v1.services.trace_service.pagers)

API documentation for `trace_v1.services.trace_service.pagers` module.