Struct ListSessionsRequest 

#[non_exhaustive]
pub struct ListSessionsRequest {
    pub parent: String,
    pub page_size: i32,
    pub page_token: String,
    pub filter: String,
    /* private fields */
}

A request to list sessions in a project.

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.

parent: String

Required. The parent, which owns this collection of sessions.

page_size: i32

Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.

page_token: String

Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page.

filter: String

Optional. A filter for the sessions to return in the response.

A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields are session_id, session_uuid, state, create_time, and labels.

Example: state = ACTIVE and create_time < "2023-01-01T00:00:00Z" is a filter for sessions in an ACTIVE state that were created before 2023-01-01. state = ACTIVE and labels.environment=production is a filter for sessions in an ACTIVE state that have a production environment label.

See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparators.

Implementations

impl ListSessionsRequest

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of parent.

Example

let x = ListSessionsRequest::new().set_parent(format!("projects/{project_id}/locations/{location_id}"));

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

Sets the value of page_size.

Example

let x = ListSessionsRequest::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 = ListSessionsRequest::new().set_page_token("example");

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

Sets the value of filter.

Example

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

Trait Implementations

impl Clone for ListSessionsRequest

fn clone(&self) -> ListSessionsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListSessionsRequest

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

Formats the value using the given formatter.

impl Default for ListSessionsRequest

fn default() -> ListSessionsRequest

Returns the “default value” for a type.

impl Message for ListSessionsRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ListSessionsRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ListSessionsRequest