Interface ListContextsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListContextsRequest, ListContextsRequest.Builder

    public interface ListContextsRequestOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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 Detail

      • getParent

        String getParent()
         Required. The session to list all contexts from. Supported formats:
         - `projects/<Project ID>/agent/sessions/<Session ID>,
         - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session
           ID>`,
         - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
           ID>/sessions/<Session ID>`,
         - `projects/<Project ID>/locations/<Location
           ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session
           ID>`,
        
         If `Location ID` is not specified we assume default 'us' location. If
         `Environment ID` is not specified, we assume default 'draft' environment.
         If `User ID` is not specified, we assume default '-' user.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.
      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The session to list all contexts from. Supported formats:
         - `projects/<Project ID>/agent/sessions/<Session ID>,
         - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session
           ID>`,
         - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
           ID>/sessions/<Session ID>`,
         - `projects/<Project ID>/locations/<Location
           ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session
           ID>`,
        
         If `Location ID` is not specified we assume default 'us' location. If
         `Environment ID` is not specified, we assume default 'draft' environment.
         If `User ID` is not specified, we assume default '-' user.
         
        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.