Struct ListGroupsRequest

#[non_exhaustive]
pub struct ListGroupsRequest {
    pub name: String,
    pub page_size: i32,
    pub page_token: String,
    pub filter: Option<Filter>,
}

The ListGroup request.

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.

name: String

Required. The project whose groups are to be listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

page_size: i32

A positive number that is the maximum number of results to return.

page_token: String

If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

filter: Option<Filter>

An optional filter consisting of a single group name. The filters limit the groups returned based on their parent-child relationship with the specified group. If no filter is specified, all groups are returned.

Implementations

impl ListGroupsRequest

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

Sets the value of name.

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

Sets the value of page_size.

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

Sets the value of page_token.

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

Sets the value of filter.

pub fn get_children_of_group(&self) -> Option<&String>

The value of filter if it holds a ChildrenOfGroup, None if the field is not set or holds a different branch.

pub fn get_ancestors_of_group(&self) -> Option<&String>

The value of filter if it holds a AncestorsOfGroup, None if the field is not set or holds a different branch.

pub fn get_descendants_of_group(&self) -> Option<&String>

The value of filter if it holds a DescendantsOfGroup, None if the field is not set or holds a different branch.

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

Sets the value of filter to hold a ChildrenOfGroup.

Note that all the setters affecting filter are mutually exclusive.

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

Sets the value of filter to hold a AncestorsOfGroup.

Note that all the setters affecting filter are mutually exclusive.

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

Sets the value of filter to hold a DescendantsOfGroup.

Note that all the setters affecting filter are mutually exclusive.

Trait Implementations

impl Clone for ListGroupsRequest

fn clone(&self) -> ListGroupsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListGroupsRequest

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

Formats the value using the given formatter.

impl Default for ListGroupsRequest

fn default() -> ListGroupsRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListGroupsRequest

where ListGroupsRequest: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for ListGroupsRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ListGroupsRequest

fn eq(&self, other: &ListGroupsRequest) -> 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 Serialize for ListGroupsRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ListGroupsRequest