Package com.google.apps.events.subscriptions.v1beta

Interface ListSubscriptionsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListSubscriptionsRequest, ListSubscriptionsRequest.Builder
@Generated public interface ListSubscriptionsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Required.
    com.google.protobuf.ByteString
    getFilterBytes()
    Required.
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getPageSize

      int getPageSize()
       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.
      int32 page_size = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       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.
      string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       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.
      string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.

    • getFilter

      String getFilter()
       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.
      string filter = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       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.
      string filter = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for filter.