Package com.google.datastore.v1 (2.19.0)

Classes

AggregationQuery

Datastore query for running an aggregation over a Query.

Protobuf type google.datastore.v1.AggregationQuery

AggregationQuery.Aggregation

Defines an aggregation that produces a single result.

Protobuf type google.datastore.v1.AggregationQuery.Aggregation

AggregationQuery.Aggregation.Avg

Average of the values of the requested property.

Only numeric values will be aggregated. All non-numeric values including NULL are skipped.
If the aggregated values contain NaN, returns NaN. Infinity math follows IEEE-754 standards.
If the aggregated value set is empty, returns NULL.
Always returns the result as a double.

Protobuf type google.datastore.v1.AggregationQuery.Aggregation.Avg

AggregationQuery.Aggregation.Avg.Builder

Average of the values of the requested property.

Only numeric values will be aggregated. All non-numeric values including NULL are skipped.
If the aggregated values contain NaN, returns NaN. Infinity math follows IEEE-754 standards.
If the aggregated value set is empty, returns NULL.
Always returns the result as a double.

Protobuf type google.datastore.v1.AggregationQuery.Aggregation.Avg

AggregationQuery.Aggregation.Builder

Defines an aggregation that produces a single result.

Protobuf type google.datastore.v1.AggregationQuery.Aggregation

AggregationQuery.Aggregation.Count

Count of entities that match the query.

The COUNT(*) aggregation function operates on the entire entity so it does not require a field reference.

Protobuf type google.datastore.v1.AggregationQuery.Aggregation.Count

AggregationQuery.Aggregation.Count.Builder

Count of entities that match the query.

The COUNT(*) aggregation function operates on the entire entity so it does not require a field reference.

Protobuf type google.datastore.v1.AggregationQuery.Aggregation.Count

AggregationQuery.Aggregation.Sum

Sum of the values of the requested property.

Only numeric values will be aggregated. All non-numeric values including NULL are skipped.
If the aggregated values contain NaN, returns NaN. Infinity math follows IEEE-754 standards.
If the aggregated value set is empty, returns 0.
Returns a 64-bit integer if all aggregated numbers are integers and the sum result does not overflow. Otherwise, the result is returned as a double. Note that even if all the aggregated values are integers, the result is returned as a double if it cannot fit within a 64-bit signed integer. When this occurs, the returned value will lose precision.
When underflow occurs, floating-point aggregation is non-deterministic. This means that running the same query repeatedly without any changes to the underlying values could produce slightly different results each time. In those cases, values should be stored as integers over floating-point numbers.

Protobuf type google.datastore.v1.AggregationQuery.Aggregation.Sum

AggregationQuery.Aggregation.Sum.Builder

Sum of the values of the requested property.

Only numeric values will be aggregated. All non-numeric values including NULL are skipped.
If the aggregated values contain NaN, returns NaN. Infinity math follows IEEE-754 standards.
If the aggregated value set is empty, returns 0.
Returns a 64-bit integer if all aggregated numbers are integers and the sum result does not overflow. Otherwise, the result is returned as a double. Note that even if all the aggregated values are integers, the result is returned as a double if it cannot fit within a 64-bit signed integer. When this occurs, the returned value will lose precision.
When underflow occurs, floating-point aggregation is non-deterministic. This means that running the same query repeatedly without any changes to the underlying values could produce slightly different results each time. In those cases, values should be stored as integers over floating-point numbers.

Protobuf type google.datastore.v1.AggregationQuery.Aggregation.Sum

AggregationQuery.Builder

Datastore query for running an aggregation over a Query.

Protobuf type google.datastore.v1.AggregationQuery

AggregationResult

The result of a single bucket from a Datastore aggregation query.

The keys of aggregate_properties are the same for all results in an aggregation query, unlike entity queries which can have different fields present for each result.

Protobuf type google.datastore.v1.AggregationResult

AggregationResult.Builder

The result of a single bucket from a Datastore aggregation query.

The keys of aggregate_properties are the same for all results in an aggregation query, unlike entity queries which can have different fields present for each result.

Protobuf type google.datastore.v1.AggregationResult

AggregationResultBatch

A batch of aggregation results produced by an aggregation query.

Protobuf type google.datastore.v1.AggregationResultBatch

AggregationResultBatch.Builder

A batch of aggregation results produced by an aggregation query.

Protobuf type google.datastore.v1.AggregationResultBatch

AllocateIdsRequest

The request for Datastore.AllocateIds.

Protobuf type google.datastore.v1.AllocateIdsRequest

AllocateIdsRequest.Builder

The request for Datastore.AllocateIds.

Protobuf type google.datastore.v1.AllocateIdsRequest

AllocateIdsResponse

The response for Datastore.AllocateIds.

Protobuf type google.datastore.v1.AllocateIdsResponse

AllocateIdsResponse.Builder

The response for Datastore.AllocateIds.

Protobuf type google.datastore.v1.AllocateIdsResponse

ArrayValue

An array value.

Protobuf type google.datastore.v1.ArrayValue

ArrayValue.Builder

An array value.

Protobuf type google.datastore.v1.ArrayValue

BeginTransactionRequest

The request for Datastore.BeginTransaction.

Protobuf type google.datastore.v1.BeginTransactionRequest

BeginTransactionRequest.Builder

The request for Datastore.BeginTransaction.

Protobuf type google.datastore.v1.BeginTransactionRequest

BeginTransactionResponse

The response for Datastore.BeginTransaction.

Protobuf type google.datastore.v1.BeginTransactionResponse

BeginTransactionResponse.Builder

The response for Datastore.BeginTransaction.

Protobuf type google.datastore.v1.BeginTransactionResponse

CommitRequest

The request for Datastore.Commit.

Protobuf type google.datastore.v1.CommitRequest

CommitRequest.Builder

The request for Datastore.Commit.

Protobuf type google.datastore.v1.CommitRequest

CommitResponse

The response for Datastore.Commit.

Protobuf type google.datastore.v1.CommitResponse

CommitResponse.Builder

The response for Datastore.Commit.

Protobuf type google.datastore.v1.CommitResponse

CompositeFilter

A filter that merges multiple other filters using the given operator.

Protobuf type google.datastore.v1.CompositeFilter

CompositeFilter.Builder

A filter that merges multiple other filters using the given operator.

Protobuf type google.datastore.v1.CompositeFilter

Entity

A Datastore data object.

Must not exceed 1 MiB - 4 bytes.

Protobuf type google.datastore.v1.Entity

Entity.Builder

A Datastore data object.

Must not exceed 1 MiB - 4 bytes.

Protobuf type google.datastore.v1.Entity

EntityResult

The result of fetching an entity from Datastore.

Protobuf type google.datastore.v1.EntityResult

EntityResult.Builder

The result of fetching an entity from Datastore.

Protobuf type google.datastore.v1.EntityResult

ExecutionStats

Execution statistics for the query.

Protobuf type google.datastore.v1.ExecutionStats

ExecutionStats.Builder

Execution statistics for the query.

Protobuf type google.datastore.v1.ExecutionStats

ExplainMetrics

Explain metrics for the query.

Protobuf type google.datastore.v1.ExplainMetrics

ExplainMetrics.Builder

Explain metrics for the query.

Protobuf type google.datastore.v1.ExplainMetrics

ExplainOptions

Explain options for the query.

Protobuf type google.datastore.v1.ExplainOptions

ExplainOptions.Builder

Explain options for the query.

Protobuf type google.datastore.v1.ExplainOptions

Filter

A holder for any type of filter.

Protobuf type google.datastore.v1.Filter

Filter.Builder

A holder for any type of filter.

Protobuf type google.datastore.v1.Filter

GqlQuery

A GQL query.

Protobuf type google.datastore.v1.GqlQuery

GqlQuery.Builder

A GQL query.

Protobuf type google.datastore.v1.GqlQuery

GqlQueryParameter

A binding parameter for a GQL query.

Protobuf type google.datastore.v1.GqlQueryParameter

GqlQueryParameter.Builder

A binding parameter for a GQL query.

Protobuf type google.datastore.v1.GqlQueryParameter

A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.

Protobuf type google.datastore.v1.Key

Key.Builder

Protobuf type google.datastore.v1.Key

Key.PathElement

A (kind, ID/name) pair used to construct a key path.

If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Protobuf type google.datastore.v1.Key.PathElement

Key.PathElement.Builder

A (kind, ID/name) pair used to construct a key path.

If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Protobuf type google.datastore.v1.Key.PathElement

KindExpression

A representation of a kind.

Protobuf type google.datastore.v1.KindExpression

KindExpression.Builder

A representation of a kind.

Protobuf type google.datastore.v1.KindExpression

LookupRequest

The request for Datastore.Lookup.

Protobuf type google.datastore.v1.LookupRequest

LookupRequest.Builder

The request for Datastore.Lookup.

Protobuf type google.datastore.v1.LookupRequest

LookupResponse

The response for Datastore.Lookup.

Protobuf type google.datastore.v1.LookupResponse

LookupResponse.Builder

The response for Datastore.Lookup.

Protobuf type google.datastore.v1.LookupResponse

Mutation

A mutation to apply to an entity.

Protobuf type google.datastore.v1.Mutation

Mutation.Builder

A mutation to apply to an entity.

Protobuf type google.datastore.v1.Mutation

MutationResult

The result of applying a mutation.

Protobuf type google.datastore.v1.MutationResult

MutationResult.Builder

The result of applying a mutation.

Protobuf type google.datastore.v1.MutationResult

PartitionId

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-]{1,100} If the value of any dimension matches regex _.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Protobuf type google.datastore.v1.PartitionId

PartitionId.Builder

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-]{1,100} If the value of any dimension matches regex _.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Protobuf type google.datastore.v1.PartitionId

PlanSummary

Planning phase information for the query.

Protobuf type google.datastore.v1.PlanSummary

PlanSummary.Builder

Planning phase information for the query.

Protobuf type google.datastore.v1.PlanSummary

Projection

A representation of a property in a projection.

Protobuf type google.datastore.v1.Projection

Projection.Builder

A representation of a property in a projection.

Protobuf type google.datastore.v1.Projection

PropertyFilter

A filter on a specific property.

Protobuf type google.datastore.v1.PropertyFilter

PropertyFilter.Builder

A filter on a specific property.

Protobuf type google.datastore.v1.PropertyFilter

PropertyOrder

The desired order for a specific property.

Protobuf type google.datastore.v1.PropertyOrder

PropertyOrder.Builder

The desired order for a specific property.

Protobuf type google.datastore.v1.PropertyOrder

PropertyReference

A reference to a property relative to the kind expressions.

Protobuf type google.datastore.v1.PropertyReference

PropertyReference.Builder

A reference to a property relative to the kind expressions.

Protobuf type google.datastore.v1.PropertyReference

Query

A query for entities.

Protobuf type google.datastore.v1.Query

Query.Builder

A query for entities.

Protobuf type google.datastore.v1.Query

QueryProfileProto

QueryProto

QueryResultBatch

A batch of results produced by a query.

Protobuf type google.datastore.v1.QueryResultBatch

QueryResultBatch.Builder

A batch of results produced by a query.

Protobuf type google.datastore.v1.QueryResultBatch

ReadOptions

The options shared by read requests.

Protobuf type google.datastore.v1.ReadOptions

ReadOptions.Builder

The options shared by read requests.

Protobuf type google.datastore.v1.ReadOptions

ReserveIdsRequest

The request for Datastore.ReserveIds.

Protobuf type google.datastore.v1.ReserveIdsRequest

ReserveIdsRequest.Builder

The request for Datastore.ReserveIds.

Protobuf type google.datastore.v1.ReserveIdsRequest

ReserveIdsResponse

The response for Datastore.ReserveIds.

Protobuf type google.datastore.v1.ReserveIdsResponse

ReserveIdsResponse.Builder

The response for Datastore.ReserveIds.

Protobuf type google.datastore.v1.ReserveIdsResponse

RollbackRequest

The request for Datastore.Rollback.

Protobuf type google.datastore.v1.RollbackRequest

RollbackRequest.Builder

The request for Datastore.Rollback.

Protobuf type google.datastore.v1.RollbackRequest

RollbackResponse

The response for Datastore.Rollback. (an empty message).

Protobuf type google.datastore.v1.RollbackResponse

RollbackResponse.Builder

The response for Datastore.Rollback. (an empty message).

Protobuf type google.datastore.v1.RollbackResponse

RunAggregationQueryRequest

The request for Datastore.RunAggregationQuery.

Protobuf type google.datastore.v1.RunAggregationQueryRequest

RunAggregationQueryRequest.Builder

The request for Datastore.RunAggregationQuery.

Protobuf type google.datastore.v1.RunAggregationQueryRequest

RunAggregationQueryResponse

The response for Datastore.RunAggregationQuery.

Protobuf type google.datastore.v1.RunAggregationQueryResponse

RunAggregationQueryResponse.Builder

The response for Datastore.RunAggregationQuery.

Protobuf type google.datastore.v1.RunAggregationQueryResponse

RunQueryRequest

The request for Datastore.RunQuery.

Protobuf type google.datastore.v1.RunQueryRequest

RunQueryRequest.Builder

The request for Datastore.RunQuery.

Protobuf type google.datastore.v1.RunQueryRequest

RunQueryResponse

The response for Datastore.RunQuery.

Protobuf type google.datastore.v1.RunQueryResponse

RunQueryResponse.Builder

The response for Datastore.RunQuery.

Protobuf type google.datastore.v1.RunQueryResponse

TransactionOptions

Options for beginning a new transaction.

Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests.

Protobuf type google.datastore.v1.TransactionOptions

TransactionOptions.Builder

Options for beginning a new transaction.

Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests.

Protobuf type google.datastore.v1.TransactionOptions

TransactionOptions.ReadOnly

Options specific to read-only transactions.

Protobuf type google.datastore.v1.TransactionOptions.ReadOnly

TransactionOptions.ReadOnly.Builder

Options specific to read-only transactions.

Protobuf type google.datastore.v1.TransactionOptions.ReadOnly

TransactionOptions.ReadWrite

Options specific to read / write transactions.

Protobuf type google.datastore.v1.TransactionOptions.ReadWrite

TransactionOptions.ReadWrite.Builder

Options specific to read / write transactions.

Protobuf type google.datastore.v1.TransactionOptions.ReadWrite

Value

A message that can hold any of the supported value types and associated metadata.

Protobuf type google.datastore.v1.Value

Value.Builder

A message that can hold any of the supported value types and associated metadata.

Protobuf type google.datastore.v1.Value

Interfaces

AggregationQuery.Aggregation.AvgOrBuilder

AggregationQuery.Aggregation.CountOrBuilder

AggregationQuery.Aggregation.SumOrBuilder

AggregationQuery.AggregationOrBuilder

AggregationQueryOrBuilder

AggregationResultBatchOrBuilder

AggregationResultOrBuilder

AllocateIdsRequestOrBuilder

AllocateIdsResponseOrBuilder

ArrayValueOrBuilder

BeginTransactionRequestOrBuilder

BeginTransactionResponseOrBuilder

CommitRequestOrBuilder

CommitResponseOrBuilder

CompositeFilterOrBuilder

EntityOrBuilder

EntityResultOrBuilder

ExecutionStatsOrBuilder

ExplainMetricsOrBuilder

ExplainOptionsOrBuilder

FilterOrBuilder

GqlQueryOrBuilder

GqlQueryParameterOrBuilder

Key.PathElementOrBuilder

KeyOrBuilder

KindExpressionOrBuilder

LookupRequestOrBuilder

LookupResponseOrBuilder

MutationOrBuilder

MutationResultOrBuilder

PartitionIdOrBuilder

PlanSummaryOrBuilder

ProjectionOrBuilder

PropertyFilterOrBuilder

PropertyOrderOrBuilder

PropertyReferenceOrBuilder

QueryOrBuilder

QueryResultBatchOrBuilder

ReadOptionsOrBuilder

ReserveIdsRequestOrBuilder

ReserveIdsResponseOrBuilder

RollbackRequestOrBuilder

RollbackResponseOrBuilder

RunAggregationQueryRequestOrBuilder

RunAggregationQueryResponseOrBuilder

RunQueryRequestOrBuilder

RunQueryResponseOrBuilder

TransactionOptions.ReadOnlyOrBuilder

TransactionOptions.ReadWriteOrBuilder

TransactionOptionsOrBuilder

ValueOrBuilder

Enums

AggregationQuery.Aggregation.OperatorCase

AggregationQuery.QueryTypeCase

CommitRequest.Mode

The modes available for commits.

Protobuf enum google.datastore.v1.CommitRequest.Mode

CommitRequest.TransactionSelectorCase

CompositeFilter.Operator

A composite filter operator.

Protobuf enum google.datastore.v1.CompositeFilter.Operator

EntityResult.ResultType

Specifies what data the 'entity' field contains. A ResultType is either implied (for example, in LookupResponse.missing from datastore.proto, it is always KEY_ONLY) or specified by context (for example, in message QueryResultBatch, field entity_result_type specifies a ResultType for all the values in field entity_results).

Protobuf enum google.datastore.v1.EntityResult.ResultType