Namespace Google.Apis.Datastore.v1.Data
Classes
Aggregation
Defines an aggregation that produces a single result.
AggregationQuery
Datastore query for running an aggregation over a Query.
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.
AggregationResultBatch
A batch of aggregation results produced by an aggregation query.
AllocateIdsRequest
The request for Datastore.AllocateIds.
AllocateIdsResponse
The response for Datastore.AllocateIds.
ArrayValue
An array value.
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.
BeginTransactionRequest
The request for Datastore.BeginTransaction.
BeginTransactionResponse
The response for Datastore.BeginTransaction.
CommitRequest
The request for Datastore.Commit.
CommitResponse
The response for Datastore.Commit.
CompositeFilter
A filter that merges multiple other filters using the given operator.
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.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
Entity
A Datastore data object. Must not exceed 1 MiB - 4 bytes.
EntityResult
The result of fetching an entity from Datastore.
ExecutionStats
Execution statistics for the query.
ExplainMetrics
Explain metrics for the query.
ExplainOptions
Explain options for the query.
Filter
A holder for any type of filter.
FindNearest
Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries.
GoogleDatastoreAdminV1CommonMetadata
Metadata common to all Datastore Admin operations.
GoogleDatastoreAdminV1DatastoreFirestoreMigrationMetadata
Metadata for Datastore to Firestore migration operations. The DatastoreFirestoreMigration operation is not started by the end-user via an explicit "creation" method. This is an intentional deviation from the LRO design pattern. This singleton resource can be accessed at: "projects/{project_id}/operations/datastore-firestore-migration"
GoogleDatastoreAdminV1EntityFilter
Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz']
GoogleDatastoreAdminV1ExportEntitiesMetadata
Metadata for ExportEntities operations.
GoogleDatastoreAdminV1ExportEntitiesRequest
The request for google.datastore.admin.v1.DatastoreAdmin.ExportEntities.
GoogleDatastoreAdminV1ExportEntitiesResponse
The response for google.datastore.admin.v1.DatastoreAdmin.ExportEntities.
GoogleDatastoreAdminV1ImportEntitiesMetadata
Metadata for ImportEntities operations.
GoogleDatastoreAdminV1ImportEntitiesRequest
The request for google.datastore.admin.v1.DatastoreAdmin.ImportEntities.
GoogleDatastoreAdminV1Index
Datastore composite index definition.
GoogleDatastoreAdminV1IndexOperationMetadata
Metadata for Index operations.
GoogleDatastoreAdminV1IndexedProperty
A property of an index.
GoogleDatastoreAdminV1ListIndexesResponse
The response for google.datastore.admin.v1.DatastoreAdmin.ListIndexes.
GoogleDatastoreAdminV1MigrationProgressEvent
An event signifying the start of a new step in a migration from Cloud Datastore to Cloud Firestore in Datastore mode.
GoogleDatastoreAdminV1MigrationStateEvent
An event signifying a change in state of a migration from Cloud Datastore to Cloud Firestore in Datastore mode.
GoogleDatastoreAdminV1PrepareStepDetails
Details for the PREPARE
step.
GoogleDatastoreAdminV1Progress
Measures the progress of a particular metric.
GoogleDatastoreAdminV1RedirectWritesStepDetails
Details for the REDIRECT_WRITES
step.
GoogleDatastoreAdminV1beta1CommonMetadata
Metadata common to all Datastore Admin operations.
GoogleDatastoreAdminV1beta1EntityFilter
Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz']
GoogleDatastoreAdminV1beta1ExportEntitiesMetadata
Metadata for ExportEntities operations.
GoogleDatastoreAdminV1beta1ExportEntitiesResponse
The response for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.
GoogleDatastoreAdminV1beta1ImportEntitiesMetadata
Metadata for ImportEntities operations.
GoogleDatastoreAdminV1beta1Progress
Measures the progress of a particular metric.
GoogleLongrunningListOperationsResponse
The response message for Operations.ListOperations.
GoogleLongrunningOperation
This resource represents a long-running operation that is the result of a network API call.
GqlQuery
A GQL query.
GqlQueryParameter
A binding parameter for a GQL query.
Key
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.
KindExpression
A representation of a kind.
LatLng
An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.
LookupRequest
The request for Datastore.Lookup.
LookupResponse
The response for Datastore.Lookup.
Mutation
A mutation to apply to an entity.
MutationResult
The result of applying a mutation.
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.
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.
PlanSummary
Planning phase information for the query.
Projection
A representation of a property in a projection.
PropertyFilter
A filter on a specific property.
PropertyMask
The set of arbitrarily nested property paths used to restrict an operation to only a subset of properties in an entity.
PropertyOrder
The desired order for a specific property.
PropertyReference
A reference to a property relative to the kind expressions.
PropertyTransform
A transformation of an entity property.
Query
A query for entities. The query stages are executed in the following order: 1. kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6. limit 7. find_nearest
QueryResultBatch
A batch of results produced by a query.
ReadOnly
Options specific to read-only transactions.
ReadOptions
The options shared by read requests.
ReadWrite
Options specific to read / write transactions.
ReserveIdsRequest
The request for Datastore.ReserveIds.
ReserveIdsResponse
The response for Datastore.ReserveIds.
RollbackRequest
The request for Datastore.Rollback.
RollbackResponse
The response for Datastore.Rollback. (an empty message).
RunAggregationQueryRequest
The request for Datastore.RunAggregationQuery.
RunAggregationQueryResponse
The response for Datastore.RunAggregationQuery.
RunQueryRequest
The request for Datastore.RunQuery.
RunQueryResponse
The response for Datastore.RunQuery.
Status
The Status
type defines a logical error model that is suitable for different programming environments,
including REST APIs and RPC APIs. It is used by gRPC. Each Status
message contains
three pieces of data: error code, error message, and error details. You can find out more about this error model
and how to work with it in the API Design Guide.
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.
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.
Value
A message that can hold any of the supported value types and associated metadata.