Google Cloud Datastore v1 API - Class DatastoreClientImpl (4.6.0)

Version 4.6.0

• 4.14.0 (latest)
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.7.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0

public sealed class DatastoreClientImpl : DatastoreClient

Reference documentation and code samples for the Google Cloud Datastore v1 API class DatastoreClientImpl.

Datastore client wrapper implementation, for convenient use.

Inheritance

object > DatastoreClient > DatastoreClientImpl

Inherited Members

DatastoreClient.DefaultEndpoint

DatastoreClient.DefaultScopes

DatastoreClient.ServiceMetadata

DatastoreClient.CreateAsync(CancellationToken)

DatastoreClient.Create()

DatastoreClient.ShutdownDefaultChannelsAsync()

DatastoreClient.LookupAsync(LookupRequest, CancellationToken)

DatastoreClient.Lookup(string, ReadOptions, IEnumerable<Key>, CallSettings)

DatastoreClient.LookupAsync(string, ReadOptions, IEnumerable<Key>, CallSettings)

DatastoreClient.LookupAsync(string, ReadOptions, IEnumerable<Key>, CancellationToken)

DatastoreClient.RunQueryAsync(RunQueryRequest, CancellationToken)

DatastoreClient.RunAggregationQueryAsync(RunAggregationQueryRequest, CancellationToken)

DatastoreClient.BeginTransactionAsync(BeginTransactionRequest, CancellationToken)

DatastoreClient.BeginTransaction(string, CallSettings)

DatastoreClient.BeginTransactionAsync(string, CallSettings)

DatastoreClient.BeginTransactionAsync(string, CancellationToken)

DatastoreClient.CommitAsync(CommitRequest, CancellationToken)

DatastoreClient.Commit(string, CommitRequest.Types.Mode, ByteString, IEnumerable<Mutation>, CallSettings)

DatastoreClient.CommitAsync(string, CommitRequest.Types.Mode, ByteString, IEnumerable<Mutation>, CallSettings)

DatastoreClient.CommitAsync(string, CommitRequest.Types.Mode, ByteString, IEnumerable<Mutation>, CancellationToken)

DatastoreClient.Commit(string, CommitRequest.Types.Mode, IEnumerable<Mutation>, CallSettings)

DatastoreClient.CommitAsync(string, CommitRequest.Types.Mode, IEnumerable<Mutation>, CallSettings)

DatastoreClient.CommitAsync(string, CommitRequest.Types.Mode, IEnumerable<Mutation>, CancellationToken)

DatastoreClient.RollbackAsync(RollbackRequest, CancellationToken)

DatastoreClient.Rollback(string, ByteString, CallSettings)

DatastoreClient.RollbackAsync(string, ByteString, CallSettings)

DatastoreClient.RollbackAsync(string, ByteString, CancellationToken)

DatastoreClient.AllocateIdsAsync(AllocateIdsRequest, CancellationToken)

DatastoreClient.AllocateIds(string, IEnumerable<Key>, CallSettings)

DatastoreClient.AllocateIdsAsync(string, IEnumerable<Key>, CallSettings)

DatastoreClient.AllocateIdsAsync(string, IEnumerable<Key>, CancellationToken)

DatastoreClient.ReserveIdsAsync(ReserveIdsRequest, CancellationToken)

DatastoreClient.ReserveIds(string, IEnumerable<Key>, CallSettings)

DatastoreClient.ReserveIdsAsync(string, IEnumerable<Key>, CallSettings)

DatastoreClient.ReserveIdsAsync(string, IEnumerable<Key>, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Datastore.V1

Assembly

Google.Cloud.Datastore.V1.dll

Remarks

Each RPC normalizes the partition IDs of the keys in its input entities, and always returns entities with keys with normalized partition IDs. This applies to all keys and entities, including those in values, except keys with both an empty path and an empty or unset partition ID. Normalization of input keys sets the project ID (if not already set) to the project ID from the request.

Constructors

DatastoreClientImpl(DatastoreClient, DatastoreSettings, ILogger)

public DatastoreClientImpl(Datastore.DatastoreClient grpcClient, DatastoreSettings settings, ILogger logger)

Constructs a client wrapper for the Datastore service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	DatastoreDatastoreClient The underlying gRPC client.
settings	DatastoreSettings The base DatastoreSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override Datastore.DatastoreClient GrpcClient { get; }

The underlying gRPC Datastore client

Property Value
Type	Description
DatastoreDatastoreClient

Overrides

DatastoreClient.GrpcClient

Methods

AllocateIds(AllocateIdsRequest, CallSettings)

public override AllocateIdsResponse AllocateIds(AllocateIdsRequest request, CallSettings callSettings = null)

Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted.

Parameters
Name	Description
request	AllocateIdsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AllocateIdsResponse	The RPC response.

Overrides

DatastoreClient.AllocateIds(AllocateIdsRequest, CallSettings)

AllocateIdsAsync(AllocateIdsRequest, CallSettings)

public override Task<AllocateIdsResponse> AllocateIdsAsync(AllocateIdsRequest request, CallSettings callSettings = null)

Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted.

Parameters
Name	Description
request	AllocateIdsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskAllocateIdsResponse	A Task containing the RPC response.

Overrides

DatastoreClient.AllocateIdsAsync(AllocateIdsRequest, CallSettings)

BeginTransaction(BeginTransactionRequest, CallSettings)

public override BeginTransactionResponse BeginTransaction(BeginTransactionRequest request, CallSettings callSettings = null)

Begins a new transaction.

Parameters
Name	Description
request	BeginTransactionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BeginTransactionResponse	The RPC response.

Overrides

DatastoreClient.BeginTransaction(BeginTransactionRequest, CallSettings)

BeginTransactionAsync(BeginTransactionRequest, CallSettings)

public override Task<BeginTransactionResponse> BeginTransactionAsync(BeginTransactionRequest request, CallSettings callSettings = null)

Begins a new transaction.

Parameters
Name	Description
request	BeginTransactionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskBeginTransactionResponse	A Task containing the RPC response.

Overrides

DatastoreClient.BeginTransactionAsync(BeginTransactionRequest, CallSettings)

Commit(CommitRequest, CallSettings)

public override CommitResponse Commit(CommitRequest request, CallSettings callSettings = null)

Commits a transaction, optionally creating, deleting or modifying some entities.

Parameters
Name	Description
request	CommitRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CommitResponse	The RPC response.

Overrides

DatastoreClient.Commit(CommitRequest, CallSettings)

CommitAsync(CommitRequest, CallSettings)

public override Task<CommitResponse> CommitAsync(CommitRequest request, CallSettings callSettings = null)

Commits a transaction, optionally creating, deleting or modifying some entities.

Parameters
Name	Description
request	CommitRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskCommitResponse	A Task containing the RPC response.

Overrides

DatastoreClient.CommitAsync(CommitRequest, CallSettings)

Lookup(LookupRequest, CallSettings)

public override LookupResponse Lookup(LookupRequest request, CallSettings callSettings = null)

Looks up entities by key.

Parameters
Name	Description
request	LookupRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
LookupResponse	The RPC response.

Overrides

DatastoreClient.Lookup(LookupRequest, CallSettings)

LookupAsync(LookupRequest, CallSettings)

public override Task<LookupResponse> LookupAsync(LookupRequest request, CallSettings callSettings = null)

Looks up entities by key.

Parameters
Name	Description
request	LookupRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskLookupResponse	A Task containing the RPC response.

Overrides

DatastoreClient.LookupAsync(LookupRequest, CallSettings)

ReserveIds(ReserveIdsRequest, CallSettings)

public override ReserveIdsResponse ReserveIds(ReserveIdsRequest request, CallSettings callSettings = null)

Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.

Parameters
Name	Description
request	ReserveIdsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ReserveIdsResponse	The RPC response.

Overrides

DatastoreClient.ReserveIds(ReserveIdsRequest, CallSettings)

ReserveIdsAsync(ReserveIdsRequest, CallSettings)

public override Task<ReserveIdsResponse> ReserveIdsAsync(ReserveIdsRequest request, CallSettings callSettings = null)

Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.

Parameters
Name	Description
request	ReserveIdsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskReserveIdsResponse	A Task containing the RPC response.

Overrides

DatastoreClient.ReserveIdsAsync(ReserveIdsRequest, CallSettings)

Rollback(RollbackRequest, CallSettings)

public override RollbackResponse Rollback(RollbackRequest request, CallSettings callSettings = null)

Rolls back a transaction.

Parameters
Name	Description
request	RollbackRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
RollbackResponse	The RPC response.

Overrides

DatastoreClient.Rollback(RollbackRequest, CallSettings)

RollbackAsync(RollbackRequest, CallSettings)

public override Task<RollbackResponse> RollbackAsync(RollbackRequest request, CallSettings callSettings = null)

Rolls back a transaction.

Parameters
Name	Description
request	RollbackRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskRollbackResponse	A Task containing the RPC response.

Overrides

DatastoreClient.RollbackAsync(RollbackRequest, CallSettings)

RunAggregationQuery(RunAggregationQueryRequest, CallSettings)

public override RunAggregationQueryResponse RunAggregationQuery(RunAggregationQueryRequest request, CallSettings callSettings = null)

Runs an aggregation query.

Parameters
Name	Description
request	RunAggregationQueryRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
RunAggregationQueryResponse	The RPC response.

Overrides

DatastoreClient.RunAggregationQuery(RunAggregationQueryRequest, CallSettings)

RunAggregationQueryAsync(RunAggregationQueryRequest, CallSettings)

public override Task<RunAggregationQueryResponse> RunAggregationQueryAsync(RunAggregationQueryRequest request, CallSettings callSettings = null)

Runs an aggregation query.

Parameters
Name	Description
request	RunAggregationQueryRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskRunAggregationQueryResponse	A Task containing the RPC response.

Overrides

DatastoreClient.RunAggregationQueryAsync(RunAggregationQueryRequest, CallSettings)

RunQuery(RunQueryRequest, CallSettings)

public override RunQueryResponse RunQuery(RunQueryRequest request, CallSettings callSettings = null)

Queries for entities.

Parameters
Name	Description
request	RunQueryRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
RunQueryResponse	The RPC response.

Overrides

DatastoreClient.RunQuery(RunQueryRequest, CallSettings)

RunQueryAsync(RunQueryRequest, CallSettings)

public override Task<RunQueryResponse> RunQueryAsync(RunQueryRequest request, CallSettings callSettings = null)

Queries for entities.

Parameters
Name	Description
request	RunQueryRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskRunQueryResponse	A Task containing the RPC response.

Overrides

DatastoreClient.RunQueryAsync(RunQueryRequest, CallSettings)