Variables
CommitRequest_Mode_name, CommitRequest_Mode_value
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 CommitRequest_Mode.
ReadOptions_ReadConsistency_name, ReadOptions_ReadConsistency_value
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 ReadOptions_ReadConsistency.
EntityResult_ResultType_name, EntityResult_ResultType_value
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 EntityResult_ResultType.
PropertyOrder_Direction_name, PropertyOrder_Direction_value
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 PropertyOrder_Direction.
CompositeFilter_Operator_name, CompositeFilter_Operator_value
var
(
CompositeFilter_Operator_name
=
map
[
int32
]
string
{
0
:
"OPERATOR_UNSPECIFIED"
,
1
:
"AND"
,
2
:
"OR"
,
}
CompositeFilter_Operator_value
=
map
[
string
]
int32
{
"OPERATOR_UNSPECIFIED"
:
0
,
"AND"
:
1
,
"OR"
:
2
,
}
)
Enum value maps for CompositeFilter_Operator.
PropertyFilter_Operator_name, PropertyFilter_Operator_value
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"
,
6
:
"IN"
,
9
:
"NOT_EQUAL"
,
11
:
"HAS_ANCESTOR"
,
13
:
"NOT_IN"
,
}
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
,
"IN"
:
6
,
"NOT_EQUAL"
:
9
,
"HAS_ANCESTOR"
:
11
,
"NOT_IN"
:
13
,
}
)
Enum value maps for PropertyFilter_Operator.
QueryResultBatch_MoreResultsType_name, QueryResultBatch_MoreResultsType_value
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
,
}
)
Enum value maps for QueryResultBatch_MoreResultsType.
File_google_datastore_v1_aggregation_result_proto
var
File_google_datastore_v1_aggregation_result_proto
protoreflect
.
FileDescriptor
File_google_datastore_v1_datastore_proto
var
File_google_datastore_v1_datastore_proto
protoreflect
.
FileDescriptor
File_google_datastore_v1_entity_proto
var
File_google_datastore_v1_entity_proto
protoreflect
.
FileDescriptor
File_google_datastore_v1_query_profile_proto
var
File_google_datastore_v1_query_profile_proto
protoreflect
.
FileDescriptor
File_google_datastore_v1_query_proto
var
File_google_datastore_v1_query_proto
protoreflect
.
FileDescriptor
Functions
func RegisterDatastoreServer
func
RegisterDatastoreServer
(
s
*
grpc
.
Server
,
srv
DatastoreServer
)
AggregationQuery
type
AggregationQuery
struct
{
// The base query to aggregate over.
//
// Types that are assignable to QueryType:
//
// *AggregationQuery_NestedQuery
QueryType
isAggregationQuery_QueryType
`protobuf_oneof:"query_type"`
// Optional. Series of aggregations to apply over the results of the
// `nested_query`.
//
// Requires:
//
// * A minimum of one and maximum of five aggregations per query.
Aggregations
[]
*
AggregationQuery_Aggregation
`protobuf:"bytes,3,rep,name=aggregations,proto3" json:"aggregations,omitempty"`
// contains filtered or unexported fields
}
Datastore query for running an aggregation over a [Query][google.datastore.v1.Query].
func (*AggregationQuery) Descriptor
func
(
*
AggregationQuery
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AggregationQuery.ProtoReflect.Descriptor instead.
func (*AggregationQuery) GetAggregations
func
(
x
*
AggregationQuery
)
GetAggregations
()
[]
*
AggregationQuery_Aggregation
func (*AggregationQuery) GetNestedQuery
func
(
x
*
AggregationQuery
)
GetNestedQuery
()
*
Query
func (*AggregationQuery) GetQueryType
func
(
m
*
AggregationQuery
)
GetQueryType
()
isAggregationQuery_QueryType
func (*AggregationQuery) ProtoMessage
func
(
*
AggregationQuery
)
ProtoMessage
()
func (*AggregationQuery) ProtoReflect
func
(
x
*
AggregationQuery
)
ProtoReflect
()
protoreflect
.
Message
func (*AggregationQuery) Reset
func
(
x
*
AggregationQuery
)
Reset
()
func (*AggregationQuery) String
func
(
x
*
AggregationQuery
)
String
()
string
AggregationQuery_Aggregation
type
AggregationQuery_Aggregation
struct
{
// The type of aggregation to perform, required.
//
// Types that are assignable to Operator:
//
// *AggregationQuery_Aggregation_Count_
// *AggregationQuery_Aggregation_Sum_
// *AggregationQuery_Aggregation_Avg_
Operator
isAggregationQuery_Aggregation_Operator
`protobuf_oneof:"operator"`
// Optional. Optional name of the property to store the result of the
// aggregation.
//
// If not provided, Datastore will pick a default name following the format
// `property_
Defines an aggregation that produces a single result.
func (*AggregationQuery_Aggregation) Descriptor
func
(
*
AggregationQuery_Aggregation
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AggregationQuery_Aggregation.ProtoReflect.Descriptor instead.
func (*AggregationQuery_Aggregation) GetAlias
func
(
x
*
AggregationQuery_Aggregation
)
GetAlias
()
string
func (*AggregationQuery_Aggregation) GetAvg
func
(
x
*
AggregationQuery_Aggregation
)
GetAvg
()
*
AggregationQuery_Aggregation_Avg
func (*AggregationQuery_Aggregation) GetCount
func
(
x
*
AggregationQuery_Aggregation
)
GetCount
()
*
AggregationQuery_Aggregation_Count
func (*AggregationQuery_Aggregation) GetOperator
func
(
m
*
AggregationQuery_Aggregation
)
GetOperator
()
isAggregationQuery_Aggregation_Operator
func (*AggregationQuery_Aggregation) GetSum
func
(
x
*
AggregationQuery_Aggregation
)
GetSum
()
*
AggregationQuery_Aggregation_Sum
func (*AggregationQuery_Aggregation) ProtoMessage
func
(
*
AggregationQuery_Aggregation
)
ProtoMessage
()
func (*AggregationQuery_Aggregation) ProtoReflect
func
(
x
*
AggregationQuery_Aggregation
)
ProtoReflect
()
protoreflect
.
Message
func (*AggregationQuery_Aggregation) Reset
func
(
x
*
AggregationQuery_Aggregation
)
Reset
()
func (*AggregationQuery_Aggregation) String
func
(
x
*
AggregationQuery_Aggregation
)
String
()
string
AggregationQuery_Aggregation_Avg
type
AggregationQuery_Aggregation_Avg
struct
{
// The property to aggregate on.
Property
*
PropertyReference
`protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
// contains filtered or unexported fields
}
Average of the values of the requested property.
-
Only numeric values will be aggregated. All non-numeric values including
NULLare skipped. -
If the aggregated values contain
NaN, returnsNaN. Infinity math follows IEEE-754 standards. -
If the aggregated value set is empty, returns
NULL. -
Always returns the result as a double.
func (*AggregationQuery_Aggregation_Avg) Descriptor
func
(
*
AggregationQuery_Aggregation_Avg
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AggregationQuery_Aggregation_Avg.ProtoReflect.Descriptor instead.
func (*AggregationQuery_Aggregation_Avg) GetProperty
func
(
x
*
AggregationQuery_Aggregation_Avg
)
GetProperty
()
*
PropertyReference
func (*AggregationQuery_Aggregation_Avg) ProtoMessage
func
(
*
AggregationQuery_Aggregation_Avg
)
ProtoMessage
()
func (*AggregationQuery_Aggregation_Avg) ProtoReflect
func
(
x
*
AggregationQuery_Aggregation_Avg
)
ProtoReflect
()
protoreflect
.
Message
func (*AggregationQuery_Aggregation_Avg) Reset
func
(
x
*
AggregationQuery_Aggregation_Avg
)
Reset
()
func (*AggregationQuery_Aggregation_Avg) String
func
(
x
*
AggregationQuery_Aggregation_Avg
)
String
()
string
AggregationQuery_Aggregation_Avg_
type
AggregationQuery_Aggregation_Avg_
struct
{
// Average aggregator.
Avg
*
AggregationQuery_Aggregation_Avg
`protobuf:"bytes,3,opt,name=avg,proto3,oneof"`
}
AggregationQuery_Aggregation_Count
type
AggregationQuery_Aggregation_Count
struct
{
// Optional. Optional constraint on the maximum number of entities to
// count.
//
// This provides a way to set an upper bound on the number of entities
// to scan, limiting latency, and cost.
//
// Unspecified is interpreted as no bound.
//
// If a zero value is provided, a count result of zero should always be
// expected.
//
// High-Level Example:
//
// ```
// AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
// ```
//
// Requires:
//
// * Must be non-negative when present.
UpTo
*
wrapperspb
.
Int64Value
`protobuf:"bytes,1,opt,name=up_to,json=upTo,proto3" json:"up_to,omitempty"`
// contains filtered or unexported fields
}
Count of entities that match the query.
The COUNT(*)
aggregation function operates on the entire entity
so it does not require a field reference.
func (*AggregationQuery_Aggregation_Count) Descriptor
func
(
*
AggregationQuery_Aggregation_Count
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AggregationQuery_Aggregation_Count.ProtoReflect.Descriptor instead.
func (*AggregationQuery_Aggregation_Count) GetUpTo
func
(
x
*
AggregationQuery_Aggregation_Count
)
GetUpTo
()
*
wrapperspb
.
Int64Value
func (*AggregationQuery_Aggregation_Count) ProtoMessage
func
(
*
AggregationQuery_Aggregation_Count
)
ProtoMessage
()
func (*AggregationQuery_Aggregation_Count) ProtoReflect
func
(
x
*
AggregationQuery_Aggregation_Count
)
ProtoReflect
()
protoreflect
.
Message
func (*AggregationQuery_Aggregation_Count) Reset
func
(
x
*
AggregationQuery_Aggregation_Count
)
Reset
()
func (*AggregationQuery_Aggregation_Count) String
func
(
x
*
AggregationQuery_Aggregation_Count
)
String
()
string
AggregationQuery_Aggregation_Count_
type
AggregationQuery_Aggregation_Count_
struct
{
// Count aggregator.
Count
*
AggregationQuery_Aggregation_Count
`protobuf:"bytes,1,opt,name=count,proto3,oneof"`
}
AggregationQuery_Aggregation_Sum
type
AggregationQuery_Aggregation_Sum
struct
{
// The property to aggregate on.
Property
*
PropertyReference
`protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
// contains filtered or unexported fields
}
Sum of the values of the requested property.
-
Only numeric values will be aggregated. All non-numeric values including
NULLare skipped. -
If the aggregated values contain
NaN, returnsNaN. 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.
func (*AggregationQuery_Aggregation_Sum) Descriptor
func
(
*
AggregationQuery_Aggregation_Sum
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AggregationQuery_Aggregation_Sum.ProtoReflect.Descriptor instead.
func (*AggregationQuery_Aggregation_Sum) GetProperty
func
(
x
*
AggregationQuery_Aggregation_Sum
)
GetProperty
()
*
PropertyReference
func (*AggregationQuery_Aggregation_Sum) ProtoMessage
func
(
*
AggregationQuery_Aggregation_Sum
)
ProtoMessage
()
func (*AggregationQuery_Aggregation_Sum) ProtoReflect
func
(
x
*
AggregationQuery_Aggregation_Sum
)
ProtoReflect
()
protoreflect
.
Message
func (*AggregationQuery_Aggregation_Sum) Reset
func
(
x
*
AggregationQuery_Aggregation_Sum
)
Reset
()
func (*AggregationQuery_Aggregation_Sum) String
func
(
x
*
AggregationQuery_Aggregation_Sum
)
String
()
string
AggregationQuery_Aggregation_Sum_
type
AggregationQuery_Aggregation_Sum_
struct
{
// Sum aggregator.
Sum
*
AggregationQuery_Aggregation_Sum
`protobuf:"bytes,2,opt,name=sum,proto3,oneof"`
}
AggregationQuery_NestedQuery
type
AggregationQuery_NestedQuery
struct
{
// Nested query for aggregation
NestedQuery
*
Query
`protobuf:"bytes,1,opt,name=nested_query,json=nestedQuery,proto3,oneof"`
}
AggregationResult
type
AggregationResult
struct
{
AggregateProperties
map
[
string
]
*
Value
""
/* 206 byte string literal not displayed */
}
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.
func (*AggregationResult) Descriptor
func
(
*
AggregationResult
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AggregationResult.ProtoReflect.Descriptor instead.
func (*AggregationResult) GetAggregateProperties
func
(
x
*
AggregationResult
)
GetAggregateProperties
()
map
[
string
]
*
Value
func (*AggregationResult) ProtoMessage
func
(
*
AggregationResult
)
ProtoMessage
()
func (*AggregationResult) ProtoReflect
func
(
x
*
AggregationResult
)
ProtoReflect
()
protoreflect
.
Message
func (*AggregationResult) Reset
func
(
x
*
AggregationResult
)
Reset
()
func (*AggregationResult) String
func
(
x
*
AggregationResult
)
String
()
string
AggregationResultBatch
type
AggregationResultBatch
struct
{
AggregationResults
[]
*
AggregationResult
`protobuf:"bytes,1,rep,name=aggregation_results,json=aggregationResults,proto3" json:"aggregation_results,omitempty"`
MoreResults
QueryResultBatch_MoreResultsType
""
/* 153 byte string literal not displayed */
ReadTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,3,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
}
A batch of aggregation results produced by an aggregation query.
func (*AggregationResultBatch) Descriptor
func
(
*
AggregationResultBatch
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AggregationResultBatch.ProtoReflect.Descriptor instead.
func (*AggregationResultBatch) GetAggregationResults
func
(
x
*
AggregationResultBatch
)
GetAggregationResults
()
[]
*
AggregationResult
func (*AggregationResultBatch) GetMoreResults
func
(
x
*
AggregationResultBatch
)
GetMoreResults
()
QueryResultBatch_MoreResultsType
func (*AggregationResultBatch) GetReadTime
func
(
x
*
AggregationResultBatch
)
GetReadTime
()
*
timestamppb
.
Timestamp
func (*AggregationResultBatch) ProtoMessage
func
(
*
AggregationResultBatch
)
ProtoMessage
()
func (*AggregationResultBatch) ProtoReflect
func
(
x
*
AggregationResultBatch
)
ProtoReflect
()
protoreflect
.
Message
func (*AggregationResultBatch) Reset
func
(
x
*
AggregationResultBatch
)
Reset
()
func (*AggregationResultBatch) String
func
(
x
*
AggregationResultBatch
)
String
()
string
AllocateIdsRequest
type
AllocateIdsRequest
struct
{
// Required. 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 ID of the database against which to make the request.
//
// '(default)' is not allowed; please use empty string ” to refer the default
// database.
DatabaseId
string
`protobuf:"bytes,9,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
// Required. 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
}
The request for [Datastore.AllocateIds][google.datastore.v1.Datastore.AllocateIds].
func (*AllocateIdsRequest) Descriptor
func
(
*
AllocateIdsRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AllocateIdsRequest.ProtoReflect.Descriptor instead.
func (*AllocateIdsRequest) GetDatabaseId
func
(
x
*
AllocateIdsRequest
)
GetDatabaseId
()
string
func (*AllocateIdsRequest) GetKeys
func
(
x
*
AllocateIdsRequest
)
GetKeys
()
[]
*
Key
func (*AllocateIdsRequest) GetProjectId
func
(
x
*
AllocateIdsRequest
)
GetProjectId
()
string
func (*AllocateIdsRequest) ProtoMessage
func
(
*
AllocateIdsRequest
)
ProtoMessage
()
func (*AllocateIdsRequest) ProtoReflect
func
(
x
*
AllocateIdsRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*AllocateIdsRequest) Reset
func
(
x
*
AllocateIdsRequest
)
Reset
()
func (*AllocateIdsRequest) String
func
(
x
*
AllocateIdsRequest
)
String
()
string
AllocateIdsResponse
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
}
The response for [Datastore.AllocateIds][google.datastore.v1.Datastore.AllocateIds].
func (*AllocateIdsResponse) Descriptor
func
(
*
AllocateIdsResponse
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AllocateIdsResponse.ProtoReflect.Descriptor instead.
func (*AllocateIdsResponse) GetKeys
func
(
x
*
AllocateIdsResponse
)
GetKeys
()
[]
*
Key
func (*AllocateIdsResponse) ProtoMessage
func
(
*
AllocateIdsResponse
)
ProtoMessage
()
func (*AllocateIdsResponse) ProtoReflect
func
(
x
*
AllocateIdsResponse
)
ProtoReflect
()
protoreflect
.
Message
func (*AllocateIdsResponse) Reset
func
(
x
*
AllocateIdsResponse
)
Reset
()
func (*AllocateIdsResponse) String
func
(
x
*
AllocateIdsResponse
)
String
()
string
ArrayValue
type
ArrayValue
struct
{
// Values in the array.
// The order of values in an array is preserved as long as all values have
// identical settings for 'exclude_from_indexes'.
Values
[]
*
Value
`protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}
An array value.
func (*ArrayValue) Descriptor
func
(
*
ArrayValue
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ArrayValue.ProtoReflect.Descriptor instead.
func (*ArrayValue) GetValues
func
(
x
*
ArrayValue
)
GetValues
()
[]
*
Value
func (*ArrayValue) ProtoMessage
func
(
*
ArrayValue
)
ProtoMessage
()
func (*ArrayValue) ProtoReflect
func
(
x
*
ArrayValue
)
ProtoReflect
()
protoreflect
.
Message
func (*ArrayValue) Reset
func
(
x
*
ArrayValue
)
Reset
()
func (*ArrayValue) String
func
(
x
*
ArrayValue
)
String
()
string
BeginTransactionRequest
type
BeginTransactionRequest
struct
{
// Required. 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 ID of the database against which to make the request.
//
// '(default)' is not allowed; please use empty string ” to refer the default
// database.
DatabaseId
string
`protobuf:"bytes,9,opt,name=database_id,json=databaseId,proto3" json:"database_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
}
The request for [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
func (*BeginTransactionRequest) Descriptor
func
(
*
BeginTransactionRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use BeginTransactionRequest.ProtoReflect.Descriptor instead.
func (*BeginTransactionRequest) GetDatabaseId
func
(
x
*
BeginTransactionRequest
)
GetDatabaseId
()
string
func (*BeginTransactionRequest) GetProjectId
func
(
x
*
BeginTransactionRequest
)
GetProjectId
()
string
func (*BeginTransactionRequest) GetTransactionOptions
func
(
x
*
BeginTransactionRequest
)
GetTransactionOptions
()
*
TransactionOptions
func (*BeginTransactionRequest) ProtoMessage
func
(
*
BeginTransactionRequest
)
ProtoMessage
()
func (*BeginTransactionRequest) ProtoReflect
func
(
x
*
BeginTransactionRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*BeginTransactionRequest) Reset
func
(
x
*
BeginTransactionRequest
)
Reset
()
func (*BeginTransactionRequest) String
func
(
x
*
BeginTransactionRequest
)
String
()
string
BeginTransactionResponse
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
}
The response for [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
func (*BeginTransactionResponse) Descriptor
func
(
*
BeginTransactionResponse
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use BeginTransactionResponse.ProtoReflect.Descriptor instead.
func (*BeginTransactionResponse) GetTransaction
func
(
x
*
BeginTransactionResponse
)
GetTransaction
()
[]
byte
func (*BeginTransactionResponse) ProtoMessage
func
(
*
BeginTransactionResponse
)
ProtoMessage
()
func (*BeginTransactionResponse) ProtoReflect
func
(
x
*
BeginTransactionResponse
)
ProtoReflect
()
protoreflect
.
Message
func (*BeginTransactionResponse) Reset
func
(
x
*
BeginTransactionResponse
)
Reset
()
func (*BeginTransactionResponse) String
func
(
x
*
BeginTransactionResponse
)
String
()
string
CommitRequest
type
CommitRequest
struct
{
// Required. 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 ID of the database against which to make the request.
//
// '(default)' is not allowed; please use empty string ” to refer the default
// database.
DatabaseId
string
`protobuf:"bytes,9,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
// The type of commit to perform. Defaults to `TRANSACTIONAL`.
Mode
CommitRequest_Mode
`protobuf:"varint,5,opt,name=mode,proto3,enum=google.datastore.v1.CommitRequest_Mode" json:"mode,omitempty"`
// Must be set when mode is `TRANSACTIONAL`.
//
// Types that are assignable to TransactionSelector:
//
// *CommitRequest_Transaction
// *CommitRequest_SingleUseTransaction
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
}
The request for [Datastore.Commit][google.datastore.v1.Datastore.Commit].
func (*CommitRequest) Descriptor
func
(
*
CommitRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use CommitRequest.ProtoReflect.Descriptor instead.
func (*CommitRequest) GetDatabaseId
func
(
x
*
CommitRequest
)
GetDatabaseId
()
string
func (*CommitRequest) GetMode
func
(
x
*
CommitRequest
)
GetMode
()
CommitRequest_Mode
func (*CommitRequest) GetMutations
func
(
x
*
CommitRequest
)
GetMutations
()
[]
*
Mutation
func (*CommitRequest) GetProjectId
func
(
x
*
CommitRequest
)
GetProjectId
()
string
func (*CommitRequest) GetSingleUseTransaction
func
(
x
*
CommitRequest
)
GetSingleUseTransaction
()
*
TransactionOptions
func (*CommitRequest) GetTransaction
func
(
x
*
CommitRequest
)
GetTransaction
()
[]
byte
func (*CommitRequest) GetTransactionSelector
func
(
m
*
CommitRequest
)
GetTransactionSelector
()
isCommitRequest_TransactionSelector
func (*CommitRequest) ProtoMessage
func
(
*
CommitRequest
)
ProtoMessage
()
func (*CommitRequest) ProtoReflect
func
(
x
*
CommitRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*CommitRequest) Reset
func
(
x
*
CommitRequest
)
Reset
()
func (*CommitRequest) String
func
(
x
*
CommitRequest
)
String
()
string
CommitRequest_Mode
type
CommitRequest_Mode
int32
The modes available for commits.
CommitRequest_MODE_UNSPECIFIED, CommitRequest_TRANSACTIONAL, CommitRequest_NON_TRANSACTIONAL
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
func
(
CommitRequest_Mode
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (CommitRequest_Mode) Enum
func
(
x
CommitRequest_Mode
)
Enum
()
*
CommitRequest_Mode
func (CommitRequest_Mode) EnumDescriptor
func
(
CommitRequest_Mode
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use CommitRequest_Mode.Descriptor instead.
func (CommitRequest_Mode) Number
func
(
x
CommitRequest_Mode
)
Number
()
protoreflect
.
EnumNumber
func (CommitRequest_Mode) String
func
(
x
CommitRequest_Mode
)
String
()
string
func (CommitRequest_Mode) Type
func
(
CommitRequest_Mode
)
Type
()
protoreflect
.
EnumType
CommitRequest_SingleUseTransaction
type
CommitRequest_SingleUseTransaction
struct
{
// Options for beginning a new transaction for this request.
// The transaction is committed when the request completes. If specified,
// [TransactionOptions.mode][google.datastore.v1.TransactionOptions] must be
// [TransactionOptions.ReadWrite][google.datastore.v1.TransactionOptions.ReadWrite].
SingleUseTransaction
*
TransactionOptions
`protobuf:"bytes,10,opt,name=single_use_transaction,json=singleUseTransaction,proto3,oneof"`
}
CommitRequest_Transaction
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.v1.Datastore.BeginTransaction].
Transaction
[]
byte
`protobuf:"bytes,1,opt,name=transaction,proto3,oneof"`
}
CommitResponse
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"`
// The transaction commit timestamp. Not set for non-transactional commits.
CommitTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,8,opt,name=commit_time,json=commitTime,proto3" json:"commit_time,omitempty"`
// contains filtered or unexported fields
}
The response for [Datastore.Commit][google.datastore.v1.Datastore.Commit].
func (*CommitResponse) Descriptor
func
(
*
CommitResponse
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use CommitResponse.ProtoReflect.Descriptor instead.
func (*CommitResponse) GetCommitTime
func
(
x
*
CommitResponse
)
GetCommitTime
()
*
timestamppb
.
Timestamp
func (*CommitResponse) GetIndexUpdates
func
(
x
*
CommitResponse
)
GetIndexUpdates
()
int32
func (*CommitResponse) GetMutationResults
func
(
x
*
CommitResponse
)
GetMutationResults
()
[]
*
MutationResult
func (*CommitResponse) ProtoMessage
func
(
*
CommitResponse
)
ProtoMessage
()
func (*CommitResponse) ProtoReflect
func
(
x
*
CommitResponse
)
ProtoReflect
()
protoreflect
.
Message
func (*CommitResponse) Reset
func
(
x
*
CommitResponse
)
Reset
()
func (*CommitResponse) String
func
(
x
*
CommitResponse
)
String
()
string
CompositeFilter
type
CompositeFilter
struct
{
// The operator for combining multiple filters.
Op
CompositeFilter_Operator
`protobuf:"varint,1,opt,name=op,proto3,enum=google.datastore.v1.CompositeFilter_Operator" json:"op,omitempty"`
// The list of filters to combine.
//
// Requires:
//
// * At least one filter is present.
Filters
[]
*
Filter
`protobuf:"bytes,2,rep,name=filters,proto3" json:"filters,omitempty"`
// contains filtered or unexported fields
}
A filter that merges multiple other filters using the given operator.
func (*CompositeFilter) Descriptor
func
(
*
CompositeFilter
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use CompositeFilter.ProtoReflect.Descriptor instead.
func (*CompositeFilter) GetFilters
func
(
x
*
CompositeFilter
)
GetFilters
()
[]
*
Filter
func (*CompositeFilter) GetOp
func
(
x
*
CompositeFilter
)
GetOp
()
CompositeFilter_Operator
func (*CompositeFilter) ProtoMessage
func
(
*
CompositeFilter
)
ProtoMessage
()
func (*CompositeFilter) ProtoReflect
func
(
x
*
CompositeFilter
)
ProtoReflect
()
protoreflect
.
Message
func (*CompositeFilter) Reset
func
(
x
*
CompositeFilter
)
Reset
()
func (*CompositeFilter) String
func
(
x
*
CompositeFilter
)
String
()
string
CompositeFilter_Operator
type
CompositeFilter_Operator
int32
A composite filter operator.
CompositeFilter_OPERATOR_UNSPECIFIED, CompositeFilter_AND, CompositeFilter_OR
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
// Documents are required to satisfy at least one of the combined filters.
CompositeFilter_OR
CompositeFilter_Operator
=
2
)
func (CompositeFilter_Operator) Descriptor
func
(
CompositeFilter_Operator
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (CompositeFilter_Operator) Enum
func
(
x
CompositeFilter_Operator
)
Enum
()
*
CompositeFilter_Operator
func (CompositeFilter_Operator) EnumDescriptor
func
(
CompositeFilter_Operator
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use CompositeFilter_Operator.Descriptor instead.
func (CompositeFilter_Operator) Number
func
(
x
CompositeFilter_Operator
)
Number
()
protoreflect
.
EnumNumber
func (CompositeFilter_Operator) String
func
(
x
CompositeFilter_Operator
)
String
()
string
func (CompositeFilter_Operator) Type
func
(
CompositeFilter_Operator
)
Type
()
protoreflect
.
EnumType
DatastoreClient
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
)
// Runs an aggregation query.
RunAggregationQuery
(
ctx
context
.
Context
,
in
*
RunAggregationQueryRequest
,
opts
...
grpc
.
CallOption
)
(
*
RunAggregationQueryResponse
,
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
)
}
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 .
func NewDatastoreClient
func
NewDatastoreClient
(
cc
grpc
.
ClientConnInterface
)
DatastoreClient
DatastoreServer
type
DatastoreServer
interface
{
// Looks up entities by key.
Lookup
(
context
.
Context
,
*
LookupRequest
)
(
*
LookupResponse
,
error
)
// Queries for entities.
RunQuery
(
context
.
Context
,
*
RunQueryRequest
)
(
*
RunQueryResponse
,
error
)
// Runs an aggregation query.
RunAggregationQuery
(
context
.
Context
,
*
RunAggregationQueryRequest
)
(
*
RunAggregationQueryResponse
,
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
)
}
DatastoreServer is the server API for Datastore service.
Entity
type
Entity
struct
{
Key
*
Key
`protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
Properties
map
[
string
]
*
Value
""
/* 161 byte string literal not displayed */
}
A Datastore data object.
Must not exceed 1 MiB - 4 bytes.
func (*Entity) Descriptor
Deprecated: Use Entity.ProtoReflect.Descriptor instead.
func (*Entity) GetKey
func (*Entity) GetProperties
func (*Entity) ProtoMessage
func
(
*
Entity
)
ProtoMessage
()
func (*Entity) ProtoReflect
func
(
x
*
Entity
)
ProtoReflect
()
protoreflect
.
Message
func (*Entity) Reset
func
(
x
*
Entity
)
Reset
()
func (*Entity) String
EntityResult
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.v1.EntityResult.ResultType.FULL] entity results.
//
// For [missing][google.datastore.v1.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"`
// The time at which the entity was created.
// This field is set for
// [`FULL`][google.datastore.v1.EntityResult.ResultType.FULL] entity results.
// If this entity is missing, this field will not be set.
CreateTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// The time at which the entity was last changed.
// This field is set for
// [`FULL`][google.datastore.v1.EntityResult.ResultType.FULL] entity results.
// If this entity is missing, this field will not be set.
UpdateTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,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
}
The result of fetching an entity from Datastore.
func (*EntityResult) Descriptor
func
(
*
EntityResult
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use EntityResult.ProtoReflect.Descriptor instead.
func (*EntityResult) GetCreateTime
func
(
x
*
EntityResult
)
GetCreateTime
()
*
timestamppb
.
Timestamp
func (*EntityResult) GetCursor
func
(
x
*
EntityResult
)
GetCursor
()
[]
byte
func (*EntityResult) GetEntity
func
(
x
*
EntityResult
)
GetEntity
()
*
Entity
func (*EntityResult) GetUpdateTime
func
(
x
*
EntityResult
)
GetUpdateTime
()
*
timestamppb
.
Timestamp
func (*EntityResult) GetVersion
func
(
x
*
EntityResult
)
GetVersion
()
int64
func (*EntityResult) ProtoMessage
func
(
*
EntityResult
)
ProtoMessage
()
func (*EntityResult) ProtoReflect
func
(
x
*
EntityResult
)
ProtoReflect
()
protoreflect
.
Message
func (*EntityResult) Reset
func
(
x
*
EntityResult
)
Reset
()
func (*EntityResult) String
func
(
x
*
EntityResult
)
String
()
string
EntityResult_ResultType
type
EntityResult_ResultType
int32
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
).
EntityResult_RESULT_TYPE_UNSPECIFIED, EntityResult_FULL, EntityResult_PROJECTION, EntityResult_KEY_ONLY
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
func
(
EntityResult_ResultType
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (EntityResult_ResultType) Enum
func
(
x
EntityResult_ResultType
)
Enum
()
*
EntityResult_ResultType
func (EntityResult_ResultType) EnumDescriptor
func
(
EntityResult_ResultType
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use EntityResult_ResultType.Descriptor instead.
func (EntityResult_ResultType) Number
func
(
x
EntityResult_ResultType
)
Number
()
protoreflect
.
EnumNumber
func (EntityResult_ResultType) String
func
(
x
EntityResult_ResultType
)
String
()
string
func (EntityResult_ResultType) Type
func
(
EntityResult_ResultType
)
Type
()
protoreflect
.
EnumType
ExecutionStats
type
ExecutionStats
struct
{
// Total number of results returned, including documents, projections,
// aggregation results, keys.
ResultsReturned
int64
`protobuf:"varint,1,opt,name=results_returned,json=resultsReturned,proto3" json:"results_returned,omitempty"`
// Total time to execute the query in the backend.
ExecutionDuration
*
durationpb
.
Duration
`protobuf:"bytes,3,opt,name=execution_duration,json=executionDuration,proto3" json:"execution_duration,omitempty"`
// Total billable read operations.
ReadOperations
int64
`protobuf:"varint,4,opt,name=read_operations,json=readOperations,proto3" json:"read_operations,omitempty"`
// Debugging statistics from the execution of the query. Note that the
// debugging stats are subject to change as Firestore evolves. It could
// include:
//
// {
// "indexes_entries_scanned": "1000",
// "documents_scanned": "20",
// "billing_details" : {
// "documents_billable": "20",
// "index_entries_billable": "1000",
// "min_query_cost": "0"
// }
// }
DebugStats
*
structpb
.
Struct
`protobuf:"bytes,5,opt,name=debug_stats,json=debugStats,proto3" json:"debug_stats,omitempty"`
// contains filtered or unexported fields
}
Execution statistics for the query.
func (*ExecutionStats) Descriptor
func
(
*
ExecutionStats
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ExecutionStats.ProtoReflect.Descriptor instead.
func (*ExecutionStats) GetDebugStats
func
(
x
*
ExecutionStats
)
GetDebugStats
()
*
structpb
.
Struct
func (*ExecutionStats) GetExecutionDuration
func
(
x
*
ExecutionStats
)
GetExecutionDuration
()
*
durationpb
.
Duration
func (*ExecutionStats) GetReadOperations
func
(
x
*
ExecutionStats
)
GetReadOperations
()
int64
func (*ExecutionStats) GetResultsReturned
func
(
x
*
ExecutionStats
)
GetResultsReturned
()
int64
func (*ExecutionStats) ProtoMessage
func
(
*
ExecutionStats
)
ProtoMessage
()
func (*ExecutionStats) ProtoReflect
func
(
x
*
ExecutionStats
)
ProtoReflect
()
protoreflect
.
Message
func (*ExecutionStats) Reset
func
(
x
*
ExecutionStats
)
Reset
()
func (*ExecutionStats) String
func
(
x
*
ExecutionStats
)
String
()
string
ExplainMetrics
type
ExplainMetrics
struct
{
// Planning phase information for the query.
PlanSummary
*
PlanSummary
`protobuf:"bytes,1,opt,name=plan_summary,json=planSummary,proto3" json:"plan_summary,omitempty"`
// Aggregated stats from the execution of the query. Only present when
// [ExplainOptions.analyze][google.datastore.v1.ExplainOptions.analyze] is set
// to true.
ExecutionStats
*
ExecutionStats
`protobuf:"bytes,2,opt,name=execution_stats,json=executionStats,proto3" json:"execution_stats,omitempty"`
// contains filtered or unexported fields
}
Explain metrics for the query.
func (*ExplainMetrics) Descriptor
func
(
*
ExplainMetrics
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ExplainMetrics.ProtoReflect.Descriptor instead.
func (*ExplainMetrics) GetExecutionStats
func
(
x
*
ExplainMetrics
)
GetExecutionStats
()
*
ExecutionStats
func (*ExplainMetrics) GetPlanSummary
func
(
x
*
ExplainMetrics
)
GetPlanSummary
()
*
PlanSummary
func (*ExplainMetrics) ProtoMessage
func
(
*
ExplainMetrics
)
ProtoMessage
()
func (*ExplainMetrics) ProtoReflect
func
(
x
*
ExplainMetrics
)
ProtoReflect
()
protoreflect
.
Message
func (*ExplainMetrics) Reset
func
(
x
*
ExplainMetrics
)
Reset
()
func (*ExplainMetrics) String
func
(
x
*
ExplainMetrics
)
String
()
string
ExplainOptions
type
ExplainOptions
struct
{
// Optional. Whether to execute this query.
//
// When false (the default), the query will be planned, returning only
// metrics from the planning stages.
//
// When true, the query will be planned and executed, returning the full
// query results along with both planning and execution stage metrics.
Analyze
bool
`protobuf:"varint,1,opt,name=analyze,proto3" json:"analyze,omitempty"`
// contains filtered or unexported fields
}
Explain options for the query.
func (*ExplainOptions) Descriptor
func
(
*
ExplainOptions
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ExplainOptions.ProtoReflect.Descriptor instead.
func (*ExplainOptions) GetAnalyze
func
(
x
*
ExplainOptions
)
GetAnalyze
()
bool
func (*ExplainOptions) ProtoMessage
func
(
*
ExplainOptions
)
ProtoMessage
()
func (*ExplainOptions) ProtoReflect
func
(
x
*
ExplainOptions
)
ProtoReflect
()
protoreflect
.
Message
func (*ExplainOptions) Reset
func
(
x
*
ExplainOptions
)
Reset
()
func (*ExplainOptions) String
func
(
x
*
ExplainOptions
)
String
()
string
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
}
A holder for any type of filter.
func (*Filter) Descriptor
Deprecated: Use Filter.ProtoReflect.Descriptor instead.
func (*Filter) GetCompositeFilter
func
(
x
*
Filter
)
GetCompositeFilter
()
*
CompositeFilter
func (*Filter) GetFilterType
func
(
m
*
Filter
)
GetFilterType
()
isFilter_FilterType
func (*Filter) GetPropertyFilter
func
(
x
*
Filter
)
GetPropertyFilter
()
*
PropertyFilter
func (*Filter) ProtoMessage
func
(
*
Filter
)
ProtoMessage
()
func (*Filter) ProtoReflect
func
(
x
*
Filter
)
ProtoReflect
()
protoreflect
.
Message
func (*Filter) Reset
func
(
x
*
Filter
)
Reset
()
func (*Filter) String
Filter_CompositeFilter
type
Filter_CompositeFilter
struct
{
// A composite filter.
CompositeFilter
*
CompositeFilter
`protobuf:"bytes,1,opt,name=composite_filter,json=compositeFilter,proto3,oneof"`
}
Filter_PropertyFilter
type
Filter_PropertyFilter
struct
{
// A filter on a property.
PropertyFilter
*
PropertyFilter
`protobuf:"bytes,2,opt,name=property_filter,json=propertyFilter,proto3,oneof"`
}
GqlQuery
type
GqlQuery
struct
{
QueryString
string
`protobuf:"bytes,1,opt,name=query_string,json=queryString,proto3" json:"query_string,omitempty"`
AllowLiterals
bool
`protobuf:"varint,2,opt,name=allow_literals,json=allowLiterals,proto3" json:"allow_literals,omitempty"`
NamedBindings
map
[
string
]
*
GqlQueryParameter
""
/* 188 byte string literal not displayed */
PositionalBindings
[]
*
GqlQueryParameter
`protobuf:"bytes,4,rep,name=positional_bindings,json=positionalBindings,proto3" json:"positional_bindings,omitempty"`
}
A GQL query .
func (*GqlQuery) Descriptor
Deprecated: Use GqlQuery.ProtoReflect.Descriptor instead.
func (*GqlQuery) GetAllowLiterals
func (*GqlQuery) GetNamedBindings
func
(
x
*
GqlQuery
)
GetNamedBindings
()
map
[
string
]
*
GqlQueryParameter
func (*GqlQuery) GetPositionalBindings
func
(
x
*
GqlQuery
)
GetPositionalBindings
()
[]
*
GqlQueryParameter
func (*GqlQuery) GetQueryString
func (*GqlQuery) ProtoMessage
func
(
*
GqlQuery
)
ProtoMessage
()
func (*GqlQuery) ProtoReflect
func
(
x
*
GqlQuery
)
ProtoReflect
()
protoreflect
.
Message
func (*GqlQuery) Reset
func
(
x
*
GqlQuery
)
Reset
()
func (*GqlQuery) String
GqlQueryParameter
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
}
A binding parameter for a GQL query.
func (*GqlQueryParameter) Descriptor
func
(
*
GqlQueryParameter
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use GqlQueryParameter.ProtoReflect.Descriptor instead.
func (*GqlQueryParameter) GetCursor
func
(
x
*
GqlQueryParameter
)
GetCursor
()
[]
byte
func (*GqlQueryParameter) GetParameterType
func
(
m
*
GqlQueryParameter
)
GetParameterType
()
isGqlQueryParameter_ParameterType
func (*GqlQueryParameter) GetValue
func
(
x
*
GqlQueryParameter
)
GetValue
()
*
Value
func (*GqlQueryParameter) ProtoMessage
func
(
*
GqlQueryParameter
)
ProtoMessage
()
func (*GqlQueryParameter) ProtoReflect
func
(
x
*
GqlQueryParameter
)
ProtoReflect
()
protoreflect
.
Message
func (*GqlQueryParameter) Reset
func
(
x
*
GqlQueryParameter
)
Reset
()
func (*GqlQueryParameter) String
func
(
x
*
GqlQueryParameter
)
String
()
string
GqlQueryParameter_Cursor
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"`
}
GqlQueryParameter_Value
type
GqlQueryParameter_Value
struct
{
// A value parameter.
Value
*
Value
`protobuf:"bytes,2,opt,name=value,proto3,oneof"`
}
Key
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
}
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.
func (*Key) Descriptor
Deprecated: Use Key.ProtoReflect.Descriptor instead.
func (*Key) GetPartitionId
func
(
x
*
Key
)
GetPartitionId
()
*
PartitionId
func (*Key) GetPath
func
(
x
*
Key
)
GetPath
()
[]
*
Key_PathElement
func (*Key) ProtoMessage
func
(
*
Key
)
ProtoMessage
()
func (*Key) ProtoReflect
func
(
x
*
Key
)
ProtoReflect
()
protoreflect
.
Message
func (*Key) Reset
func
(
x
*
Key
)
Reset
()
func (*Key) String
Key_PathElement
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 `""`.
//
// Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
// encoded as `__bytes
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.
func (*Key_PathElement) Descriptor
func
(
*
Key_PathElement
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use Key_PathElement.ProtoReflect.Descriptor instead.
func (*Key_PathElement) GetId
func
(
x
*
Key_PathElement
)
GetId
()
int64
func (*Key_PathElement) GetIdType
func
(
m
*
Key_PathElement
)
GetIdType
()
isKey_PathElement_IdType
func (*Key_PathElement) GetKind
func
(
x
*
Key_PathElement
)
GetKind
()
string
func (*Key_PathElement) GetName
func
(
x
*
Key_PathElement
)
GetName
()
string
func (*Key_PathElement) ProtoMessage
func
(
*
Key_PathElement
)
ProtoMessage
()
func (*Key_PathElement) ProtoReflect
func
(
x
*
Key_PathElement
)
ProtoReflect
()
protoreflect
.
Message
func (*Key_PathElement) Reset
func
(
x
*
Key_PathElement
)
Reset
()
func (*Key_PathElement) String
func
(
x
*
Key_PathElement
)
String
()
string
Key_PathElement_Id
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"`
}
Key_PathElement_Name
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 `""`.
//
// Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
// encoded as `__bytes
KindExpression
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
}
A representation of a kind.
func (*KindExpression) Descriptor
func
(
*
KindExpression
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use KindExpression.ProtoReflect.Descriptor instead.
func (*KindExpression) GetName
func
(
x
*
KindExpression
)
GetName
()
string
func (*KindExpression) ProtoMessage
func
(
*
KindExpression
)
ProtoMessage
()
func (*KindExpression) ProtoReflect
func
(
x
*
KindExpression
)
ProtoReflect
()
protoreflect
.
Message
func (*KindExpression) Reset
func
(
x
*
KindExpression
)
Reset
()
func (*KindExpression) String
func
(
x
*
KindExpression
)
String
()
string
LookupRequest
type
LookupRequest
struct
{
// Required. 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 ID of the database against which to make the request.
//
// '(default)' is not allowed; please use empty string ” to refer the default
// database.
DatabaseId
string
`protobuf:"bytes,9,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
// The options for this lookup request.
ReadOptions
*
ReadOptions
`protobuf:"bytes,1,opt,name=read_options,json=readOptions,proto3" json:"read_options,omitempty"`
// Required. Keys of entities to look up.
Keys
[]
*
Key
`protobuf:"bytes,3,rep,name=keys,proto3" json:"keys,omitempty"`
// The properties to return. Defaults to returning all properties.
//
// If this field is set and an entity has a property not referenced in the
// mask, it will be absent from [LookupResponse.found.entity.properties][].
//
// The entity's key is always returned.
PropertyMask
*
PropertyMask
`protobuf:"bytes,5,opt,name=property_mask,json=propertyMask,proto3" json:"property_mask,omitempty"`
// contains filtered or unexported fields
}
The request for [Datastore.Lookup][google.datastore.v1.Datastore.Lookup].
func (*LookupRequest) Descriptor
func
(
*
LookupRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use LookupRequest.ProtoReflect.Descriptor instead.
func (*LookupRequest) GetDatabaseId
func
(
x
*
LookupRequest
)
GetDatabaseId
()
string
func (*LookupRequest) GetKeys
func
(
x
*
LookupRequest
)
GetKeys
()
[]
*
Key
func (*LookupRequest) GetProjectId
func
(
x
*
LookupRequest
)
GetProjectId
()
string
func (*LookupRequest) GetPropertyMask
func
(
x
*
LookupRequest
)
GetPropertyMask
()
*
PropertyMask
func (*LookupRequest) GetReadOptions
func
(
x
*
LookupRequest
)
GetReadOptions
()
*
ReadOptions
func (*LookupRequest) ProtoMessage
func
(
*
LookupRequest
)
ProtoMessage
()
func (*LookupRequest) ProtoReflect
func
(
x
*
LookupRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*LookupRequest) Reset
func
(
x
*
LookupRequest
)
Reset
()
func (*LookupRequest) String
func
(
x
*
LookupRequest
)
String
()
string
LookupResponse
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"`
// The identifier of the transaction that was started as part of this Lookup
// request.
//
// Set only when
// [ReadOptions.new_transaction][google.datastore.v1.ReadOptions.new_transaction]
// was set in
// [LookupRequest.read_options][google.datastore.v1.LookupRequest.read_options].
Transaction
[]
byte
`protobuf:"bytes,5,opt,name=transaction,proto3" json:"transaction,omitempty"`
// The time at which these entities were read or found missing.
ReadTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,7,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
// contains filtered or unexported fields
}
The response for [Datastore.Lookup][google.datastore.v1.Datastore.Lookup].
func (*LookupResponse) Descriptor
func
(
*
LookupResponse
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use LookupResponse.ProtoReflect.Descriptor instead.
func (*LookupResponse) GetDeferred
func
(
x
*
LookupResponse
)
GetDeferred
()
[]
*
Key
func (*LookupResponse) GetFound
func
(
x
*
LookupResponse
)
GetFound
()
[]
*
EntityResult
func (*LookupResponse) GetMissing
func
(
x
*
LookupResponse
)
GetMissing
()
[]
*
EntityResult
func (*LookupResponse) GetReadTime
func
(
x
*
LookupResponse
)
GetReadTime
()
*
timestamppb
.
Timestamp
func (*LookupResponse) GetTransaction
func
(
x
*
LookupResponse
)
GetTransaction
()
[]
byte
func (*LookupResponse) ProtoMessage
func
(
*
LookupResponse
)
ProtoMessage
()
func (*LookupResponse) ProtoReflect
func
(
x
*
LookupResponse
)
ProtoReflect
()
protoreflect
.
Message
func (*LookupResponse) Reset
func
(
x
*
LookupResponse
)
Reset
()
func (*LookupResponse) String
func
(
x
*
LookupResponse
)
String
()
string
Mutation
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
// *Mutation_UpdateTime
ConflictDetectionStrategy
isMutation_ConflictDetectionStrategy
`protobuf_oneof:"conflict_detection_strategy"`
// The properties to write in this mutation.
// None of the properties in the mask may have a reserved name, except for
// `__key__`.
// This field is ignored for `delete`.
//
// If the entity already exists, only properties referenced in the mask are
// updated, others are left untouched.
// Properties referenced in the mask but not in the entity are deleted.
PropertyMask
*
PropertyMask
`protobuf:"bytes,9,opt,name=property_mask,json=propertyMask,proto3" json:"property_mask,omitempty"`
// contains filtered or unexported fields
}
A mutation to apply to an entity.
func (*Mutation) Descriptor
Deprecated: Use Mutation.ProtoReflect.Descriptor instead.
func (*Mutation) GetBaseVersion
func (*Mutation) GetConflictDetectionStrategy
func
(
m
*
Mutation
)
GetConflictDetectionStrategy
()
isMutation_ConflictDetectionStrategy
func (*Mutation) GetDelete
func (*Mutation) GetInsert
func (*Mutation) GetOperation
func
(
m
*
Mutation
)
GetOperation
()
isMutation_Operation
func (*Mutation) GetPropertyMask
func
(
x
*
Mutation
)
GetPropertyMask
()
*
PropertyMask
func (*Mutation) GetUpdate
func (*Mutation) GetUpdateTime
func
(
x
*
Mutation
)
GetUpdateTime
()
*
timestamppb
.
Timestamp
func (*Mutation) GetUpsert
func (*Mutation) ProtoMessage
func
(
*
Mutation
)
ProtoMessage
()
func (*Mutation) ProtoReflect
func
(
x
*
Mutation
)
ProtoReflect
()
protoreflect
.
Message
func (*Mutation) Reset
func
(
x
*
Mutation
)
Reset
()
func (*Mutation) String
MutationResult
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"`
// The create time of the entity. This field will not be set after a 'delete'.
CreateTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// The update time of the entity on the server after processing the mutation.
// If the mutation doesn't change anything on the server, then the timestamp
// will be the update timestamp of the current entity. This field will not be
// set after a 'delete'.
UpdateTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,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
}
The result of applying a mutation.
func (*MutationResult) Descriptor
func
(
*
MutationResult
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use MutationResult.ProtoReflect.Descriptor instead.
func (*MutationResult) GetConflictDetected
func
(
x
*
MutationResult
)
GetConflictDetected
()
bool
func (*MutationResult) GetCreateTime
func
(
x
*
MutationResult
)
GetCreateTime
()
*
timestamppb
.
Timestamp
func (*MutationResult) GetKey
func
(
x
*
MutationResult
)
GetKey
()
*
Key
func (*MutationResult) GetUpdateTime
func
(
x
*
MutationResult
)
GetUpdateTime
()
*
timestamppb
.
Timestamp
func (*MutationResult) GetVersion
func
(
x
*
MutationResult
)
GetVersion
()
int64
func (*MutationResult) ProtoMessage
func
(
*
MutationResult
)
ProtoMessage
()
func (*MutationResult) ProtoReflect
func
(
x
*
MutationResult
)
ProtoReflect
()
protoreflect
.
Message
func (*MutationResult) Reset
func
(
x
*
MutationResult
)
Reset
()
func (*MutationResult) String
func
(
x
*
MutationResult
)
String
()
string
Mutation_BaseVersion
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"`
}
Mutation_Delete
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"`
}
Mutation_Insert
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"`
}
Mutation_Update
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"`
}
Mutation_UpdateTime
type
Mutation_UpdateTime
struct
{
// The update time of the entity that this mutation is being applied
// to. If this does not match the current update time on the server, the
// mutation conflicts.
UpdateTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,11,opt,name=update_time,json=updateTime,proto3,oneof"`
}
Mutation_Upsert
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"`
}
PartitionId
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 database to which the entities
// belong.
DatabaseId
string
`protobuf:"bytes,3,opt,name=database_id,json=databaseId,proto3" json:"database_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
}
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.
func (*PartitionId) Descriptor
func
(
*
PartitionId
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use PartitionId.ProtoReflect.Descriptor instead.
func (*PartitionId) GetDatabaseId
func
(
x
*
PartitionId
)
GetDatabaseId
()
string
func (*PartitionId) GetNamespaceId
func
(
x
*
PartitionId
)
GetNamespaceId
()
string
func (*PartitionId) GetProjectId
func
(
x
*
PartitionId
)
GetProjectId
()
string
func (*PartitionId) ProtoMessage
func
(
*
PartitionId
)
ProtoMessage
()
func (*PartitionId) ProtoReflect
func
(
x
*
PartitionId
)
ProtoReflect
()
protoreflect
.
Message
func (*PartitionId) Reset
func
(
x
*
PartitionId
)
Reset
()
func (*PartitionId) String
func
(
x
*
PartitionId
)
String
()
string
PlanSummary
type
PlanSummary
struct
{
// The indexes selected for the query. For example:
//
// [
// {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"},
// {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"}
// ]
IndexesUsed
[]
*
structpb
.
Struct
`protobuf:"bytes,1,rep,name=indexes_used,json=indexesUsed,proto3" json:"indexes_used,omitempty"`
// contains filtered or unexported fields
}
Planning phase information for the query.
func (*PlanSummary) Descriptor
func
(
*
PlanSummary
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use PlanSummary.ProtoReflect.Descriptor instead.
func (*PlanSummary) GetIndexesUsed
func
(
x
*
PlanSummary
)
GetIndexesUsed
()
[]
*
structpb
.
Struct
func (*PlanSummary) ProtoMessage
func
(
*
PlanSummary
)
ProtoMessage
()
func (*PlanSummary) ProtoReflect
func
(
x
*
PlanSummary
)
ProtoReflect
()
protoreflect
.
Message
func (*PlanSummary) Reset
func
(
x
*
PlanSummary
)
Reset
()
func (*PlanSummary) String
func
(
x
*
PlanSummary
)
String
()
string
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
}
A representation of a property in a projection.
func (*Projection) Descriptor
func
(
*
Projection
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use Projection.ProtoReflect.Descriptor instead.
func (*Projection) GetProperty
func
(
x
*
Projection
)
GetProperty
()
*
PropertyReference
func (*Projection) ProtoMessage
func
(
*
Projection
)
ProtoMessage
()
func (*Projection) ProtoReflect
func
(
x
*
Projection
)
ProtoReflect
()
protoreflect
.
Message
func (*Projection) Reset
func
(
x
*
Projection
)
Reset
()
func (*Projection) String
func
(
x
*
Projection
)
String
()
string
PropertyFilter
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.v1.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
}
A filter on a specific property.
func (*PropertyFilter) Descriptor
func
(
*
PropertyFilter
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use PropertyFilter.ProtoReflect.Descriptor instead.
func (*PropertyFilter) GetOp
func
(
x
*
PropertyFilter
)
GetOp
()
PropertyFilter_Operator
func (*PropertyFilter) GetProperty
func
(
x
*
PropertyFilter
)
GetProperty
()
*
PropertyReference
func (*PropertyFilter) GetValue
func
(
x
*
PropertyFilter
)
GetValue
()
*
Value
func (*PropertyFilter) ProtoMessage
func
(
*
PropertyFilter
)
ProtoMessage
()
func (*PropertyFilter) ProtoReflect
func
(
x
*
PropertyFilter
)
ProtoReflect
()
protoreflect
.
Message
func (*PropertyFilter) Reset
func
(
x
*
PropertyFilter
)
Reset
()
func (*PropertyFilter) String
func
(
x
*
PropertyFilter
)
String
()
string
PropertyFilter_Operator
type
PropertyFilter_Operator
int32
A property filter operator.
PropertyFilter_OPERATOR_UNSPECIFIED, PropertyFilter_LESS_THAN, PropertyFilter_LESS_THAN_OR_EQUAL, PropertyFilter_GREATER_THAN, PropertyFilter_GREATER_THAN_OR_EQUAL, PropertyFilter_EQUAL, PropertyFilter_IN, PropertyFilter_NOT_EQUAL, PropertyFilter_HAS_ANCESTOR, PropertyFilter_NOT_IN
const
(
// Unspecified. This value must not be used.
PropertyFilter_OPERATOR_UNSPECIFIED
PropertyFilter_Operator
=
0
// The given `property` is less than the given `value`.
//
// Requires:
//
// * That `property` comes first in `order_by`.
PropertyFilter_LESS_THAN
PropertyFilter_Operator
=
1
// The given `property` is less than or equal to the given `value`.
//
// Requires:
//
// * That `property` comes first in `order_by`.
PropertyFilter_LESS_THAN_OR_EQUAL
PropertyFilter_Operator
=
2
// The given `property` is greater than the given `value`.
//
// Requires:
//
// * That `property` comes first in `order_by`.
PropertyFilter_GREATER_THAN
PropertyFilter_Operator
=
3
// The given `property` is greater than or equal to the given `value`.
//
// Requires:
//
// * That `property` comes first in `order_by`.
PropertyFilter_GREATER_THAN_OR_EQUAL
PropertyFilter_Operator
=
4
// The given `property` is equal to the given `value`.
PropertyFilter_EQUAL
PropertyFilter_Operator
=
5
// The given `property` is equal to at least one value in the given array.
//
// Requires:
//
// - That `value` is a non-empty `ArrayValue`, subject to disjunction
// limits.
// - No `NOT_IN` is in the same query.
PropertyFilter_IN
PropertyFilter_Operator
=
6
// The given `property` is not equal to the given `value`.
//
// Requires:
//
// * No other `NOT_EQUAL` or `NOT_IN` is in the same query.
// * That `property` comes first in the `order_by`.
PropertyFilter_NOT_EQUAL
PropertyFilter_Operator
=
9
// Limit the result set to the given entity and its descendants.
//
// Requires:
//
// * That `value` is an entity key.
// * All evaluated disjunctions must have the same `HAS_ANCESTOR` filter.
PropertyFilter_HAS_ANCESTOR
PropertyFilter_Operator
=
11
// The value of the `property` is not in the given array.
//
// Requires:
//
// * That `value` is a non-empty `ArrayValue` with at most 10 values.
// * No other `OR`, `IN`, `NOT_IN`, `NOT_EQUAL` is in the same query.
// * That `field` comes first in the `order_by`.
PropertyFilter_NOT_IN
PropertyFilter_Operator
=
13
)
func (PropertyFilter_Operator) Descriptor
func
(
PropertyFilter_Operator
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (PropertyFilter_Operator) Enum
func
(
x
PropertyFilter_Operator
)
Enum
()
*
PropertyFilter_Operator
func (PropertyFilter_Operator) EnumDescriptor
func
(
PropertyFilter_Operator
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use PropertyFilter_Operator.Descriptor instead.
func (PropertyFilter_Operator) Number
func
(
x
PropertyFilter_Operator
)
Number
()
protoreflect
.
EnumNumber
func (PropertyFilter_Operator) String
func
(
x
PropertyFilter_Operator
)
String
()
string
func (PropertyFilter_Operator) Type
func
(
PropertyFilter_Operator
)
Type
()
protoreflect
.
EnumType
PropertyMask
type
PropertyMask
struct
{
// The paths to the properties covered by this mask.
//
// A path is a list of property names separated by dots (`.`), for example
// `foo.bar` means the property `bar` inside the entity property `foo` inside
// the entity associated with this path.
//
// If a property name contains a dot `.` or a backslash `\`, then that
// name must be escaped.
//
// A path must not be empty, and may not reference a value inside an
// [array value][google.datastore.v1.Value.array_value].
Paths
[]
string
`protobuf:"bytes,1,rep,name=paths,proto3" json:"paths,omitempty"`
// contains filtered or unexported fields
}
The set of arbitrarily nested property paths used to restrict an operation to only a subset of properties in an entity.
func (*PropertyMask) Descriptor
func
(
*
PropertyMask
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use PropertyMask.ProtoReflect.Descriptor instead.
func (*PropertyMask) GetPaths
func
(
x
*
PropertyMask
)
GetPaths
()
[]
string
func (*PropertyMask) ProtoMessage
func
(
*
PropertyMask
)
ProtoMessage
()
func (*PropertyMask) ProtoReflect
func
(
x
*
PropertyMask
)
ProtoReflect
()
protoreflect
.
Message
func (*PropertyMask) Reset
func
(
x
*
PropertyMask
)
Reset
()
func (*PropertyMask) String
func
(
x
*
PropertyMask
)
String
()
string
PropertyOrder
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.v1.PropertyOrder_Direction" json:"direction,omitempty"`
// contains filtered or unexported fields
}
The desired order for a specific property.
func (*PropertyOrder) Descriptor
func
(
*
PropertyOrder
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use PropertyOrder.ProtoReflect.Descriptor instead.
func (*PropertyOrder) GetDirection
func
(
x
*
PropertyOrder
)
GetDirection
()
PropertyOrder_Direction
func (*PropertyOrder) GetProperty
func
(
x
*
PropertyOrder
)
GetProperty
()
*
PropertyReference
func (*PropertyOrder) ProtoMessage
func
(
*
PropertyOrder
)
ProtoMessage
()
func (*PropertyOrder) ProtoReflect
func
(
x
*
PropertyOrder
)
ProtoReflect
()
protoreflect
.
Message
func (*PropertyOrder) Reset
func
(
x
*
PropertyOrder
)
Reset
()
func (*PropertyOrder) String
func
(
x
*
PropertyOrder
)
String
()
string
PropertyOrder_Direction
type
PropertyOrder_Direction
int32
The sort direction.
PropertyOrder_DIRECTION_UNSPECIFIED, PropertyOrder_ASCENDING, PropertyOrder_DESCENDING
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
func
(
PropertyOrder_Direction
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (PropertyOrder_Direction) Enum
func
(
x
PropertyOrder_Direction
)
Enum
()
*
PropertyOrder_Direction
func (PropertyOrder_Direction) EnumDescriptor
func
(
PropertyOrder_Direction
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use PropertyOrder_Direction.Descriptor instead.
func (PropertyOrder_Direction) Number
func
(
x
PropertyOrder_Direction
)
Number
()
protoreflect
.
EnumNumber
func (PropertyOrder_Direction) String
func
(
x
PropertyOrder_Direction
)
String
()
string
func (PropertyOrder_Direction) Type
func
(
PropertyOrder_Direction
)
Type
()
protoreflect
.
EnumType
PropertyReference
type
PropertyReference
struct
{
// A reference to a property.
//
// Requires:
//
// * MUST be a dot-delimited (`.`) string of segments, where each segment
// conforms to [entity property name][google.datastore.v1.Entity.properties]
// limitations.
Name
string
`protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
A reference to a property relative to the kind expressions.
func (*PropertyReference) Descriptor
func
(
*
PropertyReference
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use PropertyReference.ProtoReflect.Descriptor instead.
func (*PropertyReference) GetName
func
(
x
*
PropertyReference
)
GetName
()
string
func (*PropertyReference) ProtoMessage
func
(
*
PropertyReference
)
ProtoMessage
()
func (*PropertyReference) ProtoReflect
func
(
x
*
PropertyReference
)
ProtoReflect
()
protoreflect
.
Message
func (*PropertyReference) Reset
func
(
x
*
PropertyReference
)
Reset
()
func (*PropertyReference) String
func
(
x
*
PropertyReference
)
String
()
string
Query
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).
//
// Requires:
//
// * If `order` is specified, the set of distinct on properties must appear
// before the non-distinct on properties in `order`.
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
}
A query for entities.
func (*Query) Descriptor
Deprecated: Use Query.ProtoReflect.Descriptor instead.
func (*Query) GetDistinctOn
func
(
x
*
Query
)
GetDistinctOn
()
[]
*
PropertyReference
func (*Query) GetEndCursor
func (*Query) GetFilter
func (*Query) GetKind
func
(
x
*
Query
)
GetKind
()
[]
*
KindExpression
func (*Query) GetLimit
func
(
x
*
Query
)
GetLimit
()
*
wrapperspb
.
Int32Value
func (*Query) GetOffset
func (*Query) GetOrder
func
(
x
*
Query
)
GetOrder
()
[]
*
PropertyOrder
func (*Query) GetProjection
func
(
x
*
Query
)
GetProjection
()
[]
*
Projection
func (*Query) GetStartCursor
func (*Query) ProtoMessage
func
(
*
Query
)
ProtoMessage
()
func (*Query) ProtoReflect
func
(
x
*
Query
)
ProtoReflect
()
protoreflect
.
Message
func (*Query) Reset
func
(
x
*
Query
)
Reset
()
func (*Query) String
QueryResultBatch
type
QueryResultBatch
struct
{
SkippedResults
int32
`protobuf:"varint,6,opt,name=skipped_results,json=skippedResults,proto3" json:"skipped_results,omitempty"`
SkippedCursor
[]
byte
`protobuf:"bytes,3,opt,name=skipped_cursor,json=skippedCursor,proto3" json:"skipped_cursor,omitempty"`
EntityResultType
EntityResult_ResultType
""
/* 161 byte string literal not displayed */
EntityResults
[]
*
EntityResult
`protobuf:"bytes,2,rep,name=entity_results,json=entityResults,proto3" json:"entity_results,omitempty"`
EndCursor
[]
byte
`protobuf:"bytes,4,opt,name=end_cursor,json=endCursor,proto3" json:"end_cursor,omitempty"`
MoreResults
QueryResultBatch_MoreResultsType
""
/* 153 byte string literal not displayed */
SnapshotVersion
int64
`protobuf:"varint,7,opt,name=snapshot_version,json=snapshotVersion,proto3" json:"snapshot_version,omitempty"`
ReadTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,8,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
}
A batch of results produced by a query.
func (*QueryResultBatch) Descriptor
func
(
*
QueryResultBatch
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use QueryResultBatch.ProtoReflect.Descriptor instead.
func (*QueryResultBatch) GetEndCursor
func
(
x
*
QueryResultBatch
)
GetEndCursor
()
[]
byte
func (*QueryResultBatch) GetEntityResultType
func
(
x
*
QueryResultBatch
)
GetEntityResultType
()
EntityResult_ResultType
func (*QueryResultBatch) GetEntityResults
func
(
x
*
QueryResultBatch
)
GetEntityResults
()
[]
*
EntityResult
func (*QueryResultBatch) GetMoreResults
func
(
x
*
QueryResultBatch
)
GetMoreResults
()
QueryResultBatch_MoreResultsType
func (*QueryResultBatch) GetReadTime
func
(
x
*
QueryResultBatch
)
GetReadTime
()
*
timestamppb
.
Timestamp
func (*QueryResultBatch) GetSkippedCursor
func
(
x
*
QueryResultBatch
)
GetSkippedCursor
()
[]
byte
func (*QueryResultBatch) GetSkippedResults
func
(
x
*
QueryResultBatch
)
GetSkippedResults
()
int32
func (*QueryResultBatch) GetSnapshotVersion
func
(
x
*
QueryResultBatch
)
GetSnapshotVersion
()
int64
func (*QueryResultBatch) ProtoMessage
func
(
*
QueryResultBatch
)
ProtoMessage
()
func (*QueryResultBatch) ProtoReflect
func
(
x
*
QueryResultBatch
)
ProtoReflect
()
protoreflect
.
Message
func (*QueryResultBatch) Reset
func
(
x
*
QueryResultBatch
)
Reset
()
func (*QueryResultBatch) String
func
(
x
*
QueryResultBatch
)
String
()
string
QueryResultBatch_MoreResultsType
type
QueryResultBatch_MoreResultsType
int32
The possible values for the more_results
field.
QueryResultBatch_MORE_RESULTS_TYPE_UNSPECIFIED, QueryResultBatch_NOT_FINISHED, QueryResultBatch_MORE_RESULTS_AFTER_LIMIT, QueryResultBatch_MORE_RESULTS_AFTER_CURSOR, QueryResultBatch_NO_MORE_RESULTS
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
func
(
QueryResultBatch_MoreResultsType
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (QueryResultBatch_MoreResultsType) Enum
func
(
x
QueryResultBatch_MoreResultsType
)
Enum
()
*
QueryResultBatch_MoreResultsType
func (QueryResultBatch_MoreResultsType) EnumDescriptor
func
(
QueryResultBatch_MoreResultsType
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use QueryResultBatch_MoreResultsType.Descriptor instead.
func (QueryResultBatch_MoreResultsType) Number
func
(
x
QueryResultBatch_MoreResultsType
)
Number
()
protoreflect
.
EnumNumber
func (QueryResultBatch_MoreResultsType) String
func
(
x
QueryResultBatch_MoreResultsType
)
String
()
string
func (QueryResultBatch_MoreResultsType) Type
func
(
QueryResultBatch_MoreResultsType
)
Type
()
protoreflect
.
EnumType
ReadOptions
type
ReadOptions
struct
{
// For Cloud Datastore, if read_consistency is not specified, then lookups and
// ancestor queries default to `read_consistency`=`STRONG`, global queries
// default to `read_consistency`=`EVENTUAL`.
//
// For Cloud Firestore in Datastore mode, if read_consistency is not specified
// then lookups and all queries default to `read_consistency`=`STRONG`.
//
// Explicitly setting `read_consistency`=`EVENTUAL` will result in eventually
// consistent lookups & queries in both Cloud Datastore & Cloud Firestore in
// Datastore mode.
//
// Types that are assignable to ConsistencyType:
//
// *ReadOptions_ReadConsistency_
// *ReadOptions_Transaction
// *ReadOptions_NewTransaction
// *ReadOptions_ReadTime
ConsistencyType
isReadOptions_ConsistencyType
`protobuf_oneof:"consistency_type"`
// contains filtered or unexported fields
}
The options shared by read requests.
func (*ReadOptions) Descriptor
func
(
*
ReadOptions
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ReadOptions.ProtoReflect.Descriptor instead.
func (*ReadOptions) GetConsistencyType
func
(
m
*
ReadOptions
)
GetConsistencyType
()
isReadOptions_ConsistencyType
func (*ReadOptions) GetNewTransaction
func
(
x
*
ReadOptions
)
GetNewTransaction
()
*
TransactionOptions
func (*ReadOptions) GetReadConsistency
func
(
x
*
ReadOptions
)
GetReadConsistency
()
ReadOptions_ReadConsistency
func (*ReadOptions) GetReadTime
func
(
x
*
ReadOptions
)
GetReadTime
()
*
timestamppb
.
Timestamp
func (*ReadOptions) GetTransaction
func
(
x
*
ReadOptions
)
GetTransaction
()
[]
byte
func (*ReadOptions) ProtoMessage
func
(
*
ReadOptions
)
ProtoMessage
()
func (*ReadOptions) ProtoReflect
func
(
x
*
ReadOptions
)
ProtoReflect
()
protoreflect
.
Message
func (*ReadOptions) Reset
func
(
x
*
ReadOptions
)
Reset
()
func (*ReadOptions) String
func
(
x
*
ReadOptions
)
String
()
string
ReadOptions_NewTransaction
type
ReadOptions_NewTransaction
struct
{
// Options for beginning a new transaction for this request.
//
// The new transaction identifier will be returned in the corresponding
// response as either
// [LookupResponse.transaction][google.datastore.v1.LookupResponse.transaction]
// or
// [RunQueryResponse.transaction][google.datastore.v1.RunQueryResponse.transaction].
NewTransaction
*
TransactionOptions
`protobuf:"bytes,3,opt,name=new_transaction,json=newTransaction,proto3,oneof"`
}
ReadOptions_ReadConsistency
type
ReadOptions_ReadConsistency
int32
The possible values for read consistencies.
ReadOptions_READ_CONSISTENCY_UNSPECIFIED, ReadOptions_STRONG, ReadOptions_EVENTUAL
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
func
(
ReadOptions_ReadConsistency
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (ReadOptions_ReadConsistency) Enum
func
(
x
ReadOptions_ReadConsistency
)
Enum
()
*
ReadOptions_ReadConsistency
func (ReadOptions_ReadConsistency) EnumDescriptor
func
(
ReadOptions_ReadConsistency
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ReadOptions_ReadConsistency.Descriptor instead.
func (ReadOptions_ReadConsistency) Number
func
(
x
ReadOptions_ReadConsistency
)
Number
()
protoreflect
.
EnumNumber
func (ReadOptions_ReadConsistency) String
func
(
x
ReadOptions_ReadConsistency
)
String
()
string
func (ReadOptions_ReadConsistency) Type
func
(
ReadOptions_ReadConsistency
)
Type
()
protoreflect
.
EnumType
ReadOptions_ReadConsistency_
type
ReadOptions_ReadConsistency_
struct
{
ReadConsistency
ReadOptions_ReadConsistency
""
/* 132 byte string literal not displayed */
}
ReadOptions_ReadTime
type
ReadOptions_ReadTime
struct
{
// Reads entities as they were at the given time. This value is only
// supported for Cloud Firestore in Datastore mode.
//
// This must be a microsecond precision timestamp within the past one hour,
// or if Point-in-Time Recovery is enabled, can additionally be a whole
// minute timestamp within the past 7 days.
ReadTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,4,opt,name=read_time,json=readTime,proto3,oneof"`
}
ReadOptions_Transaction
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.v1.Datastore.BeginTransaction].
Transaction
[]
byte
`protobuf:"bytes,2,opt,name=transaction,proto3,oneof"`
}
ReserveIdsRequest
type
ReserveIdsRequest
struct
{
// Required. 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 ID of the database against which to make the request.
//
// '(default)' is not allowed; please use empty string ” to refer the default
// database.
DatabaseId
string
`protobuf:"bytes,9,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
// Required. 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
}
The request for [Datastore.ReserveIds][google.datastore.v1.Datastore.ReserveIds].
func (*ReserveIdsRequest) Descriptor
func
(
*
ReserveIdsRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ReserveIdsRequest.ProtoReflect.Descriptor instead.
func (*ReserveIdsRequest) GetDatabaseId
func
(
x
*
ReserveIdsRequest
)
GetDatabaseId
()
string
func (*ReserveIdsRequest) GetKeys
func
(
x
*
ReserveIdsRequest
)
GetKeys
()
[]
*
Key
func (*ReserveIdsRequest) GetProjectId
func
(
x
*
ReserveIdsRequest
)
GetProjectId
()
string
func (*ReserveIdsRequest) ProtoMessage
func
(
*
ReserveIdsRequest
)
ProtoMessage
()
func (*ReserveIdsRequest) ProtoReflect
func
(
x
*
ReserveIdsRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*ReserveIdsRequest) Reset
func
(
x
*
ReserveIdsRequest
)
Reset
()
func (*ReserveIdsRequest) String
func
(
x
*
ReserveIdsRequest
)
String
()
string
ReserveIdsResponse
type
ReserveIdsResponse
struct
{
// contains filtered or unexported fields
}
The response for [Datastore.ReserveIds][google.datastore.v1.Datastore.ReserveIds].
func (*ReserveIdsResponse) Descriptor
func
(
*
ReserveIdsResponse
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ReserveIdsResponse.ProtoReflect.Descriptor instead.
func (*ReserveIdsResponse) ProtoMessage
func
(
*
ReserveIdsResponse
)
ProtoMessage
()
func (*ReserveIdsResponse) ProtoReflect
func
(
x
*
ReserveIdsResponse
)
ProtoReflect
()
protoreflect
.
Message
func (*ReserveIdsResponse) Reset
func
(
x
*
ReserveIdsResponse
)
Reset
()
func (*ReserveIdsResponse) String
func
(
x
*
ReserveIdsResponse
)
String
()
string
RollbackRequest
type
RollbackRequest
struct
{
// Required. 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 ID of the database against which to make the request.
//
// '(default)' is not allowed; please use empty string ” to refer the default
// database.
DatabaseId
string
`protobuf:"bytes,9,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
// Required. The transaction identifier, returned by a call to
// [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
Transaction
[]
byte
`protobuf:"bytes,1,opt,name=transaction,proto3" json:"transaction,omitempty"`
// contains filtered or unexported fields
}
The request for [Datastore.Rollback][google.datastore.v1.Datastore.Rollback].
func (*RollbackRequest) Descriptor
func
(
*
RollbackRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use RollbackRequest.ProtoReflect.Descriptor instead.
func (*RollbackRequest) GetDatabaseId
func
(
x
*
RollbackRequest
)
GetDatabaseId
()
string
func (*RollbackRequest) GetProjectId
func
(
x
*
RollbackRequest
)
GetProjectId
()
string
func (*RollbackRequest) GetTransaction
func
(
x
*
RollbackRequest
)
GetTransaction
()
[]
byte
func (*RollbackRequest) ProtoMessage
func
(
*
RollbackRequest
)
ProtoMessage
()
func (*RollbackRequest) ProtoReflect
func
(
x
*
RollbackRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*RollbackRequest) Reset
func
(
x
*
RollbackRequest
)
Reset
()
func (*RollbackRequest) String
func
(
x
*
RollbackRequest
)
String
()
string
RollbackResponse
type
RollbackResponse
struct
{
// contains filtered or unexported fields
}
The response for [Datastore.Rollback][google.datastore.v1.Datastore.Rollback]. (an empty message).
func (*RollbackResponse) Descriptor
func
(
*
RollbackResponse
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use RollbackResponse.ProtoReflect.Descriptor instead.
func (*RollbackResponse) ProtoMessage
func
(
*
RollbackResponse
)
ProtoMessage
()
func (*RollbackResponse) ProtoReflect
func
(
x
*
RollbackResponse
)
ProtoReflect
()
protoreflect
.
Message
func (*RollbackResponse) Reset
func
(
x
*
RollbackResponse
)
Reset
()
func (*RollbackResponse) String
func
(
x
*
RollbackResponse
)
String
()
string
RunAggregationQueryRequest
type
RunAggregationQueryRequest
struct
{
// Required. 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 ID of the database against which to make the request.
//
// '(default)' is not allowed; please use empty string ” to refer the default
// database.
DatabaseId
string
`protobuf:"bytes,9,opt,name=database_id,json=databaseId,proto3" json:"database_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:
//
// *RunAggregationQueryRequest_AggregationQuery
// *RunAggregationQueryRequest_GqlQuery
QueryType
isRunAggregationQueryRequest_QueryType
`protobuf_oneof:"query_type"`
// Optional. Explain options for the query. If set, additional query
// statistics will be returned. If not, only query results will be returned.
ExplainOptions
*
ExplainOptions
`protobuf:"bytes,11,opt,name=explain_options,json=explainOptions,proto3" json:"explain_options,omitempty"`
// contains filtered or unexported fields
}
The request for [Datastore.RunAggregationQuery][google.datastore.v1.Datastore.RunAggregationQuery].
func (*RunAggregationQueryRequest) Descriptor
func
(
*
RunAggregationQueryRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use RunAggregationQueryRequest.ProtoReflect.Descriptor instead.
func (*RunAggregationQueryRequest) GetAggregationQuery
func
(
x
*
RunAggregationQueryRequest
)
GetAggregationQuery
()
*
AggregationQuery
func (*RunAggregationQueryRequest) GetDatabaseId
func
(
x
*
RunAggregationQueryRequest
)
GetDatabaseId
()
string
func (*RunAggregationQueryRequest) GetExplainOptions
func
(
x
*
RunAggregationQueryRequest
)
GetExplainOptions
()
*
ExplainOptions
func (*RunAggregationQueryRequest) GetGqlQuery
func
(
x
*
RunAggregationQueryRequest
)
GetGqlQuery
()
*
GqlQuery
func (*RunAggregationQueryRequest) GetPartitionId
func
(
x
*
RunAggregationQueryRequest
)
GetPartitionId
()
*
PartitionId
func (*RunAggregationQueryRequest) GetProjectId
func
(
x
*
RunAggregationQueryRequest
)
GetProjectId
()
string
func (*RunAggregationQueryRequest) GetQueryType
func
(
m
*
RunAggregationQueryRequest
)
GetQueryType
()
isRunAggregationQueryRequest_QueryType
func (*RunAggregationQueryRequest) GetReadOptions
func
(
x
*
RunAggregationQueryRequest
)
GetReadOptions
()
*
ReadOptions
func (*RunAggregationQueryRequest) ProtoMessage
func
(
*
RunAggregationQueryRequest
)
ProtoMessage
()
func (*RunAggregationQueryRequest) ProtoReflect
func
(
x
*
RunAggregationQueryRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*RunAggregationQueryRequest) Reset
func
(
x
*
RunAggregationQueryRequest
)
Reset
()
func (*RunAggregationQueryRequest) String
func
(
x
*
RunAggregationQueryRequest
)
String
()
string
RunAggregationQueryRequest_AggregationQuery
type
RunAggregationQueryRequest_AggregationQuery
struct
{
// The query to run.
AggregationQuery
*
AggregationQuery
`protobuf:"bytes,3,opt,name=aggregation_query,json=aggregationQuery,proto3,oneof"`
}
RunAggregationQueryRequest_GqlQuery
type
RunAggregationQueryRequest_GqlQuery
struct
{
// The GQL query to run. This query must be an aggregation query.
GqlQuery
*
GqlQuery
`protobuf:"bytes,7,opt,name=gql_query,json=gqlQuery,proto3,oneof"`
}
RunAggregationQueryResponse
type
RunAggregationQueryResponse
struct
{
// A batch of aggregation results. Always present.
Batch
*
AggregationResultBatch
`protobuf:"bytes,1,opt,name=batch,proto3" json:"batch,omitempty"`
// The parsed form of the `GqlQuery` from the request, if it was set.
Query
*
AggregationQuery
`protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
// The identifier of the transaction that was started as part of this
// RunAggregationQuery request.
//
// Set only when
// [ReadOptions.new_transaction][google.datastore.v1.ReadOptions.new_transaction]
// was set in
// [RunAggregationQueryRequest.read_options][google.datastore.v1.RunAggregationQueryRequest.read_options].
Transaction
[]
byte
`protobuf:"bytes,5,opt,name=transaction,proto3" json:"transaction,omitempty"`
// Query explain metrics. This is only present when the
// [RunAggregationQueryRequest.explain_options][google.datastore.v1.RunAggregationQueryRequest.explain_options]
// is provided, and it is sent only once with the last response in the stream.
ExplainMetrics
*
ExplainMetrics
`protobuf:"bytes,9,opt,name=explain_metrics,json=explainMetrics,proto3" json:"explain_metrics,omitempty"`
// contains filtered or unexported fields
}
The response for [Datastore.RunAggregationQuery][google.datastore.v1.Datastore.RunAggregationQuery].
func (*RunAggregationQueryResponse) Descriptor
func
(
*
RunAggregationQueryResponse
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use RunAggregationQueryResponse.ProtoReflect.Descriptor instead.
func (*RunAggregationQueryResponse) GetBatch
func
(
x
*
RunAggregationQueryResponse
)
GetBatch
()
*
AggregationResultBatch
func (*RunAggregationQueryResponse) GetExplainMetrics
func
(
x
*
RunAggregationQueryResponse
)
GetExplainMetrics
()
*
ExplainMetrics
func (*RunAggregationQueryResponse) GetQuery
func
(
x
*
RunAggregationQueryResponse
)
GetQuery
()
*
AggregationQuery
func (*RunAggregationQueryResponse) GetTransaction
func
(
x
*
RunAggregationQueryResponse
)
GetTransaction
()
[]
byte
func (*RunAggregationQueryResponse) ProtoMessage
func
(
*
RunAggregationQueryResponse
)
ProtoMessage
()
func (*RunAggregationQueryResponse) ProtoReflect
func
(
x
*
RunAggregationQueryResponse
)
ProtoReflect
()
protoreflect
.
Message
func (*RunAggregationQueryResponse) Reset
func
(
x
*
RunAggregationQueryResponse
)
Reset
()
func (*RunAggregationQueryResponse) String
func
(
x
*
RunAggregationQueryResponse
)
String
()
string
RunQueryRequest
type
RunQueryRequest
struct
{
// Required. 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 ID of the database against which to make the request.
//
// '(default)' is not allowed; please use empty string ” to refer the default
// database.
DatabaseId
string
`protobuf:"bytes,9,opt,name=database_id,json=databaseId,proto3" json:"database_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"`
// The properties to return.
// This field must not be set for a projection query.
//
// See
// [LookupRequest.property_mask][google.datastore.v1.LookupRequest.property_mask].
PropertyMask
*
PropertyMask
`protobuf:"bytes,10,opt,name=property_mask,json=propertyMask,proto3" json:"property_mask,omitempty"`
// Optional. Explain options for the query. If set, additional query
// statistics will be returned. If not, only query results will be returned.
ExplainOptions
*
ExplainOptions
`protobuf:"bytes,12,opt,name=explain_options,json=explainOptions,proto3" json:"explain_options,omitempty"`
// contains filtered or unexported fields
}
The request for [Datastore.RunQuery][google.datastore.v1.Datastore.RunQuery].
func (*RunQueryRequest) Descriptor
func
(
*
RunQueryRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use RunQueryRequest.ProtoReflect.Descriptor instead.
func (*RunQueryRequest) GetDatabaseId
func
(
x
*
RunQueryRequest
)
GetDatabaseId
()
string
func (*RunQueryRequest) GetExplainOptions
func
(
x
*
RunQueryRequest
)
GetExplainOptions
()
*
ExplainOptions
func (*RunQueryRequest) GetGqlQuery
func
(
x
*
RunQueryRequest
)
GetGqlQuery
()
*
GqlQuery
func (*RunQueryRequest) GetPartitionId
func
(
x
*
RunQueryRequest
)
GetPartitionId
()
*
PartitionId
func (*RunQueryRequest) GetProjectId
func
(
x
*
RunQueryRequest
)
GetProjectId
()
string
func (*RunQueryRequest) GetPropertyMask
func
(
x
*
RunQueryRequest
)
GetPropertyMask
()
*
PropertyMask
func (*RunQueryRequest) GetQuery
func
(
x
*
RunQueryRequest
)
GetQuery
()
*
Query
func (*RunQueryRequest) GetQueryType
func
(
m
*
RunQueryRequest
)
GetQueryType
()
isRunQueryRequest_QueryType
func (*RunQueryRequest) GetReadOptions
func
(
x
*
RunQueryRequest
)
GetReadOptions
()
*
ReadOptions
func (*RunQueryRequest) ProtoMessage
func
(
*
RunQueryRequest
)
ProtoMessage
()
func (*RunQueryRequest) ProtoReflect
func
(
x
*
RunQueryRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*RunQueryRequest) Reset
func
(
x
*
RunQueryRequest
)
Reset
()
func (*RunQueryRequest) String
func
(
x
*
RunQueryRequest
)
String
()
string
RunQueryRequest_GqlQuery
type
RunQueryRequest_GqlQuery
struct
{
// The GQL query to run. This query must be a non-aggregation query.
GqlQuery
*
GqlQuery
`protobuf:"bytes,7,opt,name=gql_query,json=gqlQuery,proto3,oneof"`
}
RunQueryRequest_Query
type
RunQueryRequest_Query
struct
{
// The query to run.
Query
*
Query
`protobuf:"bytes,3,opt,name=query,proto3,oneof"`
}
RunQueryResponse
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"`
// The identifier of the transaction that was started as part of this
// RunQuery request.
//
// Set only when
// [ReadOptions.new_transaction][google.datastore.v1.ReadOptions.new_transaction]
// was set in
// [RunQueryRequest.read_options][google.datastore.v1.RunQueryRequest.read_options].
Transaction
[]
byte
`protobuf:"bytes,5,opt,name=transaction,proto3" json:"transaction,omitempty"`
// Query explain metrics. This is only present when the
// [RunQueryRequest.explain_options][google.datastore.v1.RunQueryRequest.explain_options]
// is provided, and it is sent only once with the last response in the stream.
ExplainMetrics
*
ExplainMetrics
`protobuf:"bytes,9,opt,name=explain_metrics,json=explainMetrics,proto3" json:"explain_metrics,omitempty"`
// contains filtered or unexported fields
}
The response for [Datastore.RunQuery][google.datastore.v1.Datastore.RunQuery].
func (*RunQueryResponse) Descriptor
func
(
*
RunQueryResponse
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use RunQueryResponse.ProtoReflect.Descriptor instead.
func (*RunQueryResponse) GetBatch
func
(
x
*
RunQueryResponse
)
GetBatch
()
*
QueryResultBatch
func (*RunQueryResponse) GetExplainMetrics
func
(
x
*
RunQueryResponse
)
GetExplainMetrics
()
*
ExplainMetrics
func (*RunQueryResponse) GetQuery
func
(
x
*
RunQueryResponse
)
GetQuery
()
*
Query
func (*RunQueryResponse) GetTransaction
func
(
x
*
RunQueryResponse
)
GetTransaction
()
[]
byte
func (*RunQueryResponse) ProtoMessage
func
(
*
RunQueryResponse
)
ProtoMessage
()
func (*RunQueryResponse) ProtoReflect
func
(
x
*
RunQueryResponse
)
ProtoReflect
()
protoreflect
.
Message
func (*RunQueryResponse) Reset
func
(
x
*
RunQueryResponse
)
Reset
()
func (*RunQueryResponse) String
func
(
x
*
RunQueryResponse
)
String
()
string
TransactionOptions
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
}
Options for beginning a new transaction.
Transactions can be created explicitly with calls to [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction] or implicitly by setting [ReadOptions.new_transaction][google.datastore.v1.ReadOptions.new_transaction] in read requests.
func (*TransactionOptions) Descriptor
func
(
*
TransactionOptions
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use TransactionOptions.ProtoReflect.Descriptor instead.
func (*TransactionOptions) GetMode
func
(
m
*
TransactionOptions
)
GetMode
()
isTransactionOptions_Mode
func (*TransactionOptions) GetReadOnly
func
(
x
*
TransactionOptions
)
GetReadOnly
()
*
TransactionOptions_ReadOnly
func (*TransactionOptions) GetReadWrite
func
(
x
*
TransactionOptions
)
GetReadWrite
()
*
TransactionOptions_ReadWrite
func (*TransactionOptions) ProtoMessage
func
(
*
TransactionOptions
)
ProtoMessage
()
func (*TransactionOptions) ProtoReflect
func
(
x
*
TransactionOptions
)
ProtoReflect
()
protoreflect
.
Message
func (*TransactionOptions) Reset
func
(
x
*
TransactionOptions
)
Reset
()
func (*TransactionOptions) String
func
(
x
*
TransactionOptions
)
String
()
string
TransactionOptions_ReadOnly
type
TransactionOptions_ReadOnly
struct
{
// Reads entities at the given time.
//
// This must be a microsecond precision timestamp within the past one hour,
// or if Point-in-Time Recovery is enabled, can additionally be a whole
// minute timestamp within the past 7 days.
ReadTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,1,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
// contains filtered or unexported fields
}
Options specific to read-only transactions.
func (*TransactionOptions_ReadOnly) Descriptor
func
(
*
TransactionOptions_ReadOnly
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use TransactionOptions_ReadOnly.ProtoReflect.Descriptor instead.
func (*TransactionOptions_ReadOnly) GetReadTime
func
(
x
*
TransactionOptions_ReadOnly
)
GetReadTime
()
*
timestamppb
.
Timestamp
func (*TransactionOptions_ReadOnly) ProtoMessage
func
(
*
TransactionOptions_ReadOnly
)
ProtoMessage
()
func (*TransactionOptions_ReadOnly) ProtoReflect
func
(
x
*
TransactionOptions_ReadOnly
)
ProtoReflect
()
protoreflect
.
Message
func (*TransactionOptions_ReadOnly) Reset
func
(
x
*
TransactionOptions_ReadOnly
)
Reset
()
func (*TransactionOptions_ReadOnly) String
func
(
x
*
TransactionOptions_ReadOnly
)
String
()
string
TransactionOptions_ReadOnly_
type
TransactionOptions_ReadOnly_
struct
{
// The transaction should only allow reads.
ReadOnly
*
TransactionOptions_ReadOnly
`protobuf:"bytes,2,opt,name=read_only,json=readOnly,proto3,oneof"`
}
TransactionOptions_ReadWrite
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
}
Options specific to read / write transactions.
func (*TransactionOptions_ReadWrite) Descriptor
func
(
*
TransactionOptions_ReadWrite
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use TransactionOptions_ReadWrite.ProtoReflect.Descriptor instead.
func (*TransactionOptions_ReadWrite) GetPreviousTransaction
func
(
x
*
TransactionOptions_ReadWrite
)
GetPreviousTransaction
()
[]
byte
func (*TransactionOptions_ReadWrite) ProtoMessage
func
(
*
TransactionOptions_ReadWrite
)
ProtoMessage
()
func (*TransactionOptions_ReadWrite) ProtoReflect
func
(
x
*
TransactionOptions_ReadWrite
)
ProtoReflect
()
protoreflect
.
Message
func (*TransactionOptions_ReadWrite) Reset
func
(
x
*
TransactionOptions_ReadWrite
)
Reset
()
func (*TransactionOptions_ReadWrite) String
func
(
x
*
TransactionOptions_ReadWrite
)
String
()
string
TransactionOptions_ReadWrite_
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
type
UnimplementedDatastoreServer
struct
{
}
UnimplementedDatastoreServer can be embedded to have forward compatible implementations.
func (*UnimplementedDatastoreServer) AllocateIds
func
(
*
UnimplementedDatastoreServer
)
AllocateIds
(
context
.
Context
,
*
AllocateIdsRequest
)
(
*
AllocateIdsResponse
,
error
)
func (*UnimplementedDatastoreServer) BeginTransaction
func
(
*
UnimplementedDatastoreServer
)
BeginTransaction
(
context
.
Context
,
*
BeginTransactionRequest
)
(
*
BeginTransactionResponse
,
error
)
func (*UnimplementedDatastoreServer) Commit
func
(
*
UnimplementedDatastoreServer
)
Commit
(
context
.
Context
,
*
CommitRequest
)
(
*
CommitResponse
,
error
)
func (*UnimplementedDatastoreServer) Lookup
func
(
*
UnimplementedDatastoreServer
)
Lookup
(
context
.
Context
,
*
LookupRequest
)
(
*
LookupResponse
,
error
)
func (*UnimplementedDatastoreServer) ReserveIds
func
(
*
UnimplementedDatastoreServer
)
ReserveIds
(
context
.
Context
,
*
ReserveIdsRequest
)
(
*
ReserveIdsResponse
,
error
)
func (*UnimplementedDatastoreServer) Rollback
func
(
*
UnimplementedDatastoreServer
)
Rollback
(
context
.
Context
,
*
RollbackRequest
)
(
*
RollbackResponse
,
error
)
func (*UnimplementedDatastoreServer) RunAggregationQuery
func
(
*
UnimplementedDatastoreServer
)
RunAggregationQuery
(
context
.
Context
,
*
RunAggregationQueryRequest
)
(
*
RunAggregationQueryResponse
,
error
)
func (*UnimplementedDatastoreServer) RunQuery
func
(
*
UnimplementedDatastoreServer
)
RunQuery
(
context
.
Context
,
*
RunQueryRequest
)
(
*
RunQueryResponse
,
error
)
Value
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
}
A message that can hold any of the supported value types and associated metadata.
func (*Value) Descriptor
Deprecated: Use Value.ProtoReflect.Descriptor instead.
func (*Value) GetArrayValue
func
(
x
*
Value
)
GetArrayValue
()
*
ArrayValue
func (*Value) GetBlobValue
func (*Value) GetBooleanValue
func (*Value) GetDoubleValue
func (*Value) GetEntityValue
func (*Value) GetExcludeFromIndexes
func (*Value) GetGeoPointValue
func (*Value) GetIntegerValue
func (*Value) GetKeyValue
func (*Value) GetMeaning
func (*Value) GetNullValue
func (*Value) GetStringValue
func (*Value) GetTimestampValue
func
(
x
*
Value
)
GetTimestampValue
()
*
timestamppb
.
Timestamp
func (*Value) GetValueType
func
(
m
*
Value
)
GetValueType
()
isValue_ValueType
func (*Value) ProtoMessage
func
(
*
Value
)
ProtoMessage
()
func (*Value) ProtoReflect
func
(
x
*
Value
)
ProtoReflect
()
protoreflect
.
Message
func (*Value) Reset
func
(
x
*
Value
)
Reset
()
func (*Value) String
Value_ArrayValue
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"`
}
Value_BlobValue
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"`
}
Value_BooleanValue
type
Value_BooleanValue
struct
{
// A boolean value.
BooleanValue
bool
`protobuf:"varint,1,opt,name=boolean_value,json=booleanValue,proto3,oneof"`
}
Value_DoubleValue
type
Value_DoubleValue
struct
{
// A double value.
DoubleValue
float64
`protobuf:"fixed64,3,opt,name=double_value,json=doubleValue,proto3,oneof"`
}
Value_EntityValue
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"`
}
Value_GeoPointValue
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"`
}
Value_IntegerValue
type
Value_IntegerValue
struct
{
// An integer value.
IntegerValue
int64
`protobuf:"varint,2,opt,name=integer_value,json=integerValue,proto3,oneof"`
}
Value_KeyValue
type
Value_KeyValue
struct
{
// A key value.
KeyValue
*
Key
`protobuf:"bytes,5,opt,name=key_value,json=keyValue,proto3,oneof"`
}
Value_NullValue
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"`
}
Value_StringValue
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"`
}
Value_TimestampValue
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"`
}
