Struct ListTracesRequest 

#[non_exhaustive]
pub struct ListTracesRequest {
    pub project_id: String,
    pub view: ViewType,
    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,
    /* private fields */
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

project_id: String

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

view: ViewType

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 new() -> Self

pub fn set_project_id<T: Into<String>>(self, v: T) -> Self

Sets the value of project_id.

Example

let x = ListTracesRequest::new().set_project_id("example");

pub fn set_view<T: Into<ViewType>>(self, v: T) -> Self

Sets the value of view.

Example

use google_cloud_trace_v1::model::list_traces_request::ViewType;
let x0 = ListTracesRequest::new().set_view(ViewType::Minimal);
let x1 = ListTracesRequest::new().set_view(ViewType::Rootspan);
let x2 = ListTracesRequest::new().set_view(ViewType::Complete);

pub fn set_page_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_size.

Example

let x = ListTracesRequest::new().set_page_size(42);

pub fn set_page_token<T: Into<String>>(self, v: T) -> Self

Sets the value of page_token.

Example

let x = ListTracesRequest::new().set_page_token("example");

pub fn set_start_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of start_time.

Example

use wkt::Timestamp;
let x = ListTracesRequest::new().set_start_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_start_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of start_time.

Example

use wkt::Timestamp;
let x = ListTracesRequest::new().set_or_clear_start_time(Some(Timestamp::default()/* use setters */));
let x = ListTracesRequest::new().set_or_clear_start_time(None::<Timestamp>);

pub fn set_end_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of end_time.

Example

use wkt::Timestamp;
let x = ListTracesRequest::new().set_end_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_end_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of end_time.

Example

use wkt::Timestamp;
let x = ListTracesRequest::new().set_or_clear_end_time(Some(Timestamp::default()/* use setters */));
let x = ListTracesRequest::new().set_or_clear_end_time(None::<Timestamp>);

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

Example

let x = ListTracesRequest::new().set_filter("example");

pub fn set_order_by<T: Into<String>>(self, v: T) -> Self

Sets the value of order_by.

Example

let x = ListTracesRequest::new().set_order_by("example");

Trait Implementations

impl Clone for ListTracesRequest

fn clone(&self) -> ListTracesRequest

Returns a duplicate 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() -> ListTracesRequest

Returns the “default value” for a type.

impl Message for ListTracesRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ListTracesRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ListTracesRequest