Interface ListTracesRequestOrBuilder (2.42.0)

Version 2.42.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.7
• 2.2.0
• 2.1.13

public interface ListTracesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEndTime()

public abstract Timestamp getEndTime()

End of the time interval (inclusive) during which the trace data was collected from the application.

.google.protobuf.Timestamp end_time = 6;

Returns
Type	Description
Timestamp	The endTime.

getEndTimeOrBuilder()

public abstract TimestampOrBuilder getEndTimeOrBuilder()

End of the time interval (inclusive) during which the trace data was collected from the application.

.google.protobuf.Timestamp end_time = 6;

Returns
Type	Description
TimestampOrBuilder

getFilter()

public abstract String getFilter()

Optional. A filter against labels for the request.

By default, searches use prefix matching. To specify exact match, prepend a plus symbol (+) to the search term. Multiple terms are ANDed. Syntax:

• root:NAME_PREFIX or NAME_PREFIX: Return traces where any root span starts with NAME_PREFIX.
• +root:NAME or +NAME: Return traces where any root span's name is exactly NAME.
• span:NAME_PREFIX: Return traces where any span starts with NAME_PREFIX.
• +span:NAME: Return traces where any span's name is exactly NAME.
• latency:DURATION: Return traces whose overall latency is greater or equal to than DURATION. Accepted units are nanoseconds (ns), milliseconds (ms), and seconds (s). Default is ms. For example, latency:24ms returns traces whose overall latency is greater than or equal to 24 milliseconds.
• label:LABEL_KEY: Return all traces containing the specified label key (exact match, case-sensitive) regardless of the key:value pair's value (including empty values).
• LABEL_KEY:VALUE_PREFIX: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts with VALUE_PREFIX. Both a key and a value must be specified.
• +LABEL_KEY:VALUE: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified.
• method:VALUE: Equivalent to /http/method:VALUE.
• url:VALUE: Equivalent to /http/url:VALUE.

string filter = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Optional. A filter against labels for the request.

By default, searches use prefix matching. To specify exact match, prepend a plus symbol (+) to the search term. Multiple terms are ANDed. Syntax:

• root:NAME_PREFIX or NAME_PREFIX: Return traces where any root span starts with NAME_PREFIX.
• +root:NAME or +NAME: Return traces where any root span's name is exactly NAME.
• span:NAME_PREFIX: Return traces where any span starts with NAME_PREFIX.
• +span:NAME: Return traces where any span's name is exactly NAME.
• latency:DURATION: Return traces whose overall latency is greater or equal to than DURATION. Accepted units are nanoseconds (ns), milliseconds (ms), and seconds (s). Default is ms. For example, latency:24ms returns traces whose overall latency is greater than or equal to 24 milliseconds.
• label:LABEL_KEY: Return all traces containing the specified label key (exact match, case-sensitive) regardless of the key:value pair's value (including empty values).
• LABEL_KEY:VALUE_PREFIX: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts with VALUE_PREFIX. Both a key and a value must be specified.
• +LABEL_KEY:VALUE: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified.
• method:VALUE: Equivalent to /http/method:VALUE.
• url:VALUE: Equivalent to /http/url:VALUE.

string filter = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for filter.

getOrderBy()

public abstract String getOrderBy()

Optional. Field used to sort the returned traces. Can be one of the following:

• trace_id
• name (name field of root span in the trace)
• duration (difference between end_time and start_time fields of the root span)

• start (start_time field of the root span)

  Descending order can be specified by appending desc to the sort field (for example, name desc).

  Only one sort field is permitted.

string order_by = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

Optional. Field used to sort the returned traces. Can be one of the following:

• trace_id
• name (name field of root span in the trace)
• duration (difference between end_time and start_time fields of the root span)

• start (start_time field of the root span)

  Descending order can be specified by appending desc to the sort field (for example, name desc).

  Only one sort field is permitted.

string order_by = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

Optional. Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

Token identifying the page of results to return. If provided, use the value of the next_page_token field from a previous request.

string page_token = 4;

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Token identifying the page of results to return. If provided, use the value of the next_page_token field from a previous request.

string page_token = 4;

Returns
Type	Description
ByteString	The bytes for pageToken.

getProjectId()

public abstract String getProjectId()

Required. ID of the Cloud project where the trace data is stored.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The projectId.

getProjectIdBytes()

public abstract ByteString getProjectIdBytes()

Required. ID of the Cloud project where the trace data is stored.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for projectId.

getStartTime()

public abstract Timestamp getStartTime()

Start of the time interval (inclusive) during which the trace data was collected from the application.

.google.protobuf.Timestamp start_time = 5;

Returns
Type	Description
Timestamp	The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

Start of the time interval (inclusive) during which the trace data was collected from the application.

.google.protobuf.Timestamp start_time = 5;

Returns
Type	Description
TimestampOrBuilder

getView()

public abstract ListTracesRequest.ViewType getView()

Optional. Type of data returned for traces in the list. Default is MINIMAL.

.google.devtools.cloudtrace.v1.ListTracesRequest.ViewType view = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ListTracesRequest.ViewType	The view.

getViewValue()

public abstract int getViewValue()

Optional. Type of data returned for traces in the list. Default is MINIMAL.

.google.devtools.cloudtrace.v1.ListTracesRequest.ViewType view = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for view.

hasEndTime()

public abstract boolean hasEndTime()

End of the time interval (inclusive) during which the trace data was collected from the application.

.google.protobuf.Timestamp end_time = 6;

Returns
Type	Description
boolean	Whether the endTime field is set.

hasStartTime()

public abstract boolean hasStartTime()

Start of the time interval (inclusive) during which the trace data was collected from the application.

.google.protobuf.Timestamp start_time = 5;

Returns
Type	Description
boolean	Whether the startTime field is set.