Package org.vitrivr.cottontail.grpc

Class CottontailGrpc.RequestMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.vitrivr.cottontail.grpc.CottontailGrpc.RequestMetadata

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, CottontailGrpc.RequestMetadataOrBuilder

Enclosing class:

CottontailGrpc

public static final class CottontailGrpc.RequestMetadata
extends com.google.protobuf.GeneratedMessageV3
implements CottontailGrpc.RequestMetadataOrBuilder

 Query metadata used in Cottontail DB. 
 

Protobuf type org.vitrivr.cottontail.grpc.RequestMetadata

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CottontailGrpc.RequestMetadata.Builder	Query metadata used in Cottontail DB.
static final class	CottontailGrpc.RequestMetadata.IndexHint	A query hint regarding the index that should be employed.
static interface	CottontailGrpc.RequestMetadata.IndexHintOrBuilder
static final class	CottontailGrpc.RequestMetadata.ParallelismHint	A query hint regarding parallelism.
static interface	CottontailGrpc.RequestMetadata.ParallelismHintOrBuilder
static final class	CottontailGrpc.RequestMetadata.PolicyHint	A query hint regarding the cost policy that should be employed.
static interface	CottontailGrpc.RequestMetadata.PolicyHintOrBuilder

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
private int	bitField0_
private static final CottontailGrpc.RequestMetadata	DEFAULT_INSTANCE
private CottontailGrpc.RequestMetadata.IndexHint	indexHint_
static final int	INDEXHINT_FIELD_NUMBER
private byte	memoizedIsInitialized
private boolean	noOptimiseHint_
static final int	NOOPTIMISEHINT_FIELD_NUMBER
private CottontailGrpc.RequestMetadata.ParallelismHint	parallelHint_
static final int	PARALLELHINT_FIELD_NUMBER
private static final com.google.protobuf.Parser<CottontailGrpc.RequestMetadata>	PARSER
private CottontailGrpc.RequestMetadata.PolicyHint	policyHint_
static final int	POLICYHINT_FIELD_NUMBER
private Object	queryId_
static final int	QUERYID_FIELD_NUMBER
private static final long	serialVersionUID
private long	transactionId_
static final int	TRANSACTIONID_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

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RequestMetadata()
private	RequestMetadata(com.google.protobuf.GeneratedMessageV3.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static CottontailGrpc.RequestMetadata	getDefaultInstance()
CottontailGrpc.RequestMetadata	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
CottontailGrpc.RequestMetadata.IndexHint	getIndexHint()	.org.vitrivr.cottontail.grpc.RequestMetadata.IndexHint indexHint = 11;
CottontailGrpc.RequestMetadata.IndexHintOrBuilder	getIndexHintOrBuilder()	.org.vitrivr.cottontail.grpc.RequestMetadata.IndexHint indexHint = 11;
boolean	getNoOptimiseHint()	bool noOptimiseHint = 13;
CottontailGrpc.RequestMetadata.ParallelismHint	getParallelHint()	Hints to the query planner.
CottontailGrpc.RequestMetadata.ParallelismHintOrBuilder	getParallelHintOrBuilder()	Hints to the query planner.
com.google.protobuf.Parser<CottontailGrpc.RequestMetadata>	getParserForType()
CottontailGrpc.RequestMetadata.PolicyHint	getPolicyHint()	.org.vitrivr.cottontail.grpc.RequestMetadata.PolicyHint policyHint = 12;
CottontailGrpc.RequestMetadata.PolicyHintOrBuilder	getPolicyHintOrBuilder()	.org.vitrivr.cottontail.grpc.RequestMetadata.PolicyHint policyHint = 12;
String	getQueryId()	string queryId = 2;
com.google.protobuf.ByteString	getQueryIdBytes()	string queryId = 2;
int	getSerializedSize()
long	getTransactionId()	int64 transactionId = 1;
int	hashCode()
boolean	hasIndexHint()	.org.vitrivr.cottontail.grpc.RequestMetadata.IndexHint indexHint = 11;
boolean	hasParallelHint()	Hints to the query planner.
boolean	hasPolicyHint()	.org.vitrivr.cottontail.grpc.RequestMetadata.PolicyHint policyHint = 12;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static CottontailGrpc.RequestMetadata.Builder	newBuilder()
static CottontailGrpc.RequestMetadata.Builder	newBuilder(CottontailGrpc.RequestMetadata prototype)
CottontailGrpc.RequestMetadata.Builder	newBuilderForType()
protected CottontailGrpc.RequestMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CottontailGrpc.RequestMetadata	parseDelimitedFrom(InputStream input)
static CottontailGrpc.RequestMetadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CottontailGrpc.RequestMetadata	parseFrom(byte[] data)
static CottontailGrpc.RequestMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CottontailGrpc.RequestMetadata	parseFrom(com.google.protobuf.ByteString data)
static CottontailGrpc.RequestMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CottontailGrpc.RequestMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static CottontailGrpc.RequestMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CottontailGrpc.RequestMetadata	parseFrom(InputStream input)
static CottontailGrpc.RequestMetadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CottontailGrpc.RequestMetadata	parseFrom(ByteBuffer data)
static CottontailGrpc.RequestMetadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CottontailGrpc.RequestMetadata>	parser()
CottontailGrpc.RequestMetadata.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, internalGetMapFieldReflection, 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

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

bitField0_

private int bitField0_

TRANSACTIONID_FIELD_NUMBER

public static final int TRANSACTIONID_FIELD_NUMBER

See Also:

• Constant Field Values

transactionId_

private long transactionId_

QUERYID_FIELD_NUMBER

public static final int QUERYID_FIELD_NUMBER

See Also:

• Constant Field Values

queryId_

private volatile Object queryId_

PARALLELHINT_FIELD_NUMBER

public static final int PARALLELHINT_FIELD_NUMBER

See Also:

• Constant Field Values

parallelHint_

private CottontailGrpc.RequestMetadata.ParallelismHint parallelHint_

INDEXHINT_FIELD_NUMBER

public static final int INDEXHINT_FIELD_NUMBER

See Also:

• Constant Field Values

indexHint_

private CottontailGrpc.RequestMetadata.IndexHint indexHint_

POLICYHINT_FIELD_NUMBER

public static final int POLICYHINT_FIELD_NUMBER

See Also:

• Constant Field Values

policyHint_

private CottontailGrpc.RequestMetadata.PolicyHint policyHint_

NOOPTIMISEHINT_FIELD_NUMBER

public static final int NOOPTIMISEHINT_FIELD_NUMBER

See Also:

• Constant Field Values

noOptimiseHint_

private boolean noOptimiseHint_

memoizedIsInitialized

private byte memoizedIsInitialized

DEFAULT_INSTANCE

private static final CottontailGrpc.RequestMetadata DEFAULT_INSTANCE

PARSER

private static final com.google.protobuf.Parser<CottontailGrpc.RequestMetadata> PARSER

Constructor Details

RequestMetadata

private RequestMetadata(com.google.protobuf.GeneratedMessageV3.Builder<?> builder)

RequestMetadata

private RequestMetadata()

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

getTransactionId

public long getTransactionId()

int64 transactionId = 1;

Specified by:

getTransactionId in interface CottontailGrpc.RequestMetadataOrBuilder

Returns:

The transactionId.

getQueryId

public String getQueryId()

string queryId = 2;

Specified by:

getQueryId in interface CottontailGrpc.RequestMetadataOrBuilder

Returns:

The queryId.

getQueryIdBytes

public com.google.protobuf.ByteString getQueryIdBytes()

string queryId = 2;

Specified by:

getQueryIdBytes in interface CottontailGrpc.RequestMetadataOrBuilder

Returns:

The bytes for queryId.

hasParallelHint

public boolean hasParallelHint()

 Hints to the query planner. 
 

.org.vitrivr.cottontail.grpc.RequestMetadata.ParallelismHint parallelHint = 10;

Specified by:

hasParallelHint in interface CottontailGrpc.RequestMetadataOrBuilder

Returns:

Whether the parallelHint field is set.

getParallelHint

public CottontailGrpc.RequestMetadata.ParallelismHint getParallelHint()

 Hints to the query planner. 
 

.org.vitrivr.cottontail.grpc.RequestMetadata.ParallelismHint parallelHint = 10;

Specified by:

getParallelHint in interface CottontailGrpc.RequestMetadataOrBuilder

Returns:

The parallelHint.

getParallelHintOrBuilder

public CottontailGrpc.RequestMetadata.ParallelismHintOrBuilder getParallelHintOrBuilder()

 Hints to the query planner. 
 

.org.vitrivr.cottontail.grpc.RequestMetadata.ParallelismHint parallelHint = 10;

Specified by:

getParallelHintOrBuilder in interface CottontailGrpc.RequestMetadataOrBuilder

hasIndexHint

public boolean hasIndexHint()

.org.vitrivr.cottontail.grpc.RequestMetadata.IndexHint indexHint = 11;

Specified by:

hasIndexHint in interface CottontailGrpc.RequestMetadataOrBuilder

Returns:

Whether the indexHint field is set.

getIndexHint

public CottontailGrpc.RequestMetadata.IndexHint getIndexHint()

.org.vitrivr.cottontail.grpc.RequestMetadata.IndexHint indexHint = 11;

Specified by:

getIndexHint in interface CottontailGrpc.RequestMetadataOrBuilder

Returns:

The indexHint.

getIndexHintOrBuilder

public CottontailGrpc.RequestMetadata.IndexHintOrBuilder getIndexHintOrBuilder()

.org.vitrivr.cottontail.grpc.RequestMetadata.IndexHint indexHint = 11;

Specified by:

getIndexHintOrBuilder in interface CottontailGrpc.RequestMetadataOrBuilder

hasPolicyHint

public boolean hasPolicyHint()

.org.vitrivr.cottontail.grpc.RequestMetadata.PolicyHint policyHint = 12;

Specified by:

hasPolicyHint in interface CottontailGrpc.RequestMetadataOrBuilder

Returns:

Whether the policyHint field is set.

getPolicyHint

public CottontailGrpc.RequestMetadata.PolicyHint getPolicyHint()

.org.vitrivr.cottontail.grpc.RequestMetadata.PolicyHint policyHint = 12;

Specified by:

getPolicyHint in interface CottontailGrpc.RequestMetadataOrBuilder

Returns:

The policyHint.

getPolicyHintOrBuilder

public CottontailGrpc.RequestMetadata.PolicyHintOrBuilder getPolicyHintOrBuilder()

.org.vitrivr.cottontail.grpc.RequestMetadata.PolicyHint policyHint = 12;

Specified by:

getPolicyHintOrBuilder in interface CottontailGrpc.RequestMetadataOrBuilder

getNoOptimiseHint

public boolean getNoOptimiseHint()

bool noOptimiseHint = 13;

Specified by:

getNoOptimiseHint in interface CottontailGrpc.RequestMetadataOrBuilder

Returns:

The noOptimiseHint.

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 CottontailGrpc.RequestMetadata parseFrom(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CottontailGrpc.RequestMetadata parseFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static CottontailGrpc.RequestMetadata parseDelimitedFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public CottontailGrpc.RequestMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CottontailGrpc.RequestMetadata.Builder newBuilder()

newBuilder

public static CottontailGrpc.RequestMetadata.Builder newBuilder(CottontailGrpc.RequestMetadata prototype)

toBuilder

public CottontailGrpc.RequestMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CottontailGrpc.RequestMetadata getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<CottontailGrpc.RequestMetadata> 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 CottontailGrpc.RequestMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder