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 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- Types
- 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
Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.
- datastoreService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- datastoreScope :: Proxy '["https://www.googleapis.com/auth/datastore"]
- type DatastoreAPI = ProjectsBeginTransactionResource :<|> (ProjectsAllocateIdsResource :<|> (ProjectsRunQueryResource :<|> (ProjectsRollbackResource :<|> (ProjectsLookupResource :<|> ProjectsCommitResource))))
- module Network.Google.Resource.Datastore.Projects.AllocateIds
- module Network.Google.Resource.Datastore.Projects.BeginTransaction
- module Network.Google.Resource.Datastore.Projects.Commit
- module Network.Google.Resource.Datastore.Projects.Lookup
- module Network.Google.Resource.Datastore.Projects.Rollback
- module Network.Google.Resource.Datastore.Projects.RunQuery
- 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 Source #
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"] Source #
View and manage your data across Google Cloud Platform services
datastoreScope :: Proxy '["https://www.googleapis.com/auth/datastore"] Source #
View and manage your Google Cloud Datastore data
API Declaration
type DatastoreAPI = ProjectsBeginTransactionResource :<|> (ProjectsAllocateIdsResource :<|> (ProjectsRunQueryResource :<|> (ProjectsRollbackResource :<|> (ProjectsLookupResource :<|> ProjectsCommitResource)))) Source #
Represents the entirety of the methods and resources available for the Google Cloud Datastore API service.
Resources
datastore.projects.allocateIds
datastore.projects.beginTransaction
datastore.projects.commit
datastore.projects.lookup
datastore.projects.rollback
datastore.projects.runQuery
Types
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) Source #
The latitude in degrees. It must be in the range [-90.0, +90.0].
llLongitude :: Lens' LatLng (Maybe Double) Source #
The longitude in degrees. It must be in the range [-180.0, +180.0].
PropertyOrderDirection
data PropertyOrderDirection Source #
The direction to order by. Defaults to `ASCENDING`.
DirectionUnspecified |
|
Ascending |
|
Descending |
|
RollbackRequest
data RollbackRequest Source #
The request for Datastore.Rollback.
See: rollbackRequest
smart constructor.
rollbackRequest :: RollbackRequest Source #
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) Source #
The transaction identifier, returned by a call to Datastore.BeginTransaction.
PartitionId
data PartitionId Source #
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.
partitionId :: PartitionId Source #
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) Source #
If not empty, the ID of the namespace to which the entities belong.
piProjectId :: Lens' PartitionId (Maybe Text) Source #
The ID of the project to which the entities belong.
QueryResultBatch
data QueryResultBatch Source #
A batch of results produced by a query.
See: queryResultBatch
smart constructor.
queryResultBatch :: QueryResultBatch Source #
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) Source #
The number of results skipped, typically because of an offset.
qrbSkippedCursor :: Lens' QueryResultBatch (Maybe ByteString) Source #
A cursor that points to the position after the last skipped result. Will be set when `skipped_results` != 0.
qrbEntityResultType :: Lens' QueryResultBatch (Maybe QueryResultBatchEntityResultType) Source #
The result type for every entity in `entity_results`.
qrbSnapshotVersion :: Lens' QueryResultBatch (Maybe Int64) Source #
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] Source #
The results for this batch.
qrbMoreResults :: Lens' QueryResultBatch (Maybe QueryResultBatchMoreResults) Source #
The state of the query after the current batch.
qrbEndCursor :: Lens' QueryResultBatch (Maybe ByteString) Source #
A cursor that points to the position after the last result in the batch.
CompositeFilterOp
data CompositeFilterOp Source #
The operator for combining multiple filters.
OperatorUnspecified |
|
And |
|
EntityProperties
data EntityProperties Source #
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.
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 Source #
The request for Datastore.BeginTransaction.
See: beginTransactionRequest
smart constructor.
beginTransactionRequest :: BeginTransactionRequest Source #
Creates a value of BeginTransactionRequest
with the minimum fields required to make a request.
RunQueryRequest
data RunQueryRequest Source #
The request for Datastore.RunQuery.
See: runQueryRequest
smart constructor.
runQueryRequest :: RunQueryRequest Source #
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) Source #
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) Source #
The GQL query to run.
rqrReadOptions :: Lens' RunQueryRequest (Maybe ReadOptions) Source #
The options for this query.
AllocateIdsRequest
data AllocateIdsRequest Source #
The request for Datastore.AllocateIds.
See: allocateIdsRequest
smart constructor.
allocateIdsRequest :: AllocateIdsRequest Source #
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] Source #
A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only.
QueryResultBatchEntityResultType
data QueryResultBatchEntityResultType Source #
The result type for every entity in `entity_results`.
QRBERTResultTypeUnspecified |
|
QRBERTFull |
|
QRBERTProjection |
|
QRBERTKeyOnly |
|
CompositeFilter
data CompositeFilter Source #
A filter that merges multiple other filters using the given operator.
See: compositeFilter
smart constructor.
compositeFilter :: CompositeFilter Source #
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) Source #
The operator for combining multiple filters.
cfFilters :: Lens' CompositeFilter [Filter] Source #
The list of filters to combine. Must contain at least one filter.
QueryResultBatchMoreResults
data QueryResultBatchMoreResults Source #
The state of the query after the current batch.
MoreResultsTypeUnspecified |
|
NotFinished |
|
MoreResultsAfterLimit |
|
MoreResultsAfterCursor |
|
NoMoreResults |
|
BeginTransactionResponse
data BeginTransactionResponse Source #
The response for Datastore.BeginTransaction.
See: beginTransactionResponse
smart constructor.
beginTransactionResponse :: BeginTransactionResponse Source #
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) Source #
The transaction identifier (always present).
MutationResult
data MutationResult Source #
The result of applying a mutation.
See: mutationResult
smart constructor.
mutationResult :: MutationResult Source #
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) Source #
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) Source #
The automatically allocated key. Set only when the mutation allocated a key.
mrVersion :: Lens' MutationResult (Maybe Int64) Source #
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 Source #
The response for Datastore.AllocateIds.
See: allocateIdsResponse
smart constructor.
allocateIdsResponse :: AllocateIdsResponse Source #
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] Source #
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] Source #
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) Source #
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) Source #
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 Source #
The response for Datastore.RunQuery.
See: runQueryResponse
smart constructor.
runQueryResponse :: RunQueryResponse Source #
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) Source #
A batch of query results (always present).
rQuery :: Lens' RunQueryResponse (Maybe Query) Source #
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) Source #
A geo point value representing a point on the surface of Earth.
vTimestampValue :: Lens' Value (Maybe UTCTime) Source #
A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
vEntityValue :: Lens' Value (Maybe Entity) Source #
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) Source #
If the value should be excluded from all indexes including those defined explicitly.
vStringValue :: Lens' Value (Maybe Text) Source #
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) Source #
The `meaning` field should only be populated for backwards compatibility.
vArrayValue :: Lens' Value (Maybe ArrayValue) Source #
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) Source #
A null value.
vBlobValue :: Lens' Value (Maybe ByteString) Source #
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 Source #
A null value.
NullValue |
|
LookupRequest
data LookupRequest Source #
The request for Datastore.Lookup.
See: lookupRequest
smart constructor.
lookupRequest :: LookupRequest Source #
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:
lrReadOptions :: Lens' LookupRequest (Maybe ReadOptions) Source #
The options for this lookup request.
ReadOptionsReadConsistency
data ReadOptionsReadConsistency Source #
The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries.
ReadConsistencyUnspecified |
|
Strong |
|
Eventual |
|
Mutation
A mutation to apply to an entity.
See: mutation
smart constructor.
mBaseVersion :: Lens' Mutation (Maybe Int64) Source #
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) Source #
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) Source #
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) Source #
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) Source #
The entity to update. The entity must already exist. Must have a complete key path.
GqlQueryNamedBindings
data GqlQueryNamedBindings Source #
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.
gqlQueryNamedBindings Source #
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 Source #
A reference to a property relative to the kind expressions.
See: propertyReference
smart constructor.
propertyReference :: PropertyReference Source #
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) Source #
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) Source #
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] Source #
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 Source #
A filter on a specific property.
See: propertyFilter
smart constructor.
propertyFilter :: PropertyFilter Source #
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) Source #
The property to filter by.
pfOp :: Lens' PropertyFilter (Maybe PropertyFilterOp) Source #
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) Source #
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) Source #
The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.
qKind :: Lens' Query [KindExpression] Source #
The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.
qDistinctOn :: Lens' Query [PropertyReference] Source #
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) Source #
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) Source #
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] Source #
The projection to return. Defaults to returning all properties.
qOrder :: Lens' Query [PropertyOrder] Source #
The order to apply to the query results (if empty, order is unspecified).
ArrayValue
data ArrayValue Source #
An array value.
See: arrayValue
smart constructor.
arrayValue :: ArrayValue Source #
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] Source #
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 Source #
The result of fetching an entity from Datastore.
See: entityResult
smart constructor.
entityResult :: EntityResult Source #
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) Source #
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) Source #
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 Source #
The response for Datastore.Commit.
See: commitResponse
smart constructor.
commitResponse :: CommitResponse Source #
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) Source #
The number of index entries updated during the commit, or zero if none were updated.
crMutationResults :: Lens' CommitResponse [MutationResult] Source #
The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request.
KindExpression
data KindExpression Source #
A representation of a kind.
See: kindExpression
smart constructor.
kindExpression :: KindExpression Source #
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
data ReadOptions Source #
The options shared by read requests.
See: readOptions
smart constructor.
readOptions :: ReadOptions Source #
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) Source #
The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries.
roTransaction :: Lens' ReadOptions (Maybe ByteString) Source #
The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction.
RollbackResponse
data RollbackResponse Source #
The response for Datastore.Rollback. (an empty message).
See: rollbackResponse
smart constructor.
rollbackResponse :: RollbackResponse Source #
Creates a value of RollbackResponse
with the minimum fields required to make a request.
Projection
data Projection Source #
A representation of a property in a projection.
See: projection
smart constructor.
projection :: Projection Source #
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) Source #
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) Source #
A composite filter.
fPropertyFilter :: Lens' Filter (Maybe PropertyFilter) Source #
A filter on a property.
PropertyFilterOp
data PropertyFilterOp Source #
The operator to filter by.
PFOOperatorUnspecified |
|
PFOLessThan |
|
PFOLessThanOrEqual |
|
PFOGreaterThan |
|
PFOGreaterThanOrEqual |
|
PFOEqual |
|
PFOHasAncestor |
|
CommitRequest
data CommitRequest Source #
The request for Datastore.Commit.
See: commitRequest
smart constructor.
commitRequest :: CommitRequest Source #
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] Source #
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) Source #
The type of commit to perform. Defaults to `TRANSACTIONAL`.
crTransaction :: Lens' CommitRequest (Maybe ByteString) Source #
The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.
CommitRequestMode
data CommitRequestMode Source #
The type of commit to perform. Defaults to `TRANSACTIONAL`.
ModeUnspecified |
|
Transactional |
|
NonTransactional |
|
PathElement
data PathElement Source #
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.
pathElement :: PathElement Source #
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) Source #
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) Source #
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) Source #
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) Source #
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) Source #
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 Source #
The response for Datastore.Lookup.
See: lookupResponse
smart constructor.
lookupResponse :: LookupResponse Source #
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] Source #
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] Source #
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] Source #
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 Source #
The desired order for a specific property.
See: propertyOrder
smart constructor.
propertyOrder :: PropertyOrder Source #
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) Source #
The property to order by.
poDirection :: Lens' PropertyOrder (Maybe PropertyOrderDirection) Source #
The direction to order by. Defaults to `ASCENDING`.
GqlQueryParameter
data GqlQueryParameter Source #
A binding parameter for a GQL query.
See: gqlQueryParameter
smart constructor.
gqlQueryParameter :: GqlQueryParameter Source #
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) Source #
A query cursor. Query cursors are returned in query result batches.