public static final class ListSubscriptionsRequest.Builder extends GeneratedMessageV3.Builder<ListSubscriptionsRequest.Builder> implements ListSubscriptionsRequestOrBuilderThe request message for SubscriptionsService.ListSubscriptions.
Protobuf type google.apps.events.subscriptions.v1.ListSubscriptionsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListSubscriptionsRequest.BuilderImplements
ListSubscriptionsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListSubscriptionsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | |
build()
public ListSubscriptionsRequest build()| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest | |
buildPartial()
public ListSubscriptionsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest | |
clear()
public ListSubscriptionsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public ListSubscriptionsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | |
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 | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListSubscriptionsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | |
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 | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | 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 | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | This builder for chaining. |
clone()
public ListSubscriptionsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | |
getDefaultInstanceForType()
public ListSubscriptionsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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];
| Returns | |
|---|---|
| Type | Description |
String | The filter. |
getFilterBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for filter. |
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];
| Returns | |
|---|---|
| Type | Description |
int | The pageSize. |
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];
| Returns | |
|---|---|
| Type | Description |
String | The pageToken. |
getPageTokenBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for pageToken. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(ListSubscriptionsRequest other)
public ListSubscriptionsRequest.Builder mergeFrom(ListSubscriptionsRequest other)| Parameter | |
|---|---|
| Name | Description |
other | ListSubscriptionsRequest |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListSubscriptionsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public ListSubscriptionsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListSubscriptionsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public ListSubscriptionsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | |
setFilter(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public ListSubscriptionsRequest.Builder setFilterBytes(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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | This builder for chaining. |
setPageSize(int value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | This builder for chaining. |
setPageToken(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListSubscriptionsRequest.Builder setPageTokenBytes(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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListSubscriptionsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListSubscriptionsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRequest.Builder | |