public class CloudMemcache.CloudMemcacheClient : ClientBase<CloudMemcache.CloudMemcacheClient>
Reference documentation and code samples for the Google Cloud Memorystore for Memcache v1beta2 API class CloudMemcache.CloudMemcacheClient.
Client for CloudMemcache
Inheritance
object > ClientBase > ClientBaseCloudMemcacheCloudMemcacheClient > CloudMemcache.CloudMemcacheClientNamespace
Google.Cloud.Memcache.V1Beta2Assembly
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 | |
---|---|
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(ClientBaseConfiguration)
protected CloudMemcacheClient(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration 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, DateTime?, CancellationToken)
public virtual Operation ApplyParameters(ApplyParametersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallOperation |
The call object. |
ApplyParametersAsync(ApplyParametersRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> ApplyParametersAsync(ApplyParametersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallOperation |
The call object. |
ApplySoftwareUpdate(ApplySoftwareUpdateRequest, CallOptions)
public virtual Operation ApplySoftwareUpdate(ApplySoftwareUpdateRequest request, CallOptions options)
Updates software on the selected nodes of the Instance.
Parameters | |
---|---|
Name | Description |
request |
ApplySoftwareUpdateRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
ApplySoftwareUpdate(ApplySoftwareUpdateRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation ApplySoftwareUpdate(ApplySoftwareUpdateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates software on the selected nodes of the Instance.
Parameters | |
---|---|
Name | Description |
request |
ApplySoftwareUpdateRequest 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 |
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 | |
---|---|
Name | Description |
request |
ApplySoftwareUpdateRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
ApplySoftwareUpdateAsync(ApplySoftwareUpdateRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> ApplySoftwareUpdateAsync(ApplySoftwareUpdateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates software on the selected nodes of the Instance.
Parameters | |
---|---|
Name | Description |
request |
ApplySoftwareUpdateRequest 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 |
AsyncUnaryCallOperation |
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, DateTime?, CancellationToken)
public virtual Operation CreateInstance(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallOperation |
The call object. |
CreateInstanceAsync(CreateInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallOperation |
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 |
LocationsLocationsClient |
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 |
OperationsOperationsClient |
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, DateTime?, CancellationToken)
public virtual Operation DeleteInstance(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallOperation |
The call object. |
DeleteInstanceAsync(DeleteInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallOperation |
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, DateTime?, CancellationToken)
public virtual Instance GetInstance(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallInstance |
The call object. |
GetInstanceAsync(GetInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallInstance |
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, DateTime?, CancellationToken)
public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallListInstancesResponse |
The call object. |
ListInstancesAsync(ListInstancesRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallListInstancesResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override CloudMemcache.CloudMemcacheClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Creates a new instance of client from given ClientBaseConfiguration
.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
Returns | |
---|---|
Type | Description |
CloudMemcacheCloudMemcacheClient |
RescheduleMaintenance(RescheduleMaintenanceRequest, CallOptions)
public virtual Operation RescheduleMaintenance(RescheduleMaintenanceRequest request, CallOptions options)
Performs the apply phase of the RescheduleMaintenance verb.
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, DateTime?, CancellationToken)
public virtual Operation RescheduleMaintenance(RescheduleMaintenanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Performs the apply phase of the RescheduleMaintenance verb.
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 |
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)
Performs the apply phase of the RescheduleMaintenance verb.
Parameters | |
---|---|
Name | Description |
request |
RescheduleMaintenanceRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
RescheduleMaintenanceAsync(RescheduleMaintenanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> RescheduleMaintenanceAsync(RescheduleMaintenanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Performs the apply phase of the RescheduleMaintenance verb.
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 |
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 |
AsyncUnaryCallOperation |
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, DateTime?, CancellationToken)
public virtual Operation UpdateInstance(UpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallOperation |
The call object. |
UpdateInstanceAsync(UpdateInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateInstanceAsync(UpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallOperation |
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, DateTime?, CancellationToken)
public virtual Operation UpdateParameters(UpdateParametersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallOperation |
The call object. |
UpdateParametersAsync(UpdateParametersRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateParametersAsync(UpdateParametersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallOperation |
The call object. |