Class ListSubscriptionsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListSubscriptionsRequest.Builder>
com.google.apps.events.subscriptions.v1beta.ListSubscriptionsRequest.Builder
All Implemented Interfaces:
ListSubscriptionsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListSubscriptionsRequest

public static final class ListSubscriptionsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListSubscriptionsRequest.Builder> implements ListSubscriptionsRequestOrBuilder
 The request message for
 [SubscriptionsService.ListSubscriptions][google.apps.events.subscriptions.v1beta.SubscriptionsService.ListSubscriptions].
 
Protobuf type google.apps.events.subscriptions.v1beta.ListSubscriptionsRequest
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListSubscriptionsRequest.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListSubscriptionsRequest.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListSubscriptionsRequest.Builder>
    • getDefaultInstanceForType

      public ListSubscriptionsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public ListSubscriptionsRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public ListSubscriptionsRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public ListSubscriptionsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListSubscriptionsRequest.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListSubscriptionsRequest.Builder>
    • mergeFrom

      public ListSubscriptionsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListSubscriptionsRequest.Builder>
      Throws:
      IOException
    • getPageSize

      public 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];
      Specified by:
      getPageSize in interface ListSubscriptionsRequestOrBuilder
      Returns:
      The pageSize.
    • setPageSize

      public ListSubscriptionsRequest.Builder setPageSize(int value)
       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];
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.
    • clearPageSize

      public ListSubscriptionsRequest.Builder clearPageSize()
       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:
      This builder for chaining.
    • getPageToken

      public 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];
      Specified by:
      getPageToken in interface ListSubscriptionsRequestOrBuilder
      Returns:
      The pageToken.
    • getPageTokenBytes

      public 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];
      Specified by:
      getPageTokenBytes in interface ListSubscriptionsRequestOrBuilder
      Returns:
      The bytes for pageToken.
    • setPageToken

      public ListSubscriptionsRequest.Builder setPageToken(String value)
       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];
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.
    • clearPageToken

      public ListSubscriptionsRequest.Builder clearPageToken()
       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:
      This builder for chaining.
    • setPageTokenBytes

      public ListSubscriptionsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.
    • getFilter

      public 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];
      Specified by:
      getFilter in interface ListSubscriptionsRequestOrBuilder
      Returns:
      The filter.
    • getFilterBytes

      public 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];
      Specified by:
      getFilterBytes in interface ListSubscriptionsRequestOrBuilder
      Returns:
      The bytes for filter.
    • setFilter

      public ListSubscriptionsRequest.Builder setFilter(String value)
       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];
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.
    • clearFilter

      public ListSubscriptionsRequest.Builder clearFilter()
       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:
      This builder for chaining.
    • setFilterBytes

      public ListSubscriptionsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.