Class ListSessionsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListSessionsRequest.Builder>
com.google.cloud.discoveryengine.v1beta.ListSessionsRequest.Builder
All Implemented Interfaces:
ListSessionsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListSessionsRequest

public static final class ListSessionsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListSessionsRequest.Builder> implements ListSessionsRequestOrBuilder
 Request for ListSessions method.
 
Protobuf type google.cloud.discoveryengine.v1beta.ListSessionsRequest
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListSessionsRequest.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListSessionsRequest.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListSessionsRequest.Builder>
    • getDefaultInstanceForType

      public ListSessionsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public ListSessionsRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public ListSessionsRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public ListSessionsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListSessionsRequest.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListSessionsRequest.Builder>
    • mergeFrom

      public ListSessionsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListSessionsRequest.Builder>
      Throws:
      IOException
    • getParent

      public String getParent()
       Required. The data store resource name. Format:
       `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ListSessionsRequestOrBuilder
      Returns:
      The parent.
    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The data store resource name. Format:
       `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ListSessionsRequestOrBuilder
      Returns:
      The bytes for parent.
    • setParent

      public ListSessionsRequest.Builder setParent(String value)
       Required. The data store resource name. Format:
       `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.
    • clearParent

      public ListSessionsRequest.Builder clearParent()
       Required. The data store resource name. Format:
       `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.
    • setParentBytes

      public ListSessionsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       Required. The data store resource name. Format:
       `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.
    • getPageSize

      public int getPageSize()
       Maximum number of results to return. If unspecified, defaults
       to 50. Max allowed value is 1000.
       
      int32 page_size = 2;
      Specified by:
      getPageSize in interface ListSessionsRequestOrBuilder
      Returns:
      The pageSize.
    • setPageSize

      public ListSessionsRequest.Builder setPageSize(int value)
       Maximum number of results to return. If unspecified, defaults
       to 50. Max allowed value is 1000.
       
      int32 page_size = 2;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.
    • clearPageSize

      public ListSessionsRequest.Builder clearPageSize()
       Maximum number of results to return. If unspecified, defaults
       to 50. Max allowed value is 1000.
       
      int32 page_size = 2;
      Returns:
      This builder for chaining.
    • getPageToken

      public String getPageToken()
       A page token, received from a previous `ListSessions` call.
       Provide this to retrieve the subsequent page.
       
      string page_token = 3;
      Specified by:
      getPageToken in interface ListSessionsRequestOrBuilder
      Returns:
      The pageToken.
    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       A page token, received from a previous `ListSessions` call.
       Provide this to retrieve the subsequent page.
       
      string page_token = 3;
      Specified by:
      getPageTokenBytes in interface ListSessionsRequestOrBuilder
      Returns:
      The bytes for pageToken.
    • setPageToken

      public ListSessionsRequest.Builder setPageToken(String value)
       A page token, received from a previous `ListSessions` call.
       Provide this to retrieve the subsequent page.
       
      string page_token = 3;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.
    • clearPageToken

      public ListSessionsRequest.Builder clearPageToken()
       A page token, received from a previous `ListSessions` call.
       Provide this to retrieve the subsequent page.
       
      string page_token = 3;
      Returns:
      This builder for chaining.
    • setPageTokenBytes

      public ListSessionsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       A page token, received from a previous `ListSessions` call.
       Provide this to retrieve the subsequent page.
       
      string page_token = 3;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.
    • getFilter

      public String getFilter()
       A comma-separated list of fields to filter by, in EBNF grammar.
       The supported fields are:
       * `user_pseudo_id`
       * `state`
       * `display_name`
       * `starred`
       * `is_pinned`
       * `labels`
       * `create_time`
       * `update_time`
      
       Examples:
       "user_pseudo_id = some_id"
       "display_name = \"some_name\""
       "starred = true"
       "is_pinned=true AND (NOT labels:hidden)"
       "create_time > \"1970-01-01T12:00:00Z\""
       
      string filter = 4;
      Specified by:
      getFilter in interface ListSessionsRequestOrBuilder
      Returns:
      The filter.
    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       A comma-separated list of fields to filter by, in EBNF grammar.
       The supported fields are:
       * `user_pseudo_id`
       * `state`
       * `display_name`
       * `starred`
       * `is_pinned`
       * `labels`
       * `create_time`
       * `update_time`
      
       Examples:
       "user_pseudo_id = some_id"
       "display_name = \"some_name\""
       "starred = true"
       "is_pinned=true AND (NOT labels:hidden)"
       "create_time > \"1970-01-01T12:00:00Z\""
       
      string filter = 4;
      Specified by:
      getFilterBytes in interface ListSessionsRequestOrBuilder
      Returns:
      The bytes for filter.
    • setFilter

      public ListSessionsRequest.Builder setFilter(String value)
       A comma-separated list of fields to filter by, in EBNF grammar.
       The supported fields are:
       * `user_pseudo_id`
       * `state`
       * `display_name`
       * `starred`
       * `is_pinned`
       * `labels`
       * `create_time`
       * `update_time`
      
       Examples:
       "user_pseudo_id = some_id"
       "display_name = \"some_name\""
       "starred = true"
       "is_pinned=true AND (NOT labels:hidden)"
       "create_time > \"1970-01-01T12:00:00Z\""
       
      string filter = 4;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.
    • clearFilter

      public ListSessionsRequest.Builder clearFilter()
       A comma-separated list of fields to filter by, in EBNF grammar.
       The supported fields are:
       * `user_pseudo_id`
       * `state`
       * `display_name`
       * `starred`
       * `is_pinned`
       * `labels`
       * `create_time`
       * `update_time`
      
       Examples:
       "user_pseudo_id = some_id"
       "display_name = \"some_name\""
       "starred = true"
       "is_pinned=true AND (NOT labels:hidden)"
       "create_time > \"1970-01-01T12:00:00Z\""
       
      string filter = 4;
      Returns:
      This builder for chaining.
    • setFilterBytes

      public ListSessionsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       A comma-separated list of fields to filter by, in EBNF grammar.
       The supported fields are:
       * `user_pseudo_id`
       * `state`
       * `display_name`
       * `starred`
       * `is_pinned`
       * `labels`
       * `create_time`
       * `update_time`
      
       Examples:
       "user_pseudo_id = some_id"
       "display_name = \"some_name\""
       "starred = true"
       "is_pinned=true AND (NOT labels:hidden)"
       "create_time > \"1970-01-01T12:00:00Z\""
       
      string filter = 4;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.
    • getOrderBy

      public 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`
       * `session_name`
       * `is_pinned`
      
       Example:
      
       * "update_time desc"
       * "create_time"
       * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
       by update_time.
       
      string order_by = 5;
      Specified by:
      getOrderBy in interface ListSessionsRequestOrBuilder
      Returns:
      The orderBy.
    • getOrderByBytes

      public 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`
       * `session_name`
       * `is_pinned`
      
       Example:
      
       * "update_time desc"
       * "create_time"
       * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
       by update_time.
       
      string order_by = 5;
      Specified by:
      getOrderByBytes in interface ListSessionsRequestOrBuilder
      Returns:
      The bytes for orderBy.
    • setOrderBy

      public ListSessionsRequest.Builder setOrderBy(String value)
       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`
       * `session_name`
       * `is_pinned`
      
       Example:
      
       * "update_time desc"
       * "create_time"
       * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
       by update_time.
       
      string order_by = 5;
      Parameters:
      value - The orderBy to set.
      Returns:
      This builder for chaining.
    • clearOrderBy

      public ListSessionsRequest.Builder clearOrderBy()
       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`
       * `session_name`
       * `is_pinned`
      
       Example:
      
       * "update_time desc"
       * "create_time"
       * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
       by update_time.
       
      string order_by = 5;
      Returns:
      This builder for chaining.
    • setOrderByBytes

      public ListSessionsRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
       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`
       * `session_name`
       * `is_pinned`
      
       Example:
      
       * "update_time desc"
       * "create_time"
       * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
       by update_time.
       
      string order_by = 5;
      Parameters:
      value - The bytes for orderBy to set.
      Returns:
      This builder for chaining.