public final class ListTracesRequest extends GeneratedMessageV3 implements ListTracesRequestOrBuilder
The request message for the ListTraces method. All fields are required
unless specified.
Protobuf type google.devtools.cloudtrace.v1.ListTracesRequest
Static Fields
public static final int END_TIME_FIELD_NUMBER
Field Value
public static final int FILTER_FIELD_NUMBER
Field Value
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
public static final int PROJECT_ID_FIELD_NUMBER
Field Value
public static final int START_TIME_FIELD_NUMBER
Field Value
public static final int VIEW_FIELD_NUMBER
Field Value
Static Methods
public static ListTracesRequest getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static ListTracesRequest.Builder newBuilder()
Returns
public static ListTracesRequest.Builder newBuilder(ListTracesRequest prototype)
Parameter
Returns
public static ListTracesRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListTracesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTracesRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static ListTracesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTracesRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static ListTracesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTracesRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListTracesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTracesRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListTracesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTracesRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static ListTracesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<ListTracesRequest> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public ListTracesRequest getDefaultInstanceForType()
Returns
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;
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;
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];
| Type | Description |
| String | The filter.
|
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];
public String getOrderBy()
Optional. Field used to sort the returned traces.
Can be one of the following:
trace_idname (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];
| Type | Description |
| String | The orderBy.
|
public ByteString getOrderByBytes()
Optional. Field used to sort the returned traces.
Can be one of the following:
trace_idname (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];
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];
| 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;
| 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;
public Parser<ListTracesRequest> getParserForType()
Returns
Overrides
public String getProjectId()
Required. ID of the Cloud project where the trace data is stored.
string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The projectId.
|
public ByteString getProjectIdBytes()
Required. ID of the Cloud project where the trace data is stored.
string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
public int getSerializedSize()
Returns
Overrides
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;
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;
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
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];
| Type | Description |
| int | The enum numeric value on the wire for view.
|
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;
| Type | Description |
| boolean | Whether the endTime field is set.
|
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;
| Type | Description |
| boolean | Whether the startTime field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public ListTracesRequest.Builder newBuilderForType()
Returns
protected ListTracesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public ListTracesRequest.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
