Package com.google.devtools.cloudtrace.v1

Interface ListTracesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListTracesRequest, ListTracesRequest.Builder
@Generated public interface ListTracesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Timestamp
    getEndTime()
    End of the time interval (inclusive) during which the trace data was collected from the application.
    com.google.protobuf.TimestampOrBuilder
    getEndTimeOrBuilder()
    End of the time interval (inclusive) during which the trace data was collected from the application.
    String
    getFilter()
    Optional.
    com.google.protobuf.ByteString
    getFilterBytes()
    Optional.
    String
    getOrderBy()
    Optional.
    com.google.protobuf.ByteString
    getOrderByBytes()
    Optional.
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Token identifying the page of results to return.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Token identifying the page of results to return.
    String
    getProjectId()
    Required.
    com.google.protobuf.ByteString
    getProjectIdBytes()
    Required.
    com.google.protobuf.Timestamp
    getStartTime()
    Start of the time interval (inclusive) during which the trace data was collected from the application.
    com.google.protobuf.TimestampOrBuilder
    getStartTimeOrBuilder()
    Start of the time interval (inclusive) during which the trace data was collected from the application.
    ListTracesRequest.ViewType
    getView()
    Optional.
    int
    getViewValue()
    Optional.
    boolean
    hasEndTime()
    End of the time interval (inclusive) during which the trace data was collected from the application.
    boolean
    hasStartTime()
    Start of the time interval (inclusive) during which the trace data was collected from the application.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getProjectId

      String getProjectId()
       Required. ID of the Cloud project where the trace data is stored.
      string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The projectId.

    • getProjectIdBytes

      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];
      Returns:
      The bytes for projectId.

    • getViewValue

      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:
      The enum numeric value on the wire for view.

    • getView

      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:
      The view.

    • getPageSize

      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:
      The pageSize.

    • getPageToken

      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:
      The pageToken.

    • getPageTokenBytes

      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;
      Returns:
      The bytes for pageToken.

    • hasStartTime

      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:
      Whether the startTime field is set.

    • getStartTime

      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;
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      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;

    • hasEndTime

      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:
      Whether the endTime field is set.

    • getEndTime

      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;
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      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;

    • getFilter

      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:
      The filter.

    • getFilterBytes

      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];
      Returns:
      The bytes for filter.

    • getOrderBy

      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:
      The orderBy.

    • getOrderByBytes

      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];
      Returns:
      The bytes for orderBy.