Interface ListConversationsRequestOrBuilder (4.53.0)

Version 4.53.0

• 4.59.0 (latest)
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public interface ListConversationsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering: <ul> <li>The value must be a string, a number, or a boolean.</li> <li>The comparison operator must be either =,!=, >, or <.</li> <li>To filter on multiple expressions, separate the expressions with AND or OR (omitting both implies AND).</li> <li>For clarity, expressions can be enclosed in parentheses.</li> </ul> Only lifecycle_state can be filtered on in this way. For example, the following expression only returns COMPLETED conversations:

lifecycle_state = "COMPLETED"

For more information about filtering, see API Filtering.

string filter = 4;

Returns
Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering: <ul> <li>The value must be a string, a number, or a boolean.</li> <li>The comparison operator must be either =,!=, >, or <.</li> <li>To filter on multiple expressions, separate the expressions with AND or OR (omitting both implies AND).</li> <li>For clarity, expressions can be enclosed in parentheses.</li> </ul> Only lifecycle_state can be filtered on in this way. For example, the following expression only returns COMPLETED conversations:

lifecycle_state = "COMPLETED"

For more information about filtering, see API Filtering.

string filter = 4;

Returns
Type	Description
ByteString	The bytes for filter.

getPageSize()

public abstract int getPageSize()

Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

Optional. The next_page_token value returned from a previous list request.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Optional. The next_page_token value returned from a previous list request.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public abstract String getParent()

Required. The project from which to list all conversation. Format: projects/<Project ID>/locations/<Location 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 project from which to list all conversation. Format: projects/<Project ID>/locations/<Location ID>.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.