Enum value maps for CommitRequest_Mode.
var (
CommitRequest_Mode_name = map[int32]string{
0: "MODE_UNSPECIFIED",
1: "TRANSACTIONAL",
2: "NON_TRANSACTIONAL",
}
CommitRequest_Mode_value = map[string]int32{
"MODE_UNSPECIFIED": 0,
"TRANSACTIONAL": 1,
"NON_TRANSACTIONAL": 2,
}
)
Enum value maps for ReadOptions_ReadConsistency.
var (
ReadOptions_ReadConsistency_name = map[int32]string{
0: "READ_CONSISTENCY_UNSPECIFIED",
1: "STRONG",
2: "EVENTUAL",
}
ReadOptions_ReadConsistency_value = map[string]int32{
"READ_CONSISTENCY_UNSPECIFIED": 0,
"STRONG": 1,
"EVENTUAL": 2,
}
)
Enum value maps for EntityResult_ResultType.
var (
EntityResult_ResultType_name = map[int32]string{
0: "RESULT_TYPE_UNSPECIFIED",
1: "FULL",
2: "PROJECTION",
3: "KEY_ONLY",
}
EntityResult_ResultType_value = map[string]int32{
"RESULT_TYPE_UNSPECIFIED": 0,
"FULL": 1,
"PROJECTION": 2,
"KEY_ONLY": 3,
}
)
Enum value maps for PropertyOrder_Direction.
var (
PropertyOrder_Direction_name = map[int32]string{
0: "DIRECTION_UNSPECIFIED",
1: "ASCENDING",
2: "DESCENDING",
}
PropertyOrder_Direction_value = map[string]int32{
"DIRECTION_UNSPECIFIED": 0,
"ASCENDING": 1,
"DESCENDING": 2,
}
)
Enum value maps for CompositeFilter_Operator.
var (
CompositeFilter_Operator_name = map[int32]string{
0: "OPERATOR_UNSPECIFIED",
1: "AND",
}
CompositeFilter_Operator_value = map[string]int32{
"OPERATOR_UNSPECIFIED": 0,
"AND": 1,
}
)
Enum value maps for PropertyFilter_Operator.
var (
PropertyFilter_Operator_name = map[int32]string{
0: "OPERATOR_UNSPECIFIED",
1: "LESS_THAN",
2: "LESS_THAN_OR_EQUAL",
3: "GREATER_THAN",
4: "GREATER_THAN_OR_EQUAL",
5: "EQUAL",
11: "HAS_ANCESTOR",
}
PropertyFilter_Operator_value = map[string]int32{
"OPERATOR_UNSPECIFIED": 0,
"LESS_THAN": 1,
"LESS_THAN_OR_EQUAL": 2,
"GREATER_THAN": 3,
"GREATER_THAN_OR_EQUAL": 4,
"EQUAL": 5,
"HAS_ANCESTOR": 11,
}
)
Enum value maps for QueryResultBatch_MoreResultsType.
var (
QueryResultBatch_MoreResultsType_name = map[int32]string{
0: "MORE_RESULTS_TYPE_UNSPECIFIED",
1: "NOT_FINISHED",
2: "MORE_RESULTS_AFTER_LIMIT",
4: "MORE_RESULTS_AFTER_CURSOR",
3: "NO_MORE_RESULTS",
}
QueryResultBatch_MoreResultsType_value = map[string]int32{
"MORE_RESULTS_TYPE_UNSPECIFIED": 0,
"NOT_FINISHED": 1,
"MORE_RESULTS_AFTER_LIMIT": 2,
"MORE_RESULTS_AFTER_CURSOR": 4,
"NO_MORE_RESULTS": 3,
}
)
var File_google_datastore_v1beta3_datastore_proto protoreflect.FileDescriptor
var File_google_datastore_v1beta3_entity_proto protoreflect.FileDescriptor
var File_google_datastore_v1beta3_query_proto protoreflect.FileDescriptor
func RegisterDatastoreServer(s *grpc.Server, srv DatastoreServer)
The request for [Datastore.AllocateIds][google.datastore.v1beta3.Datastore.AllocateIds].
type AllocateIdsRequest struct {
// The ID of the project against which to make the request.
ProjectId string `protobuf:"bytes,8,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// A list of keys with incomplete key paths for which to allocate IDs.
// No key may be reserved/read-only.
Keys []*Key `protobuf:"bytes,1,rep,name=keys,proto3" json:"keys,omitempty"`
// contains filtered or unexported fields
}
func (*AllocateIdsRequest) Descriptor() ([]byte, []int)
Deprecated: Use AllocateIdsRequest.ProtoReflect.Descriptor instead.
func (x *AllocateIdsRequest) GetKeys() []*Key
func (x *AllocateIdsRequest) GetProjectId() string
func (*AllocateIdsRequest) ProtoMessage()
func (x *AllocateIdsRequest) ProtoReflect() protoreflect.Message
func (x *AllocateIdsRequest) Reset()
func (x *AllocateIdsRequest) String() string
The response for [Datastore.AllocateIds][google.datastore.v1beta3.Datastore.AllocateIds].
type AllocateIdsResponse struct {
// The keys specified in the request (in the same order), each with
// its key path completed with a newly allocated ID.
Keys []*Key `protobuf:"bytes,1,rep,name=keys,proto3" json:"keys,omitempty"`
// contains filtered or unexported fields
}
func (*AllocateIdsResponse) Descriptor() ([]byte, []int)
Deprecated: Use AllocateIdsResponse.ProtoReflect.Descriptor instead.
func (x *AllocateIdsResponse) GetKeys() []*Key
func (*AllocateIdsResponse) ProtoMessage()
func (x *AllocateIdsResponse) ProtoReflect() protoreflect.Message
func (x *AllocateIdsResponse) Reset()
func (x *AllocateIdsResponse) String() string
An array value.
type ArrayValue struct {
// Values in the array.
// The order of this array may not be preserved if it contains a mix of
// indexed and unindexed values.
Values []*Value `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}
func (*ArrayValue) Descriptor() ([]byte, []int)
Deprecated: Use ArrayValue.ProtoReflect.Descriptor instead.
func (x *ArrayValue) GetValues() []*Value
func (*ArrayValue) ProtoMessage()
func (x *ArrayValue) ProtoReflect() protoreflect.Message
func (x *ArrayValue) Reset()
func (x *ArrayValue) String() string
The request for [Datastore.BeginTransaction][google.datastore.v1beta3.Datastore.BeginTransaction].
type BeginTransactionRequest struct {
// The ID of the project against which to make the request.
ProjectId string `protobuf:"bytes,8,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// Options for a new transaction.
TransactionOptions *TransactionOptions `protobuf:"bytes,10,opt,name=transaction_options,json=transactionOptions,proto3" json:"transaction_options,omitempty"`
// contains filtered or unexported fields
}
func (*BeginTransactionRequest) Descriptor() ([]byte, []int)
Deprecated: Use BeginTransactionRequest.ProtoReflect.Descriptor instead.
func (x *BeginTransactionRequest) GetProjectId() string
func (x *BeginTransactionRequest) GetTransactionOptions() *TransactionOptions
func (*BeginTransactionRequest) ProtoMessage()
func (x *BeginTransactionRequest) ProtoReflect() protoreflect.Message
func (x *BeginTransactionRequest) Reset()
func (x *BeginTransactionRequest) String() string
The response for [Datastore.BeginTransaction][google.datastore.v1beta3.Datastore.BeginTransaction].
type BeginTransactionResponse struct {
// The transaction identifier (always present).
Transaction []byte `protobuf:"bytes,1,opt,name=transaction,proto3" json:"transaction,omitempty"`
// contains filtered or unexported fields
}
func (*BeginTransactionResponse) Descriptor() ([]byte, []int)
Deprecated: Use BeginTransactionResponse.ProtoReflect.Descriptor instead.
func (x *BeginTransactionResponse) GetTransaction() []byte
func (*BeginTransactionResponse) ProtoMessage()
func (x *BeginTransactionResponse) ProtoReflect() protoreflect.Message
func (x *BeginTransactionResponse) Reset()
func (x *BeginTransactionResponse) String() string
The request for [Datastore.Commit][google.datastore.v1beta3.Datastore.Commit].
type CommitRequest struct {
// The ID of the project against which to make the request.
ProjectId string `protobuf:"bytes,8,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// The type of commit to perform. Defaults to `TRANSACTIONAL`.
Mode CommitRequest_Mode `protobuf:"varint,5,opt,name=mode,proto3,enum=google.datastore.v1beta3.CommitRequest_Mode" json:"mode,omitempty"`
// Must be set when mode is `TRANSACTIONAL`.
//
// Types that are assignable to TransactionSelector:
// *CommitRequest_Transaction
TransactionSelector isCommitRequest_TransactionSelector `protobuf_oneof:"transaction_selector"`
// The mutations to perform.
//
// When mode is `TRANSACTIONAL`, mutations affecting a single entity are
// applied in order. The following sequences of mutations affecting a single
// entity are not permitted in a single `Commit` request:
//
// - `insert` followed by `insert`
// - `update` followed by `insert`
// - `upsert` followed by `insert`
// - `delete` followed by `update`
//
// When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single
// entity.
Mutations []*Mutation `protobuf:"bytes,6,rep,name=mutations,proto3" json:"mutations,omitempty"`
// contains filtered or unexported fields
}
func (*CommitRequest) Descriptor() ([]byte, []int)
Deprecated: Use CommitRequest.ProtoReflect.Descriptor instead.
func (x *CommitRequest) GetMode() CommitRequest_Mode
func (x *CommitRequest) GetMutations() []*Mutation
func (x *CommitRequest) GetProjectId() string
func (x *CommitRequest) GetTransaction() []byte
func (m *CommitRequest) GetTransactionSelector() isCommitRequest_TransactionSelector
func (*CommitRequest) ProtoMessage()
func (x *CommitRequest) ProtoReflect() protoreflect.Message
func (x *CommitRequest) Reset()
func (x *CommitRequest) String() string
The modes available for commits.
type CommitRequest_Mode int32
const (
// Unspecified. This value must not be used.
CommitRequest_MODE_UNSPECIFIED CommitRequest_Mode = 0
// Transactional: The mutations are either all applied, or none are applied.
// Learn about transactions
// [here](https://cloud.google.com/datastore/docs/concepts/transactions).
CommitRequest_TRANSACTIONAL CommitRequest_Mode = 1
// Non-transactional: The mutations may not apply as all or none.
CommitRequest_NON_TRANSACTIONAL CommitRequest_Mode = 2
)
func (CommitRequest_Mode) Descriptor() protoreflect.EnumDescriptor
func (x CommitRequest_Mode) Enum() *CommitRequest_Mode
func (CommitRequest_Mode) EnumDescriptor() ([]byte, []int)
Deprecated: Use CommitRequest_Mode.Descriptor instead.
func (x CommitRequest_Mode) Number() protoreflect.EnumNumber
func (x CommitRequest_Mode) String() string
func (CommitRequest_Mode) Type() protoreflect.EnumType
type CommitRequest_Transaction struct {
// The identifier of the transaction associated with the commit. A
// transaction identifier is returned by a call to
// [Datastore.BeginTransaction][google.datastore.v1beta3.Datastore.BeginTransaction].
Transaction []byte `protobuf:"bytes,1,opt,name=transaction,proto3,oneof"`
}
The response for [Datastore.Commit][google.datastore.v1beta3.Datastore.Commit].
type CommitResponse struct {
// The result of performing the mutations.
// The i-th mutation result corresponds to the i-th mutation in the request.
MutationResults []*MutationResult `protobuf:"bytes,3,rep,name=mutation_results,json=mutationResults,proto3" json:"mutation_results,omitempty"`
// The number of index entries updated during the commit, or zero if none were
// updated.
IndexUpdates int32 `protobuf:"varint,4,opt,name=index_updates,json=indexUpdates,proto3" json:"index_updates,omitempty"`
// contains filtered or unexported fields
}
func (*CommitResponse) Descriptor() ([]byte, []int)
Deprecated: Use CommitResponse.ProtoReflect.Descriptor instead.
func (x *CommitResponse) GetIndexUpdates() int32
func (x *CommitResponse) GetMutationResults() []*MutationResult
func (*CommitResponse) ProtoMessage()
func (x *CommitResponse) ProtoReflect() protoreflect.Message
func (x *CommitResponse) Reset()
func (x *CommitResponse) String() string
A filter that merges multiple other filters using the given operator.
type CompositeFilter struct {
// The operator for combining multiple filters.
Op CompositeFilter_Operator `protobuf:"varint,1,opt,name=op,proto3,enum=google.datastore.v1beta3.CompositeFilter_Operator" json:"op,omitempty"`
// The list of filters to combine.
// Must contain at least one filter.
Filters []*Filter `protobuf:"bytes,2,rep,name=filters,proto3" json:"filters,omitempty"`
// contains filtered or unexported fields
}
func (*CompositeFilter) Descriptor() ([]byte, []int)
Deprecated: Use CompositeFilter.ProtoReflect.Descriptor instead.
func (x *CompositeFilter) GetFilters() []*Filter
func (x *CompositeFilter) GetOp() CompositeFilter_Operator
func (*CompositeFilter) ProtoMessage()
func (x *CompositeFilter) ProtoReflect() protoreflect.Message
func (x *CompositeFilter) Reset()
func (x *CompositeFilter) String() string
A composite filter operator.
type CompositeFilter_Operator int32
const (
// Unspecified. This value must not be used.
CompositeFilter_OPERATOR_UNSPECIFIED CompositeFilter_Operator = 0
// The results are required to satisfy each of the combined filters.
CompositeFilter_AND CompositeFilter_Operator = 1
)
func (CompositeFilter_Operator) Descriptor() protoreflect.EnumDescriptor
func (x CompositeFilter_Operator) Enum() *CompositeFilter_Operator
func (CompositeFilter_Operator) EnumDescriptor() ([]byte, []int)
Deprecated: Use CompositeFilter_Operator.Descriptor instead.
func (x CompositeFilter_Operator) Number() protoreflect.EnumNumber
func (x CompositeFilter_Operator) String() string
func (CompositeFilter_Operator) Type() protoreflect.EnumType
DatastoreClient is the client API for Datastore service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type DatastoreClient interface {
// Looks up entities by key.
Lookup(ctx context.Context, in *LookupRequest, opts ...grpc.CallOption) (*LookupResponse, error)
// Queries for entities.
RunQuery(ctx context.Context, in *RunQueryRequest, opts ...grpc.CallOption) (*RunQueryResponse, error)
// Begins a new transaction.
BeginTransaction(ctx context.Context, in *BeginTransactionRequest, opts ...grpc.CallOption) (*BeginTransactionResponse, error)
// Commits a transaction, optionally creating, deleting or modifying some
// entities.
Commit(ctx context.Context, in *CommitRequest, opts ...grpc.CallOption) (*CommitResponse, error)
// Rolls back a transaction.
Rollback(ctx context.Context, in *RollbackRequest, opts ...grpc.CallOption) (*RollbackResponse, error)
// Allocates IDs for the given keys, which is useful for referencing an entity
// before it is inserted.
AllocateIds(ctx context.Context, in *AllocateIdsRequest, opts ...grpc.CallOption) (*AllocateIdsResponse, error)
// Prevents the supplied keys' IDs from being auto-allocated by Cloud
// Datastore.
ReserveIds(ctx context.Context, in *ReserveIdsRequest, opts ...grpc.CallOption) (*ReserveIdsResponse, error)
}
func NewDatastoreClient(cc grpc.ClientConnInterface) DatastoreClient
DatastoreServer is the server API for Datastore service.
type DatastoreServer interface {
// Looks up entities by key.
Lookup(context.Context, *LookupRequest) (*LookupResponse, error)
// Queries for entities.
RunQuery(context.Context, *RunQueryRequest) (*RunQueryResponse, error)
// Begins a new transaction.
BeginTransaction(context.Context, *BeginTransactionRequest) (*BeginTransactionResponse, error)
// Commits a transaction, optionally creating, deleting or modifying some
// entities.
Commit(context.Context, *CommitRequest) (*CommitResponse, error)
// Rolls back a transaction.
Rollback(context.Context, *RollbackRequest) (*RollbackResponse, error)
// Allocates IDs for the given keys, which is useful for referencing an entity
// before it is inserted.
AllocateIds(context.Context, *AllocateIdsRequest) (*AllocateIdsResponse, error)
// Prevents the supplied keys' IDs from being auto-allocated by Cloud
// Datastore.
ReserveIds(context.Context, *ReserveIdsRequest) (*ReserveIdsResponse, error)
}
A Datastore data object.
An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message.
type Entity struct {
// The entity's key.
//
// An entity must have a key, unless otherwise documented (for example,
// an entity in `Value.entity_value` may have no key).
// An entity's kind is its key path's last element's kind,
// or null if it has no key.
Key *Key `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
// The entity's properties.
// The map's keys are property names.
// A property name matching regex `__.*__` is reserved.
// A reserved property name is forbidden in certain documented contexts.
// The name must not contain more than 500 characters.
// The name cannot be `""`.
Properties map[string]*Value `protobuf:"bytes,3,rep,name=properties,proto3" json:"properties,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*Entity) Descriptor() ([]byte, []int)
Deprecated: Use Entity.ProtoReflect.Descriptor instead.
func (x *Entity) GetKey() *Key
func (x *Entity) GetProperties() map[string]*Value
func (*Entity) ProtoMessage()
func (x *Entity) ProtoReflect() protoreflect.Message
func (x *Entity) Reset()
func (x *Entity) String() string
The result of fetching an entity from Datastore.
type EntityResult struct {
// The resulting entity.
Entity *Entity `protobuf:"bytes,1,opt,name=entity,proto3" json:"entity,omitempty"`
// The version of the entity, a strictly positive number that monotonically
// increases with changes to the entity.
//
// This field is set for
// [`FULL`][google.datastore.v1beta3.EntityResult.ResultType.FULL] entity
// results.
//
// For [missing][google.datastore.v1beta3.LookupResponse.missing] entities in
// `LookupResponse`, this is the version of the snapshot that was used to look
// up the entity, and it is always set except for eventually consistent reads.
Version int64 `protobuf:"varint,4,opt,name=version,proto3" json:"version,omitempty"`
// A cursor that points to the position after the result entity.
// Set only when the `EntityResult` is part of a `QueryResultBatch` message.
Cursor []byte `protobuf:"bytes,3,opt,name=cursor,proto3" json:"cursor,omitempty"`
// contains filtered or unexported fields
}
func (*EntityResult) Descriptor() ([]byte, []int)
Deprecated: Use EntityResult.ProtoReflect.Descriptor instead.
func (x *EntityResult) GetCursor() []byte
func (x *EntityResult) GetEntity() *Entity
func (x *EntityResult) GetVersion() int64
func (*EntityResult) ProtoMessage()
func (x *EntityResult) ProtoReflect() protoreflect.Message
func (x *EntityResult) Reset()
func (x *EntityResult) String() string
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`).
type EntityResult_ResultType int32
const (
// Unspecified. This value is never used.
EntityResult_RESULT_TYPE_UNSPECIFIED EntityResult_ResultType = 0
// The key and properties.
EntityResult_FULL EntityResult_ResultType = 1
// A projected subset of properties. The entity may have no key.
EntityResult_PROJECTION EntityResult_ResultType = 2
// Only the key.
EntityResult_KEY_ONLY EntityResult_ResultType = 3
)
func (EntityResult_ResultType) Descriptor() protoreflect.EnumDescriptor
func (x EntityResult_ResultType) Enum() *EntityResult_ResultType
func (EntityResult_ResultType) EnumDescriptor() ([]byte, []int)
Deprecated: Use EntityResult_ResultType.Descriptor instead.
func (x EntityResult_ResultType) Number() protoreflect.EnumNumber
func (x EntityResult_ResultType) String() string
func (EntityResult_ResultType) Type() protoreflect.EnumType
A holder for any type of filter.
type Filter struct {
// The type of filter.
//
// Types that are assignable to FilterType:
// *Filter_CompositeFilter
// *Filter_PropertyFilter
FilterType isFilter_FilterType `protobuf_oneof:"filter_type"`
// contains filtered or unexported fields
}
func (*Filter) Descriptor() ([]byte, []int)
Deprecated: Use Filter.ProtoReflect.Descriptor instead.
func (x *Filter) GetCompositeFilter() *CompositeFilter
func (m *Filter) GetFilterType() isFilter_FilterType
func (x *Filter) GetPropertyFilter() *PropertyFilter
func (*Filter) ProtoMessage()
func (x *Filter) ProtoReflect() protoreflect.Message
func (x *Filter) Reset()
func (x *Filter) String() string
type Filter_CompositeFilter struct {
// A composite filter.
CompositeFilter *CompositeFilter `protobuf:"bytes,1,opt,name=composite_filter,json=compositeFilter,proto3,oneof"`
}
type Filter_PropertyFilter struct {
// A filter on a property.
PropertyFilter *PropertyFilter `protobuf:"bytes,2,opt,name=property_filter,json=propertyFilter,proto3,oneof"`
}
A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
type GqlQuery struct {
// A string of the format described
// [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
QueryString string `protobuf:"bytes,1,opt,name=query_string,json=queryString,proto3" json:"query_string,omitempty"`
// When false, the query string must not contain any literals and instead must
// bind all values. For example,
// `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while
// `SELECT * FROM Kind WHERE a = @value` is.
AllowLiterals bool `protobuf:"varint,2,opt,name=allow_literals,json=allowLiterals,proto3" json:"allow_literals,omitempty"`
// For each non-reserved named binding site in the query string, there must be
// a named parameter with that name, but not necessarily the inverse.
//
// Key must match regex `[A-Za-z_$][A-Za-z_$0-9]*`, must not match regex
// `__.*__`, and must not be `""`.
NamedBindings map[string]*GqlQueryParameter `protobuf:"bytes,5,rep,name=named_bindings,json=namedBindings,proto3" json:"named_bindings,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Numbered binding site @1 references the first numbered parameter,
// effectively using 1-based indexing, rather than the usual 0.
//
// For each binding site numbered i in `query_string`, there must be an i-th
// numbered parameter. The inverse must also be true.
PositionalBindings []*GqlQueryParameter `protobuf:"bytes,4,rep,name=positional_bindings,json=positionalBindings,proto3" json:"positional_bindings,omitempty"`
// contains filtered or unexported fields
}
func (*GqlQuery) Descriptor() ([]byte, []int)
Deprecated: Use GqlQuery.ProtoReflect.Descriptor instead.
func (x *GqlQuery) GetAllowLiterals() bool
func (x *GqlQuery) GetNamedBindings() map[string]*GqlQueryParameter
func (x *GqlQuery) GetPositionalBindings() []*GqlQueryParameter
func (x *GqlQuery) GetQueryString() string
func (*GqlQuery) ProtoMessage()
func (x *GqlQuery) ProtoReflect() protoreflect.Message
func (x *GqlQuery) Reset()
func (x *GqlQuery) String() string
A binding parameter for a GQL query.
type GqlQueryParameter struct {
// The type of parameter.
//
// Types that are assignable to ParameterType:
// *GqlQueryParameter_Value
// *GqlQueryParameter_Cursor
ParameterType isGqlQueryParameter_ParameterType `protobuf_oneof:"parameter_type"`
// contains filtered or unexported fields
}
func (*GqlQueryParameter) Descriptor() ([]byte, []int)
Deprecated: Use GqlQueryParameter.ProtoReflect.Descriptor instead.
func (x *GqlQueryParameter) GetCursor() []byte
func (m *GqlQueryParameter) GetParameterType() isGqlQueryParameter_ParameterType
func (x *GqlQueryParameter) GetValue() *Value
func (*GqlQueryParameter) ProtoMessage()
func (x *GqlQueryParameter) ProtoReflect() protoreflect.Message
func (x *GqlQueryParameter) Reset()
func (x *GqlQueryParameter) String() string
type GqlQueryParameter_Cursor struct {
// A query cursor. Query cursors are returned in query
// result batches.
Cursor []byte `protobuf:"bytes,3,opt,name=cursor,proto3,oneof"`
}
type GqlQueryParameter_Value struct {
// A value parameter.
Value *Value `protobuf:"bytes,2,opt,name=value,proto3,oneof"`
}
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.
type Key struct {
// Entities are partitioned into subsets, currently identified by a project
// ID and namespace ID.
// Queries are scoped to a single partition.
PartitionId *PartitionId `protobuf:"bytes,1,opt,name=partition_id,json=partitionId,proto3" json:"partition_id,omitempty"`
// The entity path.
// An entity path consists of one or more elements composed of a kind and a
// string or numerical identifier, which identify entities. The first
// element identifies a _root entity_, the second element identifies
// a _child_ of the root entity, the third element identifies a child of the
// second entity, and so forth. The entities identified by all prefixes of
// the path are called the element's _ancestors_.
//
// An entity path is always fully complete: *all* of the entity's ancestors
// are required to be in the path along with the entity identifier itself.
// The only exception is that in some documented cases, the identifier in the
// last path element (for the entity) itself may be omitted. For example,
// the last path element of the key of `Mutation.insert` may have no
// identifier.
//
// A path can never be empty, and a path can have at most 100 elements.
Path []*Key_PathElement `protobuf:"bytes,2,rep,name=path,proto3" json:"path,omitempty"`
// contains filtered or unexported fields
}
func (*Key) Descriptor() ([]byte, []int)
Deprecated: Use Key.ProtoReflect.Descriptor instead.
func (x *Key) GetPartitionId() *PartitionId
func (x *Key) GetPath() []*Key_PathElement
func (*Key) ProtoMessage()
func (x *Key) ProtoReflect() protoreflect.Message
func (x *Key) Reset()
func (x *Key) String() string
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.
type Key_PathElement struct {
// The kind of the entity.
// A kind matching regex `__.*__` is reserved/read-only.
// A kind must not contain more than 1500 bytes when UTF-8 encoded.
// Cannot be `""`.
Kind string `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"`
// The type of ID.
//
// Types that are assignable to IdType:
// *Key_PathElement_Id
// *Key_PathElement_Name
IdType isKey_PathElement_IdType `protobuf_oneof:"id_type"`
// contains filtered or unexported fields
}
func (*Key_PathElement) Descriptor() ([]byte, []int)
Deprecated: Use Key_PathElement.ProtoReflect.Descriptor instead.
func (x *Key_PathElement) GetId() int64
func (m *Key_PathElement) GetIdType() isKey_PathElement_IdType
func (x *Key_PathElement) GetKind() string
func (x *Key_PathElement) GetName() string
func (*Key_PathElement) ProtoMessage()
func (x *Key_PathElement) ProtoReflect() protoreflect.Message
func (x *Key_PathElement) Reset()
func (x *Key_PathElement) String() string
type Key_PathElement_Id struct {
// The auto-allocated ID of the entity.
// Never equal to zero. Values less than zero are discouraged and may not
// be supported in the future.
Id int64 `protobuf:"varint,2,opt,name=id,proto3,oneof"`
}
type Key_PathElement_Name struct {
// The name of the entity.
// A name matching regex `__.*__` is reserved/read-only.
// A name must not be more than 1500 bytes when UTF-8 encoded.
// Cannot be `""`.
Name string `protobuf:"bytes,3,opt,name=name,proto3,oneof"`
}
A representation of a kind.
type KindExpression struct {
// The name of the kind.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*KindExpression) Descriptor() ([]byte, []int)
Deprecated: Use KindExpression.ProtoReflect.Descriptor instead.
func (x *KindExpression) GetName() string
func (*KindExpression) ProtoMessage()
func (x *KindExpression) ProtoReflect() protoreflect.Message
func (x *KindExpression) Reset()
func (x *KindExpression) String() string
The request for [Datastore.Lookup][google.datastore.v1beta3.Datastore.Lookup].
type LookupRequest struct {
// The ID of the project against which to make the request.
ProjectId string `protobuf:"bytes,8,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// The options for this lookup request.
ReadOptions *ReadOptions `protobuf:"bytes,1,opt,name=read_options,json=readOptions,proto3" json:"read_options,omitempty"`
// Keys of entities to look up.
Keys []*Key `protobuf:"bytes,3,rep,name=keys,proto3" json:"keys,omitempty"`
// contains filtered or unexported fields
}
func (*LookupRequest) Descriptor() ([]byte, []int)
Deprecated: Use LookupRequest.ProtoReflect.Descriptor instead.
func (x *LookupRequest) GetKeys() []*Key
func (x *LookupRequest) GetProjectId() string
func (x *LookupRequest) GetReadOptions() *ReadOptions
func (*LookupRequest) ProtoMessage()
func (x *LookupRequest) ProtoReflect() protoreflect.Message
func (x *LookupRequest) Reset()
func (x *LookupRequest) String() string
The response for [Datastore.Lookup][google.datastore.v1beta3.Datastore.Lookup].
type LookupResponse struct {
// Entities found as `ResultType.FULL` entities. The order of results in this
// field is undefined and has no relation to the order of the keys in the
// input.
Found []*EntityResult `protobuf:"bytes,1,rep,name=found,proto3" json:"found,omitempty"`
// Entities not found as `ResultType.KEY_ONLY` entities. The order of results
// in this field is undefined and has no relation to the order of the keys
// in the input.
Missing []*EntityResult `protobuf:"bytes,2,rep,name=missing,proto3" json:"missing,omitempty"`
// A list of keys that were not looked up due to resource constraints. The
// order of results in this field is undefined and has no relation to the
// order of the keys in the input.
Deferred []*Key `protobuf:"bytes,3,rep,name=deferred,proto3" json:"deferred,omitempty"`
// contains filtered or unexported fields
}
func (*LookupResponse) Descriptor() ([]byte, []int)
Deprecated: Use LookupResponse.ProtoReflect.Descriptor instead.
func (x *LookupResponse) GetDeferred() []*Key
func (x *LookupResponse) GetFound() []*EntityResult
func (x *LookupResponse) GetMissing() []*EntityResult
func (*LookupResponse) ProtoMessage()
func (x *LookupResponse) ProtoReflect() protoreflect.Message
func (x *LookupResponse) Reset()
func (x *LookupResponse) String() string
A mutation to apply to an entity.
type Mutation struct {
// The mutation operation.
//
// For `insert`, `update`, and `upsert`:
// - The entity's key must not be reserved/read-only.
// - No property in the entity may have a reserved name,
// not even a property in an entity in a value.
// - No value in the entity may have meaning 18,
// not even a value in an entity in another value.
//
// Types that are assignable to Operation:
// *Mutation_Insert
// *Mutation_Update
// *Mutation_Upsert
// *Mutation_Delete
Operation isMutation_Operation `protobuf_oneof:"operation"`
// When set, the server will detect whether or not this mutation conflicts
// with the current version of the entity on the server. Conflicting mutations
// are not applied, and are marked as such in MutationResult.
//
// Types that are assignable to ConflictDetectionStrategy:
// *Mutation_BaseVersion
ConflictDetectionStrategy isMutation_ConflictDetectionStrategy `protobuf_oneof:"conflict_detection_strategy"`
// contains filtered or unexported fields
}
func (*Mutation) Descriptor() ([]byte, []int)
Deprecated: Use Mutation.ProtoReflect.Descriptor instead.
func (x *Mutation) GetBaseVersion() int64
func (m *Mutation) GetConflictDetectionStrategy() isMutation_ConflictDetectionStrategy
func (x *Mutation) GetDelete() *Key
func (x *Mutation) GetInsert() *Entity
func (m *Mutation) GetOperation() isMutation_Operation
func (x *Mutation) GetUpdate() *Entity
func (x *Mutation) GetUpsert() *Entity
func (*Mutation) ProtoMessage()
func (x *Mutation) ProtoReflect() protoreflect.Message
func (x *Mutation) Reset()
func (x *Mutation) String() string
The result of applying a mutation.
type MutationResult struct {
// The automatically allocated key.
// Set only when the mutation allocated a key.
Key *Key `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"`
// The version of the entity on the server after processing the mutation. If
// the mutation doesn't change anything on the server, then the version will
// be the version of the current entity or, if no entity is present, a version
// that is strictly greater than the version of any previous entity and less
// than the version of any possible future entity.
Version int64 `protobuf:"varint,4,opt,name=version,proto3" json:"version,omitempty"`
// Whether a conflict was detected for this mutation. Always false when a
// conflict detection strategy field is not set in the mutation.
ConflictDetected bool `protobuf:"varint,5,opt,name=conflict_detected,json=conflictDetected,proto3" json:"conflict_detected,omitempty"`
// contains filtered or unexported fields
}
func (*MutationResult) Descriptor() ([]byte, []int)
Deprecated: Use MutationResult.ProtoReflect.Descriptor instead.
func (x *MutationResult) GetConflictDetected() bool
func (x *MutationResult) GetKey() *Key
func (x *MutationResult) GetVersion() int64
func (*MutationResult) ProtoMessage()
func (x *MutationResult) ProtoReflect() protoreflect.Message
func (x *MutationResult) Reset()
func (x *MutationResult) String() string
type Mutation_BaseVersion struct {
// The version of the entity that this mutation is being applied to. If this
// does not match the current version on the server, the mutation conflicts.
BaseVersion int64 `protobuf:"varint,8,opt,name=base_version,json=baseVersion,proto3,oneof"`
}
type Mutation_Delete struct {
// The key of the entity to delete. The entity may or may not already exist.
// Must have a complete key path and must not be reserved/read-only.
Delete *Key `protobuf:"bytes,7,opt,name=delete,proto3,oneof"`
}
type Mutation_Insert struct {
// The entity to insert. The entity must not already exist.
// The entity key's final path element may be incomplete.
Insert *Entity `protobuf:"bytes,4,opt,name=insert,proto3,oneof"`
}
type Mutation_Update struct {
// The entity to update. The entity must already exist.
// Must have a complete key path.
Update *Entity `protobuf:"bytes,5,opt,name=update,proto3,oneof"`
}
type Mutation_Upsert struct {
// The entity to upsert. The entity may or may not already exist.
// The entity key's final path element may be incomplete.
Upsert *Entity `protobuf:"bytes,6,opt,name=upsert,proto3,oneof"`
}
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.
type PartitionId struct {
// The ID of the project to which the entities belong.
ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// If not empty, the ID of the namespace to which the entities belong.
NamespaceId string `protobuf:"bytes,4,opt,name=namespace_id,json=namespaceId,proto3" json:"namespace_id,omitempty"`
// contains filtered or unexported fields
}
func (*PartitionId) Descriptor() ([]byte, []int)
Deprecated: Use PartitionId.ProtoReflect.Descriptor instead.
func (x *PartitionId) GetNamespaceId() string
func (x *PartitionId) GetProjectId() string
func (*PartitionId) ProtoMessage()
func (x *PartitionId) ProtoReflect() protoreflect.Message
func (x *PartitionId) Reset()
func (x *PartitionId) String() string
A representation of a property in a projection.
type Projection struct {
// The property to project.
Property *PropertyReference `protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
// contains filtered or unexported fields
}
func (*Projection) Descriptor() ([]byte, []int)
Deprecated: Use Projection.ProtoReflect.Descriptor instead.
func (x *Projection) GetProperty() *PropertyReference
func (*Projection) ProtoMessage()
func (x *Projection) ProtoReflect() protoreflect.Message
func (x *Projection) Reset()
func (x *Projection) String() string
A filter on a specific property.
type PropertyFilter struct {
// The property to filter by.
Property *PropertyReference `protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
// The operator to filter by.
Op PropertyFilter_Operator `protobuf:"varint,2,opt,name=op,proto3,enum=google.datastore.v1beta3.PropertyFilter_Operator" json:"op,omitempty"`
// The value to compare the property to.
Value *Value `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func (*PropertyFilter) Descriptor() ([]byte, []int)
Deprecated: Use PropertyFilter.ProtoReflect.Descriptor instead.
func (x *PropertyFilter) GetOp() PropertyFilter_Operator
func (x *PropertyFilter) GetProperty() *PropertyReference
func (x *PropertyFilter) GetValue() *Value
func (*PropertyFilter) ProtoMessage()
func (x *PropertyFilter) ProtoReflect() protoreflect.Message
func (x *PropertyFilter) Reset()
func (x *PropertyFilter) String() string
A property filter operator.
type PropertyFilter_Operator int32
const (
// Unspecified. This value must not be used.
PropertyFilter_OPERATOR_UNSPECIFIED PropertyFilter_Operator = 0
// Less than.
PropertyFilter_LESS_THAN PropertyFilter_Operator = 1
// Less than or equal.
PropertyFilter_LESS_THAN_OR_EQUAL PropertyFilter_Operator = 2
// Greater than.
PropertyFilter_GREATER_THAN PropertyFilter_Operator = 3
// Greater than or equal.
PropertyFilter_GREATER_THAN_OR_EQUAL PropertyFilter_Operator = 4
// Equal.
PropertyFilter_EQUAL PropertyFilter_Operator = 5
// Has ancestor.
PropertyFilter_HAS_ANCESTOR PropertyFilter_Operator = 11
)
func (PropertyFilter_Operator) Descriptor() protoreflect.EnumDescriptor
func (x PropertyFilter_Operator) Enum() *PropertyFilter_Operator
func (PropertyFilter_Operator) EnumDescriptor() ([]byte, []int)
Deprecated: Use PropertyFilter_Operator.Descriptor instead.
func (x PropertyFilter_Operator) Number() protoreflect.EnumNumber
func (x PropertyFilter_Operator) String() string
func (PropertyFilter_Operator) Type() protoreflect.EnumType
The desired order for a specific property.
type PropertyOrder struct {
// The property to order by.
Property *PropertyReference `protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
// The direction to order by. Defaults to `ASCENDING`.
Direction PropertyOrder_Direction `protobuf:"varint,2,opt,name=direction,proto3,enum=google.datastore.v1beta3.PropertyOrder_Direction" json:"direction,omitempty"`
// contains filtered or unexported fields
}
func (*PropertyOrder) Descriptor() ([]byte, []int)
Deprecated: Use PropertyOrder.ProtoReflect.Descriptor instead.
func (x *PropertyOrder) GetDirection() PropertyOrder_Direction
func (x *PropertyOrder) GetProperty() *PropertyReference
func (*PropertyOrder) ProtoMessage()
func (x *PropertyOrder) ProtoReflect() protoreflect.Message
func (x *PropertyOrder) Reset()
func (x *PropertyOrder) String() string
The sort direction.
type PropertyOrder_Direction int32
const (
// Unspecified. This value must not be used.
PropertyOrder_DIRECTION_UNSPECIFIED PropertyOrder_Direction = 0
// Ascending.
PropertyOrder_ASCENDING PropertyOrder_Direction = 1
// Descending.
PropertyOrder_DESCENDING PropertyOrder_Direction = 2
)
func (PropertyOrder_Direction) Descriptor() protoreflect.EnumDescriptor
func (x PropertyOrder_Direction) Enum() *PropertyOrder_Direction
func (PropertyOrder_Direction) EnumDescriptor() ([]byte, []int)
Deprecated: Use PropertyOrder_Direction.Descriptor instead.
func (x PropertyOrder_Direction) Number() protoreflect.EnumNumber
func (x PropertyOrder_Direction) String() string
func (PropertyOrder_Direction) Type() protoreflect.EnumType
A reference to a property relative to the kind expressions.
type PropertyReference struct {
// The name of the property.
// If name includes "."s, it may be interpreted as a property name path.
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*PropertyReference) Descriptor() ([]byte, []int)
Deprecated: Use PropertyReference.ProtoReflect.Descriptor instead.
func (x *PropertyReference) GetName() string
func (*PropertyReference) ProtoMessage()
func (x *PropertyReference) ProtoReflect() protoreflect.Message
func (x *PropertyReference) Reset()
func (x *PropertyReference) String() string
A query for entities.
type Query struct {
// The projection to return. Defaults to returning all properties.
Projection []*Projection `protobuf:"bytes,2,rep,name=projection,proto3" json:"projection,omitempty"`
// The kinds to query (if empty, returns entities of all kinds).
// Currently at most 1 kind may be specified.
Kind []*KindExpression `protobuf:"bytes,3,rep,name=kind,proto3" json:"kind,omitempty"`
// The filter to apply.
Filter *Filter `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// The order to apply to the query results (if empty, order is unspecified).
Order []*PropertyOrder `protobuf:"bytes,5,rep,name=order,proto3" json:"order,omitempty"`
// The properties to make distinct. The query results will contain the first
// result for each distinct combination of values for the given properties
// (if empty, all results are returned).
DistinctOn []*PropertyReference `protobuf:"bytes,6,rep,name=distinct_on,json=distinctOn,proto3" json:"distinct_on,omitempty"`
// A starting point for the query results. Query cursors are
// returned in query result batches and
// [can only be used to continue the same
// query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
StartCursor []byte `protobuf:"bytes,7,opt,name=start_cursor,json=startCursor,proto3" json:"start_cursor,omitempty"`
// An ending point for the query results. Query cursors are
// returned in query result batches and
// [can only be used to limit the same
// query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
EndCursor []byte `protobuf:"bytes,8,opt,name=end_cursor,json=endCursor,proto3" json:"end_cursor,omitempty"`
// The number of results to skip. Applies before limit, but after all other
// constraints. Optional. Must be >= 0 if specified.
Offset int32 `protobuf:"varint,10,opt,name=offset,proto3" json:"offset,omitempty"`
// The maximum number of results to return. Applies after all other
// constraints. Optional.
// Unspecified is interpreted as no limit.
// Must be >= 0 if specified.
Limit *wrapperspb.Int32Value `protobuf:"bytes,12,opt,name=limit,proto3" json:"limit,omitempty"`
// contains filtered or unexported fields
}
func (*Query) Descriptor() ([]byte, []int)
Deprecated: Use Query.ProtoReflect.Descriptor instead.
func (x *Query) GetDistinctOn() []*PropertyReference
func (x *Query) GetEndCursor() []byte
func (x *Query) GetFilter() *Filter
func (x *Query) GetKind() []*KindExpression
func (x *Query) GetLimit() *wrapperspb.Int32Value
func (x *Query) GetOffset() int32
func (x *Query) GetOrder() []*PropertyOrder
func (x *Query) GetProjection() []*Projection
func (x *Query) GetStartCursor() []byte
func (*Query) ProtoMessage()
func (x *Query) ProtoReflect() protoreflect.Message
func (x *Query) Reset()
func (x *Query) String() string
A batch of results produced by a query.
type QueryResultBatch struct {
// The number of results skipped, typically because of an offset.
SkippedResults int32 `protobuf:"varint,6,opt,name=skipped_results,json=skippedResults,proto3" json:"skipped_results,omitempty"`
// A cursor that points to the position after the last skipped result.
// Will be set when `skipped_results` != 0.
SkippedCursor []byte `protobuf:"bytes,3,opt,name=skipped_cursor,json=skippedCursor,proto3" json:"skipped_cursor,omitempty"`
// The result type for every entity in `entity_results`.
EntityResultType EntityResult_ResultType `protobuf:"varint,1,opt,name=entity_result_type,json=entityResultType,proto3,enum=google.datastore.v1beta3.EntityResult_ResultType" json:"entity_result_type,omitempty"`
// The results for this batch.
EntityResults []*EntityResult `protobuf:"bytes,2,rep,name=entity_results,json=entityResults,proto3" json:"entity_results,omitempty"`
// A cursor that points to the position after the last result in the batch.
EndCursor []byte `protobuf:"bytes,4,opt,name=end_cursor,json=endCursor,proto3" json:"end_cursor,omitempty"`
// The state of the query after the current batch.
MoreResults QueryResultBatch_MoreResultsType `protobuf:"varint,5,opt,name=more_results,json=moreResults,proto3,enum=google.datastore.v1beta3.QueryResultBatch_MoreResultsType" json:"more_results,omitempty"`
// The version number of the snapshot this batch was returned from.
// This applies to the range of results from the query's `start_cursor` (or
// the beginning of the query if no cursor was given) to this batch's
// `end_cursor` (not the query's `end_cursor`).
//
// In a single transaction, subsequent query result batches for the same query
// can have a greater snapshot version number. Each batch's snapshot version
// is valid for all preceding batches.
// The value will be zero for eventually consistent queries.
SnapshotVersion int64 `protobuf:"varint,7,opt,name=snapshot_version,json=snapshotVersion,proto3" json:"snapshot_version,omitempty"`
// contains filtered or unexported fields
}
func (*QueryResultBatch) Descriptor() ([]byte, []int)
Deprecated: Use QueryResultBatch.ProtoReflect.Descriptor instead.
func (x *QueryResultBatch) GetEndCursor() []byte
func (x *QueryResultBatch) GetEntityResultType() EntityResult_ResultType
func (x *QueryResultBatch) GetEntityResults() []*EntityResult
func (x *QueryResultBatch) GetMoreResults() QueryResultBatch_MoreResultsType
func (x *QueryResultBatch) GetSkippedCursor() []byte
func (x *QueryResultBatch) GetSkippedResults() int32
func (x *QueryResultBatch) GetSnapshotVersion() int64
func (*QueryResultBatch) ProtoMessage()
func (x *QueryResultBatch) ProtoReflect() protoreflect.Message
func (x *QueryResultBatch) Reset()
func (x *QueryResultBatch) String() string
The possible values for the `more_results` field.
type QueryResultBatch_MoreResultsType int32
const (
// Unspecified. This value is never used.
QueryResultBatch_MORE_RESULTS_TYPE_UNSPECIFIED QueryResultBatch_MoreResultsType = 0
// There may be additional batches to fetch from this query.
QueryResultBatch_NOT_FINISHED QueryResultBatch_MoreResultsType = 1
// The query is finished, but there may be more results after the limit.
QueryResultBatch_MORE_RESULTS_AFTER_LIMIT QueryResultBatch_MoreResultsType = 2
// The query is finished, but there may be more results after the end
// cursor.
QueryResultBatch_MORE_RESULTS_AFTER_CURSOR QueryResultBatch_MoreResultsType = 4
// The query is finished, and there are no more results.
QueryResultBatch_NO_MORE_RESULTS QueryResultBatch_MoreResultsType = 3
)
func (QueryResultBatch_MoreResultsType) Descriptor() protoreflect.EnumDescriptor
func (x QueryResultBatch_MoreResultsType) Enum() *QueryResultBatch_MoreResultsType
func (QueryResultBatch_MoreResultsType) EnumDescriptor() ([]byte, []int)
Deprecated: Use QueryResultBatch_MoreResultsType.Descriptor instead.
func (x QueryResultBatch_MoreResultsType) Number() protoreflect.EnumNumber
func (x QueryResultBatch_MoreResultsType) String() string
func (QueryResultBatch_MoreResultsType) Type() protoreflect.EnumType
The options shared by read requests.
type ReadOptions struct {
// If not specified, lookups and ancestor queries default to
// `read_consistency`=`STRONG`, global queries default to
// `read_consistency`=`EVENTUAL`.
//
// Types that are assignable to ConsistencyType:
// *ReadOptions_ReadConsistency_
// *ReadOptions_Transaction
ConsistencyType isReadOptions_ConsistencyType `protobuf_oneof:"consistency_type"`
// contains filtered or unexported fields
}
func (*ReadOptions) Descriptor() ([]byte, []int)
Deprecated: Use ReadOptions.ProtoReflect.Descriptor instead.
func (m *ReadOptions) GetConsistencyType() isReadOptions_ConsistencyType
func (x *ReadOptions) GetReadConsistency() ReadOptions_ReadConsistency
func (x *ReadOptions) GetTransaction() []byte
func (*ReadOptions) ProtoMessage()
func (x *ReadOptions) ProtoReflect() protoreflect.Message
func (x *ReadOptions) Reset()
func (x *ReadOptions) String() string
The possible values for read consistencies.
type ReadOptions_ReadConsistency int32
const (
// Unspecified. This value must not be used.
ReadOptions_READ_CONSISTENCY_UNSPECIFIED ReadOptions_ReadConsistency = 0
// Strong consistency.
ReadOptions_STRONG ReadOptions_ReadConsistency = 1
// Eventual consistency.
ReadOptions_EVENTUAL ReadOptions_ReadConsistency = 2
)
func (ReadOptions_ReadConsistency) Descriptor() protoreflect.EnumDescriptor
func (x ReadOptions_ReadConsistency) Enum() *ReadOptions_ReadConsistency
func (ReadOptions_ReadConsistency) EnumDescriptor() ([]byte, []int)
Deprecated: Use ReadOptions_ReadConsistency.Descriptor instead.
func (x ReadOptions_ReadConsistency) Number() protoreflect.EnumNumber
func (x ReadOptions_ReadConsistency) String() string
func (ReadOptions_ReadConsistency) Type() protoreflect.EnumType
type ReadOptions_ReadConsistency_ struct {
// The non-transactional read consistency to use.
// Cannot be set to `STRONG` for global queries.
ReadConsistency ReadOptions_ReadConsistency `protobuf:"varint,1,opt,name=read_consistency,json=readConsistency,proto3,enum=google.datastore.v1beta3.ReadOptions_ReadConsistency,oneof"`
}
type ReadOptions_Transaction struct {
// The identifier of the transaction in which to read. A
// transaction identifier is returned by a call to
// [Datastore.BeginTransaction][google.datastore.v1beta3.Datastore.BeginTransaction].
Transaction []byte `protobuf:"bytes,2,opt,name=transaction,proto3,oneof"`
}
The request for [Datastore.ReserveIds][google.datastore.v1beta3.Datastore.ReserveIds].
type ReserveIdsRequest struct {
// The ID of the project against which to make the request.
ProjectId string `protobuf:"bytes,8,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// If not empty, the ID of the database against which to make the request.
DatabaseId string `protobuf:"bytes,9,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
// A list of keys with complete key paths whose numeric IDs should not be
// auto-allocated.
Keys []*Key `protobuf:"bytes,1,rep,name=keys,proto3" json:"keys,omitempty"`
// contains filtered or unexported fields
}
func (*ReserveIdsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ReserveIdsRequest.ProtoReflect.Descriptor instead.
func (x *ReserveIdsRequest) GetDatabaseId() string
func (x *ReserveIdsRequest) GetKeys() []*Key
func (x *ReserveIdsRequest) GetProjectId() string
func (*ReserveIdsRequest) ProtoMessage()
func (x *ReserveIdsRequest) ProtoReflect() protoreflect.Message
func (x *ReserveIdsRequest) Reset()
func (x *ReserveIdsRequest) String() string
The response for [Datastore.ReserveIds][google.datastore.v1beta3.Datastore.ReserveIds].
type ReserveIdsResponse struct {
// contains filtered or unexported fields
}
func (*ReserveIdsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ReserveIdsResponse.ProtoReflect.Descriptor instead.
func (*ReserveIdsResponse) ProtoMessage()
func (x *ReserveIdsResponse) ProtoReflect() protoreflect.Message
func (x *ReserveIdsResponse) Reset()
func (x *ReserveIdsResponse) String() string
The request for [Datastore.Rollback][google.datastore.v1beta3.Datastore.Rollback].
type RollbackRequest struct {
// The ID of the project against which to make the request.
ProjectId string `protobuf:"bytes,8,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// The transaction identifier, returned by a call to
// [Datastore.BeginTransaction][google.datastore.v1beta3.Datastore.BeginTransaction].
Transaction []byte `protobuf:"bytes,1,opt,name=transaction,proto3" json:"transaction,omitempty"`
// contains filtered or unexported fields
}
func (*RollbackRequest) Descriptor() ([]byte, []int)
Deprecated: Use RollbackRequest.ProtoReflect.Descriptor instead.
func (x *RollbackRequest) GetProjectId() string
func (x *RollbackRequest) GetTransaction() []byte
func (*RollbackRequest) ProtoMessage()
func (x *RollbackRequest) ProtoReflect() protoreflect.Message
func (x *RollbackRequest) Reset()
func (x *RollbackRequest) String() string
The response for [Datastore.Rollback][google.datastore.v1beta3.Datastore.Rollback]. (an empty message).
type RollbackResponse struct {
// contains filtered or unexported fields
}
func (*RollbackResponse) Descriptor() ([]byte, []int)
Deprecated: Use RollbackResponse.ProtoReflect.Descriptor instead.
func (*RollbackResponse) ProtoMessage()
func (x *RollbackResponse) ProtoReflect() protoreflect.Message
func (x *RollbackResponse) Reset()
func (x *RollbackResponse) String() string
The request for [Datastore.RunQuery][google.datastore.v1beta3.Datastore.RunQuery].
type RunQueryRequest struct {
// The ID of the project against which to make the request.
ProjectId string `protobuf:"bytes,8,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// 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.
PartitionId *PartitionId `protobuf:"bytes,2,opt,name=partition_id,json=partitionId,proto3" json:"partition_id,omitempty"`
// The options for this query.
ReadOptions *ReadOptions `protobuf:"bytes,1,opt,name=read_options,json=readOptions,proto3" json:"read_options,omitempty"`
// The type of query.
//
// Types that are assignable to QueryType:
// *RunQueryRequest_Query
// *RunQueryRequest_GqlQuery
QueryType isRunQueryRequest_QueryType `protobuf_oneof:"query_type"`
// contains filtered or unexported fields
}
func (*RunQueryRequest) Descriptor() ([]byte, []int)
Deprecated: Use RunQueryRequest.ProtoReflect.Descriptor instead.
func (x *RunQueryRequest) GetGqlQuery() *GqlQuery
func (x *RunQueryRequest) GetPartitionId() *PartitionId
func (x *RunQueryRequest) GetProjectId() string
func (x *RunQueryRequest) GetQuery() *Query
func (m *RunQueryRequest) GetQueryType() isRunQueryRequest_QueryType
func (x *RunQueryRequest) GetReadOptions() *ReadOptions
func (*RunQueryRequest) ProtoMessage()
func (x *RunQueryRequest) ProtoReflect() protoreflect.Message
func (x *RunQueryRequest) Reset()
func (x *RunQueryRequest) String() string
type RunQueryRequest_GqlQuery struct {
// The GQL query to run.
GqlQuery *GqlQuery `protobuf:"bytes,7,opt,name=gql_query,json=gqlQuery,proto3,oneof"`
}
type RunQueryRequest_Query struct {
// The query to run.
Query *Query `protobuf:"bytes,3,opt,name=query,proto3,oneof"`
}
The response for [Datastore.RunQuery][google.datastore.v1beta3.Datastore.RunQuery].
type RunQueryResponse struct {
// A batch of query results (always present).
Batch *QueryResultBatch `protobuf:"bytes,1,opt,name=batch,proto3" json:"batch,omitempty"`
// The parsed form of the `GqlQuery` from the request, if it was set.
Query *Query `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
// contains filtered or unexported fields
}
func (*RunQueryResponse) Descriptor() ([]byte, []int)
Deprecated: Use RunQueryResponse.ProtoReflect.Descriptor instead.
func (x *RunQueryResponse) GetBatch() *QueryResultBatch
func (x *RunQueryResponse) GetQuery() *Query
func (*RunQueryResponse) ProtoMessage()
func (x *RunQueryResponse) ProtoReflect() protoreflect.Message
func (x *RunQueryResponse) Reset()
func (x *RunQueryResponse) String() string
Options for beginning a new transaction.
Transactions can be created explicitly with calls to [Datastore.BeginTransaction][google.datastore.v1beta3.Datastore.BeginTransaction] or implicitly by setting [ReadOptions.new_transaction][google.datastore.v1beta3.ReadOptions.new_transaction] in read requests.
type TransactionOptions struct {
// The `mode` of the transaction, indicating whether write operations are
// supported.
//
// Types that are assignable to Mode:
// *TransactionOptions_ReadWrite_
// *TransactionOptions_ReadOnly_
Mode isTransactionOptions_Mode `protobuf_oneof:"mode"`
// contains filtered or unexported fields
}
func (*TransactionOptions) Descriptor() ([]byte, []int)
Deprecated: Use TransactionOptions.ProtoReflect.Descriptor instead.
func (m *TransactionOptions) GetMode() isTransactionOptions_Mode
func (x *TransactionOptions) GetReadOnly() *TransactionOptions_ReadOnly
func (x *TransactionOptions) GetReadWrite() *TransactionOptions_ReadWrite
func (*TransactionOptions) ProtoMessage()
func (x *TransactionOptions) ProtoReflect() protoreflect.Message
func (x *TransactionOptions) Reset()
func (x *TransactionOptions) String() string
Options specific to read-only transactions.
type TransactionOptions_ReadOnly struct {
// contains filtered or unexported fields
}
func (*TransactionOptions_ReadOnly) Descriptor() ([]byte, []int)
Deprecated: Use TransactionOptions_ReadOnly.ProtoReflect.Descriptor instead.
func (*TransactionOptions_ReadOnly) ProtoMessage()
func (x *TransactionOptions_ReadOnly) ProtoReflect() protoreflect.Message
func (x *TransactionOptions_ReadOnly) Reset()
func (x *TransactionOptions_ReadOnly) String() string
type TransactionOptions_ReadOnly_ struct {
// The transaction should only allow reads.
ReadOnly *TransactionOptions_ReadOnly `protobuf:"bytes,2,opt,name=read_only,json=readOnly,proto3,oneof"`
}
Options specific to read / write transactions.
type TransactionOptions_ReadWrite struct {
// The transaction identifier of the transaction being retried.
PreviousTransaction []byte `protobuf:"bytes,1,opt,name=previous_transaction,json=previousTransaction,proto3" json:"previous_transaction,omitempty"`
// contains filtered or unexported fields
}
func (*TransactionOptions_ReadWrite) Descriptor() ([]byte, []int)
Deprecated: Use TransactionOptions_ReadWrite.ProtoReflect.Descriptor instead.
func (x *TransactionOptions_ReadWrite) GetPreviousTransaction() []byte
func (*TransactionOptions_ReadWrite) ProtoMessage()
func (x *TransactionOptions_ReadWrite) ProtoReflect() protoreflect.Message
func (x *TransactionOptions_ReadWrite) Reset()
func (x *TransactionOptions_ReadWrite) String() string
type TransactionOptions_ReadWrite_ struct {
// The transaction should allow both reads and writes.
ReadWrite *TransactionOptions_ReadWrite `protobuf:"bytes,1,opt,name=read_write,json=readWrite,proto3,oneof"`
}
UnimplementedDatastoreServer can be embedded to have forward compatible implementations.
type UnimplementedDatastoreServer struct {
}
func (*UnimplementedDatastoreServer) AllocateIds(context.Context, *AllocateIdsRequest) (*AllocateIdsResponse, error)
func (*UnimplementedDatastoreServer) BeginTransaction(context.Context, *BeginTransactionRequest) (*BeginTransactionResponse, error)
func (*UnimplementedDatastoreServer) Commit(context.Context, *CommitRequest) (*CommitResponse, error)
func (*UnimplementedDatastoreServer) Lookup(context.Context, *LookupRequest) (*LookupResponse, error)
func (*UnimplementedDatastoreServer) ReserveIds(context.Context, *ReserveIdsRequest) (*ReserveIdsResponse, error)
func (*UnimplementedDatastoreServer) Rollback(context.Context, *RollbackRequest) (*RollbackResponse, error)
func (*UnimplementedDatastoreServer) RunQuery(context.Context, *RunQueryRequest) (*RunQueryResponse, error)
A message that can hold any of the supported value types and associated metadata.
type Value struct {
// Must have a value set.
//
// Types that are assignable to ValueType:
// *Value_NullValue
// *Value_BooleanValue
// *Value_IntegerValue
// *Value_DoubleValue
// *Value_TimestampValue
// *Value_KeyValue
// *Value_StringValue
// *Value_BlobValue
// *Value_GeoPointValue
// *Value_EntityValue
// *Value_ArrayValue
ValueType isValue_ValueType `protobuf_oneof:"value_type"`
// The `meaning` field should only be populated for backwards compatibility.
Meaning int32 `protobuf:"varint,14,opt,name=meaning,proto3" json:"meaning,omitempty"`
// If the value should be excluded from all indexes including those defined
// explicitly.
ExcludeFromIndexes bool `protobuf:"varint,19,opt,name=exclude_from_indexes,json=excludeFromIndexes,proto3" json:"exclude_from_indexes,omitempty"`
// contains filtered or unexported fields
}
func (*Value) Descriptor() ([]byte, []int)
Deprecated: Use Value.ProtoReflect.Descriptor instead.
func (x *Value) GetArrayValue() *ArrayValue
func (x *Value) GetBlobValue() []byte
func (x *Value) GetBooleanValue() bool
func (x *Value) GetDoubleValue() float64
func (x *Value) GetEntityValue() *Entity
func (x *Value) GetExcludeFromIndexes() bool
func (x *Value) GetGeoPointValue() *latlng.LatLng
func (x *Value) GetIntegerValue() int64
func (x *Value) GetKeyValue() *Key
func (x *Value) GetMeaning() int32
func (x *Value) GetNullValue() structpb.NullValue
func (x *Value) GetStringValue() string
func (x *Value) GetTimestampValue() *timestamppb.Timestamp
func (m *Value) GetValueType() isValue_ValueType
func (*Value) ProtoMessage()
func (x *Value) ProtoReflect() protoreflect.Message
func (x *Value) Reset()
func (x *Value) String() string
type Value_ArrayValue struct {
// An array value.
// Cannot contain another array value.
// A `Value` instance that sets field `array_value` must not set fields
// `meaning` or `exclude_from_indexes`.
ArrayValue *ArrayValue `protobuf:"bytes,9,opt,name=array_value,json=arrayValue,proto3,oneof"`
}
type Value_BlobValue struct {
// A blob value.
// May have at most 1,000,000 bytes.
// When `exclude_from_indexes` is false, may have at most 1500 bytes.
// In JSON requests, must be base64-encoded.
BlobValue []byte `protobuf:"bytes,18,opt,name=blob_value,json=blobValue,proto3,oneof"`
}
type Value_BooleanValue struct {
// A boolean value.
BooleanValue bool `protobuf:"varint,1,opt,name=boolean_value,json=booleanValue,proto3,oneof"`
}
type Value_DoubleValue struct {
// A double value.
DoubleValue float64 `protobuf:"fixed64,3,opt,name=double_value,json=doubleValue,proto3,oneof"`
}
type Value_EntityValue struct {
// An entity value.
//
// - May have no key.
// - May have a key with an incomplete key path.
// - May have a reserved/read-only key.
EntityValue *Entity `protobuf:"bytes,6,opt,name=entity_value,json=entityValue,proto3,oneof"`
}
type Value_GeoPointValue struct {
// A geo point value representing a point on the surface of Earth.
GeoPointValue *latlng.LatLng `protobuf:"bytes,8,opt,name=geo_point_value,json=geoPointValue,proto3,oneof"`
}
type Value_IntegerValue struct {
// An integer value.
IntegerValue int64 `protobuf:"varint,2,opt,name=integer_value,json=integerValue,proto3,oneof"`
}
type Value_KeyValue struct {
// A key value.
KeyValue *Key `protobuf:"bytes,5,opt,name=key_value,json=keyValue,proto3,oneof"`
}
type Value_NullValue struct {
// A null value.
NullValue structpb.NullValue `protobuf:"varint,11,opt,name=null_value,json=nullValue,proto3,enum=google.protobuf.NullValue,oneof"`
}
type Value_StringValue struct {
// A UTF-8 encoded string value.
// When `exclude_from_indexes` is false (it is indexed), may have at most
// 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
StringValue string `protobuf:"bytes,17,opt,name=string_value,json=stringValue,proto3,oneof"`
}
type Value_TimestampValue struct {
// A timestamp value.
// When stored in the Datastore, precise only to microseconds;
// any additional precision is rounded down.
TimestampValue *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=timestamp_value,json=timestampValue,proto3,oneof"`
}