Struct ListGroupsOptions 

pub struct ListGroupsOptions { /* private fields */ }

Options for Admin::list_groups.

Implementations

impl ListGroupsOptions

pub fn new() -> Self

Creates default options (no filters).

pub fn for_consumer_groups() -> Self

Only consumer groups will be returned by list_groups(). This operation sets filters on group type and protocol type which select consumer groups.

pub fn for_share_groups() -> Self

Only share groups will be returned by list_groups(). This operation sets a filter on group type which select share groups.

pub fn for_streams_groups() -> Self

Only streams groups will be returned by list_groups(). This operation sets a filter on group type which select streams groups.

pub fn in_group_states(self, group_states: HashSet<GroupState>) -> Self

If group_states is set, only groups in these states will be returned by list_groups(). Otherwise, all groups are returned. This operation is supported by brokers with version 2.6.0 or later.

Arguments

• group_states - the group states to filter by.

Returns

This ListGroupsOptions instance.

pub fn with_protocol_types(self, protocol_types: HashSet<String>) -> Self

If protocol types is set, only groups of these protocol types will be returned by list_groups(). Otherwise, all groups are returned.

Arguments

• protocol_types - the protocol types to filter by.

Returns

This ListGroupsOptions instance.

pub fn with_types(self, types: HashSet<GroupType>) -> Self

If types is set, only groups of these types will be returned by list_groups(). Otherwise, all groups are returned.

Arguments

• types - the group types to filter by.

Returns

This ListGroupsOptions instance.

pub fn set_timeout_ms(self, timeout_ms: Option<i32>) -> Self

Set the timeout in milliseconds for this operation, or None if the default API timeout for the AdminClient should be used.

Arguments

• timeout_ms - the timeout in milliseconds, or None for the default API timeout.

Returns

This ListGroupsOptions instance.

pub fn group_states(&self) -> &HashSet<GroupState>

Returns the list of group states that are requested or empty if no states have been specified.

pub fn protocol_types(&self) -> &HashSet<String>

Returns the list of protocol types that are requested or empty if no protocol types have been specified.

pub fn types(&self) -> &HashSet<GroupType>

Returns the list of group types that are requested or empty if no types have been specified.

pub fn timeout_ms(&self) -> Option<i32>

Returns the timeout in milliseconds for this operation, or None if the default API timeout for the AdminClient should be used.

Trait Implementations

impl Clone for ListGroupsOptions

fn clone(&self) -> ListGroupsOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListGroupsOptions

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

Formats the value using the given formatter.

impl Default for ListGroupsOptions

fn default() -> ListGroupsOptions

Returns the “default value” for a type.