Struct google_api_proto::google::devtools::cloudtrace::v1::ListTracesRequest

pub struct ListTracesRequest {
    pub project_id: String,
    pub view: i32,
    pub page_size: i32,
    pub page_token: String,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub filter: String,
    pub order_by: String,
}

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

Fields

project_id: String

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

view: i32

Optional. Type of data returned for traces in the list. Default is MINIMAL.

page_size: i32

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.

page_token: String

Token identifying the page of results to return. If provided, use the value of the next_page_token field from a previous request.

start_time: Option<Timestamp>

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

end_time: Option<Timestamp>

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

filter: String

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.

order_by: String

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.

Implementations

impl ListTracesRequest

pub fn view(&self) -> ViewType

Returns the enum value of view, or the default if the field is set to an invalid enum value.

pub fn set_view(&mut self, value: ViewType)

Sets view to the provided enum value.

Trait Implementations

impl Clone for ListTracesRequest

fn clone(&self) -> ListTracesRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListTracesRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListTracesRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListTracesRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ListTracesRequest

fn eq(&self, other: &ListTracesRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListTracesRequest