public static final class RunAggregationQueryRequest.Builder extends GeneratedMessageV3.Builder<RunAggregationQueryRequest.Builder> implements RunAggregationQueryRequestOrBuilderThe request for Datastore.RunAggregationQuery.
Protobuf type google.datastore.v1.RunAggregationQueryRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RunAggregationQueryRequest.BuilderImplements
RunAggregationQueryRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RunAggregationQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
build()
public RunAggregationQueryRequest build()| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest |
|
buildPartial()
public RunAggregationQueryRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest |
|
clear()
public RunAggregationQueryRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
clearAggregationQuery()
public RunAggregationQueryRequest.Builder clearAggregationQuery()The query to run.
.google.datastore.v1.AggregationQuery aggregation_query = 3;
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
clearDatabaseId()
public RunAggregationQueryRequest.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 |
RunAggregationQueryRequest.Builder |
This builder for chaining. |
clearExplainOptions()
public RunAggregationQueryRequest.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 = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public RunAggregationQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
clearGqlQuery()
public RunAggregationQueryRequest.Builder clearGqlQuery()The GQL query to run. This query must be an aggregation query.
.google.datastore.v1.GqlQuery gql_query = 7;
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public RunAggregationQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
clearPartitionId()
public RunAggregationQueryRequest.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 |
RunAggregationQueryRequest.Builder |
|
clearProjectId()
public RunAggregationQueryRequest.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 |
RunAggregationQueryRequest.Builder |
This builder for chaining. |
clearQueryType()
public RunAggregationQueryRequest.Builder clearQueryType()| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
clearReadOptions()
public RunAggregationQueryRequest.Builder clearReadOptions()The options for this query.
.google.datastore.v1.ReadOptions read_options = 1;
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
clone()
public RunAggregationQueryRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
getAggregationQuery()
public AggregationQuery getAggregationQuery()The query to run.
.google.datastore.v1.AggregationQuery aggregation_query = 3;
| Returns | |
|---|---|
| Type | Description |
AggregationQuery |
The aggregationQuery. |
getAggregationQueryBuilder()
public AggregationQuery.Builder getAggregationQueryBuilder()The query to run.
.google.datastore.v1.AggregationQuery aggregation_query = 3;
| Returns | |
|---|---|
| Type | Description |
AggregationQuery.Builder |
|
getAggregationQueryOrBuilder()
public AggregationQueryOrBuilder getAggregationQueryOrBuilder()The query to run.
.google.datastore.v1.AggregationQuery aggregation_query = 3;
| Returns | |
|---|---|
| Type | Description |
AggregationQueryOrBuilder |
|
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 RunAggregationQueryRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 = 11 [(.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 = 11 [(.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 = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ExplainOptionsOrBuilder |
|
getGqlQuery()
public GqlQuery getGqlQuery()The GQL query to run. This query must be an 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 an 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 an 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. |
getQueryTypeCase()
public RunAggregationQueryRequest.QueryTypeCase getQueryTypeCase()| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.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 |
|
hasAggregationQuery()
public boolean hasAggregationQuery()The query to run.
.google.datastore.v1.AggregationQuery aggregation_query = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the aggregationQuery field is set. |
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 = 11 [(.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 an 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. |
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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAggregationQuery(AggregationQuery value)
public RunAggregationQueryRequest.Builder mergeAggregationQuery(AggregationQuery value)The query to run.
.google.datastore.v1.AggregationQuery aggregation_query = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
AggregationQuery |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
mergeExplainOptions(ExplainOptions value)
public RunAggregationQueryRequest.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 = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ExplainOptions |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
mergeFrom(RunAggregationQueryRequest other)
public RunAggregationQueryRequest.Builder mergeFrom(RunAggregationQueryRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
RunAggregationQueryRequest |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RunAggregationQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public RunAggregationQueryRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
mergeGqlQuery(GqlQuery value)
public RunAggregationQueryRequest.Builder mergeGqlQuery(GqlQuery value)The GQL query to run. This query must be an aggregation query.
.google.datastore.v1.GqlQuery gql_query = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
GqlQuery |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
mergePartitionId(PartitionId value)
public RunAggregationQueryRequest.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 |
RunAggregationQueryRequest.Builder |
|
mergeReadOptions(ReadOptions value)
public RunAggregationQueryRequest.Builder mergeReadOptions(ReadOptions value)The options for this query.
.google.datastore.v1.ReadOptions read_options = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ReadOptions |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RunAggregationQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
setAggregationQuery(AggregationQuery value)
public RunAggregationQueryRequest.Builder setAggregationQuery(AggregationQuery value)The query to run.
.google.datastore.v1.AggregationQuery aggregation_query = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
AggregationQuery |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
setAggregationQuery(AggregationQuery.Builder builderForValue)
public RunAggregationQueryRequest.Builder setAggregationQuery(AggregationQuery.Builder builderForValue)The query to run.
.google.datastore.v1.AggregationQuery aggregation_query = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AggregationQuery.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
setDatabaseId(String value)
public RunAggregationQueryRequest.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 |
StringThe databaseId to set. |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
This builder for chaining. |
setDatabaseIdBytes(ByteString value)
public RunAggregationQueryRequest.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 |
ByteStringThe bytes for databaseId to set. |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
This builder for chaining. |
setExplainOptions(ExplainOptions value)
public RunAggregationQueryRequest.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 = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ExplainOptions |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
setExplainOptions(ExplainOptions.Builder builderForValue)
public RunAggregationQueryRequest.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 = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ExplainOptions.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public RunAggregationQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
setGqlQuery(GqlQuery value)
public RunAggregationQueryRequest.Builder setGqlQuery(GqlQuery value)The GQL query to run. This query must be an aggregation query.
.google.datastore.v1.GqlQuery gql_query = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
GqlQuery |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
setGqlQuery(GqlQuery.Builder builderForValue)
public RunAggregationQueryRequest.Builder setGqlQuery(GqlQuery.Builder builderForValue)The GQL query to run. This query must be an aggregation query.
.google.datastore.v1.GqlQuery gql_query = 7;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
GqlQuery.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
setPartitionId(PartitionId value)
public RunAggregationQueryRequest.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 |
RunAggregationQueryRequest.Builder |
|
setPartitionId(PartitionId.Builder builderForValue)
public RunAggregationQueryRequest.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 |
RunAggregationQueryRequest.Builder |
|
setProjectId(String value)
public RunAggregationQueryRequest.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 |
StringThe projectId to set. |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
This builder for chaining. |
setProjectIdBytes(ByteString value)
public RunAggregationQueryRequest.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 |
ByteStringThe bytes for projectId to set. |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
This builder for chaining. |
setReadOptions(ReadOptions value)
public RunAggregationQueryRequest.Builder setReadOptions(ReadOptions value)The options for this query.
.google.datastore.v1.ReadOptions read_options = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ReadOptions |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
setReadOptions(ReadOptions.Builder builderForValue)
public RunAggregationQueryRequest.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 |
RunAggregationQueryRequest.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RunAggregationQueryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final RunAggregationQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder |
|