Package com.google.devtools.cloudtrace.v1

Class ListTracesRequest

  • All Implemented Interfaces:
    ListTracesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListTracesRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListTracesRequestOrBuilder
     The request message for the `ListTraces` method. All fields are required
 unless specified.
    Protobuf type google.devtools.cloudtrace.v1.ListTracesRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class 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.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        getProjectId in interface ListTracesRequestOrBuilder
        Returns:
        The projectId.

      • getProjectIdBytes

        public com.google.protobuf.ByteString getProjectIdBytes()
         Required. ID of the Cloud project where the trace data is stored.
        string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getProjectIdBytes in interface ListTracesRequestOrBuilder
        Returns:
        The bytes for projectId.

      • 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];
        Specified by:
        getViewValue in interface ListTracesRequestOrBuilder
        Returns:
        The enum numeric value on the wire for view.

      • 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];
        Specified by:
        getView in interface ListTracesRequestOrBuilder
        Returns:
        The view.

      • 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];
        Specified by:
        getPageSize in interface ListTracesRequestOrBuilder
        Returns:
        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;
        Specified by:
        getPageToken in interface ListTracesRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.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;
        Specified by:
        getPageTokenBytes in interface ListTracesRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • 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;
        Specified by:
        hasStartTime in interface ListTracesRequestOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         Start of the time interval (inclusive) during which the trace data was
 collected from the application.
        .google.protobuf.Timestamp start_time = 5;
        Specified by:
        getStartTime in interface ListTracesRequestOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Start of the time interval (inclusive) during which the trace data was
 collected from the application.
        .google.protobuf.Timestamp start_time = 5;
        Specified by:
        getStartTimeOrBuilder in interface ListTracesRequestOrBuilder

      • 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;
        Specified by:
        hasEndTime in interface ListTracesRequestOrBuilder
        Returns:
        Whether the endTime field is set.

      • getEndTime

        public com.google.protobuf.Timestamp getEndTime()
         End of the time interval (inclusive) during which the trace data was
 collected from the application.
        .google.protobuf.Timestamp end_time = 6;
        Specified by:
        getEndTime in interface ListTracesRequestOrBuilder
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         End of the time interval (inclusive) during which the trace data was
 collected from the application.
        .google.protobuf.Timestamp end_time = 6;
        Specified by:
        getEndTimeOrBuilder in interface ListTracesRequestOrBuilder

      • 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];
        Specified by:
        getFilter in interface ListTracesRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.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];
        Specified by:
        getFilterBytes in interface ListTracesRequestOrBuilder
        Returns:
        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];
        Specified by:
        getOrderBy in interface ListTracesRequestOrBuilder
        Returns:
        The orderBy.

      • getOrderByBytes

        public com.google.protobuf.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];
        Specified by:
        getOrderByBytes in interface ListTracesRequestOrBuilder
        Returns:
        The bytes for orderBy.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ListTracesRequest parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListTracesRequest parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListTracesRequest parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListTracesRequest parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListTracesRequest parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListTracesRequest parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListTracesRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ListTracesRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ListTracesRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ListTracesRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ListTracesRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ListTracesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder