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| Modifier and Type | Class and Description |
|---|---|
static class |
ListTracesRequest.Builder
The request message for the `ListTraces` method.
|
static class |
ListTracesRequest.ViewType
Type of data returned for traces in the list.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable| Modifier and Type | Field and Description |
|---|---|
static int |
END_TIME_FIELD_NUMBER |
static int |
FILTER_FIELD_NUMBER |
static int |
ORDER_BY_FIELD_NUMBER |
static int |
PAGE_SIZE_FIELD_NUMBER |
static int |
PAGE_TOKEN_FIELD_NUMBER |
static int |
PROJECT_ID_FIELD_NUMBER |
static int |
START_TIME_FIELD_NUMBER |
static int |
VIEW_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFieldsmemoizedSizememoizedHashCode| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
static ListTracesRequest |
getDefaultInstance() |
ListTracesRequest |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
Timestamp |
getEndTime()
End of the time interval (inclusive) during which the trace data was
collected from the application.
|
TimestampOrBuilder |
getEndTimeOrBuilder()
End of the time interval (inclusive) during which the trace data was
collected from the application.
|
java.lang.String |
getFilter()
An optional filter against labels for the request.
|
ByteString |
getFilterBytes()
An optional filter against labels for the request.
|
java.lang.String |
getOrderBy()
Field used to sort the returned traces.
|
ByteString |
getOrderByBytes()
Field used to sort the returned traces.
|
int |
getPageSize()
Maximum number of traces to return.
|
java.lang.String |
getPageToken()
Token identifying the page of results to return.
|
ByteString |
getPageTokenBytes()
Token identifying the page of results to return.
|
Parser<ListTracesRequest> |
getParserForType() |
java.lang.String |
getProjectId()
ID of the Cloud project where the trace data is stored.
|
ByteString |
getProjectIdBytes()
ID of the Cloud project where the trace data is stored.
|
int |
getSerializedSize() |
Timestamp |
getStartTime()
Start of the time interval (inclusive) during which the trace data was
collected from the application.
|
TimestampOrBuilder |
getStartTimeOrBuilder()
Start of the time interval (inclusive) during which the trace data was
collected from the application.
|
UnknownFieldSet |
getUnknownFields() |
ListTracesRequest.ViewType |
getView()
Type of data returned for traces in the list.
|
int |
getViewValue()
Type of data returned for traces in the list.
|
boolean |
hasEndTime()
End of the time interval (inclusive) during which the trace data was
collected from the application.
|
int |
hashCode() |
boolean |
hasStartTime()
Start of the time interval (inclusive) during which the trace data was
collected from the application.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ListTracesRequest.Builder |
newBuilder() |
static ListTracesRequest.Builder |
newBuilder(ListTracesRequest prototype) |
ListTracesRequest.Builder |
newBuilderForType() |
protected ListTracesRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
static ListTracesRequest |
parseDelimitedFrom(java.io.InputStream input) |
static ListTracesRequest |
parseDelimitedFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry) |
static ListTracesRequest |
parseFrom(byte[] data) |
static ListTracesRequest |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static ListTracesRequest |
parseFrom(java.nio.ByteBuffer data) |
static ListTracesRequest |
parseFrom(java.nio.ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static ListTracesRequest |
parseFrom(ByteString data) |
static ListTracesRequest |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static ListTracesRequest |
parseFrom(CodedInputStream input) |
static ListTracesRequest |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static ListTracesRequest |
parseFrom(java.io.InputStream input) |
static ListTracesRequest |
parseFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<ListTracesRequest> |
parser() |
ListTracesRequest.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoftoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int PROJECT_ID_FIELD_NUMBER
public static final int VIEW_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
public final UnknownFieldSet getUnknownFields()
getUnknownFields in interface MessageOrBuildergetUnknownFields in class GeneratedMessageV3public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3public java.lang.String getProjectId()
ID of the Cloud project where the trace data is stored.
string project_id = 1;getProjectId in interface ListTracesRequestOrBuilderpublic ByteString getProjectIdBytes()
ID of the Cloud project where the trace data is stored.
string project_id = 1;getProjectIdBytes in interface ListTracesRequestOrBuilderpublic int getViewValue()
Type of data returned for traces in the list. Optional. Default is `MINIMAL`.
.google.devtools.cloudtrace.v1.ListTracesRequest.ViewType view = 2;getViewValue in interface ListTracesRequestOrBuilderpublic ListTracesRequest.ViewType getView()
Type of data returned for traces in the list. Optional. Default is `MINIMAL`.
.google.devtools.cloudtrace.v1.ListTracesRequest.ViewType view = 2;getView in interface ListTracesRequestOrBuilderpublic int getPageSize()
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. Optional.
int32 page_size = 3;getPageSize in interface ListTracesRequestOrBuilderpublic java.lang.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. Optional.
string page_token = 4;getPageToken in interface ListTracesRequestOrBuilderpublic 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. Optional.
string page_token = 4;getPageTokenBytes in interface ListTracesRequestOrBuilderpublic boolean hasStartTime()
Start of the time interval (inclusive) during which the trace data was collected from the application.
.google.protobuf.Timestamp start_time = 5;hasStartTime in interface ListTracesRequestOrBuilderpublic Timestamp getStartTime()
Start of the time interval (inclusive) during which the trace data was collected from the application.
.google.protobuf.Timestamp start_time = 5;getStartTime in interface ListTracesRequestOrBuilderpublic TimestampOrBuilder getStartTimeOrBuilder()
Start of the time interval (inclusive) during which the trace data was collected from the application.
.google.protobuf.Timestamp start_time = 5;getStartTimeOrBuilder in interface ListTracesRequestOrBuilderpublic boolean hasEndTime()
End of the time interval (inclusive) during which the trace data was collected from the application.
.google.protobuf.Timestamp end_time = 6;hasEndTime in interface ListTracesRequestOrBuilderpublic Timestamp getEndTime()
End of the time interval (inclusive) during which the trace data was collected from the application.
.google.protobuf.Timestamp end_time = 6;getEndTime in interface ListTracesRequestOrBuilderpublic TimestampOrBuilder getEndTimeOrBuilder()
End of the time interval (inclusive) during which the trace data was collected from the application.
.google.protobuf.Timestamp end_time = 6;getEndTimeOrBuilder in interface ListTracesRequestOrBuilderpublic java.lang.String getFilter()
An optional 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;getFilter in interface ListTracesRequestOrBuilderpublic ByteString getFilterBytes()
An optional 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;getFilterBytes in interface ListTracesRequestOrBuilderpublic java.lang.String getOrderBy()
Field used to sort the returned traces. Optional.
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;getOrderBy in interface ListTracesRequestOrBuilderpublic ByteString getOrderByBytes()
Field used to sort the returned traces. Optional.
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;getOrderByBytes in interface ListTracesRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3public void writeTo(CodedOutputStream output) throws java.io.IOException
writeTo in interface MessageLitewriteTo in class GeneratedMessageV3java.io.IOExceptionpublic int getSerializedSize()
getSerializedSize in interface MessageLitegetSerializedSize in class GeneratedMessageV3public boolean equals(java.lang.Object obj)
equals in interface Messageequals in class AbstractMessagepublic int hashCode()
hashCode in interface MessagehashCode in class AbstractMessagepublic static ListTracesRequest parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListTracesRequest parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListTracesRequest parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListTracesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListTracesRequest parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListTracesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListTracesRequest parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static ListTracesRequest parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static ListTracesRequest parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static ListTracesRequest parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static ListTracesRequest parseFrom(CodedInputStream input) throws java.io.IOException
java.io.IOExceptionpublic static ListTracesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic ListTracesRequest.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static ListTracesRequest.Builder newBuilder()
public static ListTracesRequest.Builder newBuilder(ListTracesRequest prototype)
public ListTracesRequest.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected ListTracesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static ListTracesRequest getDefaultInstance()
public static Parser<ListTracesRequest> parser()
public Parser<ListTracesRequest> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public ListTracesRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilder