Cloud Memorystore for Memcached v1 API - Class CloudMemcache.CloudMemcacheClient (2.1.0)

Version 2.1.0

• 2.5.0 (latest)
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0
• 1.0.0

public class CloudMemcacheClient : ClientBase<CloudMemcache.CloudMemcacheClient>

Reference documentation and code samples for the Cloud Memorystore for Memcached v1 API class CloudMemcache.CloudMemcacheClient.

Client for CloudMemcache

Inheritance

Object > ClientBase > ClientBase<CloudMemcache.CloudMemcacheClient> > CloudMemcache.CloudMemcacheClient

Inherited Members

ClientBase<CloudMemcache.CloudMemcacheClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Memcache.V1

Assembly

Google.Cloud.Memcache.V1.dll

Constructors

CloudMemcacheClient()

protected CloudMemcacheClient()

Protected parameterless constructor to allow creation of test doubles.

CloudMemcacheClient(CallInvoker)

public CloudMemcacheClient(CallInvoker callInvoker)

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

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

CloudMemcacheClient(ChannelBase)

public CloudMemcacheClient(ChannelBase channel)

Creates a new client for CloudMemcache

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

CloudMemcacheClient(ClientBase.ClientBaseConfiguration)

protected CloudMemcacheClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration The client configuration.

Methods

ApplyParameters(ApplyParametersRequest, CallOptions)

public virtual Operation ApplyParameters(ApplyParametersRequest request, CallOptions options)

ApplyParameters restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.

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

Returns
Type	Description
Operation	The response received from the server.

ApplyParameters(ApplyParametersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ApplyParameters(ApplyParametersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

ApplyParameters restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.

Parameters
Name	Description
request	ApplyParametersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
Operation	The response received from the server.

ApplyParametersAsync(ApplyParametersRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ApplyParametersAsync(ApplyParametersRequest request, CallOptions options)

ApplyParameters restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.

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

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

ApplyParametersAsync(ApplyParametersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ApplyParametersAsync(ApplyParametersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

ApplyParameters restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.

Parameters
Name	Description
request	ApplyParametersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.

CreateInstance(CreateInstanceRequest, CallOptions)

public virtual Operation CreateInstance(CreateInstanceRequest request, CallOptions options)

Creates a new Instance in a given location.

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

Returns
Type	Description
Operation	The response received from the server.

CreateInstance(CreateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateInstance(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new Instance in a given location.

Parameters
Name	Description
request	CreateInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
Operation	The response received from the server.

CreateInstanceAsync(CreateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, CallOptions options)

Creates a new Instance in a given location.

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

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateInstanceAsync(CreateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new Instance in a given location.

Parameters
Name	Description
request	CreateInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
Locations.LocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
Operations.OperationsClient	A new Operations client for the same target as this client.

DeleteInstance(DeleteInstanceRequest, CallOptions)

public virtual Operation DeleteInstance(DeleteInstanceRequest request, CallOptions options)

Deletes a single Instance.

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

Returns
Type	Description
Operation	The response received from the server.

DeleteInstance(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteInstance(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a single Instance.

Parameters
Name	Description
request	DeleteInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
Operation	The response received from the server.

DeleteInstanceAsync(DeleteInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, CallOptions options)

Deletes a single Instance.

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

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

DeleteInstanceAsync(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a single Instance.

Parameters
Name	Description
request	DeleteInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.

GetInstance(GetInstanceRequest, CallOptions)

public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)

Gets details of a single Instance.

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

Returns
Type	Description
Instance	The response received from the server.

GetInstance(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Instance GetInstance(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single Instance.

Parameters
Name	Description
request	GetInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
Instance	The response received from the server.

GetInstanceAsync(GetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, CallOptions options)

Gets details of a single Instance.

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

Returns
Type	Description
AsyncUnaryCall<Instance>	The call object.

GetInstanceAsync(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single Instance.

Parameters
Name	Description
request	GetInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Instance>	The call object.

ListInstances(ListInstancesRequest, CallOptions)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallOptions options)

Lists Instances in a given location.

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

Returns
Type	Description
ListInstancesResponse	The response received from the server.

ListInstances(ListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists Instances in a given location.

Parameters
Name	Description
request	ListInstancesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
ListInstancesResponse	The response received from the server.

ListInstancesAsync(ListInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, CallOptions options)

Lists Instances in a given location.

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

Returns
Type	Description
AsyncUnaryCall<ListInstancesResponse>	The call object.

ListInstancesAsync(ListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists Instances in a given location.

Parameters
Name	Description
request	ListInstancesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<ListInstancesResponse>	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override CloudMemcache.CloudMemcacheClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration

Returns
Type	Description
CloudMemcache.CloudMemcacheClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Memcache.V1.CloudMemcache.CloudMemcacheClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RescheduleMaintenance(RescheduleMaintenanceRequest, CallOptions)

public virtual Operation RescheduleMaintenance(RescheduleMaintenanceRequest request, CallOptions options)

Reschedules upcoming maintenance event.

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

Returns
Type	Description
Operation	The response received from the server.

RescheduleMaintenance(RescheduleMaintenanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation RescheduleMaintenance(RescheduleMaintenanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Reschedules upcoming maintenance event.

Parameters
Name	Description
request	RescheduleMaintenanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
Operation	The response received from the server.

RescheduleMaintenanceAsync(RescheduleMaintenanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RescheduleMaintenanceAsync(RescheduleMaintenanceRequest request, CallOptions options)

Reschedules upcoming maintenance event.

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

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

RescheduleMaintenanceAsync(RescheduleMaintenanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> RescheduleMaintenanceAsync(RescheduleMaintenanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Reschedules upcoming maintenance event.

Parameters
Name	Description
request	RescheduleMaintenanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.

UpdateInstance(UpdateInstanceRequest, CallOptions)

public virtual Operation UpdateInstance(UpdateInstanceRequest request, CallOptions options)

Updates an existing Instance in a given project and location.

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

Returns
Type	Description
Operation	The response received from the server.

UpdateInstance(UpdateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpdateInstance(UpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates an existing Instance in a given project and location.

Parameters
Name	Description
request	UpdateInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
Operation	The response received from the server.

UpdateInstanceAsync(UpdateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateInstanceAsync(UpdateInstanceRequest request, CallOptions options)

Updates an existing Instance in a given project and location.

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

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

UpdateInstanceAsync(UpdateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateInstanceAsync(UpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates an existing Instance in a given project and location.

Parameters
Name	Description
request	UpdateInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.

UpdateParameters(UpdateParametersRequest, CallOptions)

public virtual Operation UpdateParameters(UpdateParametersRequest request, CallOptions options)

Updates the defined Memcached parameters for an existing instance. This method only stages the parameters, it must be followed by ApplyParameters to apply the parameters to nodes of the Memcached instance.

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

Returns
Type	Description
Operation	The response received from the server.

UpdateParameters(UpdateParametersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpdateParameters(UpdateParametersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the defined Memcached parameters for an existing instance. This method only stages the parameters, it must be followed by ApplyParameters to apply the parameters to nodes of the Memcached instance.

Parameters
Name	Description
request	UpdateParametersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
Operation	The response received from the server.

UpdateParametersAsync(UpdateParametersRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateParametersAsync(UpdateParametersRequest request, CallOptions options)

Updates the defined Memcached parameters for an existing instance. This method only stages the parameters, it must be followed by ApplyParameters to apply the parameters to nodes of the Memcached instance.

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

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

UpdateParametersAsync(UpdateParametersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateParametersAsync(UpdateParametersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the defined Memcached parameters for an existing instance. This method only stages the parameters, it must be followed by ApplyParameters to apply the parameters to nodes of the Memcached instance.

Parameters
Name	Description
request	UpdateParametersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.