public interface ListMessagesRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getFilter()
public abstract String getFilter()A query filter.
You can filter messages by date (create_time) and thread (thread.name).
To filter messages by the date they were created, specify the create_time
with a timestamp in RFC-3339
format and double quotation marks. For example,
"2023-04-21T11:30:00-04:00". You can use the greater than operator > to
list messages that were created after a timestamp, or the less than
operator < to list messages that were created before a timestamp. To
filter messages within a time interval, use the AND operator between two
timestamps.
To filter by thread, specify the thread.name, formatted as
spaces/{space}/threads/{thread}. You can only specify one
thread.name per query.
To filter by both thread and date, use the AND operator in your query.
For example, the following queries are valid:
`
create_time > "2012-04-21T11:30:00-04:00"
create_time > "2012-04-21T11:30:00-04:00" AND
thread.name = spaces/AAAAAAAAAAA/threads/123
create_time > "2012-04-21T11:30:00+00:00" AND
create_time < "2013-01-01T00:00:00+00:00" AND
thread.name = spaces/AAAAAAAAAAA/threads/123
thread.name = spaces/AAAAAAAAAAA/threads/123
Invalid queries are rejected by the server with an INVALID_ARGUMENT`
error.
string filter = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes()A query filter.
You can filter messages by date (create_time) and thread (thread.name).
To filter messages by the date they were created, specify the create_time
with a timestamp in RFC-3339
format and double quotation marks. For example,
"2023-04-21T11:30:00-04:00". You can use the greater than operator > to
list messages that were created after a timestamp, or the less than
operator < to list messages that were created before a timestamp. To
filter messages within a time interval, use the AND operator between two
timestamps.
To filter by thread, specify the thread.name, formatted as
spaces/{space}/threads/{thread}. You can only specify one
thread.name per query.
To filter by both thread and date, use the AND operator in your query.
For example, the following queries are valid:
`
create_time > "2012-04-21T11:30:00-04:00"
create_time > "2012-04-21T11:30:00-04:00" AND
thread.name = spaces/AAAAAAAAAAA/threads/123
create_time > "2012-04-21T11:30:00+00:00" AND
create_time < "2013-01-01T00:00:00+00:00" AND
thread.name = spaces/AAAAAAAAAAA/threads/123
thread.name = spaces/AAAAAAAAAAA/threads/123
Invalid queries are rejected by the server with an INVALID_ARGUMENT`
error.
string filter = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getOrderBy()
public abstract String getOrderBy()Optional, if resuming from a previous query.
How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows:
ASCfor ascending.DESCfor descending.The default ordering is
create_time ASC.
string order_by = 5;
| Returns | |
|---|---|
| Type | Description |
String |
The orderBy. |
getOrderByBytes()
public abstract ByteString getOrderByBytes()Optional, if resuming from a previous query.
How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows:
ASCfor ascending.DESCfor descending.The default ordering is
create_time ASC.
string order_by = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for orderBy. |
getPageSize()
public abstract int getPageSize()The maximum number of messages returned. The service might return fewer messages than this value.
If unspecified, at most 25 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 = 2;
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public abstract String getPageToken()Optional, if resuming from a previous query.
A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page.
When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes()Optional, if resuming from a previous query.
A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page.
When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public abstract String getParent()Required. The resource name of the space to list messages from.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public abstract ByteString getParentBytes()Required. The resource name of the space to list messages from.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
getShowDeleted()
public abstract boolean getShowDeleted()Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.
bool show_deleted = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
The showDeleted. |