Struct google_api_proto::google::apps::events::subscriptions::v1::ListSubscriptionsRequest

pub struct ListSubscriptionsRequest {
    pub page_size: i32,
    pub page_token: String,
    pub filter: String,
}

The request message for [SubscriptionsService.ListSubscriptions][google.apps.events.subscriptions.v1.SubscriptionsService.ListSubscriptions].

Fields

page_size: i32

Optional. The maximum number of subscriptions to return. The service might return fewer than this value.

If unspecified or set to 0, up to 50 subscriptions are returned.

The maximum value is 100. If you specify a value more than 100, the system only returns 100 subscriptions.

page_token: String

Optional. A page token, received from a previous list subscriptions call. Provide this parameter to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.

filter: String

Required. A query filter.

You can filter subscriptions by event type (event_types) and target resource (target_resource).

You must specify at least one event type in your query. To filter for multiple event types, use the OR operator.

To filter by both event type and target resource, use the AND operator and specify the full resource name, such as //chat.googleapis.com/spaces/{space}.

For example, the following queries are valid:

event_types:"google.workspace.chat.membership.v1.updated" OR
   event_types:"google.workspace.chat.message.v1.created"

event_types:"google.workspace.chat.message.v1.created" AND
   target_resource="//chat.googleapis.com/spaces/{space}"

( event_types:"google.workspace.chat.membership.v1.updated" OR
   event_types:"google.workspace.chat.message.v1.created" ) AND
   target_resource="//chat.googleapis.com/spaces/{space}"

The server rejects invalid queries with an INVALID_ARGUMENT error.

Trait Implementations

impl Clone for ListSubscriptionsRequest

fn clone(&self) -> ListSubscriptionsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListSubscriptionsRequest

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

Formats the value using the given formatter.

impl Default for ListSubscriptionsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListSubscriptionsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ListSubscriptionsRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListSubscriptionsRequest