Class RunQueryRequest (2.29.1)

publicfinalclass RunQueryRequestextendsGeneratedMessageV3implementsRunQueryRequestOrBuilder

The request for Datastore.RunQuery.

Protobuf type google.datastore.v1.RunQueryRequest

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

DATABASE_ID_FIELD_NUMBER

publicstaticfinalintDATABASE_ID_FIELD_NUMBER
Field Value
Type Description
int

EXPLAIN_OPTIONS_FIELD_NUMBER

publicstaticfinalintEXPLAIN_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

GQL_QUERY_FIELD_NUMBER

publicstaticfinalintGQL_QUERY_FIELD_NUMBER
Field Value
Type Description
int

PARTITION_ID_FIELD_NUMBER

publicstaticfinalintPARTITION_ID_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

publicstaticfinalintPROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

PROPERTY_MASK_FIELD_NUMBER

publicstaticfinalintPROPERTY_MASK_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

publicstaticfinalintQUERY_FIELD_NUMBER
Field Value
Type Description
int

READ_OPTIONS_FIELD_NUMBER

publicstaticfinalintREAD_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticRunQueryRequestgetDefaultInstance()
Returns
Type Description
RunQueryRequest

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticRunQueryRequest.BuildernewBuilder()
Returns
Type Description
RunQueryRequest.Builder

newBuilder(RunQueryRequest prototype)

publicstaticRunQueryRequest.BuildernewBuilder(RunQueryRequestprototype)
Parameter
Name Description
prototype RunQueryRequest
Returns
Type Description
RunQueryRequest.Builder

parseDelimitedFrom(InputStream input)

publicstaticRunQueryRequestparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
RunQueryRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticRunQueryRequestparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunQueryRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticRunQueryRequestparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
RunQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticRunQueryRequestparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticRunQueryRequestparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
RunQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticRunQueryRequestparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticRunQueryRequestparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RunQueryRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticRunQueryRequestparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunQueryRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticRunQueryRequestparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
RunQueryRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticRunQueryRequestparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunQueryRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticRunQueryRequestparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RunQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticRunQueryRequestparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<RunQueryRequest>parser()
Returns
Type Description
Parser<RunQueryRequest>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDatabaseId()

publicStringgetDatabaseId()

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()

publicByteStringgetDatabaseIdBytes()

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()

publicRunQueryRequestgetDefaultInstanceForType()
Returns
Type Description
RunQueryRequest

getExplainOptions()

publicExplainOptionsgetExplainOptions()

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()

publicExplainOptionsOrBuildergetExplainOptionsOrBuilder()

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()

publicGqlQuerygetGqlQuery()

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()

publicGqlQueryOrBuildergetGqlQueryOrBuilder()

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()

publicParser<RunQueryRequest>getParserForType()
Returns
Type Description
Parser<RunQueryRequest>
Overrides

getPartitionId()

publicPartitionIdgetPartitionId()

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()

publicPartitionIdOrBuildergetPartitionIdOrBuilder()

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()

publicStringgetProjectId()

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()

publicByteStringgetProjectIdBytes()

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()

publicPropertyMaskgetPropertyMask()

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()

publicPropertyMaskOrBuildergetPropertyMaskOrBuilder()

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()

publicQuerygetQuery()

The query to run.

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

Returns
Type Description
Query

The query.

getQueryOrBuilder()

publicQueryOrBuildergetQueryOrBuilder()

The query to run.

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

Returns
Type Description
QueryOrBuilder

getQueryTypeCase()

publicRunQueryRequest.QueryTypeCasegetQueryTypeCase()
Returns
Type Description
RunQueryRequest.QueryTypeCase

getReadOptions()

publicReadOptionsgetReadOptions()

The options for this query.

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

Returns
Type Description
ReadOptions

The readOptions.

getReadOptionsOrBuilder()

publicReadOptionsOrBuildergetReadOptionsOrBuilder()

The options for this query.

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

Returns
Type Description
ReadOptionsOrBuilder

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

hasExplainOptions()

publicbooleanhasExplainOptions()

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()

publicbooleanhasGqlQuery()

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()

publicbooleanhasPartitionId()

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()

publicbooleanhasPropertyMask()

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()

publicbooleanhasQuery()

The query to run.

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

Returns
Type Description
boolean

Whether the query field is set.

hasReadOptions()

publicbooleanhasReadOptions()

The options for this query.

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

Returns
Type Description
boolean

Whether the readOptions field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicRunQueryRequest.BuildernewBuilderForType()
Returns
Type Description
RunQueryRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedRunQueryRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RunQueryRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicRunQueryRequest.BuildertoBuilder()
Returns
Type Description
RunQueryRequest.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.