Struct ListSessionsRequest 

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

Available on crate features conversational-search-service or session-service only.

Request for ListSessions method.

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 data store resource name. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

page_size: i32

Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

page_token: String

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

filter: String

A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are:

• user_pseudo_id
• state
• display_name
• starred
• is_pinned
• labels
• create_time
• update_time

Examples: “user_pseudo_id = some_id” “display_name = "some_name"” “starred = true” “is_pinned=true AND (NOT labels:hidden)” “create_time > "1970-01-01T12:00:00Z"”

order_by: String

A comma-separated list of fields to order by, sorted in ascending order. Use “desc” after a field name for descending. Supported fields:

• update_time
• create_time
• session_name
• is_pinned

Example:

• “update_time desc”
• “create_time”
• “is_pinned desc,update_time desc”: list sessions by is_pinned first, then by update_time.

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}/dataStores/{data_store_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");

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

Sets the value of order_by.

Example

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