Class RunQueryRequest (2.21.3)

Version 2.21.3

• 2.25.1 (latest)
• 2.24.3
• 2.23.0
• 2.22.0
• 2.21.3
• 2.20.2
• 2.19.2
• 2.18.5
• 2.17.6

public final class RunQueryRequest extends GeneratedMessageV3 implements RunQueryRequestOrBuilder

The request for Datastore.RunQuery.

Protobuf type google.datastore.v1.RunQueryRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RunQueryRequest

Implements

RunQueryRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DATABASE_ID_FIELD_NUMBER

public static final int DATABASE_ID_FIELD_NUMBER

Field Value
Type	Description
int

EXPLAIN_OPTIONS_FIELD_NUMBER

public static final int EXPLAIN_OPTIONS_FIELD_NUMBER

Field Value
Type	Description
int

GQL_QUERY_FIELD_NUMBER

public static final int GQL_QUERY_FIELD_NUMBER

Field Value
Type	Description
int

PARTITION_ID_FIELD_NUMBER

public static final int PARTITION_ID_FIELD_NUMBER

Field Value
Type	Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER

Field Value
Type	Description
int

PROPERTY_MASK_FIELD_NUMBER

public static final int PROPERTY_MASK_FIELD_NUMBER

Field Value
Type	Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER

Field Value
Type	Description
int

READ_OPTIONS_FIELD_NUMBER

public static final int READ_OPTIONS_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static RunQueryRequest getDefaultInstance()

Returns
Type	Description
RunQueryRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static RunQueryRequest.Builder newBuilder()

Returns
Type	Description
RunQueryRequest.Builder

newBuilder(RunQueryRequest prototype)

public static RunQueryRequest.Builder newBuilder(RunQueryRequest prototype)

Parameter
Name	Description
prototype	RunQueryRequest

Returns
Type	Description
RunQueryRequest.Builder

parseDelimitedFrom(InputStream input)

public static RunQueryRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
RunQueryRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RunQueryRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static RunQueryRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
RunQueryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RunQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RunQueryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RunQueryRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
RunQueryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RunQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RunQueryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RunQueryRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
RunQueryRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RunQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RunQueryRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static RunQueryRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
RunQueryRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RunQueryRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static RunQueryRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
RunQueryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RunQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RunQueryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<RunQueryRequest> parser()

Returns
Type	Description
Parser<RunQueryRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDatabaseId()

public String getDatabaseId()

The ID of the database against which to make the request.

'(default)' is not allowed; please use empty string '' to refer the default database.

string database_id = 9;

Returns
Type	Description
String	The databaseId.

getDatabaseIdBytes()

public ByteString getDatabaseIdBytes()

The ID of the database against which to make the request.

'(default)' is not allowed; please use empty string '' to refer the default database.

string database_id = 9;

Returns
Type	Description
ByteString	The bytes for databaseId.

getDefaultInstanceForType()

public RunQueryRequest getDefaultInstanceForType()

Returns
Type	Description
RunQueryRequest

getExplainOptions()

public ExplainOptions getExplainOptions()

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

.google.datastore.v1.ExplainOptions explain_options = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ExplainOptions	The explainOptions.

getExplainOptionsOrBuilder()

public ExplainOptionsOrBuilder getExplainOptionsOrBuilder()

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

.google.datastore.v1.ExplainOptions explain_options = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ExplainOptionsOrBuilder

getGqlQuery()

public GqlQuery getGqlQuery()

The GQL query to run. This query must be a non-aggregation query.

.google.datastore.v1.GqlQuery gql_query = 7;

Returns
Type	Description
GqlQuery	The gqlQuery.

getGqlQueryOrBuilder()

public GqlQueryOrBuilder getGqlQueryOrBuilder()

The GQL query to run. This query must be a non-aggregation query.

.google.datastore.v1.GqlQuery gql_query = 7;

Returns
Type	Description
GqlQueryOrBuilder

getParserForType()

public Parser<RunQueryRequest> getParserForType()

Returns
Type	Description
Parser<RunQueryRequest>

Overrides

GeneratedMessageV3.getParserForType()

getPartitionId()

public PartitionId getPartitionId()

Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.

.google.datastore.v1.PartitionId partition_id = 2;

Returns
Type	Description
PartitionId	The partitionId.

getPartitionIdOrBuilder()

public PartitionIdOrBuilder getPartitionIdOrBuilder()

Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.

.google.datastore.v1.PartitionId partition_id = 2;

Returns
Type	Description
PartitionIdOrBuilder

getProjectId()

public String getProjectId()

Required. The ID of the project against which to make the request.

string project_id = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Required. The ID of the project against which to make the request.

string project_id = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for projectId.

getPropertyMask()

public PropertyMask getPropertyMask()

The properties to return. This field must not be set for a projection query.

See LookupRequest.property_mask.

.google.datastore.v1.PropertyMask property_mask = 10;

Returns
Type	Description
PropertyMask	The propertyMask.

getPropertyMaskOrBuilder()

public PropertyMaskOrBuilder getPropertyMaskOrBuilder()

The properties to return. This field must not be set for a projection query.

See LookupRequest.property_mask.

.google.datastore.v1.PropertyMask property_mask = 10;

Returns
Type	Description
PropertyMaskOrBuilder

getQuery()

public Query getQuery()

The query to run.

.google.datastore.v1.Query query = 3;

Returns
Type	Description
Query	The query.

getQueryOrBuilder()

public QueryOrBuilder getQueryOrBuilder()

The query to run.

.google.datastore.v1.Query query = 3;

Returns
Type	Description
QueryOrBuilder

getQueryTypeCase()

public RunQueryRequest.QueryTypeCase getQueryTypeCase()

Returns
Type	Description
RunQueryRequest.QueryTypeCase

getReadOptions()

public ReadOptions getReadOptions()

The options for this query.

.google.datastore.v1.ReadOptions read_options = 1;

Returns
Type	Description
ReadOptions	The readOptions.

getReadOptionsOrBuilder()

public ReadOptionsOrBuilder getReadOptionsOrBuilder()

The options for this query.

.google.datastore.v1.ReadOptions read_options = 1;

Returns
Type	Description
ReadOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hasExplainOptions()

public boolean hasExplainOptions()

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

.google.datastore.v1.ExplainOptions explain_options = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the explainOptions field is set.

hasGqlQuery()

public boolean hasGqlQuery()

The GQL query to run. This query must be a non-aggregation query.

.google.datastore.v1.GqlQuery gql_query = 7;

Returns
Type	Description
boolean	Whether the gqlQuery field is set.

hasPartitionId()

public boolean hasPartitionId()

Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.

.google.datastore.v1.PartitionId partition_id = 2;

Returns
Type	Description
boolean	Whether the partitionId field is set.

hasPropertyMask()

public boolean hasPropertyMask()

The properties to return. This field must not be set for a projection query.

See LookupRequest.property_mask.

.google.datastore.v1.PropertyMask property_mask = 10;

Returns
Type	Description
boolean	Whether the propertyMask field is set.

hasQuery()

public boolean hasQuery()

The query to run.

.google.datastore.v1.Query query = 3;

Returns
Type	Description
boolean	Whether the query field is set.

hasReadOptions()

public boolean hasReadOptions()

The options for this query.

.google.datastore.v1.ReadOptions read_options = 1;

Returns
Type	Description
boolean	Whether the readOptions field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public RunQueryRequest.Builder newBuilderForType()

Returns
Type	Description
RunQueryRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RunQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
RunQueryRequest.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public RunQueryRequest.Builder toBuilder()

Returns
Type	Description
RunQueryRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException