Class QueryOptions.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<QueryOptions.Builder>
com.buildless.service.v1.QueryOptions.Builder
All Implemented Interfaces:
QueryOptionsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
QueryOptions

public static final class QueryOptions.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<QueryOptions.Builder> implements QueryOptionsOrBuilder
 ## Query Options

 Specifies a combined set of generic query input parameters, including support for sort specifications, filter clauses
 and features like pagination and output control. An exhaustive list of features supported by this model is provided
 below.

 The Buildless API makes use of this model across multiple methods and multiple services. Some query options may only
 be supported by a subset of methods. See specific method documentation for more info.
 
Protobuf type buildless.service.v1.QueryOptions
  • Method Details

    • getDescriptor

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

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

      public QueryOptions.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.GeneratedMessageV3.Builder<QueryOptions.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.GeneratedMessageV3.Builder<QueryOptions.Builder>
    • getDefaultInstanceForType

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

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

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

      public QueryOptions.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<QueryOptions.Builder>
    • setField

      public QueryOptions.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryOptions.Builder>
    • clearField

      public QueryOptions.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryOptions.Builder>
    • clearOneof

      public QueryOptions.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<QueryOptions.Builder>
    • setRepeatedField

      public QueryOptions.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryOptions.Builder>
    • addRepeatedField

      public QueryOptions.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryOptions.Builder>
    • mergeFrom

      public QueryOptions.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<QueryOptions.Builder>
    • mergeFrom

      public QueryOptions.Builder mergeFrom(QueryOptions other)
    • isInitialized

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

      public QueryOptions.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<QueryOptions.Builder>
      Throws:
      IOException
    • hasPage

      public boolean hasPage()
       Pagination control for the query.
       
      .buildless.service.v1.QueryOptions.Pagination page = 1 [json_name = "page"];
      Specified by:
      hasPage in interface QueryOptionsOrBuilder
      Returns:
      Whether the page field is set.
    • getPage

      public QueryOptions.Pagination getPage()
       Pagination control for the query.
       
      .buildless.service.v1.QueryOptions.Pagination page = 1 [json_name = "page"];
      Specified by:
      getPage in interface QueryOptionsOrBuilder
      Returns:
      The page.
    • setPage

       Pagination control for the query.
       
      .buildless.service.v1.QueryOptions.Pagination page = 1 [json_name = "page"];
    • setPage

      public QueryOptions.Builder setPage(QueryOptions.Pagination.Builder builderForValue)
       Pagination control for the query.
       
      .buildless.service.v1.QueryOptions.Pagination page = 1 [json_name = "page"];
    • mergePage

       Pagination control for the query.
       
      .buildless.service.v1.QueryOptions.Pagination page = 1 [json_name = "page"];
    • clearPage

      public QueryOptions.Builder clearPage()
       Pagination control for the query.
       
      .buildless.service.v1.QueryOptions.Pagination page = 1 [json_name = "page"];
    • getPageBuilder

      public QueryOptions.Pagination.Builder getPageBuilder()
       Pagination control for the query.
       
      .buildless.service.v1.QueryOptions.Pagination page = 1 [json_name = "page"];
    • getPageOrBuilder

      public QueryOptions.PaginationOrBuilder getPageOrBuilder()
       Pagination control for the query.
       
      .buildless.service.v1.QueryOptions.Pagination page = 1 [json_name = "page"];
      Specified by:
      getPageOrBuilder in interface QueryOptionsOrBuilder
    • getSortList

      public List<QueryOptions.Sort> getSortList()
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
      Specified by:
      getSortList in interface QueryOptionsOrBuilder
    • getSortCount

      public int getSortCount()
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
      Specified by:
      getSortCount in interface QueryOptionsOrBuilder
    • getSort

      public QueryOptions.Sort getSort(int index)
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
      Specified by:
      getSort in interface QueryOptionsOrBuilder
    • setSort

      public QueryOptions.Builder setSort(int index, QueryOptions.Sort value)
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
    • setSort

      public QueryOptions.Builder setSort(int index, QueryOptions.Sort.Builder builderForValue)
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
    • addSort

      public QueryOptions.Builder addSort(QueryOptions.Sort value)
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
    • addSort

      public QueryOptions.Builder addSort(int index, QueryOptions.Sort value)
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
    • addSort

      public QueryOptions.Builder addSort(QueryOptions.Sort.Builder builderForValue)
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
    • addSort

      public QueryOptions.Builder addSort(int index, QueryOptions.Sort.Builder builderForValue)
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
    • addAllSort

      public QueryOptions.Builder addAllSort(Iterable<? extends QueryOptions.Sort> values)
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
    • clearSort

      public QueryOptions.Builder clearSort()
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
    • removeSort

      public QueryOptions.Builder removeSort(int index)
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
    • getSortBuilder

      public QueryOptions.Sort.Builder getSortBuilder(int index)
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
    • getSortOrBuilder

      public QueryOptions.SortOrBuilder getSortOrBuilder(int index)
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
      Specified by:
      getSortOrBuilder in interface QueryOptionsOrBuilder
    • getSortOrBuilderList

      public List<? extends QueryOptions.SortOrBuilder> getSortOrBuilderList()
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
      Specified by:
      getSortOrBuilderList in interface QueryOptionsOrBuilder
    • addSortBuilder

      public QueryOptions.Sort.Builder addSortBuilder()
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
    • addSortBuilder

      public QueryOptions.Sort.Builder addSortBuilder(int index)
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
    • getSortBuilderList

      public List<QueryOptions.Sort.Builder> getSortBuilderList()
       Sort directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Sort sort = 2 [json_name = "sort"];
    • getFilterList

      public List<QueryOptions.Filter> getFilterList()
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
      Specified by:
      getFilterList in interface QueryOptionsOrBuilder
    • getFilterCount

      public int getFilterCount()
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
      Specified by:
      getFilterCount in interface QueryOptionsOrBuilder
    • getFilter

      public QueryOptions.Filter getFilter(int index)
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
      Specified by:
      getFilter in interface QueryOptionsOrBuilder
    • setFilter

      public QueryOptions.Builder setFilter(int index, QueryOptions.Filter value)
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
    • setFilter

      public QueryOptions.Builder setFilter(int index, QueryOptions.Filter.Builder builderForValue)
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
    • addFilter

      public QueryOptions.Builder addFilter(QueryOptions.Filter value)
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
    • addFilter

      public QueryOptions.Builder addFilter(int index, QueryOptions.Filter value)
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
    • addFilter

      public QueryOptions.Builder addFilter(QueryOptions.Filter.Builder builderForValue)
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
    • addFilter

      public QueryOptions.Builder addFilter(int index, QueryOptions.Filter.Builder builderForValue)
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
    • addAllFilter

      public QueryOptions.Builder addAllFilter(Iterable<? extends QueryOptions.Filter> values)
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
    • clearFilter

      public QueryOptions.Builder clearFilter()
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
    • removeFilter

      public QueryOptions.Builder removeFilter(int index)
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
    • getFilterBuilder

      public QueryOptions.Filter.Builder getFilterBuilder(int index)
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
    • getFilterOrBuilder

      public QueryOptions.FilterOrBuilder getFilterOrBuilder(int index)
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
      Specified by:
      getFilterOrBuilder in interface QueryOptionsOrBuilder
    • getFilterOrBuilderList

      public List<? extends QueryOptions.FilterOrBuilder> getFilterOrBuilderList()
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
      Specified by:
      getFilterOrBuilderList in interface QueryOptionsOrBuilder
    • addFilterBuilder

      public QueryOptions.Filter.Builder addFilterBuilder()
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
    • addFilterBuilder

      public QueryOptions.Filter.Builder addFilterBuilder(int index)
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
    • getFilterBuilderList

      public List<QueryOptions.Filter.Builder> getFilterBuilderList()
       Filter directives for the query.
       
      repeated .buildless.service.v1.QueryOptions.Filter filter = 3 [json_name = "filter"];
    • hasOut

      public boolean hasOut()
       Output controls for the query.
       
      .buildless.service.v1.QueryOptions.Output out = 4 [json_name = "out"];
      Specified by:
      hasOut in interface QueryOptionsOrBuilder
      Returns:
      Whether the out field is set.
    • getOut

      public QueryOptions.Output getOut()
       Output controls for the query.
       
      .buildless.service.v1.QueryOptions.Output out = 4 [json_name = "out"];
      Specified by:
      getOut in interface QueryOptionsOrBuilder
      Returns:
      The out.
    • setOut

       Output controls for the query.
       
      .buildless.service.v1.QueryOptions.Output out = 4 [json_name = "out"];
    • setOut

      public QueryOptions.Builder setOut(QueryOptions.Output.Builder builderForValue)
       Output controls for the query.
       
      .buildless.service.v1.QueryOptions.Output out = 4 [json_name = "out"];
    • mergeOut

      public QueryOptions.Builder mergeOut(QueryOptions.Output value)
       Output controls for the query.
       
      .buildless.service.v1.QueryOptions.Output out = 4 [json_name = "out"];
    • clearOut

      public QueryOptions.Builder clearOut()
       Output controls for the query.
       
      .buildless.service.v1.QueryOptions.Output out = 4 [json_name = "out"];
    • getOutBuilder

      public QueryOptions.Output.Builder getOutBuilder()
       Output controls for the query.
       
      .buildless.service.v1.QueryOptions.Output out = 4 [json_name = "out"];
    • getOutOrBuilder

      public QueryOptions.OutputOrBuilder getOutOrBuilder()
       Output controls for the query.
       
      .buildless.service.v1.QueryOptions.Output out = 4 [json_name = "out"];
      Specified by:
      getOutOrBuilder in interface QueryOptionsOrBuilder
    • setUnknownFields

      public final QueryOptions.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QueryOptions.Builder>
    • mergeUnknownFields

      public final QueryOptions.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QueryOptions.Builder>