Memorystore v1 API - Class Memorystore.MemorystoreClient (1.0.0-beta03) 

public class Memorystore.MemorystoreClient : ClientBase<Memorystore.MemorystoreClient>

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

Client for Memorystore

Inheritance

object > ClientBase > ClientBaseMemorystoreMemorystoreClient > Memorystore.MemorystoreClient

Namespace

Google.Cloud.Memorystore.V1

Assembly

Google.Cloud.Memorystore.V1.dll

Constructors

MemorystoreClient()

protected MemorystoreClient()

Protected parameterless constructor to allow creation of test doubles.

MemorystoreClient(CallInvoker)

public MemorystoreClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

MemorystoreClient(ChannelBase)

public MemorystoreClient(ChannelBase channel)

Creates a new client for Memorystore

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

MemorystoreClient(ClientBaseConfiguration)

protected MemorystoreClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

BackupInstance(BackupInstanceRequest, CallOptions)

public virtual Operation BackupInstance(BackupInstanceRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

BackupInstance(BackupInstanceRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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.

BackupInstanceAsync(BackupInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> BackupInstanceAsync(BackupInstanceRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

BackupInstanceAsync(BackupInstanceRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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 project and 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 project and 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 System.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 project and 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 project and 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 System.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.

DeleteBackup(DeleteBackupRequest, CallOptions)

public virtual Operation DeleteBackup(DeleteBackupRequest request, CallOptions options)

Deletes a specific backup.

Parameters
Name Description
request DeleteBackupRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteBackup(DeleteBackupRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a specific backup.

Parameters
Name Description
request DeleteBackupRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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.

DeleteBackupAsync(DeleteBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteBackupAsync(DeleteBackupRequest request, CallOptions options)

Deletes a specific backup.

Parameters
Name Description
request DeleteBackupRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteBackupAsync(DeleteBackupRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a specific backup.

Parameters
Name Description
request DeleteBackupRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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.

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 System.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 System.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.

ExportBackup(ExportBackupRequest, CallOptions)

public virtual Operation ExportBackup(ExportBackupRequest request, CallOptions options)

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

Parameters
Name Description
request ExportBackupRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

ExportBackup(ExportBackupRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request ExportBackupRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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.

ExportBackupAsync(ExportBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportBackupAsync(ExportBackupRequest request, CallOptions options)

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

Parameters
Name Description
request ExportBackupRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

ExportBackupAsync(ExportBackupRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request ExportBackupRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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.

GetBackup(GetBackupRequest, CallOptions)

public virtual Backup GetBackup(GetBackupRequest request, CallOptions options)

Gets the details of a specific backup.

Parameters
Name Description
request GetBackupRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Backup

The response received from the server.

GetBackup(GetBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Backup GetBackup(GetBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of a specific backup.

Parameters
Name Description
request GetBackupRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
Backup

The response received from the server.

GetBackupAsync(GetBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Backup> GetBackupAsync(GetBackupRequest request, CallOptions options)

Gets the details of a specific backup.

Parameters
Name Description
request GetBackupRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallBackup

The call object.

GetBackupAsync(GetBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Backup> GetBackupAsync(GetBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of a specific backup.

Parameters
Name Description
request GetBackupRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallBackup

The call object.

GetBackupCollection(GetBackupCollectionRequest, CallOptions)

public virtual BackupCollection GetBackupCollection(GetBackupCollectionRequest request, CallOptions options)

Get a backup collection.

Parameters
Name Description
request GetBackupCollectionRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
BackupCollection

The response received from the server.

GetBackupCollection(GetBackupCollectionRequest, Metadata, DateTime?, CancellationToken)

public virtual BackupCollection GetBackupCollection(GetBackupCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get a backup collection.

Parameters
Name Description
request GetBackupCollectionRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
BackupCollection

The response received from the server.

GetBackupCollectionAsync(GetBackupCollectionRequest, CallOptions)

public virtual AsyncUnaryCall<BackupCollection> GetBackupCollectionAsync(GetBackupCollectionRequest request, CallOptions options)

Get a backup collection.

Parameters
Name Description
request GetBackupCollectionRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallBackupCollection

The call object.

GetBackupCollectionAsync(GetBackupCollectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BackupCollection> GetBackupCollectionAsync(GetBackupCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get a backup collection.

Parameters
Name Description
request GetBackupCollectionRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallBackupCollection

The call object.

GetCertificateAuthority(GetCertificateAuthorityRequest, CallOptions)

public virtual CertificateAuthority GetCertificateAuthority(GetCertificateAuthorityRequest request, CallOptions options)

Gets details about the certificate authority for an Instance.

Parameters
Name Description
request GetCertificateAuthorityRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
CertificateAuthority

The response received from the server.

GetCertificateAuthority(GetCertificateAuthorityRequest, Metadata, DateTime?, CancellationToken)

public virtual CertificateAuthority GetCertificateAuthority(GetCertificateAuthorityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details about the certificate authority for an Instance.

Parameters
Name Description
request GetCertificateAuthorityRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
CertificateAuthority

The response received from the server.

GetCertificateAuthorityAsync(GetCertificateAuthorityRequest, CallOptions)

public virtual AsyncUnaryCall<CertificateAuthority> GetCertificateAuthorityAsync(GetCertificateAuthorityRequest request, CallOptions options)

Gets details about the certificate authority for an Instance.

Parameters
Name Description
request GetCertificateAuthorityRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallCertificateAuthority

The call object.

GetCertificateAuthorityAsync(GetCertificateAuthorityRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CertificateAuthority> GetCertificateAuthorityAsync(GetCertificateAuthorityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details about the certificate authority for an Instance.

Parameters
Name Description
request GetCertificateAuthorityRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallCertificateAuthority

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 System.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 System.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.

ListBackupCollections(ListBackupCollectionsRequest, CallOptions)

public virtual ListBackupCollectionsResponse ListBackupCollections(ListBackupCollectionsRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListBackupCollectionsResponse

The response received from the server.

ListBackupCollections(ListBackupCollectionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListBackupCollectionsResponse ListBackupCollections(ListBackupCollectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
ListBackupCollectionsResponse

The response received from the server.

ListBackupCollectionsAsync(ListBackupCollectionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListBackupCollectionsResponse> ListBackupCollectionsAsync(ListBackupCollectionsRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListBackupCollectionsResponse

The call object.

ListBackupCollectionsAsync(ListBackupCollectionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListBackupCollectionsResponse> ListBackupCollectionsAsync(ListBackupCollectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallListBackupCollectionsResponse

The call object.

ListBackups(ListBackupsRequest, CallOptions)

public virtual ListBackupsResponse ListBackups(ListBackupsRequest request, CallOptions options)

Lists all backups owned by a backup collection.

Parameters
Name Description
request ListBackupsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListBackupsResponse

The response received from the server.

ListBackups(ListBackupsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListBackupsResponse ListBackups(ListBackupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all backups owned by a backup collection.

Parameters
Name Description
request ListBackupsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
ListBackupsResponse

The response received from the server.

ListBackupsAsync(ListBackupsRequest, CallOptions)

public virtual AsyncUnaryCall<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, CallOptions options)

Lists all backups owned by a backup collection.

Parameters
Name Description
request ListBackupsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListBackupsResponse

The call object.

ListBackupsAsync(ListBackupsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all backups owned by a backup collection.

Parameters
Name Description
request ListBackupsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallListBackupsResponse

The call object.

ListInstances(ListInstancesRequest, CallOptions)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallOptions options)

Lists Instances in a given project and 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 project and 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 System.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 project and 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 project and 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 System.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 Memorystore.MemorystoreClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
MemorystoreMemorystoreClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Memorystore.V1.Memorystore.MemorystoreClient>.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, DateTime?, CancellationToken)

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

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 System.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
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)

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 System.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 the parameters of a single Instance.

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 the parameters of a single Instance.

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 System.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 the parameters of a single Instance.

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 the parameters of a single Instance.

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 System.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.