public interface ListMessagesRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getFilter()
public abstract String getFilter()Optional. Filtering results. See AIP-160 for syntax.
ListMessages allows filtering by:
- create_time (e.g.,
createTime > "2025-01-28T06:51:56-08:00") - update_time
string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes()Optional. Filtering results. See AIP-160 for syntax.
ListMessages allows filtering by:
- create_time (e.g.,
createTime > "2025-01-28T06:51:56-08:00") - update_time
string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getPageSize()
public abstract int getPageSize()Optional. Requested page size. Server may return fewer items than requested. The max page size is 100. All larger page sizes will be coerced to 100. If unspecified, server will pick 50 as an approperiate default.
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public abstract String getPageToken()Optional. A token identifying a page of results the server should return.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes()Optional. A token identifying a page of results the server should return.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public abstract String getParent() Required. The conversation to list messages under.
Format:
projects/{project}/locations/{location}/conversations/{conversation_id}
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 conversation to list messages under.
Format:
projects/{project}/locations/{location}/conversations/{conversation_id}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |