Package com.google.cloud.discoveryengine.v1beta

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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      A filter to apply on the list results.
      com.google.protobuf.ByteString getFilterBytes()
      A filter to apply on the list results.
      String getOrderBy()
      A comma-separated list of fields to order by, sorted in ascending order.
      com.google.protobuf.ByteString getOrderByBytes()
      A comma-separated list of fields to order by, sorted in ascending order.
      int getPageSize()
      Maximum number of results to return.
      String getPageToken()
      A page token, received from a previous `ListConversations` call.
      com.google.protobuf.ByteString getPageTokenBytes()
      A page token, received from a previous `ListConversations` call.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getParent

        String getParent()
         Required. The data store resource name. Format:
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The data store resource name. Format:
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.

      • getPageSize

        int getPageSize()
         Maximum number of results to return. If unspecified, defaults
 to 50. Max allowed value is 1000.
        int32 page_size = 2;
        Returns:
        The pageSize.

      • getPageToken

        String getPageToken()
         A page token, received from a previous `ListConversations` call.
 Provide this to retrieve the subsequent page.
        string page_token = 3;
        Returns:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         A page token, received from a previous `ListConversations` call.
 Provide this to retrieve the subsequent page.
        string page_token = 3;
        Returns:
        The bytes for pageToken.

      • getFilter

        String getFilter()
         A filter to apply on the list results. The supported features are:
 user_pseudo_id, state.

 Example:
 "user_pseudo_id = some_id"
        string filter = 4;
        Returns:
        The filter.

      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         A filter to apply on the list results. The supported features are:
 user_pseudo_id, state.

 Example:
 "user_pseudo_id = some_id"
        string filter = 4;
        Returns:
        The bytes for filter.

      • getOrderBy

        String getOrderBy()
         A comma-separated list of fields to order by, sorted in ascending order.
 Use "desc" after a field name for descending.
 Supported fields:
   * `update_time`
   * `create_time`
   * `conversation_name`

 Example:
 "update_time desc"
 "create_time"
        string order_by = 5;
        Returns:
        The orderBy.

      • getOrderByBytes

        com.google.protobuf.ByteString getOrderByBytes()
         A comma-separated list of fields to order by, sorted in ascending order.
 Use "desc" after a field name for descending.
 Supported fields:
   * `update_time`
   * `create_time`
   * `conversation_name`

 Example:
 "update_time desc"
 "create_time"
        string order_by = 5;
        Returns:
        The bytes for orderBy.