Google Cloud Datastore v1 API - Class Datastore.DatastoreClient (4.5.0)

Version 4.5.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 class Datastore.DatastoreClient : ClientBase<Datastore.DatastoreClient>

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

Client for Datastore

Inheritance

object > ClientBase > ClientBaseDatastoreDatastoreClient > Datastore.DatastoreClient

Inherited Members

ClientBase<Datastore.DatastoreClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

GoogleCloudGoogle.Cloud.DatastoreV1

Assembly

Google.Cloud.Datastore.V1.dll

Constructors

DatastoreClient()

protected DatastoreClient()

Protected parameterless constructor to allow creation of test doubles.

DatastoreClient(CallInvoker)

public DatastoreClient(CallInvoker callInvoker)

Creates a new client for Datastore that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

DatastoreClient(ChannelBase)

public DatastoreClient(ChannelBase channel)

Creates a new client for Datastore

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

DatastoreClient(ClientBaseConfiguration)

protected DatastoreClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AllocateIds(AllocateIdsRequest, CallOptions)

public virtual AllocateIdsResponse AllocateIds(AllocateIdsRequest request, CallOptions options)

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

Parameters
Name	Description
request	AllocateIdsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AllocateIdsResponse	The response received from the server.

AllocateIds(AllocateIdsRequest, Metadata, DateTime?, CancellationToken)

public virtual AllocateIdsResponse AllocateIds(AllocateIdsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	AllocateIdsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AllocateIdsResponse	The response received from the server.

AllocateIdsAsync(AllocateIdsRequest, CallOptions)

public virtual AsyncUnaryCall<AllocateIdsResponse> AllocateIdsAsync(AllocateIdsRequest request, CallOptions options)

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

Parameters
Name	Description
request	AllocateIdsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallAllocateIdsResponse	The call object.

AllocateIdsAsync(AllocateIdsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AllocateIdsResponse> AllocateIdsAsync(AllocateIdsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	AllocateIdsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallAllocateIdsResponse	The call object.

BeginTransaction(BeginTransactionRequest, CallOptions)

public virtual BeginTransactionResponse BeginTransaction(BeginTransactionRequest request, CallOptions options)

Begins a new transaction.

Parameters
Name	Description
request	BeginTransactionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
BeginTransactionResponse	The response received from the server.

BeginTransaction(BeginTransactionRequest, Metadata, DateTime?, CancellationToken)

public virtual BeginTransactionResponse BeginTransaction(BeginTransactionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Begins a new transaction.

Parameters
Name	Description
request	BeginTransactionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
BeginTransactionResponse	The response received from the server.

BeginTransactionAsync(BeginTransactionRequest, CallOptions)

public virtual AsyncUnaryCall<BeginTransactionResponse> BeginTransactionAsync(BeginTransactionRequest request, CallOptions options)

Begins a new transaction.

Parameters
Name	Description
request	BeginTransactionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallBeginTransactionResponse	The call object.

BeginTransactionAsync(BeginTransactionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BeginTransactionResponse> BeginTransactionAsync(BeginTransactionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Begins a new transaction.

Parameters
Name	Description
request	BeginTransactionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallBeginTransactionResponse	The call object.

Commit(CommitRequest, CallOptions)

public virtual CommitResponse Commit(CommitRequest request, CallOptions options)

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

Parameters
Name	Description
request	CommitRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
CommitResponse	The response received from the server.

Commit(CommitRequest, Metadata, DateTime?, CancellationToken)

public virtual CommitResponse Commit(CommitRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CommitRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
CommitResponse	The response received from the server.

CommitAsync(CommitRequest, CallOptions)

public virtual AsyncUnaryCall<CommitResponse> CommitAsync(CommitRequest request, CallOptions options)

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

Parameters
Name	Description
request	CommitRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallCommitResponse	The call object.

CommitAsync(CommitRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CommitResponse> CommitAsync(CommitRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CommitRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallCommitResponse	The call object.

Lookup(LookupRequest, CallOptions)

public virtual LookupResponse Lookup(LookupRequest request, CallOptions options)

Looks up entities by key.

Parameters
Name	Description
request	LookupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
LookupResponse	The response received from the server.

Lookup(LookupRequest, Metadata, DateTime?, CancellationToken)

public virtual LookupResponse Lookup(LookupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Looks up entities by key.

Parameters
Name	Description
request	LookupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
LookupResponse	The response received from the server.

LookupAsync(LookupRequest, CallOptions)

public virtual AsyncUnaryCall<LookupResponse> LookupAsync(LookupRequest request, CallOptions options)

Looks up entities by key.

Parameters
Name	Description
request	LookupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallLookupResponse	The call object.

LookupAsync(LookupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<LookupResponse> LookupAsync(LookupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Looks up entities by key.

Parameters
Name	Description
request	LookupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallLookupResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override Datastore.DatastoreClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
DatastoreDatastoreClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Datastore.V1.Datastore.DatastoreClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

ReserveIds(ReserveIdsRequest, CallOptions)

public virtual ReserveIdsResponse ReserveIds(ReserveIdsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ReserveIdsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ReserveIdsResponse	The response received from the server.

ReserveIds(ReserveIdsRequest, Metadata, DateTime?, CancellationToken)

public virtual ReserveIdsResponse ReserveIds(ReserveIdsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ReserveIdsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ReserveIdsResponse	The response received from the server.

ReserveIdsAsync(ReserveIdsRequest, CallOptions)

public virtual AsyncUnaryCall<ReserveIdsResponse> ReserveIdsAsync(ReserveIdsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ReserveIdsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallReserveIdsResponse	The call object.

ReserveIdsAsync(ReserveIdsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ReserveIdsResponse> ReserveIdsAsync(ReserveIdsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ReserveIdsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallReserveIdsResponse	The call object.

Rollback(RollbackRequest, CallOptions)

public virtual RollbackResponse Rollback(RollbackRequest request, CallOptions options)

Rolls back a transaction.

Parameters
Name	Description
request	RollbackRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
RollbackResponse	The response received from the server.

Rollback(RollbackRequest, Metadata, DateTime?, CancellationToken)

public virtual RollbackResponse Rollback(RollbackRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Rolls back a transaction.

Parameters
Name	Description
request	RollbackRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
RollbackResponse	The response received from the server.

RollbackAsync(RollbackRequest, CallOptions)

public virtual AsyncUnaryCall<RollbackResponse> RollbackAsync(RollbackRequest request, CallOptions options)

Rolls back a transaction.

Parameters
Name	Description
request	RollbackRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRollbackResponse	The call object.

RollbackAsync(RollbackRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RollbackResponse> RollbackAsync(RollbackRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Rolls back a transaction.

Parameters
Name	Description
request	RollbackRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRollbackResponse	The call object.

RunAggregationQuery(RunAggregationQueryRequest, CallOptions)

public virtual RunAggregationQueryResponse RunAggregationQuery(RunAggregationQueryRequest request, CallOptions options)

Runs an aggregation query.

Parameters
Name	Description
request	RunAggregationQueryRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
RunAggregationQueryResponse	The response received from the server.

RunAggregationQuery(RunAggregationQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual RunAggregationQueryResponse RunAggregationQuery(RunAggregationQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Runs an aggregation query.

Parameters
Name	Description
request	RunAggregationQueryRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
RunAggregationQueryResponse	The response received from the server.

RunAggregationQueryAsync(RunAggregationQueryRequest, CallOptions)

public virtual AsyncUnaryCall<RunAggregationQueryResponse> RunAggregationQueryAsync(RunAggregationQueryRequest request, CallOptions options)

Runs an aggregation query.

Parameters
Name	Description
request	RunAggregationQueryRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRunAggregationQueryResponse	The call object.

RunAggregationQueryAsync(RunAggregationQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RunAggregationQueryResponse> RunAggregationQueryAsync(RunAggregationQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Runs an aggregation query.

Parameters
Name	Description
request	RunAggregationQueryRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRunAggregationQueryResponse	The call object.

RunQuery(RunQueryRequest, CallOptions)

public virtual RunQueryResponse RunQuery(RunQueryRequest request, CallOptions options)

Queries for entities.

Parameters
Name	Description
request	RunQueryRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
RunQueryResponse	The response received from the server.

RunQuery(RunQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual RunQueryResponse RunQuery(RunQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Queries for entities.

Parameters
Name	Description
request	RunQueryRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
RunQueryResponse	The response received from the server.

RunQueryAsync(RunQueryRequest, CallOptions)

public virtual AsyncUnaryCall<RunQueryResponse> RunQueryAsync(RunQueryRequest request, CallOptions options)

Queries for entities.

Parameters
Name	Description
request	RunQueryRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRunQueryResponse	The call object.

RunQueryAsync(RunQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RunQueryResponse> RunQueryAsync(RunQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Queries for entities.

Parameters
Name	Description
request	RunQueryRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRunQueryResponse	The call object.