| Copyright | (c) 2015-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.Datastore.Types
Contents
- Service Configuration
- OAuth Scopes
- LatLng
- PropertyOrderDirection
- RollbackRequest
- PartitionId
- QueryResultBatch
- CompositeFilterOp
- EntityProperties
- BeginTransactionRequest
- RunQueryRequest
- AllocateIdsRequest
- QueryResultBatchEntityResultType
- CompositeFilter
- QueryResultBatchMoreResults
- BeginTransactionResponse
- MutationResult
- AllocateIdsResponse
- GqlQuery
- RunQueryResponse
- Value
- ValueNullValue
- LookupRequest
- ReadOptionsReadConsistency
- Mutation
- GqlQueryNamedBindings
- PropertyReference
- Key
- PropertyFilter
- Query
- ArrayValue
- EntityResult
- Xgafv
- CommitResponse
- KindExpression
- ReadOptions
- RollbackResponse
- Projection
- Filter
- PropertyFilterOp
- CommitRequest
- CommitRequestMode
- PathElement
- Entity
- LookupResponse
- PropertyOrder
- GqlQueryParameter
Description
- datastoreService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- datastoreScope :: Proxy '["https://www.googleapis.com/auth/datastore"]
- data LatLng
- latLng :: LatLng
- llLatitude :: Lens' LatLng (Maybe Double)
- llLongitude :: Lens' LatLng (Maybe Double)
- data PropertyOrderDirection
- data RollbackRequest
- rollbackRequest :: RollbackRequest
- rrTransaction :: Lens' RollbackRequest (Maybe ByteString)
- data PartitionId
- partitionId :: PartitionId
- piNamespaceId :: Lens' PartitionId (Maybe Text)
- piProjectId :: Lens' PartitionId (Maybe Text)
- data QueryResultBatch
- queryResultBatch :: QueryResultBatch
- qrbSkippedResults :: Lens' QueryResultBatch (Maybe Int32)
- qrbSkippedCursor :: Lens' QueryResultBatch (Maybe ByteString)
- qrbEntityResultType :: Lens' QueryResultBatch (Maybe QueryResultBatchEntityResultType)
- qrbSnapshotVersion :: Lens' QueryResultBatch (Maybe Int64)
- qrbEntityResults :: Lens' QueryResultBatch [EntityResult]
- qrbMoreResults :: Lens' QueryResultBatch (Maybe QueryResultBatchMoreResults)
- qrbEndCursor :: Lens' QueryResultBatch (Maybe ByteString)
- data CompositeFilterOp
- data EntityProperties
- entityProperties :: HashMap Text Value -> EntityProperties
- epAddtional :: Lens' EntityProperties (HashMap Text Value)
- data BeginTransactionRequest
- beginTransactionRequest :: BeginTransactionRequest
- data RunQueryRequest
- runQueryRequest :: RunQueryRequest
- rqrPartitionId :: Lens' RunQueryRequest (Maybe PartitionId)
- rqrGqlQuery :: Lens' RunQueryRequest (Maybe GqlQuery)
- rqrQuery :: Lens' RunQueryRequest (Maybe Query)
- rqrReadOptions :: Lens' RunQueryRequest (Maybe ReadOptions)
- data AllocateIdsRequest
- allocateIdsRequest :: AllocateIdsRequest
- airKeys :: Lens' AllocateIdsRequest [Key]
- data QueryResultBatchEntityResultType
- data CompositeFilter
- compositeFilter :: CompositeFilter
- cfOp :: Lens' CompositeFilter (Maybe CompositeFilterOp)
- cfFilters :: Lens' CompositeFilter [Filter]
- data QueryResultBatchMoreResults
- data BeginTransactionResponse
- beginTransactionResponse :: BeginTransactionResponse
- btrTransaction :: Lens' BeginTransactionResponse (Maybe ByteString)
- data MutationResult
- mutationResult :: MutationResult
- mrConflictDetected :: Lens' MutationResult (Maybe Bool)
- mrKey :: Lens' MutationResult (Maybe Key)
- mrVersion :: Lens' MutationResult (Maybe Int64)
- data AllocateIdsResponse
- allocateIdsResponse :: AllocateIdsResponse
- aKeys :: Lens' AllocateIdsResponse [Key]
- data GqlQuery
- gqlQuery :: GqlQuery
- gqPositionalBindings :: Lens' GqlQuery [GqlQueryParameter]
- gqNamedBindings :: Lens' GqlQuery (Maybe GqlQueryNamedBindings)
- gqQueryString :: Lens' GqlQuery (Maybe Text)
- gqAllowLiterals :: Lens' GqlQuery (Maybe Bool)
- data RunQueryResponse
- runQueryResponse :: RunQueryResponse
- rBatch :: Lens' RunQueryResponse (Maybe QueryResultBatch)
- rQuery :: Lens' RunQueryResponse (Maybe Query)
- data Value
- value :: Value
- vKeyValue :: Lens' Value (Maybe Key)
- vGeoPointValue :: Lens' Value (Maybe LatLng)
- vIntegerValue :: Lens' Value (Maybe Int64)
- vTimestampValue :: Lens' Value (Maybe UTCTime)
- vEntityValue :: Lens' Value (Maybe Entity)
- vExcludeFromIndexes :: Lens' Value (Maybe Bool)
- vDoubleValue :: Lens' Value (Maybe Double)
- vStringValue :: Lens' Value (Maybe Text)
- vBooleanValue :: Lens' Value (Maybe Bool)
- vMeaning :: Lens' Value (Maybe Int32)
- vArrayValue :: Lens' Value (Maybe ArrayValue)
- vNullValue :: Lens' Value (Maybe ValueNullValue)
- vBlobValue :: Lens' Value (Maybe ByteString)
- data ValueNullValue = NullValue
- data LookupRequest
- lookupRequest :: LookupRequest
- lrKeys :: Lens' LookupRequest [Key]
- lrReadOptions :: Lens' LookupRequest (Maybe ReadOptions)
- data ReadOptionsReadConsistency
- data Mutation
- mutation :: Mutation
- mBaseVersion :: Lens' Mutation (Maybe Int64)
- mInsert :: Lens' Mutation (Maybe Entity)
- mUpsert :: Lens' Mutation (Maybe Entity)
- mDelete :: Lens' Mutation (Maybe Key)
- mUpdate :: Lens' Mutation (Maybe Entity)
- data GqlQueryNamedBindings
- gqlQueryNamedBindings :: HashMap Text GqlQueryParameter -> GqlQueryNamedBindings
- gqnbAddtional :: Lens' GqlQueryNamedBindings (HashMap Text GqlQueryParameter)
- data PropertyReference
- propertyReference :: PropertyReference
- prName :: Lens' PropertyReference (Maybe Text)
- data Key
- key :: Key
- kPartitionId :: Lens' Key (Maybe PartitionId)
- kPath :: Lens' Key [PathElement]
- data PropertyFilter
- propertyFilter :: PropertyFilter
- pfProperty :: Lens' PropertyFilter (Maybe PropertyReference)
- pfOp :: Lens' PropertyFilter (Maybe PropertyFilterOp)
- pfValue :: Lens' PropertyFilter (Maybe Value)
- data Query
- query :: Query
- qStartCursor :: Lens' Query (Maybe ByteString)
- qOffSet :: Lens' Query (Maybe Int32)
- qKind :: Lens' Query [KindExpression]
- qDistinctOn :: Lens' Query [PropertyReference]
- qEndCursor :: Lens' Query (Maybe ByteString)
- qLimit :: Lens' Query (Maybe Int32)
- qProjection :: Lens' Query [Projection]
- qFilter :: Lens' Query (Maybe Filter)
- qOrder :: Lens' Query [PropertyOrder]
- data ArrayValue
- arrayValue :: ArrayValue
- avValues :: Lens' ArrayValue [Value]
- data EntityResult
- entityResult :: EntityResult
- erCursor :: Lens' EntityResult (Maybe ByteString)
- erVersion :: Lens' EntityResult (Maybe Int64)
- erEntity :: Lens' EntityResult (Maybe Entity)
- data Xgafv
- data CommitResponse
- commitResponse :: CommitResponse
- crIndexUpdates :: Lens' CommitResponse (Maybe Int32)
- crMutationResults :: Lens' CommitResponse [MutationResult]
- data KindExpression
- kindExpression :: KindExpression
- keName :: Lens' KindExpression (Maybe Text)
- data ReadOptions
- readOptions :: ReadOptions
- roReadConsistency :: Lens' ReadOptions (Maybe ReadOptionsReadConsistency)
- roTransaction :: Lens' ReadOptions (Maybe ByteString)
- data RollbackResponse
- rollbackResponse :: RollbackResponse
- data Projection
- projection :: Projection
- pProperty :: Lens' Projection (Maybe PropertyReference)
- data Filter
- filter' :: Filter
- fCompositeFilter :: Lens' Filter (Maybe CompositeFilter)
- fPropertyFilter :: Lens' Filter (Maybe PropertyFilter)
- data PropertyFilterOp
- data CommitRequest
- commitRequest :: CommitRequest
- crMutations :: Lens' CommitRequest [Mutation]
- crMode :: Lens' CommitRequest (Maybe CommitRequestMode)
- crTransaction :: Lens' CommitRequest (Maybe ByteString)
- data CommitRequestMode
- data PathElement
- pathElement :: PathElement
- peKind :: Lens' PathElement (Maybe Text)
- peName :: Lens' PathElement (Maybe Text)
- peId :: Lens' PathElement (Maybe Int64)
- data Entity
- entity :: Entity
- eKey :: Lens' Entity (Maybe Key)
- eProperties :: Lens' Entity (Maybe EntityProperties)
- data LookupResponse
- lookupResponse :: LookupResponse
- lrDeferred :: Lens' LookupResponse [Key]
- lrFound :: Lens' LookupResponse [EntityResult]
- lrMissing :: Lens' LookupResponse [EntityResult]
- data PropertyOrder
- propertyOrder :: PropertyOrder
- poProperty :: Lens' PropertyOrder (Maybe PropertyReference)
- poDirection :: Lens' PropertyOrder (Maybe PropertyOrderDirection)
- data GqlQueryParameter
- gqlQueryParameter :: GqlQueryParameter
- gqpCursor :: Lens' GqlQueryParameter (Maybe ByteString)
- gqpValue :: Lens' GqlQueryParameter (Maybe Value)
Service Configuration
datastoreService :: ServiceConfig #
Default request referring to version v1 of the Google Cloud Datastore API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] #
View and manage your data across Google Cloud Platform services
datastoreScope :: Proxy '["https://www.googleapis.com/auth/datastore"] #
View and manage your Google Cloud Datastore data
LatLng
An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): """Wraps decimal degrees longitude to [-180.0, 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """Wraps decimal degrees latitude and longitude to [-90.0, 90.0] and [-180.0, 180.0], respectively.""" r = latitude % 360.0 if r <= 90.0: return r, NormalizeLongitude(longitude) elif r >= 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) The code in logs/storage/validator/logs_validator_traits.cc treats this type as if it were annotated as ST_LOCATION.
See: latLng smart constructor.
Creates a value of LatLng with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llLatitude :: Lens' LatLng (Maybe Double) #
The latitude in degrees. It must be in the range [-90.0, +90.0].
llLongitude :: Lens' LatLng (Maybe Double) #
The longitude in degrees. It must be in the range [-180.0, +180.0].
PropertyOrderDirection
data PropertyOrderDirection #
The direction to order by. Defaults to `ASCENDING`.
Constructors
| DirectionUnspecified |
|
| Ascending |
|
| Descending |
|
Instances
RollbackRequest
data RollbackRequest #
The request for Datastore.Rollback.
See: rollbackRequest smart constructor.
rollbackRequest :: RollbackRequest #
Creates a value of RollbackRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrTransaction :: Lens' RollbackRequest (Maybe ByteString) #
The transaction identifier, returned by a call to Datastore.BeginTransaction.
PartitionId
data PartitionId #
A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `.*`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.
See: partitionId smart constructor.
Instances
Creates a value of PartitionId with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
piNamespaceId :: Lens' PartitionId (Maybe Text) #
If not empty, the ID of the namespace to which the entities belong.
piProjectId :: Lens' PartitionId (Maybe Text) #
The ID of the project to which the entities belong.
QueryResultBatch
data QueryResultBatch #
A batch of results produced by a query.
See: queryResultBatch smart constructor.
queryResultBatch :: QueryResultBatch #
Creates a value of QueryResultBatch with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qrbSkippedResults :: Lens' QueryResultBatch (Maybe Int32) #
The number of results skipped, typically because of an offset.
qrbSkippedCursor :: Lens' QueryResultBatch (Maybe ByteString) #
A cursor that points to the position after the last skipped result. Will be set when `skipped_results` != 0.
qrbEntityResultType :: Lens' QueryResultBatch (Maybe QueryResultBatchEntityResultType) #
The result type for every entity in `entity_results`.
qrbSnapshotVersion :: Lens' QueryResultBatch (Maybe Int64) #
The version number of the snapshot this batch was returned from. This applies to the range of results from the query's `start_cursor` (or the beginning of the query if no cursor was given) to this batch's `end_cursor` (not the query's `end_cursor`). In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries.
qrbEntityResults :: Lens' QueryResultBatch [EntityResult] #
The results for this batch.
qrbMoreResults :: Lens' QueryResultBatch (Maybe QueryResultBatchMoreResults) #
The state of the query after the current batch.
qrbEndCursor :: Lens' QueryResultBatch (Maybe ByteString) #
A cursor that points to the position after the last result in the batch.
CompositeFilterOp
data CompositeFilterOp #
The operator for combining multiple filters.
Constructors
| OperatorUnspecified |
|
| And |
|
Instances
EntityProperties
data EntityProperties #
The entity's properties. The map's keys are property names. A property name matching regex `.*` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
See: entityProperties smart constructor.
Arguments
| :: HashMap Text Value | |
| -> EntityProperties |
Creates a value of EntityProperties with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
BeginTransactionRequest
data BeginTransactionRequest #
The request for Datastore.BeginTransaction.
See: beginTransactionRequest smart constructor.
beginTransactionRequest :: BeginTransactionRequest #
Creates a value of BeginTransactionRequest with the minimum fields required to make a request.
RunQueryRequest
data RunQueryRequest #
The request for Datastore.RunQuery.
See: runQueryRequest smart constructor.
runQueryRequest :: RunQueryRequest #
Creates a value of RunQueryRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rqrPartitionId :: Lens' RunQueryRequest (Maybe PartitionId) #
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.
rqrGqlQuery :: Lens' RunQueryRequest (Maybe GqlQuery) #
The GQL query to run.
rqrReadOptions :: Lens' RunQueryRequest (Maybe ReadOptions) #
The options for this query.
AllocateIdsRequest
data AllocateIdsRequest #
The request for Datastore.AllocateIds.
See: allocateIdsRequest smart constructor.
allocateIdsRequest :: AllocateIdsRequest #
Creates a value of AllocateIdsRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
airKeys :: Lens' AllocateIdsRequest [Key] #
A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only.
QueryResultBatchEntityResultType
data QueryResultBatchEntityResultType #
The result type for every entity in `entity_results`.
Constructors
| QRBERTResultTypeUnspecified |
|
| QRBERTFull |
|
| QRBERTProjection |
|
| QRBERTKeyOnly |
|
Instances
CompositeFilter
data CompositeFilter #
A filter that merges multiple other filters using the given operator.
See: compositeFilter smart constructor.
compositeFilter :: CompositeFilter #
Creates a value of CompositeFilter with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cfOp :: Lens' CompositeFilter (Maybe CompositeFilterOp) #
The operator for combining multiple filters.
cfFilters :: Lens' CompositeFilter [Filter] #
The list of filters to combine. Must contain at least one filter.
QueryResultBatchMoreResults
data QueryResultBatchMoreResults #
The state of the query after the current batch.
Constructors
| MoreResultsTypeUnspecified |
|
| NotFinished |
|
| MoreResultsAfterLimit |
|
| MoreResultsAfterCursor |
|
| NoMoreResults |
|
Instances
BeginTransactionResponse
data BeginTransactionResponse #
The response for Datastore.BeginTransaction.
See: beginTransactionResponse smart constructor.
beginTransactionResponse :: BeginTransactionResponse #
Creates a value of BeginTransactionResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
btrTransaction :: Lens' BeginTransactionResponse (Maybe ByteString) #
The transaction identifier (always present).
MutationResult
data MutationResult #
The result of applying a mutation.
See: mutationResult smart constructor.
Instances
mutationResult :: MutationResult #
Creates a value of MutationResult with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mrConflictDetected :: Lens' MutationResult (Maybe Bool) #
Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation.
mrKey :: Lens' MutationResult (Maybe Key) #
The automatically allocated key. Set only when the mutation allocated a key.
mrVersion :: Lens' MutationResult (Maybe Int64) #
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.
AllocateIdsResponse
data AllocateIdsResponse #
The response for Datastore.AllocateIds.
See: allocateIdsResponse smart constructor.
allocateIdsResponse :: AllocateIdsResponse #
Creates a value of AllocateIdsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aKeys :: Lens' AllocateIdsResponse [Key] #
The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID.
GqlQuery
Creates a value of GqlQuery with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gqPositionalBindings :: Lens' GqlQuery [GqlQueryParameter] #
Numbered binding site '1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0. For each binding site numbered i in `query_string`, there must be an i-th numbered parameter. The inverse must also be true.
gqNamedBindings :: Lens' GqlQuery (Maybe GqlQueryNamedBindings) #
For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse. Key must match regex `A-Za-z_$*`, must not match regex `.*`, and must not be `""`.
gqAllowLiterals :: Lens' GqlQuery (Maybe Bool) #
When false, the query string must not contain any literals and instead must bind all values. For example, `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while `SELECT * FROM Kind WHERE a = 'value` is.
RunQueryResponse
data RunQueryResponse #
The response for Datastore.RunQuery.
See: runQueryResponse smart constructor.
runQueryResponse :: RunQueryResponse #
Creates a value of RunQueryResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rBatch :: Lens' RunQueryResponse (Maybe QueryResultBatch) #
A batch of query results (always present).
rQuery :: Lens' RunQueryResponse (Maybe Query) #
The parsed form of the `GqlQuery` from the request, if it was set.
Value
A message that can hold any of the supported value types and associated metadata.
See: value smart constructor.
Creates a value of Value with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vGeoPointValue :: Lens' Value (Maybe LatLng) #
A geo point value representing a point on the surface of Earth.
vTimestampValue :: Lens' Value (Maybe UTCTime) #
A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
vEntityValue :: Lens' Value (Maybe Entity) #
An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
vExcludeFromIndexes :: Lens' Value (Maybe Bool) #
If the value should be excluded from all indexes including those defined explicitly.
vStringValue :: Lens' Value (Maybe Text) #
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 least 1,000,000 bytes.
vMeaning :: Lens' Value (Maybe Int32) #
The `meaning` field should only be populated for backwards compatibility.
vArrayValue :: Lens' Value (Maybe ArrayValue) #
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`.
vNullValue :: Lens' Value (Maybe ValueNullValue) #
A null value.
vBlobValue :: Lens' Value (Maybe ByteString) #
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.
ValueNullValue
data ValueNullValue #
A null value.
Constructors
| NullValue |
|
Instances
LookupRequest
lookupRequest :: LookupRequest #
Creates a value of LookupRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrKeys :: Lens' LookupRequest [Key] #
Keys of entities to look up.
lrReadOptions :: Lens' LookupRequest (Maybe ReadOptions) #
The options for this lookup request.
ReadOptionsReadConsistency
data ReadOptionsReadConsistency #
The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries.
Constructors
| ReadConsistencyUnspecified |
|
| Strong |
|
| Eventual |
|
Instances
Mutation
A mutation to apply to an entity.
See: mutation smart constructor.
mBaseVersion :: Lens' Mutation (Maybe Int64) #
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.
mInsert :: Lens' Mutation (Maybe Entity) #
The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete.
mUpsert :: Lens' Mutation (Maybe Entity) #
The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete.
mDelete :: Lens' Mutation (Maybe Key) #
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.
mUpdate :: Lens' Mutation (Maybe Entity) #
The entity to update. The entity must already exist. Must have a complete key path.
GqlQueryNamedBindings
data GqlQueryNamedBindings #
For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse. Key must match regex `A-Za-z_$*`, must not match regex `.*`, and must not be `""`.
See: gqlQueryNamedBindings smart constructor.
Arguments
| :: HashMap Text GqlQueryParameter | |
| -> GqlQueryNamedBindings |
Creates a value of GqlQueryNamedBindings with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
PropertyReference
data PropertyReference #
A reference to a property relative to the kind expressions.
See: propertyReference smart constructor.
propertyReference :: PropertyReference #
Creates a value of PropertyReference with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prName :: Lens' PropertyReference (Maybe Text) #
The name of the property. If name includes "."s, it may be interpreted as a property name path.
Key
A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.
See: key smart constructor.
Creates a value of Key with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
kPartitionId :: Lens' Key (Maybe PartitionId) #
Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
kPath :: Lens' Key [PathElement] #
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.
PropertyFilter
data PropertyFilter #
A filter on a specific property.
See: propertyFilter smart constructor.
Instances
propertyFilter :: PropertyFilter #
Creates a value of PropertyFilter with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pfProperty :: Lens' PropertyFilter (Maybe PropertyReference) #
The property to filter by.
pfOp :: Lens' PropertyFilter (Maybe PropertyFilterOp) #
The operator to filter by.
Query
A query for entities.
See: query smart constructor.
Creates a value of Query with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qStartCursor :: Lens' Query (Maybe ByteString) #
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.
qOffSet :: Lens' Query (Maybe Int32) #
The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.
qKind :: Lens' Query [KindExpression] #
The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.
qDistinctOn :: Lens' Query [PropertyReference] #
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).
qEndCursor :: Lens' Query (Maybe ByteString) #
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.
qLimit :: Lens' Query (Maybe Int32) #
The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.
qProjection :: Lens' Query [Projection] #
The projection to return. Defaults to returning all properties.
qOrder :: Lens' Query [PropertyOrder] #
The order to apply to the query results (if empty, order is unspecified).
ArrayValue
Creates a value of ArrayValue with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
avValues :: Lens' ArrayValue [Value] #
Values in the array. The order of this array may not be preserved if it contains a mix of indexed and unindexed values.
EntityResult
data EntityResult #
The result of fetching an entity from Datastore.
See: entityResult smart constructor.
Instances
entityResult :: EntityResult #
Creates a value of EntityResult with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
erCursor :: Lens' EntityResult (Maybe ByteString) #
A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message.
erVersion :: Lens' EntityResult (Maybe Int64) #
The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For 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.
Xgafv
V1 error format.
CommitResponse
data CommitResponse #
The response for Datastore.Commit.
See: commitResponse smart constructor.
Instances
commitResponse :: CommitResponse #
Creates a value of CommitResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crIndexUpdates :: Lens' CommitResponse (Maybe Int32) #
The number of index entries updated during the commit, or zero if none were updated.
crMutationResults :: Lens' CommitResponse [MutationResult] #
The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request.
KindExpression
kindExpression :: KindExpression #
Creates a value of KindExpression with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ReadOptions
Creates a value of ReadOptions with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
roReadConsistency :: Lens' ReadOptions (Maybe ReadOptionsReadConsistency) #
The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries.
roTransaction :: Lens' ReadOptions (Maybe ByteString) #
The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction.
RollbackResponse
data RollbackResponse #
The response for Datastore.Rollback. (an empty message).
See: rollbackResponse smart constructor.
rollbackResponse :: RollbackResponse #
Creates a value of RollbackResponse with the minimum fields required to make a request.
Projection
data Projection #
A representation of a property in a projection.
See: projection smart constructor.
Instances
Creates a value of Projection with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pProperty :: Lens' Projection (Maybe PropertyReference) #
The property to project.
Filter
A holder for any type of filter.
See: filter' smart constructor.
Creates a value of Filter with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fCompositeFilter :: Lens' Filter (Maybe CompositeFilter) #
A composite filter.
fPropertyFilter :: Lens' Filter (Maybe PropertyFilter) #
A filter on a property.
PropertyFilterOp
data PropertyFilterOp #
The operator to filter by.
Constructors
| PFOOperatorUnspecified |
|
| PFOLessThan |
|
| PFOLessThanOrEqual |
|
| PFOGreaterThan |
|
| PFOGreaterThanOrEqual |
|
| PFOEqual |
|
| PFOHasAncestor |
|
Instances
CommitRequest
commitRequest :: CommitRequest #
Creates a value of CommitRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crMutations :: Lens' CommitRequest [Mutation] #
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.
crMode :: Lens' CommitRequest (Maybe CommitRequestMode) #
The type of commit to perform. Defaults to `TRANSACTIONAL`.
crTransaction :: Lens' CommitRequest (Maybe ByteString) #
The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.
CommitRequestMode
data CommitRequestMode #
The type of commit to perform. Defaults to `TRANSACTIONAL`.
Constructors
| ModeUnspecified |
|
| Transactional |
|
| NonTransactional |
|
Instances
PathElement
data PathElement #
A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
See: pathElement smart constructor.
Instances
Creates a value of PathElement with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
peKind :: Lens' PathElement (Maybe Text) #
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 `""`.
peName :: Lens' PathElement (Maybe Text) #
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 `""`.
peId :: Lens' PathElement (Maybe Int64) #
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.
Entity
A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message.
See: entity smart constructor.
Creates a value of Entity with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eKey :: Lens' Entity (Maybe Key) #
The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
eProperties :: Lens' Entity (Maybe EntityProperties) #
The entity's properties. The map's keys are property names. A property name matching regex `.*` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
LookupResponse
data LookupResponse #
The response for Datastore.Lookup.
See: lookupResponse smart constructor.
Instances
lookupResponse :: LookupResponse #
Creates a value of LookupResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrDeferred :: Lens' LookupResponse [Key] #
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.
lrFound :: Lens' LookupResponse [EntityResult] #
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.
lrMissing :: Lens' LookupResponse [EntityResult] #
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.
PropertyOrder
data PropertyOrder #
The desired order for a specific property.
See: propertyOrder smart constructor.
Instances
propertyOrder :: PropertyOrder #
Creates a value of PropertyOrder with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
poProperty :: Lens' PropertyOrder (Maybe PropertyReference) #
The property to order by.
poDirection :: Lens' PropertyOrder (Maybe PropertyOrderDirection) #
The direction to order by. Defaults to `ASCENDING`.
GqlQueryParameter
data GqlQueryParameter #
A binding parameter for a GQL query.
See: gqlQueryParameter smart constructor.
gqlQueryParameter :: GqlQueryParameter #
Creates a value of GqlQueryParameter with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gqpCursor :: Lens' GqlQueryParameter (Maybe ByteString) #
A query cursor. Query cursors are returned in query result batches.