public final class ListMessagesRequest extends GeneratedMessageV3 implements ListMessagesRequestOrBuilder
Lists messages in the specified space, that the user is a member of.
Protobuf type google.chat.v1.ListMessagesRequest
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 | |
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_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 | |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SHOW_DELETED_FIELD_NUMBER
public static final int SHOW_DELETED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ListMessagesRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListMessagesRequest.Builder newBuilder()
newBuilder(ListMessagesRequest prototype)
public static ListMessagesRequest.Builder newBuilder(ListMessagesRequest prototype)
public static ListMessagesRequest parseDelimitedFrom(InputStream input)
public static ListMessagesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListMessagesRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListMessagesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListMessagesRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListMessagesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListMessagesRequest parseFrom(CodedInputStream input)
public static ListMessagesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListMessagesRequest parseFrom(InputStream input)
public static ListMessagesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListMessagesRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListMessagesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListMessagesRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public ListMessagesRequest getDefaultInstanceForType()
getFilter()
public 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 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 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:
string order_by = 5;
| Returns |
|---|
| Type | Description |
String | The orderBy.
|
getOrderByBytes()
public 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:
string order_by = 5;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for orderBy.
|
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 1,000. If you use a value more than 1,000, it's
automatically changed to 1,000.
Negative values return an INVALID_ARGUMENT error.
int32 page_size = 2;
| Returns |
|---|
| Type | Description |
int | The pageSize.
|
getPageToken()
public 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 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 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 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.
|
getParserForType()
public Parser<ListMessagesRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getShowDeleted()
public 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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListMessagesRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListMessagesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ListMessagesRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
