Class RunQueryRequest (2.17.2)

public final class RunQueryRequest extends GeneratedMessageV3 implements RunQueryRequestOrBuilder

The request for Datastore.RunQuery.

Protobuf type google.datastore.v1.RunQueryRequest

Static Fields

DATABASE_ID_FIELD_NUMBER

public static final int DATABASE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

GQL_QUERY_FIELD_NUMBER

public static final int GQL_QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

PARTITION_ID_FIELD_NUMBER

public static final int PARTITION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

READ_OPTIONS_FIELD_NUMBER

public static final int READ_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RunQueryRequest getDefaultInstance()
Returns
TypeDescription
RunQueryRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RunQueryRequest.Builder newBuilder()
Returns
TypeDescription
RunQueryRequest.Builder

newBuilder(RunQueryRequest prototype)

public static RunQueryRequest.Builder newBuilder(RunQueryRequest prototype)
Parameter
NameDescription
prototypeRunQueryRequest
Returns
TypeDescription
RunQueryRequest.Builder

parseDelimitedFrom(InputStream input)

public static RunQueryRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RunQueryRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RunQueryRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RunQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RunQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RunQueryRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RunQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RunQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RunQueryRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RunQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RunQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RunQueryRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RunQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RunQueryRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RunQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RunQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RunQueryRequest> parser()
Returns
TypeDescription
Parser<RunQueryRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
TypeDescription
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
TypeDescription
ByteString

The bytes for databaseId.

getDefaultInstanceForType()

public RunQueryRequest getDefaultInstanceForType()
Returns
TypeDescription
RunQueryRequest

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
TypeDescription
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
TypeDescription
GqlQueryOrBuilder

getParserForType()

public Parser<RunQueryRequest> getParserForType()
Returns
TypeDescription
Parser<RunQueryRequest>
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;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for projectId.

getQuery()

public Query getQuery()

The query to run.

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

Returns
TypeDescription
Query

The query.

getQueryOrBuilder()

public QueryOrBuilder getQueryOrBuilder()

The query to run.

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

Returns
TypeDescription
QueryOrBuilder

getQueryTypeCase()

public RunQueryRequest.QueryTypeCase getQueryTypeCase()
Returns
TypeDescription
RunQueryRequest.QueryTypeCase

getReadOptions()

public ReadOptions getReadOptions()

The options for this query.

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

Returns
TypeDescription
ReadOptions

The readOptions.

getReadOptionsOrBuilder()

public ReadOptionsOrBuilder getReadOptionsOrBuilder()

The options for this query.

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

Returns
TypeDescription
ReadOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
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
TypeDescription
boolean

Whether the partitionId field is set.

hasQuery()

public boolean hasQuery()

The query to run.

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

Returns
TypeDescription
boolean

Whether the query field is set.

hasReadOptions()

public boolean hasReadOptions()

The options for this query.

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

Returns
TypeDescription
boolean

Whether the readOptions field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RunQueryRequest.Builder newBuilderForType()
Returns
TypeDescription
RunQueryRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RunQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RunQueryRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RunQueryRequest.Builder toBuilder()
Returns
TypeDescription
RunQueryRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException