Interface ListConversationsRequestOrBuilder (4.46.0)

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.