public final class ListSubscriptionsRequest extends GeneratedMessageV3 implements ListSubscriptionsRequestOrBuilder
The request message for
SubscriptionsService.ListSubscriptions.
Protobuf type google.apps.events.subscriptions.v1.ListSubscriptionsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListSubscriptionsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListSubscriptionsRequest.Builder newBuilder()
newBuilder(ListSubscriptionsRequest prototype)
public static ListSubscriptionsRequest.Builder newBuilder(ListSubscriptionsRequest prototype)
public static ListSubscriptionsRequest parseDelimitedFrom(InputStream input)
public static ListSubscriptionsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListSubscriptionsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListSubscriptionsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListSubscriptionsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListSubscriptionsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListSubscriptionsRequest parseFrom(CodedInputStream input)
public static ListSubscriptionsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListSubscriptionsRequest parseFrom(InputStream input)
public static ListSubscriptionsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListSubscriptionsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListSubscriptionsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListSubscriptionsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListSubscriptionsRequest getDefaultInstanceForType()
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()
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.
|
getParserForType()
public Parser<ListSubscriptionsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListSubscriptionsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListSubscriptionsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListSubscriptionsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
