com.google.cloud.dialogflow.v2beta1

Interface ListConversationsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListConversationsRequest, ListConversationsRequest.Builder

public interface ListConversationsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() A filter expression that filters conversations listed in the response.
com.google.protobuf.ByteString	getFilterBytes() A filter expression that filters conversations listed in the response.
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

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:

The parent.

getParentBytes

com.google.protobuf.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:

The bytes for parent.

getPageSize

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;

Returns:

The pageSize.

getPageToken

String getPageToken()

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

string page_token = 3;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

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

string page_token = 3;

Returns:

The bytes for pageToken.

getFilter

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](https://aip.dev/160).
 

string filter = 4;

Returns:

The filter.

getFilterBytes

com.google.protobuf.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](https://aip.dev/160).
 

string filter = 4;

Returns:

The bytes for filter.