Class CloudMemcache.CloudMemcacheClient

public class CloudMemcacheClient : ClientBase<CloudMemcache.CloudMemcacheClient>

Client for CloudMemcache

Inheritance

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

Namespace

Google.Cloud.Memcache.V1Beta2

Assembly

Google.Cloud.Memcache.V1Beta2.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
TypeNameDescription
CallInvokercallInvoker

The callInvoker to use to make remote calls.

CloudMemcacheClient(ChannelBase)

public CloudMemcacheClient(ChannelBase channel)

Creates a new client for CloudMemcache

Parameter
TypeNameDescription
ChannelBasechannel

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
TypeNameDescription
ClientBase.ClientBaseConfigurationconfiguration

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
TypeNameDescription
ApplyParametersRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

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

public virtual Operation ApplyParameters(ApplyParametersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), 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
TypeNameDescription
ApplyParametersRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
ApplyParametersRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

public virtual AsyncUnaryCall<Operation> ApplyParametersAsync(ApplyParametersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), 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
TypeNameDescription
ApplyParametersRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ApplySoftwareUpdate(ApplySoftwareUpdateRequest, CallOptions)

public virtual Operation ApplySoftwareUpdate(ApplySoftwareUpdateRequest request, CallOptions options)

Updates software on the selected nodes of the Instance.

Parameters
TypeNameDescription
ApplySoftwareUpdateRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ApplySoftwareUpdate(ApplySoftwareUpdateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates software on the selected nodes of the Instance.

Parameters
TypeNameDescription
ApplySoftwareUpdateRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ApplySoftwareUpdateAsync(ApplySoftwareUpdateRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ApplySoftwareUpdateAsync(ApplySoftwareUpdateRequest request, CallOptions options)

Updates software on the selected nodes of the Instance.

Parameters
TypeNameDescription
ApplySoftwareUpdateRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ApplySoftwareUpdateAsync(ApplySoftwareUpdateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates software on the selected nodes of the Instance.

Parameters
TypeNameDescription
ApplySoftwareUpdateRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
CreateInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

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

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

Creates a new Instance in a given location.

Parameters
TypeNameDescription
CreateInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
CreateInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

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

Creates a new Instance in a given location.

Parameters
TypeNameDescription
CreateInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

Returns
TypeDescription
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
TypeNameDescription
DeleteInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

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

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

Deletes a single Instance.

Parameters
TypeNameDescription
DeleteInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteInstanceAsync(DeleteInstanceRequest, CallOptions)

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

Deletes a single Instance.

Parameters
TypeNameDescription
DeleteInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

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

Deletes a single Instance.

Parameters
TypeNameDescription
DeleteInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

GetInstance(GetInstanceRequest, CallOptions)

public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)

Gets details of a single Instance.

Parameters
TypeNameDescription
GetInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Instance

The response received from the server.

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

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

Gets details of a single Instance.

Parameters
TypeNameDescription
GetInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
GetInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Instance>

The call object.

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

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

Gets details of a single Instance.

Parameters
TypeNameDescription
GetInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Instance>

The call object.

ListInstances(ListInstancesRequest, CallOptions)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallOptions options)

Lists Instances in a given location.

Parameters
TypeNameDescription
ListInstancesRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
ListInstancesResponse

The response received from the server.

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

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

Lists Instances in a given location.

Parameters
TypeNameDescription
ListInstancesRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
ListInstancesRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListInstancesResponse>

The call object.

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

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

Lists Instances in a given location.

Parameters
TypeNameDescription
ListInstancesRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
ClientBase.ClientBaseConfigurationconfiguration
Returns
TypeDescription
CloudMemcache.CloudMemcacheClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Memcache.V1Beta2.CloudMemcache.CloudMemcacheClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateInstance(UpdateInstanceRequest, CallOptions)

public virtual Operation UpdateInstance(UpdateInstanceRequest request, CallOptions options)

Updates an existing Instance in a given project and location.

Parameters
TypeNameDescription
UpdateInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

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

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

Updates an existing Instance in a given project and location.

Parameters
TypeNameDescription
UpdateInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
UpdateInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

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

Updates an existing Instance in a given project and location.

Parameters
TypeNameDescription
UpdateInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
UpdateParametersRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

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

public virtual Operation UpdateParameters(UpdateParametersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), 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
TypeNameDescription
UpdateParametersRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
UpdateParametersRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

public virtual AsyncUnaryCall<Operation> UpdateParametersAsync(UpdateParametersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), 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
TypeNameDescription
UpdateParametersRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.