Memorystore v1 API - Class MemorystoreClientImpl (1.0.0-beta03) 

public sealed class MemorystoreClientImpl : MemorystoreClient

Reference documentation and code samples for the Memorystore v1 API class MemorystoreClientImpl.

Memorystore client wrapper implementation, for convenient use.

Inheritance

object > MemorystoreClient > MemorystoreClientImpl

Namespace

Google.Cloud.Memorystore.V1

Assembly

Google.Cloud.Memorystore.V1.dll

Remarks

Service describing handlers for resources

Constructors

MemorystoreClientImpl(MemorystoreClient, MemorystoreSettings, ILogger)

public MemorystoreClientImpl(Memorystore.MemorystoreClient grpcClient, MemorystoreSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient MemorystoreMemorystoreClient

The underlying gRPC client.
settings MemorystoreSettings

The base MemorystoreSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

BackupInstanceOperationsClient

public override OperationsClient BackupInstanceOperationsClient { get; }

The long-running operations client for BackupInstance.

Property Value
Type Description
OperationsClient
Overrides

CreateInstanceOperationsClient

public override OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
Type Description
OperationsClient
Overrides

DeleteBackupOperationsClient

public override OperationsClient DeleteBackupOperationsClient { get; }

The long-running operations client for DeleteBackup.

Property Value
Type Description
OperationsClient
Overrides

DeleteInstanceOperationsClient

public override OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
Type Description
OperationsClient
Overrides

ExportBackupOperationsClient

public override OperationsClient ExportBackupOperationsClient { get; }

The long-running operations client for ExportBackup.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override Memorystore.MemorystoreClient GrpcClient { get; }

The underlying gRPC Memorystore client

Property Value
Type Description
MemorystoreMemorystoreClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

RescheduleMaintenanceOperationsClient

public override OperationsClient RescheduleMaintenanceOperationsClient { get; }

The long-running operations client for RescheduleMaintenance.

Property Value
Type Description
OperationsClient
Overrides

UpdateInstanceOperationsClient

public override OperationsClient UpdateInstanceOperationsClient { get; }

The long-running operations client for UpdateInstance.

Property Value
Type Description
OperationsClient
Overrides

Methods

BackupInstance(BackupInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> BackupInstance(BackupInstanceRequest request, CallSettings callSettings = null)

Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.

Parameters
Name Description
request BackupInstanceRequest

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

BackupInstanceAsync(BackupInstanceRequest, CallSettings)

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

Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.

Parameters
Name Description
request BackupInstanceRequest

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

CreateInstance(CreateInstanceRequest, CallSettings)

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

Creates a new Instance in a given project and 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

CreateInstanceAsync(CreateInstanceRequest, CallSettings)

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

Creates a new Instance in a given project and 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

DeleteBackup(DeleteBackupRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteBackup(DeleteBackupRequest request, CallSettings callSettings = null)

Deletes a specific backup.

Parameters
Name Description
request DeleteBackupRequest

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

DeleteBackupAsync(DeleteBackupRequest, CallSettings)

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

Deletes a specific backup.

Parameters
Name Description
request DeleteBackupRequest

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

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

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

ExportBackup(ExportBackupRequest, CallSettings)

public override Operation<Backup, OperationMetadata> ExportBackup(ExportBackupRequest request, CallSettings callSettings = null)

Exports a specific backup to a customer target Cloud Storage URI.

Parameters
Name Description
request ExportBackupRequest

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
OperationBackupOperationMetadata

The RPC response.
Overrides

ExportBackupAsync(ExportBackupRequest, CallSettings)

public override Task<Operation<Backup, OperationMetadata>> ExportBackupAsync(ExportBackupRequest request, CallSettings callSettings = null)

Exports a specific backup to a customer target Cloud Storage URI.

Parameters
Name Description
request ExportBackupRequest

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
TaskOperationBackupOperationMetadata

A Task containing the RPC response.
Overrides

GetBackup(GetBackupRequest, CallSettings)

public override Backup GetBackup(GetBackupRequest request, CallSettings callSettings = null)

Gets the details of a specific backup.

Parameters
Name Description
request GetBackupRequest

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
Backup

The RPC response.
Overrides

GetBackupAsync(GetBackupRequest, CallSettings)

public override Task<Backup> GetBackupAsync(GetBackupRequest request, CallSettings callSettings = null)

Gets the details of a specific backup.

Parameters
Name Description
request GetBackupRequest

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
TaskBackup

A Task containing the RPC response.
Overrides

GetBackupCollection(GetBackupCollectionRequest, CallSettings)

public override BackupCollection GetBackupCollection(GetBackupCollectionRequest request, CallSettings callSettings = null)

Get a backup collection.

Parameters
Name Description
request GetBackupCollectionRequest

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
BackupCollection

The RPC response.
Overrides

GetBackupCollectionAsync(GetBackupCollectionRequest, CallSettings)

public override Task<BackupCollection> GetBackupCollectionAsync(GetBackupCollectionRequest request, CallSettings callSettings = null)

Get a backup collection.

Parameters
Name Description
request GetBackupCollectionRequest

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
TaskBackupCollection

A Task containing the RPC response.
Overrides

GetCertificateAuthority(GetCertificateAuthorityRequest, CallSettings)

public override CertificateAuthority GetCertificateAuthority(GetCertificateAuthorityRequest request, CallSettings callSettings = null)

Gets details about the certificate authority for an Instance.

Parameters
Name Description
request GetCertificateAuthorityRequest

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
CertificateAuthority

The RPC response.
Overrides

GetCertificateAuthorityAsync(GetCertificateAuthorityRequest, CallSettings)

public override Task<CertificateAuthority> GetCertificateAuthorityAsync(GetCertificateAuthorityRequest request, CallSettings callSettings = null)

Gets details about the certificate authority for an Instance.

Parameters
Name Description
request GetCertificateAuthorityRequest

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
TaskCertificateAuthority

A Task containing the RPC response.
Overrides

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

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

ListBackupCollections(ListBackupCollectionsRequest, CallSettings)

public override PagedEnumerable<ListBackupCollectionsResponse, BackupCollection> ListBackupCollections(ListBackupCollectionsRequest request, CallSettings callSettings = null)

Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.

If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

Parameters
Name Description
request ListBackupCollectionsRequest

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
PagedEnumerableListBackupCollectionsResponseBackupCollection

A pageable sequence of BackupCollection resources.
Overrides

ListBackupCollectionsAsync(ListBackupCollectionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListBackupCollectionsResponse, BackupCollection> ListBackupCollectionsAsync(ListBackupCollectionsRequest request, CallSettings callSettings = null)

Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.

If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

Parameters
Name Description
request ListBackupCollectionsRequest

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
PagedAsyncEnumerableListBackupCollectionsResponseBackupCollection

A pageable asynchronous sequence of BackupCollection resources.
Overrides

ListBackups(ListBackupsRequest, CallSettings)

public override PagedEnumerable<ListBackupsResponse, Backup> ListBackups(ListBackupsRequest request, CallSettings callSettings = null)

Lists all backups owned by a backup collection.

Parameters
Name Description
request ListBackupsRequest

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
PagedEnumerableListBackupsResponseBackup

A pageable sequence of Backup resources.
Overrides

ListBackupsAsync(ListBackupsRequest, CallSettings)

public override PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(ListBackupsRequest request, CallSettings callSettings = null)

Lists all backups owned by a backup collection.

Parameters
Name Description
request ListBackupsRequest

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
PagedAsyncEnumerableListBackupsResponseBackup

A pageable asynchronous sequence of Backup resources.
Overrides

ListInstances(ListInstancesRequest, CallSettings)

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

Lists Instances in a given project and 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

ListInstancesAsync(ListInstancesRequest, CallSettings)

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

Lists Instances in a given project and 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

RescheduleMaintenance(RescheduleMaintenanceRequest, CallSettings)

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

Reschedules upcoming maintenance event.

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

RescheduleMaintenanceAsync(RescheduleMaintenanceRequest, CallSettings)

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

Reschedules upcoming maintenance event.

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

UpdateInstance(UpdateInstanceRequest, CallSettings)

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

Updates the parameters of a single Instance.

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

UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)

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

Updates the parameters of a single Instance.

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