Class RunQueryRequest.Builder (2.20.1)

public static final class RunQueryRequest.Builder extends GeneratedMessageV3.Builder<RunQueryRequest.Builder> implements RunQueryRequestOrBuilder

The request for Datastore.RunQuery.

Protobuf type google.datastore.v1.RunQueryRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunQueryRequest.Builder
Overrides

build()

public RunQueryRequest build()
Returns
Type Description
RunQueryRequest

buildPartial()

public RunQueryRequest buildPartial()
Returns
Type Description
RunQueryRequest

clear()

public RunQueryRequest.Builder clear()
Returns
Type Description
RunQueryRequest.Builder
Overrides

clearDatabaseId()

public RunQueryRequest.Builder clearDatabaseId()

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
RunQueryRequest.Builder

This builder for chaining.

clearExplainOptions()

public RunQueryRequest.Builder clearExplainOptions()

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
RunQueryRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public RunQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RunQueryRequest.Builder
Overrides

clearGqlQuery()

public RunQueryRequest.Builder clearGqlQuery()

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

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

Returns
Type Description
RunQueryRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public RunQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RunQueryRequest.Builder
Overrides

clearPartitionId()

public RunQueryRequest.Builder clearPartitionId()

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
RunQueryRequest.Builder

clearProjectId()

public RunQueryRequest.Builder clearProjectId()

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

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

Returns
Type Description
RunQueryRequest.Builder

This builder for chaining.

clearPropertyMask()

public RunQueryRequest.Builder clearPropertyMask()

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
RunQueryRequest.Builder

clearQuery()

public RunQueryRequest.Builder clearQuery()

The query to run.

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

Returns
Type Description
RunQueryRequest.Builder

clearQueryType()

public RunQueryRequest.Builder clearQueryType()
Returns
Type Description
RunQueryRequest.Builder

clearReadOptions()

public RunQueryRequest.Builder clearReadOptions()

The options for this query.

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

Returns
Type Description
RunQueryRequest.Builder

clone()

public RunQueryRequest.Builder clone()
Returns
Type Description
RunQueryRequest.Builder
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()
Returns
Type Description
RunQueryRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getExplainOptionsBuilder()

public ExplainOptions.Builder getExplainOptionsBuilder()

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.Builder

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.

getGqlQueryBuilder()

public GqlQuery.Builder getGqlQueryBuilder()

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

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

Returns
Type Description
GqlQuery.Builder

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

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.

getPartitionIdBuilder()

public PartitionId.Builder getPartitionIdBuilder()

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.Builder

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.

getPropertyMaskBuilder()

public PropertyMask.Builder getPropertyMaskBuilder()

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.Builder

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.

getQueryBuilder()

public Query.Builder getQueryBuilder()

The query to run.

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

Returns
Type Description
Query.Builder

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.

getReadOptionsBuilder()

public ReadOptions.Builder getReadOptionsBuilder()

The options for this query.

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

Returns
Type Description
ReadOptions.Builder

getReadOptionsOrBuilder()

public ReadOptionsOrBuilder getReadOptionsOrBuilder()

The options for this query.

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

Returns
Type Description
ReadOptionsOrBuilder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeExplainOptions(ExplainOptions value)

public RunQueryRequest.Builder mergeExplainOptions(ExplainOptions value)

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];

Parameter
Name Description
value ExplainOptions
Returns
Type Description
RunQueryRequest.Builder

mergeFrom(RunQueryRequest other)

public RunQueryRequest.Builder mergeFrom(RunQueryRequest other)
Parameter
Name Description
other RunQueryRequest
Returns
Type Description
RunQueryRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunQueryRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RunQueryRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RunQueryRequest.Builder
Overrides

mergeGqlQuery(GqlQuery value)

public RunQueryRequest.Builder mergeGqlQuery(GqlQuery value)

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

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

Parameter
Name Description
value GqlQuery
Returns
Type Description
RunQueryRequest.Builder

mergePartitionId(PartitionId value)

public RunQueryRequest.Builder mergePartitionId(PartitionId value)

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;

Parameter
Name Description
value PartitionId
Returns
Type Description
RunQueryRequest.Builder

mergePropertyMask(PropertyMask value)

public RunQueryRequest.Builder mergePropertyMask(PropertyMask value)

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;

Parameter
Name Description
value PropertyMask
Returns
Type Description
RunQueryRequest.Builder

mergeQuery(Query value)

public RunQueryRequest.Builder mergeQuery(Query value)

The query to run.

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

Parameter
Name Description
value Query
Returns
Type Description
RunQueryRequest.Builder

mergeReadOptions(ReadOptions value)

public RunQueryRequest.Builder mergeReadOptions(ReadOptions value)

The options for this query.

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

Parameter
Name Description
value ReadOptions
Returns
Type Description
RunQueryRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunQueryRequest.Builder
Overrides

setDatabaseId(String value)

public RunQueryRequest.Builder setDatabaseId(String value)

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;

Parameter
Name Description
value String

The databaseId to set.

Returns
Type Description
RunQueryRequest.Builder

This builder for chaining.

setDatabaseIdBytes(ByteString value)

public RunQueryRequest.Builder setDatabaseIdBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for databaseId to set.

Returns
Type Description
RunQueryRequest.Builder

This builder for chaining.

setExplainOptions(ExplainOptions value)

public RunQueryRequest.Builder setExplainOptions(ExplainOptions value)

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];

Parameter
Name Description
value ExplainOptions
Returns
Type Description
RunQueryRequest.Builder

setExplainOptions(ExplainOptions.Builder builderForValue)

public RunQueryRequest.Builder setExplainOptions(ExplainOptions.Builder builderForValue)

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];

Parameter
Name Description
builderForValue ExplainOptions.Builder
Returns
Type Description
RunQueryRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RunQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunQueryRequest.Builder
Overrides

setGqlQuery(GqlQuery value)

public RunQueryRequest.Builder setGqlQuery(GqlQuery value)

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

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

Parameter
Name Description
value GqlQuery
Returns
Type Description
RunQueryRequest.Builder

setGqlQuery(GqlQuery.Builder builderForValue)

public RunQueryRequest.Builder setGqlQuery(GqlQuery.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue GqlQuery.Builder
Returns
Type Description
RunQueryRequest.Builder

setPartitionId(PartitionId value)

public RunQueryRequest.Builder setPartitionId(PartitionId value)

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;

Parameter
Name Description
value PartitionId
Returns
Type Description
RunQueryRequest.Builder

setPartitionId(PartitionId.Builder builderForValue)

public RunQueryRequest.Builder setPartitionId(PartitionId.Builder builderForValue)

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;

Parameter
Name Description
builderForValue PartitionId.Builder
Returns
Type Description
RunQueryRequest.Builder

setProjectId(String value)

public RunQueryRequest.Builder setProjectId(String value)

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

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

Parameter
Name Description
value String

The projectId to set.

Returns
Type Description
RunQueryRequest.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public RunQueryRequest.Builder setProjectIdBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for projectId to set.

Returns
Type Description
RunQueryRequest.Builder

This builder for chaining.

setPropertyMask(PropertyMask value)

public RunQueryRequest.Builder setPropertyMask(PropertyMask value)

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;

Parameter
Name Description
value PropertyMask
Returns
Type Description
RunQueryRequest.Builder

setPropertyMask(PropertyMask.Builder builderForValue)

public RunQueryRequest.Builder setPropertyMask(PropertyMask.Builder builderForValue)

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;

Parameter
Name Description
builderForValue PropertyMask.Builder
Returns
Type Description
RunQueryRequest.Builder

setQuery(Query value)

public RunQueryRequest.Builder setQuery(Query value)

The query to run.

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

Parameter
Name Description
value Query
Returns
Type Description
RunQueryRequest.Builder

setQuery(Query.Builder builderForValue)

public RunQueryRequest.Builder setQuery(Query.Builder builderForValue)

The query to run.

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

Parameter
Name Description
builderForValue Query.Builder
Returns
Type Description
RunQueryRequest.Builder

setReadOptions(ReadOptions value)

public RunQueryRequest.Builder setReadOptions(ReadOptions value)

The options for this query.

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

Parameter
Name Description
value ReadOptions
Returns
Type Description
RunQueryRequest.Builder

setReadOptions(ReadOptions.Builder builderForValue)

public RunQueryRequest.Builder setReadOptions(ReadOptions.Builder builderForValue)

The options for this query.

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

Parameter
Name Description
builderForValue ReadOptions.Builder
Returns
Type Description
RunQueryRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RunQueryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RunQueryRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RunQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunQueryRequest.Builder
Overrides