Package com.google.cloud.dialogflow.cx.v3beta1

Interface ListConversationsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListConversationsRequest, ListConversationsRequest.Builder
@Generated public interface ListConversationsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Optional.
    com.google.protobuf.ByteString
    getFilterBytes()
    Optional.
    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.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getParent

      String getParent()
       Required. The agent to list all conversations for.
 Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The agent to list all conversations for.
 Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getFilter

      String getFilter()
       Optional. The filter string. Supports filter by create_time,
 metrics.has_end_interaction, metrics.has_live_agent_handoff,
 intents.display_name, pages.display_name and flows.display_name. Timestamps
 expect an [RFC-3339][https://datatracker.ietf.org/doc/html/rfc3339]
 formatted string (e.g. 2012-04-21T11:30:00-04:00). UTC offsets are
 supported. Some examples:
 1. By create time:
 create_time > "2022-04-21T11:30:00-04:00"
 2. By intent display name:
 intents.display_name : "billing"
 3. By end interaction signal:
 metrics.has_end_interaction = true
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Optional. The filter string. Supports filter by create_time,
 metrics.has_end_interaction, metrics.has_live_agent_handoff,
 intents.display_name, pages.display_name and flows.display_name. Timestamps
 expect an [RFC-3339][https://datatracker.ietf.org/doc/html/rfc3339]
 formatted string (e.g. 2012-04-21T11:30:00-04:00). UTC offsets are
 supported. Some examples:
 1. By create time:
 create_time > "2022-04-21T11:30:00-04:00"
 2. By intent display name:
 intents.display_name : "billing"
 3. By end interaction signal:
 metrics.has_end_interaction = true
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.

    • 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 = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       Optional. The next_page_token value returned from a previous list request.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Optional. The next_page_token value returned from a previous list request.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.