public static final class ListMessagesRequest.Builder extends GeneratedMessageV3.Builder<ListMessagesRequest.Builder> implements ListMessagesRequestOrBuilderLists messages in the specified space, that the user is a member of.
Protobuf type google.chat.v1.ListMessagesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListMessagesRequest.BuilderImplements
ListMessagesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListMessagesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | |
build()
public ListMessagesRequest build()| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest | |
buildPartial()
public ListMessagesRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest | |
clear()
public ListMessagesRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public ListMessagesRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | |
clearFilter()
public ListMessagesRequest.Builder clearFilter()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 |
ListMessagesRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListMessagesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | |
clearOrderBy()
public ListMessagesRequest.Builder clearOrderBy()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 |
ListMessagesRequest.Builder | This builder for chaining. |
clearPageSize()
public ListMessagesRequest.Builder clearPageSize()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 |
ListMessagesRequest.Builder | This builder for chaining. |
clearPageToken()
public ListMessagesRequest.Builder clearPageToken()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 |
ListMessagesRequest.Builder | This builder for chaining. |
clearParent()
public ListMessagesRequest.Builder clearParent()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 |
ListMessagesRequest.Builder | This builder for chaining. |
clearShowDeleted()
public ListMessagesRequest.Builder clearShowDeleted()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 |
ListMessagesRequest.Builder | This builder for chaining. |
clone()
public ListMessagesRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | |
getDefaultInstanceForType()
public ListMessagesRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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:
ASCfor ascending.DESCfor descending.The default ordering is
create_time ASC.
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:
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 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 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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(ListMessagesRequest other)
public ListMessagesRequest.Builder mergeFrom(ListMessagesRequest other)| Parameter | |
|---|---|
| Name | Description |
other | ListMessagesRequest |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListMessagesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public ListMessagesRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListMessagesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public ListMessagesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | |
setFilter(String value)
public ListMessagesRequest.Builder setFilter(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public ListMessagesRequest.Builder setFilterBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | This builder for chaining. |
setOrderBy(String value)
public ListMessagesRequest.Builder setOrderBy(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | This builder for chaining. |
setOrderByBytes(ByteString value)
public ListMessagesRequest.Builder setOrderByBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | This builder for chaining. |
setPageSize(int value)
public ListMessagesRequest.Builder setPageSize(int value)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;
| Parameter | |
|---|---|
| Name | Description |
value | intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | This builder for chaining. |
setPageToken(String value)
public ListMessagesRequest.Builder setPageToken(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListMessagesRequest.Builder setPageTokenBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | This builder for chaining. |
setParent(String value)
public ListMessagesRequest.Builder setParent(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ListMessagesRequest.Builder setParentBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListMessagesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | |
setShowDeleted(boolean value)
public ListMessagesRequest.Builder setShowDeleted(boolean value)Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.
bool show_deleted = 6;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe showDeleted to set. |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListMessagesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListMessagesRequest.Builder | |