Google Cloud Memorystore for Memcache v1beta2 API - Class CloudMemcacheClientImpl (2.0.0-beta04)

Version 2.0.0-beta04

• 2.0.0-beta05 (latest)
• 2.0.0-beta04
• 1.0.0-beta05

public sealed class CloudMemcacheClientImpl : CloudMemcacheClient

Reference documentation and code samples for the Google Cloud Memorystore for Memcache v1beta2 API class CloudMemcacheClientImpl.

CloudMemcache client wrapper implementation, for convenient use.

Inheritance

object > CloudMemcacheClient > CloudMemcacheClientImpl

Inherited Members

CloudMemcacheClient.DefaultEndpoint

CloudMemcacheClient.DefaultScopes

CloudMemcacheClient.ServiceMetadata

CloudMemcacheClient.CreateAsync(CancellationToken)

CloudMemcacheClient.Create()

CloudMemcacheClient.ShutdownDefaultChannelsAsync()

CloudMemcacheClient.ListInstances(string, string, int?, CallSettings)

CloudMemcacheClient.ListInstancesAsync(string, string, int?, CallSettings)

CloudMemcacheClient.ListInstances(LocationName, string, int?, CallSettings)

CloudMemcacheClient.ListInstancesAsync(LocationName, string, int?, CallSettings)

CloudMemcacheClient.GetInstanceAsync(GetInstanceRequest, CancellationToken)

CloudMemcacheClient.GetInstance(string, CallSettings)

CloudMemcacheClient.GetInstanceAsync(string, CallSettings)

CloudMemcacheClient.GetInstanceAsync(string, CancellationToken)

CloudMemcacheClient.GetInstance(InstanceName, CallSettings)

CloudMemcacheClient.GetInstanceAsync(InstanceName, CallSettings)

CloudMemcacheClient.GetInstanceAsync(InstanceName, CancellationToken)

CloudMemcacheClient.CreateInstanceAsync(CreateInstanceRequest, CancellationToken)

CloudMemcacheClient.PollOnceCreateInstance(string, CallSettings)

CloudMemcacheClient.PollOnceCreateInstanceAsync(string, CallSettings)

CloudMemcacheClient.CreateInstance(string, string, Instance, CallSettings)

CloudMemcacheClient.CreateInstanceAsync(string, string, Instance, CallSettings)

CloudMemcacheClient.CreateInstanceAsync(string, string, Instance, CancellationToken)

CloudMemcacheClient.CreateInstance(LocationName, string, Instance, CallSettings)

CloudMemcacheClient.CreateInstanceAsync(LocationName, string, Instance, CallSettings)

CloudMemcacheClient.CreateInstanceAsync(LocationName, string, Instance, CancellationToken)

CloudMemcacheClient.UpdateInstanceAsync(UpdateInstanceRequest, CancellationToken)

CloudMemcacheClient.PollOnceUpdateInstance(string, CallSettings)

CloudMemcacheClient.PollOnceUpdateInstanceAsync(string, CallSettings)

CloudMemcacheClient.UpdateInstance(FieldMask, Instance, CallSettings)

CloudMemcacheClient.UpdateInstanceAsync(FieldMask, Instance, CallSettings)

CloudMemcacheClient.UpdateInstanceAsync(FieldMask, Instance, CancellationToken)

CloudMemcacheClient.UpdateParametersAsync(UpdateParametersRequest, CancellationToken)

CloudMemcacheClient.PollOnceUpdateParameters(string, CallSettings)

CloudMemcacheClient.PollOnceUpdateParametersAsync(string, CallSettings)

CloudMemcacheClient.UpdateParameters(string, FieldMask, MemcacheParameters, CallSettings)

CloudMemcacheClient.UpdateParametersAsync(string, FieldMask, MemcacheParameters, CallSettings)

CloudMemcacheClient.UpdateParametersAsync(string, FieldMask, MemcacheParameters, CancellationToken)

CloudMemcacheClient.UpdateParameters(InstanceName, FieldMask, MemcacheParameters, CallSettings)

CloudMemcacheClient.UpdateParametersAsync(InstanceName, FieldMask, MemcacheParameters, CallSettings)

CloudMemcacheClient.UpdateParametersAsync(InstanceName, FieldMask, MemcacheParameters, CancellationToken)

CloudMemcacheClient.DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken)

CloudMemcacheClient.PollOnceDeleteInstance(string, CallSettings)

CloudMemcacheClient.PollOnceDeleteInstanceAsync(string, CallSettings)

CloudMemcacheClient.DeleteInstance(string, CallSettings)

CloudMemcacheClient.DeleteInstanceAsync(string, CallSettings)

CloudMemcacheClient.DeleteInstanceAsync(string, CancellationToken)

CloudMemcacheClient.DeleteInstance(InstanceName, CallSettings)

CloudMemcacheClient.DeleteInstanceAsync(InstanceName, CallSettings)

CloudMemcacheClient.DeleteInstanceAsync(InstanceName, CancellationToken)

CloudMemcacheClient.ApplyParametersAsync(ApplyParametersRequest, CancellationToken)

CloudMemcacheClient.PollOnceApplyParameters(string, CallSettings)

CloudMemcacheClient.PollOnceApplyParametersAsync(string, CallSettings)

CloudMemcacheClient.ApplyParameters(string, IEnumerable<string>, bool, CallSettings)

CloudMemcacheClient.ApplyParametersAsync(string, IEnumerable<string>, bool, CallSettings)

CloudMemcacheClient.ApplyParametersAsync(string, IEnumerable<string>, bool, CancellationToken)

CloudMemcacheClient.ApplyParameters(InstanceName, IEnumerable<string>, bool, CallSettings)

CloudMemcacheClient.ApplyParametersAsync(InstanceName, IEnumerable<string>, bool, CallSettings)

CloudMemcacheClient.ApplyParametersAsync(InstanceName, IEnumerable<string>, bool, CancellationToken)

CloudMemcacheClient.ApplySoftwareUpdateAsync(ApplySoftwareUpdateRequest, CancellationToken)

CloudMemcacheClient.PollOnceApplySoftwareUpdate(string, CallSettings)

CloudMemcacheClient.PollOnceApplySoftwareUpdateAsync(string, CallSettings)

CloudMemcacheClient.ApplySoftwareUpdate(string, IEnumerable<string>, bool, CallSettings)

CloudMemcacheClient.ApplySoftwareUpdateAsync(string, IEnumerable<string>, bool, CallSettings)

CloudMemcacheClient.ApplySoftwareUpdateAsync(string, IEnumerable<string>, bool, CancellationToken)

CloudMemcacheClient.ApplySoftwareUpdate(InstanceName, IEnumerable<string>, bool, CallSettings)

CloudMemcacheClient.ApplySoftwareUpdateAsync(InstanceName, IEnumerable<string>, bool, CallSettings)

CloudMemcacheClient.ApplySoftwareUpdateAsync(InstanceName, IEnumerable<string>, bool, CancellationToken)

CloudMemcacheClient.RescheduleMaintenanceAsync(RescheduleMaintenanceRequest, CancellationToken)

CloudMemcacheClient.PollOnceRescheduleMaintenance(string, CallSettings)

CloudMemcacheClient.PollOnceRescheduleMaintenanceAsync(string, CallSettings)

CloudMemcacheClient.RescheduleMaintenance(string, RescheduleMaintenanceRequest.Types.RescheduleType, Timestamp, CallSettings)

CloudMemcacheClient.RescheduleMaintenanceAsync(string, RescheduleMaintenanceRequest.Types.RescheduleType, Timestamp, CallSettings)

CloudMemcacheClient.RescheduleMaintenanceAsync(string, RescheduleMaintenanceRequest.Types.RescheduleType, Timestamp, CancellationToken)

CloudMemcacheClient.RescheduleMaintenance(InstanceName, RescheduleMaintenanceRequest.Types.RescheduleType, Timestamp, CallSettings)

CloudMemcacheClient.RescheduleMaintenanceAsync(InstanceName, RescheduleMaintenanceRequest.Types.RescheduleType, Timestamp, CallSettings)

CloudMemcacheClient.RescheduleMaintenanceAsync(InstanceName, RescheduleMaintenanceRequest.Types.RescheduleType, Timestamp, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Memcache.V1Beta2

Assembly

Google.Cloud.Memcache.V1Beta2.dll

Remarks

Configures and manages Cloud Memorystore for Memcached instances.

The memcache.googleapis.com service implements the Google Cloud Memorystore for Memcached API and defines the following resource model for managing Memorystore Memcached (also called Memcached below) instances:

• The service works with a collection of cloud projects, named: /projects/*
• Each project has a collection of available locations, named: /locations/*
• Each location has a collection of Memcached instances, named: /instances/*
• As such, Memcached instances are resources of the form: /projects/{project_id}/locations/{location_id}/instances/{instance_id}

Note that location_id must be a GCP region; for example:

• projects/my-memcached-project/locations/us-central1/instances/my-memcached

Constructors

CloudMemcacheClientImpl(CloudMemcacheClient, CloudMemcacheSettings, ILogger)

public CloudMemcacheClientImpl(CloudMemcache.CloudMemcacheClient grpcClient, CloudMemcacheSettings settings, ILogger logger)

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

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

Properties

ApplyParametersOperationsClient

public override OperationsClient ApplyParametersOperationsClient { get; }

The long-running operations client for ApplyParameters.

Property Value
Type	Description
OperationsClient

Overrides

CloudMemcacheClient.ApplyParametersOperationsClient

ApplySoftwareUpdateOperationsClient

public override OperationsClient ApplySoftwareUpdateOperationsClient { get; }

The long-running operations client for ApplySoftwareUpdate.

Property Value
Type	Description
OperationsClient

Overrides

CloudMemcacheClient.ApplySoftwareUpdateOperationsClient

CreateInstanceOperationsClient

public override OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
Type	Description
OperationsClient

Overrides

CloudMemcacheClient.CreateInstanceOperationsClient

DeleteInstanceOperationsClient

public override OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
Type	Description
OperationsClient

Overrides

CloudMemcacheClient.DeleteInstanceOperationsClient

GrpcClient

public override CloudMemcache.CloudMemcacheClient GrpcClient { get; }

The underlying gRPC CloudMemcache client

Property Value
Type	Description
CloudMemcacheCloudMemcacheClient

Overrides

CloudMemcacheClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

CloudMemcacheClient.LocationsClient

RescheduleMaintenanceOperationsClient

public override OperationsClient RescheduleMaintenanceOperationsClient { get; }

The long-running operations client for RescheduleMaintenance.

Property Value
Type	Description
OperationsClient

Overrides

CloudMemcacheClient.RescheduleMaintenanceOperationsClient

UpdateInstanceOperationsClient

public override OperationsClient UpdateInstanceOperationsClient { get; }

The long-running operations client for UpdateInstance.

Property Value
Type	Description
OperationsClient

Overrides

CloudMemcacheClient.UpdateInstanceOperationsClient

UpdateParametersOperationsClient

public override OperationsClient UpdateParametersOperationsClient { get; }

The long-running operations client for UpdateParameters.

Property Value
Type	Description
OperationsClient

Overrides

CloudMemcacheClient.UpdateParametersOperationsClient

Methods

ApplyParameters(ApplyParametersRequest, CallSettings)

public override Operation<Instance, OperationMetadata> ApplyParameters(ApplyParametersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationInstanceOperationMetadata	The RPC response.

Overrides

CloudMemcacheClient.ApplyParameters(ApplyParametersRequest, CallSettings)

ApplyParametersAsync(ApplyParametersRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> ApplyParametersAsync(ApplyParametersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationInstanceOperationMetadata	A Task containing the RPC response.

Overrides

CloudMemcacheClient.ApplyParametersAsync(ApplyParametersRequest, CallSettings)

ApplySoftwareUpdate(ApplySoftwareUpdateRequest, CallSettings)

public override Operation<Instance, OperationMetadata> ApplySoftwareUpdate(ApplySoftwareUpdateRequest request, CallSettings callSettings = null)

Updates software on the selected nodes of the Instance.

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

Returns
Type	Description
OperationInstanceOperationMetadata	The RPC response.

Overrides

CloudMemcacheClient.ApplySoftwareUpdate(ApplySoftwareUpdateRequest, CallSettings)

ApplySoftwareUpdateAsync(ApplySoftwareUpdateRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> ApplySoftwareUpdateAsync(ApplySoftwareUpdateRequest request, CallSettings callSettings = null)

Updates software on the selected nodes of the Instance.

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

Returns
Type	Description
TaskOperationInstanceOperationMetadata	A Task containing the RPC response.

Overrides

CloudMemcacheClient.ApplySoftwareUpdateAsync(ApplySoftwareUpdateRequest, CallSettings)

CreateInstance(CreateInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> CreateInstance(CreateInstanceRequest request, CallSettings callSettings = null)

Creates a new Instance in a given location.

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

Returns
Type	Description
OperationInstanceOperationMetadata	The RPC response.

Overrides

CloudMemcacheClient.CreateInstance(CreateInstanceRequest, CallSettings)

CreateInstanceAsync(CreateInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> CreateInstanceAsync(CreateInstanceRequest request, CallSettings callSettings = null)

Creates a new Instance in a given location.

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

Returns
Type	Description
TaskOperationInstanceOperationMetadata	A Task containing the RPC response.

Overrides

CloudMemcacheClient.CreateInstanceAsync(CreateInstanceRequest, CallSettings)

DeleteInstance(DeleteInstanceRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteInstance(DeleteInstanceRequest request, CallSettings callSettings = null)

Deletes a single Instance.

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

Returns
Type	Description
OperationEmptyOperationMetadata	The RPC response.

Overrides

CloudMemcacheClient.DeleteInstance(DeleteInstanceRequest, CallSettings)

DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(DeleteInstanceRequest request, CallSettings callSettings = null)

Deletes a single Instance.

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

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Overrides

CloudMemcacheClient.DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

GetInstance(GetInstanceRequest, CallSettings)

public override Instance GetInstance(GetInstanceRequest request, CallSettings callSettings = null)

Gets details of a single Instance.

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

Returns
Type	Description
Instance	The RPC response.

Overrides

CloudMemcacheClient.GetInstance(GetInstanceRequest, CallSettings)

GetInstanceAsync(GetInstanceRequest, CallSettings)

public override Task<Instance> GetInstanceAsync(GetInstanceRequest request, CallSettings callSettings = null)

Gets details of a single Instance.

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

Returns
Type	Description
TaskInstance	A Task containing the RPC response.

Overrides

CloudMemcacheClient.GetInstanceAsync(GetInstanceRequest, CallSettings)

ListInstances(ListInstancesRequest, CallSettings)

public override PagedEnumerable<ListInstancesResponse, Instance> ListInstances(ListInstancesRequest request, CallSettings callSettings = null)

Lists Instances in a given location.

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

Returns
Type	Description
PagedEnumerableListInstancesResponseInstance	A pageable sequence of Instance resources.

Overrides

CloudMemcacheClient.ListInstances(ListInstancesRequest, CallSettings)

ListInstancesAsync(ListInstancesRequest, CallSettings)

public override PagedAsyncEnumerable<ListInstancesResponse, Instance> ListInstancesAsync(ListInstancesRequest request, CallSettings callSettings = null)

Lists Instances in a given location.

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

Returns
Type	Description
PagedAsyncEnumerableListInstancesResponseInstance	A pageable asynchronous sequence of Instance resources.

Overrides

CloudMemcacheClient.ListInstancesAsync(ListInstancesRequest, CallSettings)

RescheduleMaintenance(RescheduleMaintenanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> RescheduleMaintenance(RescheduleMaintenanceRequest request, CallSettings callSettings = null)

Performs the apply phase of the RescheduleMaintenance verb.

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

Returns
Type	Description
OperationInstanceOperationMetadata	The RPC response.

Overrides

CloudMemcacheClient.RescheduleMaintenance(RescheduleMaintenanceRequest, CallSettings)

RescheduleMaintenanceAsync(RescheduleMaintenanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> RescheduleMaintenanceAsync(RescheduleMaintenanceRequest request, CallSettings callSettings = null)

Performs the apply phase of the RescheduleMaintenance verb.

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

Returns
Type	Description
TaskOperationInstanceOperationMetadata	A Task containing the RPC response.

Overrides

CloudMemcacheClient.RescheduleMaintenanceAsync(RescheduleMaintenanceRequest, CallSettings)

UpdateInstance(UpdateInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> UpdateInstance(UpdateInstanceRequest request, CallSettings callSettings = null)

Updates an existing Instance in a given project and location.

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

Returns
Type	Description
OperationInstanceOperationMetadata	The RPC response.

Overrides

CloudMemcacheClient.UpdateInstance(UpdateInstanceRequest, CallSettings)

UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> UpdateInstanceAsync(UpdateInstanceRequest request, CallSettings callSettings = null)

Updates an existing Instance in a given project and location.

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

Returns
Type	Description
TaskOperationInstanceOperationMetadata	A Task containing the RPC response.

Overrides

CloudMemcacheClient.UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)

UpdateParameters(UpdateParametersRequest, CallSettings)

public override Operation<Instance, OperationMetadata> UpdateParameters(UpdateParametersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationInstanceOperationMetadata	The RPC response.

Overrides

CloudMemcacheClient.UpdateParameters(UpdateParametersRequest, CallSettings)

UpdateParametersAsync(UpdateParametersRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> UpdateParametersAsync(UpdateParametersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationInstanceOperationMetadata	A Task containing the RPC response.

Overrides

CloudMemcacheClient.UpdateParametersAsync(UpdateParametersRequest, CallSettings)