Class RunQueryRequest (2.19.2)
Version 2.19.2keyboard_arrow_down
public final class RunQueryRequest extends GeneratedMessageV3 implements RunQueryRequestOrBuilder
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
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
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static RunQueryRequest . Builder newBuilder ()
newBuilder(RunQueryRequest prototype)
public static RunQueryRequest . Builder newBuilder ( RunQueryRequest prototype )
public static RunQueryRequest parseDelimitedFrom ( InputStream input )
public static RunQueryRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static RunQueryRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RunQueryRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static RunQueryRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunQueryRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static RunQueryRequest parseFrom ( CodedInputStream input )
public static RunQueryRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static RunQueryRequest parseFrom ( InputStream input )
public static RunQueryRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static RunQueryRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RunQueryRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<RunQueryRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
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 ()
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];
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];
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;
getParserForType()
public Parser<RunQueryRequest> getParserForType ()
Overrides
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;
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;
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.
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;
getQueryTypeCase()
public RunQueryRequest . QueryTypeCase getQueryTypeCase ()
getReadOptions()
public ReadOptions getReadOptions ()
The options for this query.
.google.datastore.v1.ReadOptions read_options = 1;
getReadOptionsOrBuilder()
public ReadOptionsOrBuilder getReadOptionsOrBuilder ()
The options for this query.
.google.datastore.v1.ReadOptions read_options = 1;
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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.
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()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public RunQueryRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RunQueryRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public RunQueryRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
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-10-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
