Package com.buildless.service.v1

Class QueryOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.buildless.service.v1.QueryOptions

All Implemented Interfaces:

QueryOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class QueryOptions
extends com.google.protobuf.GeneratedMessageV3
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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	QueryOptions.Builder	## 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.
static final class	QueryOptions.Filter	Specifies a filter directive which should apply to a data query.
static interface	QueryOptions.FilterOrBuilder
static final class	QueryOptions.Output	Specifies an output directive which controls relationship expansion, property sub-setting, and so on.
static interface	QueryOptions.OutputOrBuilder
static final class	QueryOptions.Pagination	Specifies a pagination directive which controls the record window to return.
static interface	QueryOptions.PaginationOrBuilder
static final class	QueryOptions.Sort	Specifies a sort directive which should apply to a data query.
static interface	QueryOptions.SortOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FILTER_FIELD_NUMBER
static final int	OUT_FIELD_NUMBER
static final int	PAGE_FIELD_NUMBER
static final int	SORT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static QueryOptions	getDefaultInstance()
QueryOptions	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
QueryOptions.Filter	getFilter(int index)	Filter directives for the query.
int	getFilterCount()	Filter directives for the query.
List<QueryOptions.Filter>	getFilterList()	Filter directives for the query.
QueryOptions.FilterOrBuilder	getFilterOrBuilder(int index)	Filter directives for the query.
List<? extends QueryOptions.FilterOrBuilder>	getFilterOrBuilderList()	Filter directives for the query.
QueryOptions.Output	getOut()	Output controls for the query.
QueryOptions.OutputOrBuilder	getOutOrBuilder()	Output controls for the query.
QueryOptions.Pagination	getPage()	Pagination control for the query.
QueryOptions.PaginationOrBuilder	getPageOrBuilder()	Pagination control for the query.
com.google.protobuf.Parser<QueryOptions>	getParserForType()
int	getSerializedSize()
QueryOptions.Sort	getSort(int index)	Sort directives for the query.
int	getSortCount()	Sort directives for the query.
List<QueryOptions.Sort>	getSortList()	Sort directives for the query.
QueryOptions.SortOrBuilder	getSortOrBuilder(int index)	Sort directives for the query.
List<? extends QueryOptions.SortOrBuilder>	getSortOrBuilderList()	Sort directives for the query.
int	hashCode()
boolean	hasOut()	Output controls for the query.
boolean	hasPage()	Pagination control for the query.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static QueryOptions.Builder	newBuilder()
static QueryOptions.Builder	newBuilder(QueryOptions prototype)
QueryOptions.Builder	newBuilderForType()
protected QueryOptions.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static QueryOptions	parseDelimitedFrom(InputStream input)
static QueryOptions	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryOptions	parseFrom(byte[] data)
static QueryOptions	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryOptions	parseFrom(com.google.protobuf.ByteString data)
static QueryOptions	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryOptions	parseFrom(com.google.protobuf.CodedInputStream input)
static QueryOptions	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryOptions	parseFrom(InputStream input)
static QueryOptions	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryOptions	parseFrom(ByteBuffer data)
static QueryOptions	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<QueryOptions>	parser()
QueryOptions.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

PAGE_FIELD_NUMBER

public static final int PAGE_FIELD_NUMBER

See Also:

• Constant Field Values

SORT_FIELD_NUMBER

public static final int SORT_FIELD_NUMBER

See Also:

• Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

• Constant Field Values

OUT_FIELD_NUMBER

public static final int OUT_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

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.

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

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

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

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

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

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

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

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

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.

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static QueryOptions parseFrom(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryOptions parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryOptions parseFrom(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryOptions parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryOptions parseFrom(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryOptions parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryOptions parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static QueryOptions parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static QueryOptions parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static QueryOptions parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseFrom

public static QueryOptions parseFrom(com.google.protobuf.CodedInputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static QueryOptions parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

newBuilderForType

public QueryOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static QueryOptions.Builder newBuilder()

newBuilder

public static QueryOptions.Builder newBuilder(QueryOptions prototype)

toBuilder

public QueryOptions.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected QueryOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static QueryOptions getDefaultInstance()

parser

public static com.google.protobuf.Parser<QueryOptions> parser()

getParserForType

public com.google.protobuf.Parser<QueryOptions> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public QueryOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder