Class ListTracesRequest.Builder (2.1.11)

Version 2.1.11

• 2.54.0 (latest)
• 2.53.0
• 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 static final class ListTracesRequest.Builder extends GeneratedMessageV3.Builder<ListTracesRequest.Builder> implements ListTracesRequestOrBuilder

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

Protobuf type google.devtools.cloudtrace.v1.ListTracesRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListTracesRequest.Builder

Implements

ListTracesRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListTracesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ListTracesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ListTracesRequest build()

Returns

Type	Description
ListTracesRequest

buildPartial()

public ListTracesRequest buildPartial()

Returns

Type	Description
ListTracesRequest

clear()

public ListTracesRequest.Builder clear()

Returns

Type	Description
ListTracesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearEndTime()

public ListTracesRequest.Builder clearEndTime()

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
ListTracesRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public ListTracesRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
ListTracesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public ListTracesRequest.Builder clearFilter()

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
ListTracesRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListTracesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
ListTracesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOrderBy()

public ListTracesRequest.Builder clearOrderBy()

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
ListTracesRequest.Builder	This builder for chaining.

clearPageSize()

public ListTracesRequest.Builder clearPageSize()

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
ListTracesRequest.Builder	This builder for chaining.

clearPageToken()

public ListTracesRequest.Builder clearPageToken()

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
ListTracesRequest.Builder	This builder for chaining.

clearProjectId()

public ListTracesRequest.Builder clearProjectId()

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

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

Returns

Type	Description
ListTracesRequest.Builder	This builder for chaining.

clearStartTime()

public ListTracesRequest.Builder clearStartTime()

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
ListTracesRequest.Builder

clearView()

public ListTracesRequest.Builder clearView()

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.Builder	This builder for chaining.

clone()

public ListTracesRequest.Builder clone()

Returns

Type	Description
ListTracesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListTracesRequest getDefaultInstanceForType()

Returns

Type	Description
ListTracesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEndTime()

public 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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

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
Builder

getEndTimeOrBuilder()

public 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 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 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 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 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 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 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 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 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 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 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.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

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
Builder

getStartTimeOrBuilder()

public 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeEndTime(Timestamp value)

public ListTracesRequest.Builder mergeEndTime(Timestamp value)

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

.google.protobuf.Timestamp end_time = 6;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
ListTracesRequest.Builder

mergeFrom(ListTracesRequest other)

public ListTracesRequest.Builder mergeFrom(ListTracesRequest other)

Parameter

Name	Description
other	ListTracesRequest

Returns

Type	Description
ListTracesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListTracesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ListTracesRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ListTracesRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
ListTracesRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeStartTime(Timestamp value)

public ListTracesRequest.Builder mergeStartTime(Timestamp value)

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

.google.protobuf.Timestamp start_time = 5;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
ListTracesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListTracesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ListTracesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setEndTime(Timestamp value)

public ListTracesRequest.Builder setEndTime(Timestamp value)

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

.google.protobuf.Timestamp end_time = 6;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
ListTracesRequest.Builder

setEndTime(Timestamp.Builder builderForValue)

public ListTracesRequest.Builder setEndTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp end_time = 6;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
ListTracesRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ListTracesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ListTracesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

public ListTracesRequest.Builder setFilter(String value)

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];

Parameter

Name	Description
value	String The filter to set.

Returns

Type	Description
ListTracesRequest.Builder	This builder for chaining.

setFilterBytes(ByteString value)

public ListTracesRequest.Builder setFilterBytes(ByteString value)

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];

Parameter

Name	Description
value	ByteString The bytes for filter to set.

Returns

Type	Description
ListTracesRequest.Builder	This builder for chaining.

setOrderBy(String value)

public ListTracesRequest.Builder setOrderBy(String value)

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];

Parameter

Name	Description
value	String The orderBy to set.

Returns

Type	Description
ListTracesRequest.Builder	This builder for chaining.

setOrderByBytes(ByteString value)

public ListTracesRequest.Builder setOrderByBytes(ByteString value)

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];

Parameter

Name	Description
value	ByteString The bytes for orderBy to set.

Returns

Type	Description
ListTracesRequest.Builder	This builder for chaining.

setPageSize(int value)

public ListTracesRequest.Builder setPageSize(int value)

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];

Parameter

Name	Description
value	int The pageSize to set.

Returns

Type	Description
ListTracesRequest.Builder	This builder for chaining.

setPageToken(String value)

public ListTracesRequest.Builder setPageToken(String value)

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;

Parameter

Name	Description
value	String The pageToken to set.

Returns

Type	Description
ListTracesRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public ListTracesRequest.Builder setPageTokenBytes(ByteString value)

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;

Parameter

Name	Description
value	ByteString The bytes for pageToken to set.

Returns

Type	Description
ListTracesRequest.Builder	This builder for chaining.

setProjectId(String value)

public ListTracesRequest.Builder setProjectId(String value)

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

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

Parameter

Name	Description
value	String The projectId to set.

Returns

Type	Description
ListTracesRequest.Builder	This builder for chaining.

setProjectIdBytes(ByteString value)

public ListTracesRequest.Builder setProjectIdBytes(ByteString value)

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

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

Parameter

Name	Description
value	ByteString The bytes for projectId to set.

Returns

Type	Description
ListTracesRequest.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListTracesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
ListTracesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setStartTime(Timestamp value)

public ListTracesRequest.Builder setStartTime(Timestamp value)

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

.google.protobuf.Timestamp start_time = 5;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
ListTracesRequest.Builder

setStartTime(Timestamp.Builder builderForValue)

public ListTracesRequest.Builder setStartTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp start_time = 5;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
ListTracesRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ListTracesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ListTracesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setView(ListTracesRequest.ViewType value)

public ListTracesRequest.Builder setView(ListTracesRequest.ViewType value)

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];

Parameter

Name	Description
value	ListTracesRequest.ViewType The view to set.

Returns

Type	Description
ListTracesRequest.Builder	This builder for chaining.

setViewValue(int value)

public ListTracesRequest.Builder setViewValue(int value)

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];

Parameter

Name	Description
value	int The enum numeric value on the wire for view to set.

Returns

Type	Description
ListTracesRequest.Builder	This builder for chaining.