Struct google_cloudtrace1::api::ProjectTraceListCall

source ·

pub struct ProjectTraceListCall<'a, S>where
    S: 'a,
{ /* private fields */ }

Expand description

Returns a list of traces that match the specified filter conditions.

A builder for the traces.list method supported by a project resource. It is not used directly, but through a ProjectMethods instance.

§Example

Instantiate a resource method builder

 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().traces_list("projectId")
             .view("takimata")
             .start_time(chrono::Utc::now())
             .page_token("amet.")
             .page_size(-20)
             .order_by("ipsum")
             .filter("gubergren")
             .end_time(chrono::Utc::now())
             .doit().await;

Implementations§

source §

impl<'a, S> ProjectTraceListCall<'a, S>
where S: Service<Uri> + Clone + Send + Sync + 'static, S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static, S::Future: Send + Unpin + 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>,

source

pub async fn doit(self) -> Result<(Response<Body>, ListTracesResponse)>

Perform the operation you have build so far.

source

pub fn project_id(self, new_value: &str) -> ProjectTraceListCall<'a, S>

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

Sets the project id path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

source

pub fn view(self, new_value: &str) -> ProjectTraceListCall<'a, S>

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

Sets the view query property to the given value.

source

pub fn start_time(self, new_value: DateTime<Utc>) -> ProjectTraceListCall<'a, S>

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

Sets the start time query property to the given value.

source

pub fn page_token(self, new_value: &str) -> ProjectTraceListCall<'a, S>

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

Sets the page token query property to the given value.

source

pub fn page_size(self, new_value: i32) -> ProjectTraceListCall<'a, S>

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.

Sets the page size query property to the given value.

source

pub fn order_by(self, new_value: &str) -> ProjectTraceListCall<'a, S>

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.

Sets the order by query property to the given value.

source

pub fn filter(self, new_value: &str) -> ProjectTraceListCall<'a, S>

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.

Sets the filter query property to the given value.

source

pub fn end_time(self, new_value: DateTime<Utc>) -> ProjectTraceListCall<'a, S>

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

Sets the end time query property to the given value.

source

pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> ProjectTraceListCall<'a, S>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

                  It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

source

pub fn param<T>(self, name: T, value: T) -> ProjectTraceListCall<'a, S>
where T: AsRef<str>,

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

§Additional Parameters

$.xgafv (query-string) - V1 error format.
access_token (query-string) - OAuth access token.
alt (query-string) - Data format for response.
callback (query-string) - JSONP
fields (query-string) - Selector specifying which fields to include in a partial response.
key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
oauth_token (query-string) - OAuth 2.0 token for the current user.
prettyPrint (query-boolean) - Returns response with indentations and line breaks.
quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).

source

pub fn add_scope<St>(self, scope: St) -> ProjectTraceListCall<'a, S>
where St: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead of the default Scope variant Scope::TraceReadonly.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope.

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

source

pub fn add_scopes<I, St>(self, scopes: I) -> ProjectTraceListCall<'a, S>
where I: IntoIterator<Item = St>, St: AsRef<str>,

Identifies the authorization scope(s) for the method you are building.

See Self::add_scope() for details.

source

pub fn clear_scopes(self) -> ProjectTraceListCall<'a, S>

Removes all scopes, and no default scope will be used either. In this case, you have to specify your API-key using the key parameter (see Self::param() for details).