Interface ListSpacesRequestOrBuilder (0.20.0)
Stay organized with collections
Save and categorize content based on your preferences.
publicinterface ListSpacesRequestOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
getFilter()
publicabstractStringgetFilter()Optional. A query filter.
You can filter spaces by the space type
(space_type).
To filter by space type, you must specify valid enum value, such as
SPACE or GROUP_CHAT (the space_type can't be
SPACE_TYPE_UNSPECIFIED). To query for multiple space types, use the OR
operator.
For example, the following queries are valid:
`
space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"
Invalid queries are rejected by the server with an INVALID_ARGUMENT`
error.
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
publicabstractByteStringgetFilterBytes()Optional. A query filter.
You can filter spaces by the space type
(space_type).
To filter by space type, you must specify valid enum value, such as
SPACE or GROUP_CHAT (the space_type can't be
SPACE_TYPE_UNSPECIFIED). To query for multiple space types, use the OR
operator.
For example, the following queries are valid:
`
space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"
Invalid queries are rejected by the server with an INVALID_ARGUMENT`
error.
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getPageSize()
publicabstractintgetPageSize()Optional. The maximum number of spaces to return. The service might return fewer than this value.
If unspecified, at most 100 spaces are returned.
The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.
Negative values return an INVALID_ARGUMENT error.
int32 page_size = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
publicabstractStringgetPageToken()Optional. A page token, received from a previous list spaces 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 may lead to unexpected results.
string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
publicabstractByteStringgetPageTokenBytes()Optional. A page token, received from a previous list spaces 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 may lead to unexpected results.
string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |