Google Cloud Memorystore for Redis (cluster management) v1 API - Class CloudRedisClusterClient (1.10.0)

public abstract class CloudRedisClusterClient

Reference documentation and code samples for the Google Cloud Memorystore for Redis (cluster management) v1 API class CloudRedisClusterClient.

CloudRedisCluster client wrapper, for convenient use.

Inheritance

object > CloudRedisClusterClient

Namespace

Google.Cloud.Redis.Cluster.V1

Assembly

Google.Cloud.Redis.Cluster.V1.dll

Remarks

Configures and manages Cloud Memorystore for Redis clusters

Google Cloud Memorystore for Redis Cluster

The redis.googleapis.com service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis clusters:

  • 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 Redis clusters, named: /clusters/*
  • As such, Redis clusters are resources of the form: /projects/{project_id}/locations/{location_id}/clusters/{instance_id}

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

  • projects/redpepper-1290/locations/us-central1/clusters/my-redis

Properties

AddAuthTokenOperationsClient

public virtual OperationsClient AddAuthTokenOperationsClient { get; }

The long-running operations client for AddAuthToken.

Property Value
Type Description
OperationsClient

AddTokenAuthUserOperationsClient

public virtual OperationsClient AddTokenAuthUserOperationsClient { get; }

The long-running operations client for AddTokenAuthUser.

Property Value
Type Description
OperationsClient

BackupClusterOperationsClient

public virtual OperationsClient BackupClusterOperationsClient { get; }

The long-running operations client for BackupCluster.

Property Value
Type Description
OperationsClient

CreateClusterOperationsClient

public virtual OperationsClient CreateClusterOperationsClient { get; }

The long-running operations client for CreateCluster.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the CloudRedisCluster service, which is a host of "redis.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default CloudRedisCluster scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default CloudRedisCluster scopes are:

DeleteAclPolicyOperationsClient

public virtual OperationsClient DeleteAclPolicyOperationsClient { get; }

The long-running operations client for DeleteAclPolicy.

Property Value
Type Description
OperationsClient

DeleteAuthTokenOperationsClient

public virtual OperationsClient DeleteAuthTokenOperationsClient { get; }

The long-running operations client for DeleteAuthToken.

Property Value
Type Description
OperationsClient

DeleteBackupOperationsClient

public virtual OperationsClient DeleteBackupOperationsClient { get; }

The long-running operations client for DeleteBackup.

Property Value
Type Description
OperationsClient

DeleteClusterOperationsClient

public virtual OperationsClient DeleteClusterOperationsClient { get; }

The long-running operations client for DeleteCluster.

Property Value
Type Description
OperationsClient

DeleteTokenAuthUserOperationsClient

public virtual OperationsClient DeleteTokenAuthUserOperationsClient { get; }

The long-running operations client for DeleteTokenAuthUser.

Property Value
Type Description
OperationsClient

ExportBackupOperationsClient

public virtual OperationsClient ExportBackupOperationsClient { get; }

The long-running operations client for ExportBackup.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual CloudRedisCluster.CloudRedisClusterClient GrpcClient { get; }

The underlying gRPC CloudRedisCluster client

Property Value
Type Description
CloudRedisClusterCloudRedisClusterClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

RescheduleClusterMaintenanceOperationsClient

public virtual OperationsClient RescheduleClusterMaintenanceOperationsClient { get; }

The long-running operations client for RescheduleClusterMaintenance.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

UpdateAclPolicyOperationsClient

public virtual OperationsClient UpdateAclPolicyOperationsClient { get; }

The long-running operations client for UpdateAclPolicy.

Property Value
Type Description
OperationsClient

UpdateClusterOperationsClient

public virtual OperationsClient UpdateClusterOperationsClient { get; }

The long-running operations client for UpdateCluster.

Property Value
Type Description
OperationsClient

Methods

AddAuthToken(AddAuthTokenRequest, CallSettings)

public virtual Operation<TokenAuthUser, OperationMetadata> AddAuthToken(AddAuthTokenRequest request, CallSettings callSettings = null)

Adds a auth token for a user of a token based auth enabled cluster.

Parameters
Name Description
request AddAuthTokenRequest

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
OperationTokenAuthUserOperationMetadata

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
AddAuthTokenRequest request = new AddAuthTokenRequest
{
    TokenAuthUserAsTokenAuthUserName = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]"),
    AuthToken = new AuthToken(),
};
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = cloudRedisClusterClient.AddAuthToken(request);

// Poll until the returned long-running operation is complete
Operation<TokenAuthUser, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
TokenAuthUser result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<TokenAuthUser, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceAddAuthToken(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    TokenAuthUser retrievedResult = retrievedResponse.Result;
}

AddAuthToken(TokenAuthUserName, AuthToken, CallSettings)

public virtual Operation<TokenAuthUser, OperationMetadata> AddAuthToken(TokenAuthUserName tokenAuthUser, AuthToken authToken, CallSettings callSettings = null)

Adds a auth token for a user of a token based auth enabled cluster.

Parameters
Name Description
tokenAuthUser TokenAuthUserName

Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

authToken AuthToken

Required. The auth token to add.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationTokenAuthUserOperationMetadata

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
TokenAuthUserName tokenAuthUser = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]");
AuthToken authToken = new AuthToken();
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = cloudRedisClusterClient.AddAuthToken(tokenAuthUser, authToken);

// Poll until the returned long-running operation is complete
Operation<TokenAuthUser, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
TokenAuthUser result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<TokenAuthUser, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceAddAuthToken(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    TokenAuthUser retrievedResult = retrievedResponse.Result;
}

AddAuthToken(string, AuthToken, CallSettings)

public virtual Operation<TokenAuthUser, OperationMetadata> AddAuthToken(string tokenAuthUser, AuthToken authToken, CallSettings callSettings = null)

Adds a auth token for a user of a token based auth enabled cluster.

Parameters
Name Description
tokenAuthUser string

Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

authToken AuthToken

Required. The auth token to add.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationTokenAuthUserOperationMetadata

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string tokenAuthUser = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]";
AuthToken authToken = new AuthToken();
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = cloudRedisClusterClient.AddAuthToken(tokenAuthUser, authToken);

// Poll until the returned long-running operation is complete
Operation<TokenAuthUser, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
TokenAuthUser result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<TokenAuthUser, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceAddAuthToken(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    TokenAuthUser retrievedResult = retrievedResponse.Result;
}

AddAuthTokenAsync(AddAuthTokenRequest, CallSettings)

public virtual Task<Operation<TokenAuthUser, OperationMetadata>> AddAuthTokenAsync(AddAuthTokenRequest request, CallSettings callSettings = null)

Adds a auth token for a user of a token based auth enabled cluster.

Parameters
Name Description
request AddAuthTokenRequest

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
TaskOperationTokenAuthUserOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AddAuthTokenRequest request = new AddAuthTokenRequest
{
    TokenAuthUserAsTokenAuthUserName = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]"),
    AuthToken = new AuthToken(),
};
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = await cloudRedisClusterClient.AddAuthTokenAsync(request);

// Poll until the returned long-running operation is complete
Operation<TokenAuthUser, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
TokenAuthUser result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<TokenAuthUser, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceAddAuthTokenAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    TokenAuthUser retrievedResult = retrievedResponse.Result;
}

AddAuthTokenAsync(AddAuthTokenRequest, CancellationToken)

public virtual Task<Operation<TokenAuthUser, OperationMetadata>> AddAuthTokenAsync(AddAuthTokenRequest request, CancellationToken cancellationToken)

Adds a auth token for a user of a token based auth enabled cluster.

Parameters
Name Description
request AddAuthTokenRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationTokenAuthUserOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AddAuthTokenRequest request = new AddAuthTokenRequest
{
    TokenAuthUserAsTokenAuthUserName = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]"),
    AuthToken = new AuthToken(),
};
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = await cloudRedisClusterClient.AddAuthTokenAsync(request);

// Poll until the returned long-running operation is complete
Operation<TokenAuthUser, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
TokenAuthUser result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<TokenAuthUser, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceAddAuthTokenAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    TokenAuthUser retrievedResult = retrievedResponse.Result;
}

AddAuthTokenAsync(TokenAuthUserName, AuthToken, CallSettings)

public virtual Task<Operation<TokenAuthUser, OperationMetadata>> AddAuthTokenAsync(TokenAuthUserName tokenAuthUser, AuthToken authToken, CallSettings callSettings = null)

Adds a auth token for a user of a token based auth enabled cluster.

Parameters
Name Description
tokenAuthUser TokenAuthUserName

Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

authToken AuthToken

Required. The auth token to add.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationTokenAuthUserOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
TokenAuthUserName tokenAuthUser = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]");
AuthToken authToken = new AuthToken();
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = await cloudRedisClusterClient.AddAuthTokenAsync(tokenAuthUser, authToken);

// Poll until the returned long-running operation is complete
Operation<TokenAuthUser, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
TokenAuthUser result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<TokenAuthUser, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceAddAuthTokenAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    TokenAuthUser retrievedResult = retrievedResponse.Result;
}

AddAuthTokenAsync(TokenAuthUserName, AuthToken, CancellationToken)

public virtual Task<Operation<TokenAuthUser, OperationMetadata>> AddAuthTokenAsync(TokenAuthUserName tokenAuthUser, AuthToken authToken, CancellationToken cancellationToken)

Adds a auth token for a user of a token based auth enabled cluster.

Parameters
Name Description
tokenAuthUser TokenAuthUserName

Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

authToken AuthToken

Required. The auth token to add.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationTokenAuthUserOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
TokenAuthUserName tokenAuthUser = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]");
AuthToken authToken = new AuthToken();
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = await cloudRedisClusterClient.AddAuthTokenAsync(tokenAuthUser, authToken);

// Poll until the returned long-running operation is complete
Operation<TokenAuthUser, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
TokenAuthUser result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<TokenAuthUser, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceAddAuthTokenAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    TokenAuthUser retrievedResult = retrievedResponse.Result;
}

AddAuthTokenAsync(string, AuthToken, CallSettings)

public virtual Task<Operation<TokenAuthUser, OperationMetadata>> AddAuthTokenAsync(string tokenAuthUser, AuthToken authToken, CallSettings callSettings = null)

Adds a auth token for a user of a token based auth enabled cluster.

Parameters
Name Description
tokenAuthUser string

Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

authToken AuthToken

Required. The auth token to add.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationTokenAuthUserOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string tokenAuthUser = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]";
AuthToken authToken = new AuthToken();
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = await cloudRedisClusterClient.AddAuthTokenAsync(tokenAuthUser, authToken);

// Poll until the returned long-running operation is complete
Operation<TokenAuthUser, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
TokenAuthUser result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<TokenAuthUser, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceAddAuthTokenAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    TokenAuthUser retrievedResult = retrievedResponse.Result;
}

AddAuthTokenAsync(string, AuthToken, CancellationToken)

public virtual Task<Operation<TokenAuthUser, OperationMetadata>> AddAuthTokenAsync(string tokenAuthUser, AuthToken authToken, CancellationToken cancellationToken)

Adds a auth token for a user of a token based auth enabled cluster.

Parameters
Name Description
tokenAuthUser string

Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

authToken AuthToken

Required. The auth token to add.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationTokenAuthUserOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string tokenAuthUser = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]";
AuthToken authToken = new AuthToken();
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = await cloudRedisClusterClient.AddAuthTokenAsync(tokenAuthUser, authToken);

// Poll until the returned long-running operation is complete
Operation<TokenAuthUser, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
TokenAuthUser result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<TokenAuthUser, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceAddAuthTokenAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    TokenAuthUser retrievedResult = retrievedResponse.Result;
}

AddTokenAuthUser(AddTokenAuthUserRequest, CallSettings)

public virtual Operation<Cluster, OperationMetadata> AddTokenAuthUser(AddTokenAuthUserRequest request, CallSettings callSettings = null)

Adds a token auth user for a token based auth enabled cluster.

Parameters
Name Description
request AddTokenAuthUserRequest

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
OperationClusterOperationMetadata

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
AddTokenAuthUserRequest request = new AddTokenAuthUserRequest
{
    ClusterAsClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    TokenAuthUserAsTokenAuthUserName = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]"),
};
// Make the request
Operation<Cluster, OperationMetadata> response = cloudRedisClusterClient.AddTokenAuthUser(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceAddTokenAuthUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

AddTokenAuthUser(ClusterName, TokenAuthUserName, CallSettings)

public virtual Operation<Cluster, OperationMetadata> AddTokenAuthUser(ClusterName cluster, TokenAuthUserName tokenAuthUser, CallSettings callSettings = null)

Adds a token auth user for a token based auth enabled cluster.

Parameters
Name Description
cluster ClusterName

Required. The cluster resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}

tokenAuthUser TokenAuthUserName

Required. The id of the token auth user to add.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationClusterOperationMetadata

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
ClusterName cluster = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
TokenAuthUserName tokenAuthUser = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]");
// Make the request
Operation<Cluster, OperationMetadata> response = cloudRedisClusterClient.AddTokenAuthUser(cluster, tokenAuthUser);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceAddTokenAuthUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

AddTokenAuthUser(string, string, CallSettings)

public virtual Operation<Cluster, OperationMetadata> AddTokenAuthUser(string cluster, string tokenAuthUser, CallSettings callSettings = null)

Adds a token auth user for a token based auth enabled cluster.

Parameters
Name Description
cluster string

Required. The cluster resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}

tokenAuthUser string

Required. The id of the token auth user to add.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationClusterOperationMetadata

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string cluster = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
string tokenAuthUser = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
Operation<Cluster, OperationMetadata> response = cloudRedisClusterClient.AddTokenAuthUser(cluster, tokenAuthUser);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceAddTokenAuthUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

AddTokenAuthUserAsync(AddTokenAuthUserRequest, CallSettings)

public virtual Task<Operation<Cluster, OperationMetadata>> AddTokenAuthUserAsync(AddTokenAuthUserRequest request, CallSettings callSettings = null)

Adds a token auth user for a token based auth enabled cluster.

Parameters
Name Description
request AddTokenAuthUserRequest

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
TaskOperationClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AddTokenAuthUserRequest request = new AddTokenAuthUserRequest
{
    ClusterAsClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    TokenAuthUserAsTokenAuthUserName = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]"),
};
// Make the request
Operation<Cluster, OperationMetadata> response = await cloudRedisClusterClient.AddTokenAuthUserAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceAddTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

AddTokenAuthUserAsync(AddTokenAuthUserRequest, CancellationToken)

public virtual Task<Operation<Cluster, OperationMetadata>> AddTokenAuthUserAsync(AddTokenAuthUserRequest request, CancellationToken cancellationToken)

Adds a token auth user for a token based auth enabled cluster.

Parameters
Name Description
request AddTokenAuthUserRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AddTokenAuthUserRequest request = new AddTokenAuthUserRequest
{
    ClusterAsClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    TokenAuthUserAsTokenAuthUserName = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]"),
};
// Make the request
Operation<Cluster, OperationMetadata> response = await cloudRedisClusterClient.AddTokenAuthUserAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceAddTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

AddTokenAuthUserAsync(ClusterName, TokenAuthUserName, CallSettings)

public virtual Task<Operation<Cluster, OperationMetadata>> AddTokenAuthUserAsync(ClusterName cluster, TokenAuthUserName tokenAuthUser, CallSettings callSettings = null)

Adds a token auth user for a token based auth enabled cluster.

Parameters
Name Description
cluster ClusterName

Required. The cluster resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}

tokenAuthUser TokenAuthUserName

Required. The id of the token auth user to add.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ClusterName cluster = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
TokenAuthUserName tokenAuthUser = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]");
// Make the request
Operation<Cluster, OperationMetadata> response = await cloudRedisClusterClient.AddTokenAuthUserAsync(cluster, tokenAuthUser);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceAddTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

AddTokenAuthUserAsync(ClusterName, TokenAuthUserName, CancellationToken)

public virtual Task<Operation<Cluster, OperationMetadata>> AddTokenAuthUserAsync(ClusterName cluster, TokenAuthUserName tokenAuthUser, CancellationToken cancellationToken)

Adds a token auth user for a token based auth enabled cluster.

Parameters
Name Description
cluster ClusterName

Required. The cluster resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}

tokenAuthUser TokenAuthUserName

Required. The id of the token auth user to add.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ClusterName cluster = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
TokenAuthUserName tokenAuthUser = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]");
// Make the request
Operation<Cluster, OperationMetadata> response = await cloudRedisClusterClient.AddTokenAuthUserAsync(cluster, tokenAuthUser);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceAddTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

AddTokenAuthUserAsync(string, string, CallSettings)

public virtual Task<Operation<Cluster, OperationMetadata>> AddTokenAuthUserAsync(string cluster, string tokenAuthUser, CallSettings callSettings = null)

Adds a token auth user for a token based auth enabled cluster.

Parameters
Name Description
cluster string

Required. The cluster resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}

tokenAuthUser string

Required. The id of the token auth user to add.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string cluster = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
string tokenAuthUser = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
Operation<Cluster, OperationMetadata> response = await cloudRedisClusterClient.AddTokenAuthUserAsync(cluster, tokenAuthUser);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceAddTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

AddTokenAuthUserAsync(string, string, CancellationToken)

public virtual Task<Operation<Cluster, OperationMetadata>> AddTokenAuthUserAsync(string cluster, string tokenAuthUser, CancellationToken cancellationToken)

Adds a token auth user for a token based auth enabled cluster.

Parameters
Name Description
cluster string

Required. The cluster resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}

tokenAuthUser string

Required. The id of the token auth user to add.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string cluster = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
string tokenAuthUser = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
Operation<Cluster, OperationMetadata> response = await cloudRedisClusterClient.AddTokenAuthUserAsync(cluster, tokenAuthUser);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceAddTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

BackupCluster(BackupClusterRequest, CallSettings)

public virtual Operation<Cluster, Any> BackupCluster(BackupClusterRequest request, CallSettings callSettings = null)

Backup Redis Cluster. 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 cluster'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 BackupClusterRequest

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
OperationClusterAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
BackupClusterRequest request = new BackupClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    Ttl = new Duration(),
    BackupId = "",
};
// Make the request
Operation<Cluster, Any> response = cloudRedisClusterClient.BackupCluster(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = cloudRedisClusterClient.PollOnceBackupCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

BackupCluster(ClusterName, CallSettings)

public virtual Operation<Cluster, Any> BackupCluster(ClusterName name, CallSettings callSettings = null)

Backup Redis Cluster. 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 cluster'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
name ClusterName

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationClusterAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Operation<Cluster, Any> response = cloudRedisClusterClient.BackupCluster(name);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = cloudRedisClusterClient.PollOnceBackupCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

BackupCluster(string, CallSettings)

public virtual Operation<Cluster, Any> BackupCluster(string name, CallSettings callSettings = null)

Backup Redis Cluster. 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 cluster'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
name string

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationClusterAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Operation<Cluster, Any> response = cloudRedisClusterClient.BackupCluster(name);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = cloudRedisClusterClient.PollOnceBackupCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

BackupClusterAsync(BackupClusterRequest, CallSettings)

public virtual Task<Operation<Cluster, Any>> BackupClusterAsync(BackupClusterRequest request, CallSettings callSettings = null)

Backup Redis Cluster. 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 cluster'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 BackupClusterRequest

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
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
BackupClusterRequest request = new BackupClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    Ttl = new Duration(),
    BackupId = "",
};
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.BackupClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceBackupClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

BackupClusterAsync(BackupClusterRequest, CancellationToken)

public virtual Task<Operation<Cluster, Any>> BackupClusterAsync(BackupClusterRequest request, CancellationToken cancellationToken)

Backup Redis Cluster. 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 cluster'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 BackupClusterRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
BackupClusterRequest request = new BackupClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    Ttl = new Duration(),
    BackupId = "",
};
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.BackupClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceBackupClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

BackupClusterAsync(ClusterName, CallSettings)

public virtual Task<Operation<Cluster, Any>> BackupClusterAsync(ClusterName name, CallSettings callSettings = null)

Backup Redis Cluster. 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 cluster'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
name ClusterName

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.BackupClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceBackupClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

BackupClusterAsync(ClusterName, CancellationToken)

public virtual Task<Operation<Cluster, Any>> BackupClusterAsync(ClusterName name, CancellationToken cancellationToken)

Backup Redis Cluster. 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 cluster'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
name ClusterName

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.BackupClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceBackupClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

BackupClusterAsync(string, CallSettings)

public virtual Task<Operation<Cluster, Any>> BackupClusterAsync(string name, CallSettings callSettings = null)

Backup Redis Cluster. 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 cluster'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
name string

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.BackupClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceBackupClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

BackupClusterAsync(string, CancellationToken)

public virtual Task<Operation<Cluster, Any>> BackupClusterAsync(string name, CancellationToken cancellationToken)

Backup Redis Cluster. 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 cluster'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
name string

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.BackupClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceBackupClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

Create()

public static CloudRedisClusterClient Create()

Synchronously creates a CloudRedisClusterClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CloudRedisClusterClientBuilder.

Returns
Type Description
CloudRedisClusterClient

The created CloudRedisClusterClient.

CreateAclPolicy(LocationName, AclPolicy, string, CallSettings)

public virtual AclPolicy CreateAclPolicy(LocationName parent, AclPolicy aclPolicy, string aclPolicyId, CallSettings callSettings = null)

Creates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.

Parameters
Name Description
parent LocationName

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a Google Cloud region.

aclPolicy AclPolicy

Required. The ACL policy that is to be created.

aclPolicyId string

Required. The logical name of the ACL policy in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AclPolicy

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AclPolicy aclPolicy = new AclPolicy();
string aclPolicyId = "";
// Make the request
AclPolicy response = cloudRedisClusterClient.CreateAclPolicy(parent, aclPolicy, aclPolicyId);

CreateAclPolicy(CreateAclPolicyRequest, CallSettings)

public virtual AclPolicy CreateAclPolicy(CreateAclPolicyRequest request, CallSettings callSettings = null)

Creates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.

Parameters
Name Description
request CreateAclPolicyRequest

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
AclPolicy

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
CreateAclPolicyRequest request = new CreateAclPolicyRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AclPolicyId = "",
    AclPolicy = new AclPolicy(),
    RequestId = "",
};
// Make the request
AclPolicy response = cloudRedisClusterClient.CreateAclPolicy(request);

CreateAclPolicy(string, AclPolicy, string, CallSettings)

public virtual AclPolicy CreateAclPolicy(string parent, AclPolicy aclPolicy, string aclPolicyId, CallSettings callSettings = null)

Creates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.

Parameters
Name Description
parent string

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a Google Cloud region.

aclPolicy AclPolicy

Required. The ACL policy that is to be created.

aclPolicyId string

Required. The logical name of the ACL policy in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AclPolicy

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AclPolicy aclPolicy = new AclPolicy();
string aclPolicyId = "";
// Make the request
AclPolicy response = cloudRedisClusterClient.CreateAclPolicy(parent, aclPolicy, aclPolicyId);

CreateAclPolicyAsync(LocationName, AclPolicy, string, CallSettings)

public virtual Task<AclPolicy> CreateAclPolicyAsync(LocationName parent, AclPolicy aclPolicy, string aclPolicyId, CallSettings callSettings = null)

Creates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.

Parameters
Name Description
parent LocationName

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a Google Cloud region.

aclPolicy AclPolicy

Required. The ACL policy that is to be created.

aclPolicyId string

Required. The logical name of the ACL policy in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAclPolicy

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AclPolicy aclPolicy = new AclPolicy();
string aclPolicyId = "";
// Make the request
AclPolicy response = await cloudRedisClusterClient.CreateAclPolicyAsync(parent, aclPolicy, aclPolicyId);

CreateAclPolicyAsync(LocationName, AclPolicy, string, CancellationToken)

public virtual Task<AclPolicy> CreateAclPolicyAsync(LocationName parent, AclPolicy aclPolicy, string aclPolicyId, CancellationToken cancellationToken)

Creates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.

Parameters
Name Description
parent LocationName

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a Google Cloud region.

aclPolicy AclPolicy

Required. The ACL policy that is to be created.

aclPolicyId string

Required. The logical name of the ACL policy in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAclPolicy

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AclPolicy aclPolicy = new AclPolicy();
string aclPolicyId = "";
// Make the request
AclPolicy response = await cloudRedisClusterClient.CreateAclPolicyAsync(parent, aclPolicy, aclPolicyId);

CreateAclPolicyAsync(CreateAclPolicyRequest, CallSettings)

public virtual Task<AclPolicy> CreateAclPolicyAsync(CreateAclPolicyRequest request, CallSettings callSettings = null)

Creates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.

Parameters
Name Description
request CreateAclPolicyRequest

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
TaskAclPolicy

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
CreateAclPolicyRequest request = new CreateAclPolicyRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AclPolicyId = "",
    AclPolicy = new AclPolicy(),
    RequestId = "",
};
// Make the request
AclPolicy response = await cloudRedisClusterClient.CreateAclPolicyAsync(request);

CreateAclPolicyAsync(CreateAclPolicyRequest, CancellationToken)

public virtual Task<AclPolicy> CreateAclPolicyAsync(CreateAclPolicyRequest request, CancellationToken cancellationToken)

Creates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.

Parameters
Name Description
request CreateAclPolicyRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAclPolicy

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
CreateAclPolicyRequest request = new CreateAclPolicyRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AclPolicyId = "",
    AclPolicy = new AclPolicy(),
    RequestId = "",
};
// Make the request
AclPolicy response = await cloudRedisClusterClient.CreateAclPolicyAsync(request);

CreateAclPolicyAsync(string, AclPolicy, string, CallSettings)

public virtual Task<AclPolicy> CreateAclPolicyAsync(string parent, AclPolicy aclPolicy, string aclPolicyId, CallSettings callSettings = null)

Creates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.

Parameters
Name Description
parent string

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a Google Cloud region.

aclPolicy AclPolicy

Required. The ACL policy that is to be created.

aclPolicyId string

Required. The logical name of the ACL policy in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAclPolicy

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AclPolicy aclPolicy = new AclPolicy();
string aclPolicyId = "";
// Make the request
AclPolicy response = await cloudRedisClusterClient.CreateAclPolicyAsync(parent, aclPolicy, aclPolicyId);

CreateAclPolicyAsync(string, AclPolicy, string, CancellationToken)

public virtual Task<AclPolicy> CreateAclPolicyAsync(string parent, AclPolicy aclPolicy, string aclPolicyId, CancellationToken cancellationToken)

Creates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.

Parameters
Name Description
parent string

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a Google Cloud region.

aclPolicy AclPolicy

Required. The ACL policy that is to be created.

aclPolicyId string

Required. The logical name of the ACL policy in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAclPolicy

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AclPolicy aclPolicy = new AclPolicy();
string aclPolicyId = "";
// Make the request
AclPolicy response = await cloudRedisClusterClient.CreateAclPolicyAsync(parent, aclPolicy, aclPolicyId);

CreateAsync(CancellationToken)

public static Task<CloudRedisClusterClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a CloudRedisClusterClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CloudRedisClusterClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskCloudRedisClusterClient

The task representing the created CloudRedisClusterClient.

CreateCluster(LocationName, Cluster, string, CallSettings)

public virtual Operation<Cluster, Any> CreateCluster(LocationName parent, Cluster cluster, string clusterId, CallSettings callSettings = null)

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
parent LocationName

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

cluster Cluster

Required. The cluster that is to be created.

clusterId string

Required. The logical name of the Redis cluster in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationClusterAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, Any> response = cloudRedisClusterClient.CreateCluster(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = cloudRedisClusterClient.PollOnceCreateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateCluster(CreateClusterRequest, CallSettings)

public virtual Operation<Cluster, Any> CreateCluster(CreateClusterRequest request, CallSettings callSettings = null)

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
request CreateClusterRequest

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
OperationClusterAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
CreateClusterRequest request = new CreateClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ClusterId = "",
    Cluster = new Cluster(),
    RequestId = "",
};
// Make the request
Operation<Cluster, Any> response = cloudRedisClusterClient.CreateCluster(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = cloudRedisClusterClient.PollOnceCreateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateCluster(string, Cluster, string, CallSettings)

public virtual Operation<Cluster, Any> CreateCluster(string parent, Cluster cluster, string clusterId, CallSettings callSettings = null)

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
parent string

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

cluster Cluster

Required. The cluster that is to be created.

clusterId string

Required. The logical name of the Redis cluster in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationClusterAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, Any> response = cloudRedisClusterClient.CreateCluster(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = cloudRedisClusterClient.PollOnceCreateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(LocationName, Cluster, string, CallSettings)

public virtual Task<Operation<Cluster, Any>> CreateClusterAsync(LocationName parent, Cluster cluster, string clusterId, CallSettings callSettings = null)

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
parent LocationName

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

cluster Cluster

Required. The cluster that is to be created.

clusterId string

Required. The logical name of the Redis cluster in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.CreateClusterAsync(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(LocationName, Cluster, string, CancellationToken)

public virtual Task<Operation<Cluster, Any>> CreateClusterAsync(LocationName parent, Cluster cluster, string clusterId, CancellationToken cancellationToken)

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
parent LocationName

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

cluster Cluster

Required. The cluster that is to be created.

clusterId string

Required. The logical name of the Redis cluster in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.CreateClusterAsync(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(CreateClusterRequest, CallSettings)

public virtual Task<Operation<Cluster, Any>> CreateClusterAsync(CreateClusterRequest request, CallSettings callSettings = null)

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
request CreateClusterRequest

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
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
CreateClusterRequest request = new CreateClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ClusterId = "",
    Cluster = new Cluster(),
    RequestId = "",
};
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.CreateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(CreateClusterRequest, CancellationToken)

public virtual Task<Operation<Cluster, Any>> CreateClusterAsync(CreateClusterRequest request, CancellationToken cancellationToken)

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
request CreateClusterRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
CreateClusterRequest request = new CreateClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ClusterId = "",
    Cluster = new Cluster(),
    RequestId = "",
};
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.CreateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(string, Cluster, string, CallSettings)

public virtual Task<Operation<Cluster, Any>> CreateClusterAsync(string parent, Cluster cluster, string clusterId, CallSettings callSettings = null)

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
parent string

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

cluster Cluster

Required. The cluster that is to be created.

clusterId string

Required. The logical name of the Redis cluster in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.CreateClusterAsync(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(string, Cluster, string, CancellationToken)

public virtual Task<Operation<Cluster, Any>> CreateClusterAsync(string parent, Cluster cluster, string clusterId, CancellationToken cancellationToken)

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
parent string

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

cluster Cluster

Required. The cluster that is to be created.

clusterId string

Required. The logical name of the Redis cluster in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.CreateClusterAsync(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

DeleteAclPolicy(AclPolicyName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteAclPolicy(AclPolicyName name, CallSettings callSettings = null)

Deletes a specific ACL policy. This action will delete the ACL policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster.

Parameters
Name Description
name AclPolicyName

Required. Redis ACL policy resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id} where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
AclPolicyName name = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]");
// Make the request
Operation<Empty, OperationMetadata> response = cloudRedisClusterClient.DeleteAclPolicy(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteAclPolicy(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAclPolicy(DeleteAclPolicyRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteAclPolicy(DeleteAclPolicyRequest request, CallSettings callSettings = null)

Deletes a specific ACL policy. This action will delete the ACL policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster.

Parameters
Name Description
request DeleteAclPolicyRequest

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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
DeleteAclPolicyRequest request = new DeleteAclPolicyRequest
{
    AclPolicyName = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]"),
    RequestId = "",
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = cloudRedisClusterClient.DeleteAclPolicy(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteAclPolicy(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAclPolicy(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteAclPolicy(string name, CallSettings callSettings = null)

Deletes a specific ACL policy. This action will delete the ACL policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster.

Parameters
Name Description
name string

Required. Redis ACL policy resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id} where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/aclPolicies/[ACL_POLICY]";
// Make the request
Operation<Empty, OperationMetadata> response = cloudRedisClusterClient.DeleteAclPolicy(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteAclPolicy(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAclPolicyAsync(AclPolicyName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAclPolicyAsync(AclPolicyName name, CallSettings callSettings = null)

Deletes a specific ACL policy. This action will delete the ACL policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster.

Parameters
Name Description
name AclPolicyName

Required. Redis ACL policy resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id} where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AclPolicyName name = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]");
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteAclPolicyAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteAclPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAclPolicyAsync(AclPolicyName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAclPolicyAsync(AclPolicyName name, CancellationToken cancellationToken)

Deletes a specific ACL policy. This action will delete the ACL policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster.

Parameters
Name Description
name AclPolicyName

Required. Redis ACL policy resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id} where location_id refers to a Google Cloud region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AclPolicyName name = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]");
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteAclPolicyAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteAclPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAclPolicyAsync(DeleteAclPolicyRequest, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAclPolicyAsync(DeleteAclPolicyRequest request, CallSettings callSettings = null)

Deletes a specific ACL policy. This action will delete the ACL policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster.

Parameters
Name Description
request DeleteAclPolicyRequest

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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
DeleteAclPolicyRequest request = new DeleteAclPolicyRequest
{
    AclPolicyName = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]"),
    RequestId = "",
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteAclPolicyAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteAclPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAclPolicyAsync(DeleteAclPolicyRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAclPolicyAsync(DeleteAclPolicyRequest request, CancellationToken cancellationToken)

Deletes a specific ACL policy. This action will delete the ACL policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster.

Parameters
Name Description
request DeleteAclPolicyRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
DeleteAclPolicyRequest request = new DeleteAclPolicyRequest
{
    AclPolicyName = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]"),
    RequestId = "",
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteAclPolicyAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteAclPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAclPolicyAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAclPolicyAsync(string name, CallSettings callSettings = null)

Deletes a specific ACL policy. This action will delete the ACL policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster.

Parameters
Name Description
name string

Required. Redis ACL policy resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id} where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/aclPolicies/[ACL_POLICY]";
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteAclPolicyAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteAclPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAclPolicyAsync(string, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAclPolicyAsync(string name, CancellationToken cancellationToken)

Deletes a specific ACL policy. This action will delete the ACL policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster.

Parameters
Name Description
name string

Required. Redis ACL policy resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id} where location_id refers to a Google Cloud region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/aclPolicies/[ACL_POLICY]";
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteAclPolicyAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteAclPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAuthToken(AuthTokenName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteAuthToken(AuthTokenName name, CallSettings callSettings = null)

Removes a auth token for a user of a token based auth enabled instance.

Parameters
Name Description
name AuthTokenName

Required. The name of the token auth user resource that this auth token will be deleted from. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
AuthTokenName name = AuthTokenName.FromProjectLocationClusterTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]");
// Make the request
Operation<Empty, OperationMetadata> response = cloudRedisClusterClient.DeleteAuthToken(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteAuthToken(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAuthToken(DeleteAuthTokenRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteAuthToken(DeleteAuthTokenRequest request, CallSettings callSettings = null)

Removes a auth token for a user of a token based auth enabled instance.

Parameters
Name Description
request DeleteAuthTokenRequest

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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
DeleteAuthTokenRequest request = new DeleteAuthTokenRequest
{
    AuthTokenName = AuthTokenName.FromProjectLocationClusterTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = cloudRedisClusterClient.DeleteAuthToken(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteAuthToken(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAuthToken(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteAuthToken(string name, CallSettings callSettings = null)

Removes a auth token for a user of a token based auth enabled instance.

Parameters
Name Description
name string

Required. The name of the token auth user resource that this auth token will be deleted from. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]/authTokens/[AUTH_TOKEN]";
// Make the request
Operation<Empty, OperationMetadata> response = cloudRedisClusterClient.DeleteAuthToken(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteAuthToken(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAuthTokenAsync(AuthTokenName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAuthTokenAsync(AuthTokenName name, CallSettings callSettings = null)

Removes a auth token for a user of a token based auth enabled instance.

Parameters
Name Description
name AuthTokenName

Required. The name of the token auth user resource that this auth token will be deleted from. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AuthTokenName name = AuthTokenName.FromProjectLocationClusterTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]");
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteAuthTokenAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteAuthTokenAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAuthTokenAsync(AuthTokenName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAuthTokenAsync(AuthTokenName name, CancellationToken cancellationToken)

Removes a auth token for a user of a token based auth enabled instance.

Parameters
Name Description
name AuthTokenName

Required. The name of the token auth user resource that this auth token will be deleted from. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AuthTokenName name = AuthTokenName.FromProjectLocationClusterTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]");
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteAuthTokenAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteAuthTokenAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAuthTokenAsync(DeleteAuthTokenRequest, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAuthTokenAsync(DeleteAuthTokenRequest request, CallSettings callSettings = null)

Removes a auth token for a user of a token based auth enabled instance.

Parameters
Name Description
request DeleteAuthTokenRequest

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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
DeleteAuthTokenRequest request = new DeleteAuthTokenRequest
{
    AuthTokenName = AuthTokenName.FromProjectLocationClusterTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteAuthTokenAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteAuthTokenAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAuthTokenAsync(DeleteAuthTokenRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAuthTokenAsync(DeleteAuthTokenRequest request, CancellationToken cancellationToken)

Removes a auth token for a user of a token based auth enabled instance.

Parameters
Name Description
request DeleteAuthTokenRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
DeleteAuthTokenRequest request = new DeleteAuthTokenRequest
{
    AuthTokenName = AuthTokenName.FromProjectLocationClusterTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteAuthTokenAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteAuthTokenAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAuthTokenAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAuthTokenAsync(string name, CallSettings callSettings = null)

Removes a auth token for a user of a token based auth enabled instance.

Parameters
Name Description
name string

Required. The name of the token auth user resource that this auth token will be deleted from. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]/authTokens/[AUTH_TOKEN]";
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteAuthTokenAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteAuthTokenAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAuthTokenAsync(string, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAuthTokenAsync(string name, CancellationToken cancellationToken)

Removes a auth token for a user of a token based auth enabled instance.

Parameters
Name Description
name string

Required. The name of the token auth user resource that this auth token will be deleted from. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]/authTokens/[AUTH_TOKEN]";
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteAuthTokenAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteAuthTokenAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteBackup(BackupName, CallSettings)

public virtual Operation<Empty, Any> DeleteBackup(BackupName name, CallSettings callSettings = null)

Deletes a specific backup.

Parameters
Name Description
name BackupName

Required. Redis backup resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]");
// Make the request
Operation<Empty, Any> response = cloudRedisClusterClient.DeleteBackup(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteBackup(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteBackup(DeleteBackupRequest, CallSettings)

public virtual Operation<Empty, Any> 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
OperationEmptyAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
    RequestId = "",
};
// Make the request
Operation<Empty, Any> response = cloudRedisClusterClient.DeleteBackup(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteBackup(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteBackup(string, CallSettings)

public virtual Operation<Empty, Any> DeleteBackup(string name, CallSettings callSettings = null)

Deletes a specific backup.

Parameters
Name Description
name string

Required. Redis backup resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]/backups/[BACKUP]";
// Make the request
Operation<Empty, Any> response = cloudRedisClusterClient.DeleteBackup(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteBackup(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteBackupAsync(BackupName, CallSettings)

public virtual Task<Operation<Empty, Any>> DeleteBackupAsync(BackupName name, CallSettings callSettings = null)

Deletes a specific backup.

Parameters
Name Description
name BackupName

Required. Redis backup resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]");
// Make the request
Operation<Empty, Any> response = await cloudRedisClusterClient.DeleteBackupAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteBackupAsync(BackupName, CancellationToken)

public virtual Task<Operation<Empty, Any>> DeleteBackupAsync(BackupName name, CancellationToken cancellationToken)

Deletes a specific backup.

Parameters
Name Description
name BackupName

Required. Redis backup resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]");
// Make the request
Operation<Empty, Any> response = await cloudRedisClusterClient.DeleteBackupAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteBackupAsync(DeleteBackupRequest, CallSettings)

public virtual Task<Operation<Empty, Any>> 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
TaskOperationEmptyAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
    RequestId = "",
};
// Make the request
Operation<Empty, Any> response = await cloudRedisClusterClient.DeleteBackupAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteBackupAsync(DeleteBackupRequest, CancellationToken)

public virtual Task<Operation<Empty, Any>> DeleteBackupAsync(DeleteBackupRequest request, CancellationToken cancellationToken)

Deletes a specific backup.

Parameters
Name Description
request DeleteBackupRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
    RequestId = "",
};
// Make the request
Operation<Empty, Any> response = await cloudRedisClusterClient.DeleteBackupAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteBackupAsync(string, CallSettings)

public virtual Task<Operation<Empty, Any>> DeleteBackupAsync(string name, CallSettings callSettings = null)

Deletes a specific backup.

Parameters
Name Description
name string

Required. Redis backup resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]/backups/[BACKUP]";
// Make the request
Operation<Empty, Any> response = await cloudRedisClusterClient.DeleteBackupAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteBackupAsync(string, CancellationToken)

public virtual Task<Operation<Empty, Any>> DeleteBackupAsync(string name, CancellationToken cancellationToken)

Deletes a specific backup.

Parameters
Name Description
name string

Required. Redis backup resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]/backups/[BACKUP]";
// Make the request
Operation<Empty, Any> response = await cloudRedisClusterClient.DeleteBackupAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteCluster(ClusterName, CallSettings)

public virtual Operation<Empty, Any> DeleteCluster(ClusterName name, CallSettings callSettings = null)

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Parameters
Name Description
name ClusterName

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Operation<Empty, Any> response = cloudRedisClusterClient.DeleteCluster(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteCluster(DeleteClusterRequest, CallSettings)

public virtual Operation<Empty, Any> DeleteCluster(DeleteClusterRequest request, CallSettings callSettings = null)

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Parameters
Name Description
request DeleteClusterRequest

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
OperationEmptyAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
DeleteClusterRequest request = new DeleteClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    RequestId = "",
};
// Make the request
Operation<Empty, Any> response = cloudRedisClusterClient.DeleteCluster(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteCluster(string, CallSettings)

public virtual Operation<Empty, Any> DeleteCluster(string name, CallSettings callSettings = null)

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Parameters
Name Description
name string

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Operation<Empty, Any> response = cloudRedisClusterClient.DeleteCluster(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteClusterAsync(ClusterName, CallSettings)

public virtual Task<Operation<Empty, Any>> DeleteClusterAsync(ClusterName name, CallSettings callSettings = null)

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Parameters
Name Description
name ClusterName

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Operation<Empty, Any> response = await cloudRedisClusterClient.DeleteClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteClusterAsync(ClusterName, CancellationToken)

public virtual Task<Operation<Empty, Any>> DeleteClusterAsync(ClusterName name, CancellationToken cancellationToken)

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Parameters
Name Description
name ClusterName

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Operation<Empty, Any> response = await cloudRedisClusterClient.DeleteClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteClusterAsync(DeleteClusterRequest, CallSettings)

public virtual Task<Operation<Empty, Any>> DeleteClusterAsync(DeleteClusterRequest request, CallSettings callSettings = null)

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Parameters
Name Description
request DeleteClusterRequest

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
TaskOperationEmptyAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
DeleteClusterRequest request = new DeleteClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    RequestId = "",
};
// Make the request
Operation<Empty, Any> response = await cloudRedisClusterClient.DeleteClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteClusterAsync(DeleteClusterRequest, CancellationToken)

public virtual Task<Operation<Empty, Any>> DeleteClusterAsync(DeleteClusterRequest request, CancellationToken cancellationToken)

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Parameters
Name Description
request DeleteClusterRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
DeleteClusterRequest request = new DeleteClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    RequestId = "",
};
// Make the request
Operation<Empty, Any> response = await cloudRedisClusterClient.DeleteClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteClusterAsync(string, CallSettings)

public virtual Task<Operation<Empty, Any>> DeleteClusterAsync(string name, CallSettings callSettings = null)

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Parameters
Name Description
name string

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Operation<Empty, Any> response = await cloudRedisClusterClient.DeleteClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteClusterAsync(string, CancellationToken)

public virtual Task<Operation<Empty, Any>> DeleteClusterAsync(string name, CancellationToken cancellationToken)

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Parameters
Name Description
name string

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Operation<Empty, Any> response = await cloudRedisClusterClient.DeleteClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTokenAuthUser(DeleteTokenAuthUserRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteTokenAuthUser(DeleteTokenAuthUserRequest request, CallSettings callSettings = null)

Deletes a token auth user for a token based auth enabled cluster.

Parameters
Name Description
request DeleteTokenAuthUserRequest

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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
DeleteTokenAuthUserRequest request = new DeleteTokenAuthUserRequest
{
    TokenAuthUserName = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]"),
    RequestId = "",
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = cloudRedisClusterClient.DeleteTokenAuthUser(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteTokenAuthUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTokenAuthUser(TokenAuthUserName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteTokenAuthUser(TokenAuthUserName name, CallSettings callSettings = null)

Deletes a token auth user for a token based auth enabled cluster.

Parameters
Name Description
name TokenAuthUserName

Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
TokenAuthUserName name = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]");
// Make the request
Operation<Empty, OperationMetadata> response = cloudRedisClusterClient.DeleteTokenAuthUser(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteTokenAuthUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTokenAuthUser(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteTokenAuthUser(string name, CallSettings callSettings = null)

Deletes a token auth user for a token based auth enabled cluster.

Parameters
Name Description
name string

Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
Operation<Empty, OperationMetadata> response = cloudRedisClusterClient.DeleteTokenAuthUser(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceDeleteTokenAuthUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTokenAuthUserAsync(DeleteTokenAuthUserRequest, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteTokenAuthUserAsync(DeleteTokenAuthUserRequest request, CallSettings callSettings = null)

Deletes a token auth user for a token based auth enabled cluster.

Parameters
Name Description
request DeleteTokenAuthUserRequest

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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
DeleteTokenAuthUserRequest request = new DeleteTokenAuthUserRequest
{
    TokenAuthUserName = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]"),
    RequestId = "",
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteTokenAuthUserAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTokenAuthUserAsync(DeleteTokenAuthUserRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteTokenAuthUserAsync(DeleteTokenAuthUserRequest request, CancellationToken cancellationToken)

Deletes a token auth user for a token based auth enabled cluster.

Parameters
Name Description
request DeleteTokenAuthUserRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
DeleteTokenAuthUserRequest request = new DeleteTokenAuthUserRequest
{
    TokenAuthUserName = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]"),
    RequestId = "",
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteTokenAuthUserAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTokenAuthUserAsync(TokenAuthUserName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteTokenAuthUserAsync(TokenAuthUserName name, CallSettings callSettings = null)

Deletes a token auth user for a token based auth enabled cluster.

Parameters
Name Description
name TokenAuthUserName

Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
TokenAuthUserName name = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]");
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteTokenAuthUserAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTokenAuthUserAsync(TokenAuthUserName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteTokenAuthUserAsync(TokenAuthUserName name, CancellationToken cancellationToken)

Deletes a token auth user for a token based auth enabled cluster.

Parameters
Name Description
name TokenAuthUserName

Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
TokenAuthUserName name = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]");
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteTokenAuthUserAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTokenAuthUserAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteTokenAuthUserAsync(string name, CallSettings callSettings = null)

Deletes a token auth user for a token based auth enabled cluster.

Parameters
Name Description
name string

Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteTokenAuthUserAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTokenAuthUserAsync(string, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteTokenAuthUserAsync(string name, CancellationToken cancellationToken)

Deletes a token auth user for a token based auth enabled cluster.

Parameters
Name Description
name string

Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
Operation<Empty, OperationMetadata> response = await cloudRedisClusterClient.DeleteTokenAuthUserAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceDeleteTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

ExportBackup(ExportBackupRequest, CallSettings)

public virtual Operation<Backup, Any> 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
OperationBackupAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
ExportBackupRequest request = new ExportBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
    GcsBucket = "",
};
// Make the request
Operation<Backup, Any> response = cloudRedisClusterClient.ExportBackup(request);

// Poll until the returned long-running operation is complete
Operation<Backup, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Backup result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Backup, Any> retrievedResponse = cloudRedisClusterClient.PollOnceExportBackup(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Backup retrievedResult = retrievedResponse.Result;
}

ExportBackupAsync(ExportBackupRequest, CallSettings)

public virtual Task<Operation<Backup, Any>> 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
TaskOperationBackupAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ExportBackupRequest request = new ExportBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
    GcsBucket = "",
};
// Make the request
Operation<Backup, Any> response = await cloudRedisClusterClient.ExportBackupAsync(request);

// Poll until the returned long-running operation is complete
Operation<Backup, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Backup result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Backup, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceExportBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Backup retrievedResult = retrievedResponse.Result;
}

ExportBackupAsync(ExportBackupRequest, CancellationToken)

public virtual Task<Operation<Backup, Any>> ExportBackupAsync(ExportBackupRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ExportBackupRequest request = new ExportBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
    GcsBucket = "",
};
// Make the request
Operation<Backup, Any> response = await cloudRedisClusterClient.ExportBackupAsync(request);

// Poll until the returned long-running operation is complete
Operation<Backup, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Backup result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Backup, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceExportBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Backup retrievedResult = retrievedResponse.Result;
}

GetAclPolicy(AclPolicyName, CallSettings)

public virtual AclPolicy GetAclPolicy(AclPolicyName name, CallSettings callSettings = null)

Gets the details of a specific Redis Cluster ACL policy.

Parameters
Name Description
name AclPolicyName

Required. Redis ACL policy resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id} where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AclPolicy

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
AclPolicyName name = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]");
// Make the request
AclPolicy response = cloudRedisClusterClient.GetAclPolicy(name);

GetAclPolicy(GetAclPolicyRequest, CallSettings)

public virtual AclPolicy GetAclPolicy(GetAclPolicyRequest request, CallSettings callSettings = null)

Gets the details of a specific Redis Cluster ACL policy.

Parameters
Name Description
request GetAclPolicyRequest

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
AclPolicy

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
GetAclPolicyRequest request = new GetAclPolicyRequest
{
    AclPolicyName = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]"),
};
// Make the request
AclPolicy response = cloudRedisClusterClient.GetAclPolicy(request);

GetAclPolicy(string, CallSettings)

public virtual AclPolicy GetAclPolicy(string name, CallSettings callSettings = null)

Gets the details of a specific Redis Cluster ACL policy.

Parameters
Name Description
name string

Required. Redis ACL policy resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id} where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AclPolicy

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/aclPolicies/[ACL_POLICY]";
// Make the request
AclPolicy response = cloudRedisClusterClient.GetAclPolicy(name);

GetAclPolicyAsync(AclPolicyName, CallSettings)

public virtual Task<AclPolicy> GetAclPolicyAsync(AclPolicyName name, CallSettings callSettings = null)

Gets the details of a specific Redis Cluster ACL policy.

Parameters
Name Description
name AclPolicyName

Required. Redis ACL policy resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id} where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAclPolicy

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AclPolicyName name = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]");
// Make the request
AclPolicy response = await cloudRedisClusterClient.GetAclPolicyAsync(name);

GetAclPolicyAsync(AclPolicyName, CancellationToken)

public virtual Task<AclPolicy> GetAclPolicyAsync(AclPolicyName name, CancellationToken cancellationToken)

Gets the details of a specific Redis Cluster ACL policy.

Parameters
Name Description
name AclPolicyName

Required. Redis ACL policy resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id} where location_id refers to a Google Cloud region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAclPolicy

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AclPolicyName name = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]");
// Make the request
AclPolicy response = await cloudRedisClusterClient.GetAclPolicyAsync(name);

GetAclPolicyAsync(GetAclPolicyRequest, CallSettings)

public virtual Task<AclPolicy> GetAclPolicyAsync(GetAclPolicyRequest request, CallSettings callSettings = null)

Gets the details of a specific Redis Cluster ACL policy.

Parameters
Name Description
request GetAclPolicyRequest

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
TaskAclPolicy

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetAclPolicyRequest request = new GetAclPolicyRequest
{
    AclPolicyName = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]"),
};
// Make the request
AclPolicy response = await cloudRedisClusterClient.GetAclPolicyAsync(request);

GetAclPolicyAsync(GetAclPolicyRequest, CancellationToken)

public virtual Task<AclPolicy> GetAclPolicyAsync(GetAclPolicyRequest request, CancellationToken cancellationToken)

Gets the details of a specific Redis Cluster ACL policy.

Parameters
Name Description
request GetAclPolicyRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAclPolicy

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetAclPolicyRequest request = new GetAclPolicyRequest
{
    AclPolicyName = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]"),
};
// Make the request
AclPolicy response = await cloudRedisClusterClient.GetAclPolicyAsync(request);

GetAclPolicyAsync(string, CallSettings)

public virtual Task<AclPolicy> GetAclPolicyAsync(string name, CallSettings callSettings = null)

Gets the details of a specific Redis Cluster ACL policy.

Parameters
Name Description
name string

Required. Redis ACL policy resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id} where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAclPolicy

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/aclPolicies/[ACL_POLICY]";
// Make the request
AclPolicy response = await cloudRedisClusterClient.GetAclPolicyAsync(name);

GetAclPolicyAsync(string, CancellationToken)

public virtual Task<AclPolicy> GetAclPolicyAsync(string name, CancellationToken cancellationToken)

Gets the details of a specific Redis Cluster ACL policy.

Parameters
Name Description
name string

Required. Redis ACL policy resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id} where location_id refers to a Google Cloud region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAclPolicy

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/aclPolicies/[ACL_POLICY]";
// Make the request
AclPolicy response = await cloudRedisClusterClient.GetAclPolicyAsync(name);

GetAclPolicyRevision(AclPolicyRevisionName, CallSettings)

public virtual AclPolicyRevision GetAclPolicyRevision(AclPolicyRevisionName name, CallSettings callSettings = null)

Gets details of a specific ACL policy revision.

Parameters
Name Description
name AclPolicyRevisionName

Required. Redis ACL policy revision resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}/revisions/{revision_id} where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AclPolicyRevision

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
AclPolicyRevisionName name = AclPolicyRevisionName.FromProjectLocationAclPolicyRevision("[PROJECT]", "[LOCATION]", "[ACL_POLICY]", "[REVISION]");
// Make the request
AclPolicyRevision response = cloudRedisClusterClient.GetAclPolicyRevision(name);

GetAclPolicyRevision(GetAclPolicyRevisionRequest, CallSettings)

public virtual AclPolicyRevision GetAclPolicyRevision(GetAclPolicyRevisionRequest request, CallSettings callSettings = null)

Gets details of a specific ACL policy revision.

Parameters
Name Description
request GetAclPolicyRevisionRequest

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
AclPolicyRevision

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
GetAclPolicyRevisionRequest request = new GetAclPolicyRevisionRequest
{
    AclPolicyRevisionName = AclPolicyRevisionName.FromProjectLocationAclPolicyRevision("[PROJECT]", "[LOCATION]", "[ACL_POLICY]", "[REVISION]"),
};
// Make the request
AclPolicyRevision response = cloudRedisClusterClient.GetAclPolicyRevision(request);

GetAclPolicyRevision(string, CallSettings)

public virtual AclPolicyRevision GetAclPolicyRevision(string name, CallSettings callSettings = null)

Gets details of a specific ACL policy revision.

Parameters
Name Description
name string

Required. Redis ACL policy revision resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}/revisions/{revision_id} where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AclPolicyRevision

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/aclPolicies/[ACL_POLICY]/revisions/[REVISION]";
// Make the request
AclPolicyRevision response = cloudRedisClusterClient.GetAclPolicyRevision(name);

GetAclPolicyRevisionAsync(AclPolicyRevisionName, CallSettings)

public virtual Task<AclPolicyRevision> GetAclPolicyRevisionAsync(AclPolicyRevisionName name, CallSettings callSettings = null)

Gets details of a specific ACL policy revision.

Parameters
Name Description
name AclPolicyRevisionName

Required. Redis ACL policy revision resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}/revisions/{revision_id} where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAclPolicyRevision

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AclPolicyRevisionName name = AclPolicyRevisionName.FromProjectLocationAclPolicyRevision("[PROJECT]", "[LOCATION]", "[ACL_POLICY]", "[REVISION]");
// Make the request
AclPolicyRevision response = await cloudRedisClusterClient.GetAclPolicyRevisionAsync(name);

GetAclPolicyRevisionAsync(AclPolicyRevisionName, CancellationToken)

public virtual Task<AclPolicyRevision> GetAclPolicyRevisionAsync(AclPolicyRevisionName name, CancellationToken cancellationToken)

Gets details of a specific ACL policy revision.

Parameters
Name Description
name AclPolicyRevisionName

Required. Redis ACL policy revision resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}/revisions/{revision_id} where location_id refers to a Google Cloud region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAclPolicyRevision

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AclPolicyRevisionName name = AclPolicyRevisionName.FromProjectLocationAclPolicyRevision("[PROJECT]", "[LOCATION]", "[ACL_POLICY]", "[REVISION]");
// Make the request
AclPolicyRevision response = await cloudRedisClusterClient.GetAclPolicyRevisionAsync(name);

GetAclPolicyRevisionAsync(GetAclPolicyRevisionRequest, CallSettings)

public virtual Task<AclPolicyRevision> GetAclPolicyRevisionAsync(GetAclPolicyRevisionRequest request, CallSettings callSettings = null)

Gets details of a specific ACL policy revision.

Parameters
Name Description
request GetAclPolicyRevisionRequest

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
TaskAclPolicyRevision

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetAclPolicyRevisionRequest request = new GetAclPolicyRevisionRequest
{
    AclPolicyRevisionName = AclPolicyRevisionName.FromProjectLocationAclPolicyRevision("[PROJECT]", "[LOCATION]", "[ACL_POLICY]", "[REVISION]"),
};
// Make the request
AclPolicyRevision response = await cloudRedisClusterClient.GetAclPolicyRevisionAsync(request);

GetAclPolicyRevisionAsync(GetAclPolicyRevisionRequest, CancellationToken)

public virtual Task<AclPolicyRevision> GetAclPolicyRevisionAsync(GetAclPolicyRevisionRequest request, CancellationToken cancellationToken)

Gets details of a specific ACL policy revision.

Parameters
Name Description
request GetAclPolicyRevisionRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAclPolicyRevision

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetAclPolicyRevisionRequest request = new GetAclPolicyRevisionRequest
{
    AclPolicyRevisionName = AclPolicyRevisionName.FromProjectLocationAclPolicyRevision("[PROJECT]", "[LOCATION]", "[ACL_POLICY]", "[REVISION]"),
};
// Make the request
AclPolicyRevision response = await cloudRedisClusterClient.GetAclPolicyRevisionAsync(request);

GetAclPolicyRevisionAsync(string, CallSettings)

public virtual Task<AclPolicyRevision> GetAclPolicyRevisionAsync(string name, CallSettings callSettings = null)

Gets details of a specific ACL policy revision.

Parameters
Name Description
name string

Required. Redis ACL policy revision resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}/revisions/{revision_id} where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAclPolicyRevision

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/aclPolicies/[ACL_POLICY]/revisions/[REVISION]";
// Make the request
AclPolicyRevision response = await cloudRedisClusterClient.GetAclPolicyRevisionAsync(name);

GetAclPolicyRevisionAsync(string, CancellationToken)

public virtual Task<AclPolicyRevision> GetAclPolicyRevisionAsync(string name, CancellationToken cancellationToken)

Gets details of a specific ACL policy revision.

Parameters
Name Description
name string

Required. Redis ACL policy revision resource name using the form: projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}/revisions/{revision_id} where location_id refers to a Google Cloud region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAclPolicyRevision

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/aclPolicies/[ACL_POLICY]/revisions/[REVISION]";
// Make the request
AclPolicyRevision response = await cloudRedisClusterClient.GetAclPolicyRevisionAsync(name);

GetAuthToken(AuthTokenName, CallSettings)

public virtual AuthToken GetAuthToken(AuthTokenName name, CallSettings callSettings = null)

Gets a specific auth token for a specific token auth user.

Parameters
Name Description
name AuthTokenName

Required. The name of auth token for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AuthToken

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
AuthTokenName name = AuthTokenName.FromProjectLocationClusterTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]");
// Make the request
AuthToken response = cloudRedisClusterClient.GetAuthToken(name);

GetAuthToken(GetAuthTokenRequest, CallSettings)

public virtual AuthToken GetAuthToken(GetAuthTokenRequest request, CallSettings callSettings = null)

Gets a specific auth token for a specific token auth user.

Parameters
Name Description
request GetAuthTokenRequest

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
AuthToken

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
GetAuthTokenRequest request = new GetAuthTokenRequest
{
    AuthTokenName = AuthTokenName.FromProjectLocationClusterTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]"),
};
// Make the request
AuthToken response = cloudRedisClusterClient.GetAuthToken(request);

GetAuthToken(string, CallSettings)

public virtual AuthToken GetAuthToken(string name, CallSettings callSettings = null)

Gets a specific auth token for a specific token auth user.

Parameters
Name Description
name string

Required. The name of auth token for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AuthToken

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]/authTokens/[AUTH_TOKEN]";
// Make the request
AuthToken response = cloudRedisClusterClient.GetAuthToken(name);

GetAuthTokenAsync(AuthTokenName, CallSettings)

public virtual Task<AuthToken> GetAuthTokenAsync(AuthTokenName name, CallSettings callSettings = null)

Gets a specific auth token for a specific token auth user.

Parameters
Name Description
name AuthTokenName

Required. The name of auth token for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAuthToken

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AuthTokenName name = AuthTokenName.FromProjectLocationClusterTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]");
// Make the request
AuthToken response = await cloudRedisClusterClient.GetAuthTokenAsync(name);

GetAuthTokenAsync(AuthTokenName, CancellationToken)

public virtual Task<AuthToken> GetAuthTokenAsync(AuthTokenName name, CancellationToken cancellationToken)

Gets a specific auth token for a specific token auth user.

Parameters
Name Description
name AuthTokenName

Required. The name of auth token for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAuthToken

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AuthTokenName name = AuthTokenName.FromProjectLocationClusterTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]");
// Make the request
AuthToken response = await cloudRedisClusterClient.GetAuthTokenAsync(name);

GetAuthTokenAsync(GetAuthTokenRequest, CallSettings)

public virtual Task<AuthToken> GetAuthTokenAsync(GetAuthTokenRequest request, CallSettings callSettings = null)

Gets a specific auth token for a specific token auth user.

Parameters
Name Description
request GetAuthTokenRequest

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
TaskAuthToken

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetAuthTokenRequest request = new GetAuthTokenRequest
{
    AuthTokenName = AuthTokenName.FromProjectLocationClusterTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]"),
};
// Make the request
AuthToken response = await cloudRedisClusterClient.GetAuthTokenAsync(request);

GetAuthTokenAsync(GetAuthTokenRequest, CancellationToken)

public virtual Task<AuthToken> GetAuthTokenAsync(GetAuthTokenRequest request, CancellationToken cancellationToken)

Gets a specific auth token for a specific token auth user.

Parameters
Name Description
request GetAuthTokenRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAuthToken

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetAuthTokenRequest request = new GetAuthTokenRequest
{
    AuthTokenName = AuthTokenName.FromProjectLocationClusterTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]"),
};
// Make the request
AuthToken response = await cloudRedisClusterClient.GetAuthTokenAsync(request);

GetAuthTokenAsync(string, CallSettings)

public virtual Task<AuthToken> GetAuthTokenAsync(string name, CallSettings callSettings = null)

Gets a specific auth token for a specific token auth user.

Parameters
Name Description
name string

Required. The name of auth token for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAuthToken

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]/authTokens/[AUTH_TOKEN]";
// Make the request
AuthToken response = await cloudRedisClusterClient.GetAuthTokenAsync(name);

GetAuthTokenAsync(string, CancellationToken)

public virtual Task<AuthToken> GetAuthTokenAsync(string name, CancellationToken cancellationToken)

Gets a specific auth token for a specific token auth user.

Parameters
Name Description
name string

Required. The name of auth token for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAuthToken

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]/authTokens/[AUTH_TOKEN]";
// Make the request
AuthToken response = await cloudRedisClusterClient.GetAuthTokenAsync(name);

GetBackup(BackupName, CallSettings)

public virtual Backup GetBackup(BackupName name, CallSettings callSettings = null)

Gets the details of a specific backup.

Parameters
Name Description
name BackupName

Required. Redis backup resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Backup

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]");
// Make the request
Backup response = cloudRedisClusterClient.GetBackup(name);

GetBackup(GetBackupRequest, CallSettings)

public virtual 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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
GetBackupRequest request = new GetBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
};
// Make the request
Backup response = cloudRedisClusterClient.GetBackup(request);

GetBackup(string, CallSettings)

public virtual Backup GetBackup(string name, CallSettings callSettings = null)

Gets the details of a specific backup.

Parameters
Name Description
name string

Required. Redis backup resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Backup

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]/backups/[BACKUP]";
// Make the request
Backup response = cloudRedisClusterClient.GetBackup(name);

GetBackupAsync(BackupName, CallSettings)

public virtual Task<Backup> GetBackupAsync(BackupName name, CallSettings callSettings = null)

Gets the details of a specific backup.

Parameters
Name Description
name BackupName

Required. Redis backup resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackup

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]");
// Make the request
Backup response = await cloudRedisClusterClient.GetBackupAsync(name);

GetBackupAsync(BackupName, CancellationToken)

public virtual Task<Backup> GetBackupAsync(BackupName name, CancellationToken cancellationToken)

Gets the details of a specific backup.

Parameters
Name Description
name BackupName

Required. Redis backup resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackup

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]");
// Make the request
Backup response = await cloudRedisClusterClient.GetBackupAsync(name);

GetBackupAsync(GetBackupRequest, CallSettings)

public virtual 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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetBackupRequest request = new GetBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
};
// Make the request
Backup response = await cloudRedisClusterClient.GetBackupAsync(request);

GetBackupAsync(GetBackupRequest, CancellationToken)

public virtual Task<Backup> GetBackupAsync(GetBackupRequest request, CancellationToken cancellationToken)

Gets the details of a specific backup.

Parameters
Name Description
request GetBackupRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackup

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetBackupRequest request = new GetBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
};
// Make the request
Backup response = await cloudRedisClusterClient.GetBackupAsync(request);

GetBackupAsync(string, CallSettings)

public virtual Task<Backup> GetBackupAsync(string name, CallSettings callSettings = null)

Gets the details of a specific backup.

Parameters
Name Description
name string

Required. Redis backup resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackup

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]/backups/[BACKUP]";
// Make the request
Backup response = await cloudRedisClusterClient.GetBackupAsync(name);

GetBackupAsync(string, CancellationToken)

public virtual Task<Backup> GetBackupAsync(string name, CancellationToken cancellationToken)

Gets the details of a specific backup.

Parameters
Name Description
name string

Required. Redis backup resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackup

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]/backups/[BACKUP]";
// Make the request
Backup response = await cloudRedisClusterClient.GetBackupAsync(name);

GetBackupCollection(BackupCollectionName, CallSettings)

public virtual BackupCollection GetBackupCollection(BackupCollectionName name, CallSettings callSettings = null)

Get a backup collection.

Parameters
Name Description
name BackupCollectionName

Required. Redis backupCollection resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BackupCollection

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
BackupCollectionName name = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]");
// Make the request
BackupCollection response = cloudRedisClusterClient.GetBackupCollection(name);

GetBackupCollection(GetBackupCollectionRequest, CallSettings)

public virtual 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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
GetBackupCollectionRequest request = new GetBackupCollectionRequest
{
    BackupCollectionName = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]"),
};
// Make the request
BackupCollection response = cloudRedisClusterClient.GetBackupCollection(request);

GetBackupCollection(string, CallSettings)

public virtual BackupCollection GetBackupCollection(string name, CallSettings callSettings = null)

Get a backup collection.

Parameters
Name Description
name string

Required. Redis backupCollection resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BackupCollection

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]";
// Make the request
BackupCollection response = cloudRedisClusterClient.GetBackupCollection(name);

GetBackupCollectionAsync(BackupCollectionName, CallSettings)

public virtual Task<BackupCollection> GetBackupCollectionAsync(BackupCollectionName name, CallSettings callSettings = null)

Get a backup collection.

Parameters
Name Description
name BackupCollectionName

Required. Redis backupCollection resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackupCollection

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
BackupCollectionName name = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]");
// Make the request
BackupCollection response = await cloudRedisClusterClient.GetBackupCollectionAsync(name);

GetBackupCollectionAsync(BackupCollectionName, CancellationToken)

public virtual Task<BackupCollection> GetBackupCollectionAsync(BackupCollectionName name, CancellationToken cancellationToken)

Get a backup collection.

Parameters
Name Description
name BackupCollectionName

Required. Redis backupCollection resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id} where location_id refers to a GCP region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackupCollection

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
BackupCollectionName name = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]");
// Make the request
BackupCollection response = await cloudRedisClusterClient.GetBackupCollectionAsync(name);

GetBackupCollectionAsync(GetBackupCollectionRequest, CallSettings)

public virtual 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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetBackupCollectionRequest request = new GetBackupCollectionRequest
{
    BackupCollectionName = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]"),
};
// Make the request
BackupCollection response = await cloudRedisClusterClient.GetBackupCollectionAsync(request);

GetBackupCollectionAsync(GetBackupCollectionRequest, CancellationToken)

public virtual Task<BackupCollection> GetBackupCollectionAsync(GetBackupCollectionRequest request, CancellationToken cancellationToken)

Get a backup collection.

Parameters
Name Description
request GetBackupCollectionRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackupCollection

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetBackupCollectionRequest request = new GetBackupCollectionRequest
{
    BackupCollectionName = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]"),
};
// Make the request
BackupCollection response = await cloudRedisClusterClient.GetBackupCollectionAsync(request);

GetBackupCollectionAsync(string, CallSettings)

public virtual Task<BackupCollection> GetBackupCollectionAsync(string name, CallSettings callSettings = null)

Get a backup collection.

Parameters
Name Description
name string

Required. Redis backupCollection resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackupCollection

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]";
// Make the request
BackupCollection response = await cloudRedisClusterClient.GetBackupCollectionAsync(name);

GetBackupCollectionAsync(string, CancellationToken)

public virtual Task<BackupCollection> GetBackupCollectionAsync(string name, CancellationToken cancellationToken)

Get a backup collection.

Parameters
Name Description
name string

Required. Redis backupCollection resource name using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id} where location_id refers to a GCP region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackupCollection

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]";
// Make the request
BackupCollection response = await cloudRedisClusterClient.GetBackupCollectionAsync(name);

GetCluster(ClusterName, CallSettings)

public virtual Cluster GetCluster(ClusterName name, CallSettings callSettings = null)

Gets the details of a specific Redis cluster.

Parameters
Name Description
name ClusterName

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Cluster

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Cluster response = cloudRedisClusterClient.GetCluster(name);

GetCluster(GetClusterRequest, CallSettings)

public virtual Cluster GetCluster(GetClusterRequest request, CallSettings callSettings = null)

Gets the details of a specific Redis cluster.

Parameters
Name Description
request GetClusterRequest

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
Cluster

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
GetClusterRequest request = new GetClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
};
// Make the request
Cluster response = cloudRedisClusterClient.GetCluster(request);

GetCluster(string, CallSettings)

public virtual Cluster GetCluster(string name, CallSettings callSettings = null)

Gets the details of a specific Redis cluster.

Parameters
Name Description
name string

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Cluster

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Cluster response = cloudRedisClusterClient.GetCluster(name);

GetClusterAsync(ClusterName, CallSettings)

public virtual Task<Cluster> GetClusterAsync(ClusterName name, CallSettings callSettings = null)

Gets the details of a specific Redis cluster.

Parameters
Name Description
name ClusterName

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskCluster

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Cluster response = await cloudRedisClusterClient.GetClusterAsync(name);

GetClusterAsync(ClusterName, CancellationToken)

public virtual Task<Cluster> GetClusterAsync(ClusterName name, CancellationToken cancellationToken)

Gets the details of a specific Redis cluster.

Parameters
Name Description
name ClusterName

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskCluster

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Cluster response = await cloudRedisClusterClient.GetClusterAsync(name);

GetClusterAsync(GetClusterRequest, CallSettings)

public virtual Task<Cluster> GetClusterAsync(GetClusterRequest request, CallSettings callSettings = null)

Gets the details of a specific Redis cluster.

Parameters
Name Description
request GetClusterRequest

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
TaskCluster

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetClusterRequest request = new GetClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
};
// Make the request
Cluster response = await cloudRedisClusterClient.GetClusterAsync(request);

GetClusterAsync(GetClusterRequest, CancellationToken)

public virtual Task<Cluster> GetClusterAsync(GetClusterRequest request, CancellationToken cancellationToken)

Gets the details of a specific Redis cluster.

Parameters
Name Description
request GetClusterRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskCluster

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetClusterRequest request = new GetClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
};
// Make the request
Cluster response = await cloudRedisClusterClient.GetClusterAsync(request);

GetClusterAsync(string, CallSettings)

public virtual Task<Cluster> GetClusterAsync(string name, CallSettings callSettings = null)

Gets the details of a specific Redis cluster.

Parameters
Name Description
name string

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskCluster

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Cluster response = await cloudRedisClusterClient.GetClusterAsync(name);

GetClusterAsync(string, CancellationToken)

public virtual Task<Cluster> GetClusterAsync(string name, CancellationToken cancellationToken)

Gets the details of a specific Redis cluster.

Parameters
Name Description
name string

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskCluster

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Cluster response = await cloudRedisClusterClient.GetClusterAsync(name);

GetClusterCertificateAuthority(CertificateAuthorityName, CallSettings)

public virtual CertificateAuthority GetClusterCertificateAuthority(CertificateAuthorityName name, CallSettings callSettings = null)

Gets the details of certificate authority information for Redis cluster.

Parameters
Name Description
name CertificateAuthorityName

Required. Redis cluster certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
CertificateAuthority

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
CertificateAuthorityName name = CertificateAuthorityName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
CertificateAuthority response = cloudRedisClusterClient.GetClusterCertificateAuthority(name);

GetClusterCertificateAuthority(GetClusterCertificateAuthorityRequest, CallSettings)

public virtual CertificateAuthority GetClusterCertificateAuthority(GetClusterCertificateAuthorityRequest request, CallSettings callSettings = null)

Gets the details of certificate authority information for Redis cluster.

Parameters
Name Description
request GetClusterCertificateAuthorityRequest

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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
GetClusterCertificateAuthorityRequest request = new GetClusterCertificateAuthorityRequest
{
    CertificateAuthorityName = CertificateAuthorityName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
};
// Make the request
CertificateAuthority response = cloudRedisClusterClient.GetClusterCertificateAuthority(request);

GetClusterCertificateAuthority(string, CallSettings)

public virtual CertificateAuthority GetClusterCertificateAuthority(string name, CallSettings callSettings = null)

Gets the details of certificate authority information for Redis cluster.

Parameters
Name Description
name string

Required. Redis cluster certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
CertificateAuthority

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/certificateAuthority";
// Make the request
CertificateAuthority response = cloudRedisClusterClient.GetClusterCertificateAuthority(name);

GetClusterCertificateAuthorityAsync(CertificateAuthorityName, CallSettings)

public virtual Task<CertificateAuthority> GetClusterCertificateAuthorityAsync(CertificateAuthorityName name, CallSettings callSettings = null)

Gets the details of certificate authority information for Redis cluster.

Parameters
Name Description
name CertificateAuthorityName

Required. Redis cluster certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskCertificateAuthority

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
CertificateAuthorityName name = CertificateAuthorityName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
CertificateAuthority response = await cloudRedisClusterClient.GetClusterCertificateAuthorityAsync(name);

GetClusterCertificateAuthorityAsync(CertificateAuthorityName, CancellationToken)

public virtual Task<CertificateAuthority> GetClusterCertificateAuthorityAsync(CertificateAuthorityName name, CancellationToken cancellationToken)

Gets the details of certificate authority information for Redis cluster.

Parameters
Name Description
name CertificateAuthorityName

Required. Redis cluster certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority where location_id refers to a GCP region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskCertificateAuthority

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
CertificateAuthorityName name = CertificateAuthorityName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
CertificateAuthority response = await cloudRedisClusterClient.GetClusterCertificateAuthorityAsync(name);

GetClusterCertificateAuthorityAsync(GetClusterCertificateAuthorityRequest, CallSettings)

public virtual Task<CertificateAuthority> GetClusterCertificateAuthorityAsync(GetClusterCertificateAuthorityRequest request, CallSettings callSettings = null)

Gets the details of certificate authority information for Redis cluster.

Parameters
Name Description
request GetClusterCertificateAuthorityRequest

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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetClusterCertificateAuthorityRequest request = new GetClusterCertificateAuthorityRequest
{
    CertificateAuthorityName = CertificateAuthorityName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
};
// Make the request
CertificateAuthority response = await cloudRedisClusterClient.GetClusterCertificateAuthorityAsync(request);

GetClusterCertificateAuthorityAsync(GetClusterCertificateAuthorityRequest, CancellationToken)

public virtual Task<CertificateAuthority> GetClusterCertificateAuthorityAsync(GetClusterCertificateAuthorityRequest request, CancellationToken cancellationToken)

Gets the details of certificate authority information for Redis cluster.

Parameters
Name Description
request GetClusterCertificateAuthorityRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskCertificateAuthority

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetClusterCertificateAuthorityRequest request = new GetClusterCertificateAuthorityRequest
{
    CertificateAuthorityName = CertificateAuthorityName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
};
// Make the request
CertificateAuthority response = await cloudRedisClusterClient.GetClusterCertificateAuthorityAsync(request);

GetClusterCertificateAuthorityAsync(string, CallSettings)

public virtual Task<CertificateAuthority> GetClusterCertificateAuthorityAsync(string name, CallSettings callSettings = null)

Gets the details of certificate authority information for Redis cluster.

Parameters
Name Description
name string

Required. Redis cluster certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority where location_id refers to a GCP region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskCertificateAuthority

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/certificateAuthority";
// Make the request
CertificateAuthority response = await cloudRedisClusterClient.GetClusterCertificateAuthorityAsync(name);

GetClusterCertificateAuthorityAsync(string, CancellationToken)

public virtual Task<CertificateAuthority> GetClusterCertificateAuthorityAsync(string name, CancellationToken cancellationToken)

Gets the details of certificate authority information for Redis cluster.

Parameters
Name Description
name string

Required. Redis cluster certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority where location_id refers to a GCP region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskCertificateAuthority

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/certificateAuthority";
// Make the request
CertificateAuthority response = await cloudRedisClusterClient.GetClusterCertificateAuthorityAsync(name);

GetSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest, CallSettings)

public virtual SharedRegionalCertificateAuthority GetSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest request, CallSettings callSettings = null)

Gets the details of regional certificate authority information for Redis cluster.

Parameters
Name Description
request GetSharedRegionalCertificateAuthorityRequest

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
SharedRegionalCertificateAuthority

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
GetSharedRegionalCertificateAuthorityRequest request = new GetSharedRegionalCertificateAuthorityRequest
{
    SharedRegionalCertificateAuthorityName = SharedRegionalCertificateAuthorityName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
SharedRegionalCertificateAuthority response = cloudRedisClusterClient.GetSharedRegionalCertificateAuthority(request);

GetSharedRegionalCertificateAuthority(SharedRegionalCertificateAuthorityName, CallSettings)

public virtual SharedRegionalCertificateAuthority GetSharedRegionalCertificateAuthority(SharedRegionalCertificateAuthorityName name, CallSettings callSettings = null)

Gets the details of regional certificate authority information for Redis cluster.

Parameters
Name Description
name SharedRegionalCertificateAuthorityName

Required. Regional certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/sharedRegionalCertificateAuthority where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SharedRegionalCertificateAuthority

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
SharedRegionalCertificateAuthorityName name = SharedRegionalCertificateAuthorityName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
SharedRegionalCertificateAuthority response = cloudRedisClusterClient.GetSharedRegionalCertificateAuthority(name);

GetSharedRegionalCertificateAuthority(string, CallSettings)

public virtual SharedRegionalCertificateAuthority GetSharedRegionalCertificateAuthority(string name, CallSettings callSettings = null)

Gets the details of regional certificate authority information for Redis cluster.

Parameters
Name Description
name string

Required. Regional certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/sharedRegionalCertificateAuthority where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SharedRegionalCertificateAuthority

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/sharedRegionalCertificateAuthority";
// Make the request
SharedRegionalCertificateAuthority response = cloudRedisClusterClient.GetSharedRegionalCertificateAuthority(name);

GetSharedRegionalCertificateAuthorityAsync(GetSharedRegionalCertificateAuthorityRequest, CallSettings)

public virtual Task<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthorityAsync(GetSharedRegionalCertificateAuthorityRequest request, CallSettings callSettings = null)

Gets the details of regional certificate authority information for Redis cluster.

Parameters
Name Description
request GetSharedRegionalCertificateAuthorityRequest

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
TaskSharedRegionalCertificateAuthority

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetSharedRegionalCertificateAuthorityRequest request = new GetSharedRegionalCertificateAuthorityRequest
{
    SharedRegionalCertificateAuthorityName = SharedRegionalCertificateAuthorityName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
SharedRegionalCertificateAuthority response = await cloudRedisClusterClient.GetSharedRegionalCertificateAuthorityAsync(request);

GetSharedRegionalCertificateAuthorityAsync(GetSharedRegionalCertificateAuthorityRequest, CancellationToken)

public virtual Task<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthorityAsync(GetSharedRegionalCertificateAuthorityRequest request, CancellationToken cancellationToken)

Gets the details of regional certificate authority information for Redis cluster.

Parameters
Name Description
request GetSharedRegionalCertificateAuthorityRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSharedRegionalCertificateAuthority

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetSharedRegionalCertificateAuthorityRequest request = new GetSharedRegionalCertificateAuthorityRequest
{
    SharedRegionalCertificateAuthorityName = SharedRegionalCertificateAuthorityName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
SharedRegionalCertificateAuthority response = await cloudRedisClusterClient.GetSharedRegionalCertificateAuthorityAsync(request);

GetSharedRegionalCertificateAuthorityAsync(SharedRegionalCertificateAuthorityName, CallSettings)

public virtual Task<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthorityAsync(SharedRegionalCertificateAuthorityName name, CallSettings callSettings = null)

Gets the details of regional certificate authority information for Redis cluster.

Parameters
Name Description
name SharedRegionalCertificateAuthorityName

Required. Regional certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/sharedRegionalCertificateAuthority where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSharedRegionalCertificateAuthority

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
SharedRegionalCertificateAuthorityName name = SharedRegionalCertificateAuthorityName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
SharedRegionalCertificateAuthority response = await cloudRedisClusterClient.GetSharedRegionalCertificateAuthorityAsync(name);

GetSharedRegionalCertificateAuthorityAsync(SharedRegionalCertificateAuthorityName, CancellationToken)

public virtual Task<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthorityAsync(SharedRegionalCertificateAuthorityName name, CancellationToken cancellationToken)

Gets the details of regional certificate authority information for Redis cluster.

Parameters
Name Description
name SharedRegionalCertificateAuthorityName

Required. Regional certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/sharedRegionalCertificateAuthority where location_id refers to a Google Cloud region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSharedRegionalCertificateAuthority

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
SharedRegionalCertificateAuthorityName name = SharedRegionalCertificateAuthorityName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
SharedRegionalCertificateAuthority response = await cloudRedisClusterClient.GetSharedRegionalCertificateAuthorityAsync(name);

GetSharedRegionalCertificateAuthorityAsync(string, CallSettings)

public virtual Task<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthorityAsync(string name, CallSettings callSettings = null)

Gets the details of regional certificate authority information for Redis cluster.

Parameters
Name Description
name string

Required. Regional certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/sharedRegionalCertificateAuthority where location_id refers to a Google Cloud region.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSharedRegionalCertificateAuthority

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/sharedRegionalCertificateAuthority";
// Make the request
SharedRegionalCertificateAuthority response = await cloudRedisClusterClient.GetSharedRegionalCertificateAuthorityAsync(name);

GetSharedRegionalCertificateAuthorityAsync(string, CancellationToken)

public virtual Task<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthorityAsync(string name, CancellationToken cancellationToken)

Gets the details of regional certificate authority information for Redis cluster.

Parameters
Name Description
name string

Required. Regional certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/sharedRegionalCertificateAuthority where location_id refers to a Google Cloud region.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSharedRegionalCertificateAuthority

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/sharedRegionalCertificateAuthority";
// Make the request
SharedRegionalCertificateAuthority response = await cloudRedisClusterClient.GetSharedRegionalCertificateAuthorityAsync(name);

GetTokenAuthUser(GetTokenAuthUserRequest, CallSettings)

public virtual TokenAuthUser GetTokenAuthUser(GetTokenAuthUserRequest request, CallSettings callSettings = null)

Gets a specific token auth user for a basic auth enabled cluster.

Parameters
Name Description
request GetTokenAuthUserRequest

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
TokenAuthUser

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
GetTokenAuthUserRequest request = new GetTokenAuthUserRequest
{
    TokenAuthUserName = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]"),
};
// Make the request
TokenAuthUser response = cloudRedisClusterClient.GetTokenAuthUser(request);

GetTokenAuthUser(TokenAuthUserName, CallSettings)

public virtual TokenAuthUser GetTokenAuthUser(TokenAuthUserName name, CallSettings callSettings = null)

Gets a specific token auth user for a basic auth enabled cluster.

Parameters
Name Description
name TokenAuthUserName

Required. The name of token auth user for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TokenAuthUser

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
TokenAuthUserName name = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]");
// Make the request
TokenAuthUser response = cloudRedisClusterClient.GetTokenAuthUser(name);

GetTokenAuthUser(string, CallSettings)

public virtual TokenAuthUser GetTokenAuthUser(string name, CallSettings callSettings = null)

Gets a specific token auth user for a basic auth enabled cluster.

Parameters
Name Description
name string

Required. The name of token auth user for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TokenAuthUser

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
TokenAuthUser response = cloudRedisClusterClient.GetTokenAuthUser(name);

GetTokenAuthUserAsync(GetTokenAuthUserRequest, CallSettings)

public virtual Task<TokenAuthUser> GetTokenAuthUserAsync(GetTokenAuthUserRequest request, CallSettings callSettings = null)

Gets a specific token auth user for a basic auth enabled cluster.

Parameters
Name Description
request GetTokenAuthUserRequest

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
TaskTokenAuthUser

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetTokenAuthUserRequest request = new GetTokenAuthUserRequest
{
    TokenAuthUserName = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]"),
};
// Make the request
TokenAuthUser response = await cloudRedisClusterClient.GetTokenAuthUserAsync(request);

GetTokenAuthUserAsync(GetTokenAuthUserRequest, CancellationToken)

public virtual Task<TokenAuthUser> GetTokenAuthUserAsync(GetTokenAuthUserRequest request, CancellationToken cancellationToken)

Gets a specific token auth user for a basic auth enabled cluster.

Parameters
Name Description
request GetTokenAuthUserRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTokenAuthUser

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
GetTokenAuthUserRequest request = new GetTokenAuthUserRequest
{
    TokenAuthUserName = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]"),
};
// Make the request
TokenAuthUser response = await cloudRedisClusterClient.GetTokenAuthUserAsync(request);

GetTokenAuthUserAsync(TokenAuthUserName, CallSettings)

public virtual Task<TokenAuthUser> GetTokenAuthUserAsync(TokenAuthUserName name, CallSettings callSettings = null)

Gets a specific token auth user for a basic auth enabled cluster.

Parameters
Name Description
name TokenAuthUserName

Required. The name of token auth user for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTokenAuthUser

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
TokenAuthUserName name = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]");
// Make the request
TokenAuthUser response = await cloudRedisClusterClient.GetTokenAuthUserAsync(name);

GetTokenAuthUserAsync(TokenAuthUserName, CancellationToken)

public virtual Task<TokenAuthUser> GetTokenAuthUserAsync(TokenAuthUserName name, CancellationToken cancellationToken)

Gets a specific token auth user for a basic auth enabled cluster.

Parameters
Name Description
name TokenAuthUserName

Required. The name of token auth user for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTokenAuthUser

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
TokenAuthUserName name = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]");
// Make the request
TokenAuthUser response = await cloudRedisClusterClient.GetTokenAuthUserAsync(name);

GetTokenAuthUserAsync(string, CallSettings)

public virtual Task<TokenAuthUser> GetTokenAuthUserAsync(string name, CallSettings callSettings = null)

Gets a specific token auth user for a basic auth enabled cluster.

Parameters
Name Description
name string

Required. The name of token auth user for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTokenAuthUser

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
TokenAuthUser response = await cloudRedisClusterClient.GetTokenAuthUserAsync(name);

GetTokenAuthUserAsync(string, CancellationToken)

public virtual Task<TokenAuthUser> GetTokenAuthUserAsync(string name, CancellationToken cancellationToken)

Gets a specific token auth user for a basic auth enabled cluster.

Parameters
Name Description
name string

Required. The name of token auth user for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTokenAuthUser

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
TokenAuthUser response = await cloudRedisClusterClient.GetTokenAuthUserAsync(name);

ListAclPolicies(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListAclPoliciesResponse, AclPolicy> ListAclPolicies(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all ACL policies owned by a project in either the specified location (region) or all locations.

The location should have the following format:

  • projects/{project_id}/locations/{location_id}

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

Parameters
Name Description
parent LocationName

Required. The resource name of the ACL policy location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a Google Cloud region.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAclPoliciesResponseAclPolicy

A pageable sequence of AclPolicy resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListAclPoliciesResponse, AclPolicy> response = cloudRedisClusterClient.ListAclPolicies(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (AclPolicy item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAclPoliciesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AclPolicy item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AclPolicy> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AclPolicy item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAclPolicies(ListAclPoliciesRequest, CallSettings)

public virtual PagedEnumerable<ListAclPoliciesResponse, AclPolicy> ListAclPolicies(ListAclPoliciesRequest request, CallSettings callSettings = null)

Lists all ACL policies owned by a project in either the specified location (region) or all locations.

The location should have the following format:

  • projects/{project_id}/locations/{location_id}

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 ListAclPoliciesRequest

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
PagedEnumerableListAclPoliciesResponseAclPolicy

A pageable sequence of AclPolicy resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
ListAclPoliciesRequest request = new ListAclPoliciesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListAclPoliciesResponse, AclPolicy> response = cloudRedisClusterClient.ListAclPolicies(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (AclPolicy item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAclPoliciesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AclPolicy item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AclPolicy> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AclPolicy item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAclPolicies(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListAclPoliciesResponse, AclPolicy> ListAclPolicies(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all ACL policies owned by a project in either the specified location (region) or all locations.

The location should have the following format:

  • projects/{project_id}/locations/{location_id}

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

Parameters
Name Description
parent string

Required. The resource name of the ACL policy location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a Google Cloud region.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAclPoliciesResponseAclPolicy

A pageable sequence of AclPolicy resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListAclPoliciesResponse, AclPolicy> response = cloudRedisClusterClient.ListAclPolicies(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (AclPolicy item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAclPoliciesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AclPolicy item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AclPolicy> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AclPolicy item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAclPoliciesAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAclPoliciesResponse, AclPolicy> ListAclPoliciesAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all ACL policies owned by a project in either the specified location (region) or all locations.

The location should have the following format:

  • projects/{project_id}/locations/{location_id}

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

Parameters
Name Description
parent LocationName

Required. The resource name of the ACL policy location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a Google Cloud region.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAclPoliciesResponseAclPolicy

A pageable asynchronous sequence of AclPolicy resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListAclPoliciesResponse, AclPolicy> response = cloudRedisClusterClient.ListAclPoliciesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (AclPolicy item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAclPoliciesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AclPolicy item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AclPolicy> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AclPolicy item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAclPoliciesAsync(ListAclPoliciesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListAclPoliciesResponse, AclPolicy> ListAclPoliciesAsync(ListAclPoliciesRequest request, CallSettings callSettings = null)

Lists all ACL policies owned by a project in either the specified location (region) or all locations.

The location should have the following format:

  • projects/{project_id}/locations/{location_id}

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 ListAclPoliciesRequest

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
PagedAsyncEnumerableListAclPoliciesResponseAclPolicy

A pageable asynchronous sequence of AclPolicy resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ListAclPoliciesRequest request = new ListAclPoliciesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListAclPoliciesResponse, AclPolicy> response = cloudRedisClusterClient.ListAclPoliciesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (AclPolicy item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAclPoliciesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AclPolicy item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AclPolicy> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AclPolicy item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAclPoliciesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAclPoliciesResponse, AclPolicy> ListAclPoliciesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all ACL policies owned by a project in either the specified location (region) or all locations.

The location should have the following format:

  • projects/{project_id}/locations/{location_id}

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

Parameters
Name Description
parent string

Required. The resource name of the ACL policy location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a Google Cloud region.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAclPoliciesResponseAclPolicy

A pageable asynchronous sequence of AclPolicy resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListAclPoliciesResponse, AclPolicy> response = cloudRedisClusterClient.ListAclPoliciesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (AclPolicy item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAclPoliciesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AclPolicy item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AclPolicy> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AclPolicy item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAclPolicyRevisions(AclPolicyName, string, int?, CallSettings)

public virtual PagedEnumerable<ListAclPolicyRevisionsResponse, AclPolicyRevision> ListAclPolicyRevisions(AclPolicyName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all ACL policy revisions in a given ACL policy.

Parameters
Name Description
parent AclPolicyName

Required. The name of the ACL policy to list revisions for. Format: "projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAclPolicyRevisionsResponseAclPolicyRevision

A pageable sequence of AclPolicyRevision resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
AclPolicyName parent = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]");
// Make the request
PagedEnumerable<ListAclPolicyRevisionsResponse, AclPolicyRevision> response = cloudRedisClusterClient.ListAclPolicyRevisions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (AclPolicyRevision item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAclPolicyRevisionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AclPolicyRevision item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AclPolicyRevision> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AclPolicyRevision item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAclPolicyRevisions(ListAclPolicyRevisionsRequest, CallSettings)

public virtual PagedEnumerable<ListAclPolicyRevisionsResponse, AclPolicyRevision> ListAclPolicyRevisions(ListAclPolicyRevisionsRequest request, CallSettings callSettings = null)

Lists all ACL policy revisions in a given ACL policy.

Parameters
Name Description
request ListAclPolicyRevisionsRequest

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
PagedEnumerableListAclPolicyRevisionsResponseAclPolicyRevision

A pageable sequence of AclPolicyRevision resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
ListAclPolicyRevisionsRequest request = new ListAclPolicyRevisionsRequest
{
    ParentAsAclPolicyName = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]"),
};
// Make the request
PagedEnumerable<ListAclPolicyRevisionsResponse, AclPolicyRevision> response = cloudRedisClusterClient.ListAclPolicyRevisions(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (AclPolicyRevision item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAclPolicyRevisionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AclPolicyRevision item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AclPolicyRevision> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AclPolicyRevision item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAclPolicyRevisions(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListAclPolicyRevisionsResponse, AclPolicyRevision> ListAclPolicyRevisions(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all ACL policy revisions in a given ACL policy.

Parameters
Name Description
parent string

Required. The name of the ACL policy to list revisions for. Format: "projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAclPolicyRevisionsResponseAclPolicyRevision

A pageable sequence of AclPolicyRevision resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/aclPolicies/[ACL_POLICY]";
// Make the request
PagedEnumerable<ListAclPolicyRevisionsResponse, AclPolicyRevision> response = cloudRedisClusterClient.ListAclPolicyRevisions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (AclPolicyRevision item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAclPolicyRevisionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AclPolicyRevision item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AclPolicyRevision> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AclPolicyRevision item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAclPolicyRevisionsAsync(AclPolicyName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAclPolicyRevisionsResponse, AclPolicyRevision> ListAclPolicyRevisionsAsync(AclPolicyName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all ACL policy revisions in a given ACL policy.

Parameters
Name Description
parent AclPolicyName

Required. The name of the ACL policy to list revisions for. Format: "projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAclPolicyRevisionsResponseAclPolicyRevision

A pageable asynchronous sequence of AclPolicyRevision resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AclPolicyName parent = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]");
// Make the request
PagedAsyncEnumerable<ListAclPolicyRevisionsResponse, AclPolicyRevision> response = cloudRedisClusterClient.ListAclPolicyRevisionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (AclPolicyRevision item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAclPolicyRevisionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AclPolicyRevision item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AclPolicyRevision> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AclPolicyRevision item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAclPolicyRevisionsAsync(ListAclPolicyRevisionsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListAclPolicyRevisionsResponse, AclPolicyRevision> ListAclPolicyRevisionsAsync(ListAclPolicyRevisionsRequest request, CallSettings callSettings = null)

Lists all ACL policy revisions in a given ACL policy.

Parameters
Name Description
request ListAclPolicyRevisionsRequest

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
PagedAsyncEnumerableListAclPolicyRevisionsResponseAclPolicyRevision

A pageable asynchronous sequence of AclPolicyRevision resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ListAclPolicyRevisionsRequest request = new ListAclPolicyRevisionsRequest
{
    ParentAsAclPolicyName = AclPolicyName.FromProjectLocationAclPolicy("[PROJECT]", "[LOCATION]", "[ACL_POLICY]"),
};
// Make the request
PagedAsyncEnumerable<ListAclPolicyRevisionsResponse, AclPolicyRevision> response = cloudRedisClusterClient.ListAclPolicyRevisionsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (AclPolicyRevision item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAclPolicyRevisionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AclPolicyRevision item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AclPolicyRevision> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AclPolicyRevision item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAclPolicyRevisionsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAclPolicyRevisionsResponse, AclPolicyRevision> ListAclPolicyRevisionsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all ACL policy revisions in a given ACL policy.

Parameters
Name Description
parent string

Required. The name of the ACL policy to list revisions for. Format: "projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAclPolicyRevisionsResponseAclPolicyRevision

A pageable asynchronous sequence of AclPolicyRevision resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/aclPolicies/[ACL_POLICY]";
// Make the request
PagedAsyncEnumerable<ListAclPolicyRevisionsResponse, AclPolicyRevision> response = cloudRedisClusterClient.ListAclPolicyRevisionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (AclPolicyRevision item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAclPolicyRevisionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AclPolicyRevision item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AclPolicyRevision> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AclPolicyRevision item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAuthTokens(ListAuthTokensRequest, CallSettings)

public virtual PagedEnumerable<ListAuthTokensResponse, AuthToken> ListAuthTokens(ListAuthTokensRequest request, CallSettings callSettings = null)

Lists all the auth tokens for a specific token auth user.

Parameters
Name Description
request ListAuthTokensRequest

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
PagedEnumerableListAuthTokensResponseAuthToken

A pageable sequence of AuthToken resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
ListAuthTokensRequest request = new ListAuthTokensRequest
{
    ParentAsTokenAuthUserName = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListAuthTokensResponse, AuthToken> response = cloudRedisClusterClient.ListAuthTokens(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (AuthToken item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAuthTokensResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AuthToken item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AuthToken> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AuthToken item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAuthTokens(TokenAuthUserName, string, int?, CallSettings)

public virtual PagedEnumerable<ListAuthTokensResponse, AuthToken> ListAuthTokens(TokenAuthUserName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the auth tokens for a specific token auth user.

Parameters
Name Description
parent TokenAuthUserName

Required. The parent resource that this auth token will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAuthTokensResponseAuthToken

A pageable sequence of AuthToken resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
TokenAuthUserName parent = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]");
// Make the request
PagedEnumerable<ListAuthTokensResponse, AuthToken> response = cloudRedisClusterClient.ListAuthTokens(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (AuthToken item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAuthTokensResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AuthToken item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AuthToken> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AuthToken item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAuthTokens(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListAuthTokensResponse, AuthToken> ListAuthTokens(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the auth tokens for a specific token auth user.

Parameters
Name Description
parent string

Required. The parent resource that this auth token will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAuthTokensResponseAuthToken

A pageable sequence of AuthToken resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
PagedEnumerable<ListAuthTokensResponse, AuthToken> response = cloudRedisClusterClient.ListAuthTokens(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (AuthToken item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAuthTokensResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AuthToken item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AuthToken> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AuthToken item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAuthTokensAsync(ListAuthTokensRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListAuthTokensResponse, AuthToken> ListAuthTokensAsync(ListAuthTokensRequest request, CallSettings callSettings = null)

Lists all the auth tokens for a specific token auth user.

Parameters
Name Description
request ListAuthTokensRequest

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
PagedAsyncEnumerableListAuthTokensResponseAuthToken

A pageable asynchronous sequence of AuthToken resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ListAuthTokensRequest request = new ListAuthTokensRequest
{
    ParentAsTokenAuthUserName = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListAuthTokensResponse, AuthToken> response = cloudRedisClusterClient.ListAuthTokensAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (AuthToken item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAuthTokensResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AuthToken item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AuthToken> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AuthToken item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAuthTokensAsync(TokenAuthUserName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAuthTokensResponse, AuthToken> ListAuthTokensAsync(TokenAuthUserName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the auth tokens for a specific token auth user.

Parameters
Name Description
parent TokenAuthUserName

Required. The parent resource that this auth token will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAuthTokensResponseAuthToken

A pageable asynchronous sequence of AuthToken resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
TokenAuthUserName parent = TokenAuthUserName.FromProjectLocationClusterTokenAuthUser("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOKEN_AUTH_USER]");
// Make the request
PagedAsyncEnumerable<ListAuthTokensResponse, AuthToken> response = cloudRedisClusterClient.ListAuthTokensAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (AuthToken item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAuthTokensResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AuthToken item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AuthToken> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AuthToken item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAuthTokensAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAuthTokensResponse, AuthToken> ListAuthTokensAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the auth tokens for a specific token auth user.

Parameters
Name Description
parent string

Required. The parent resource that this auth token will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAuthTokensResponseAuthToken

A pageable asynchronous sequence of AuthToken resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
PagedAsyncEnumerable<ListAuthTokensResponse, AuthToken> response = cloudRedisClusterClient.ListAuthTokensAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (AuthToken item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListAuthTokensResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AuthToken item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AuthToken> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AuthToken item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupCollections(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListBackupCollectionsResponse, BackupCollection> ListBackupCollections(LocationName parent, string pageToken = null, int? pageSize = null, 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
parent LocationName

Required. The resource name of the backupCollection location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupCollectionsResponseBackupCollection

A pageable sequence of BackupCollection resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListBackupCollectionsResponse, BackupCollection> response = cloudRedisClusterClient.ListBackupCollections(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (BackupCollection item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupCollectionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (BackupCollection item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<BackupCollection> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (BackupCollection item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupCollections(ListBackupCollectionsRequest, CallSettings)

public virtual 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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
ListBackupCollectionsRequest request = new ListBackupCollectionsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListBackupCollectionsResponse, BackupCollection> response = cloudRedisClusterClient.ListBackupCollections(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (BackupCollection item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupCollectionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (BackupCollection item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<BackupCollection> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (BackupCollection item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupCollections(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListBackupCollectionsResponse, BackupCollection> ListBackupCollections(string parent, string pageToken = null, int? pageSize = null, 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
parent string

Required. The resource name of the backupCollection location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupCollectionsResponseBackupCollection

A pageable sequence of BackupCollection resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListBackupCollectionsResponse, BackupCollection> response = cloudRedisClusterClient.ListBackupCollections(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (BackupCollection item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupCollectionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (BackupCollection item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<BackupCollection> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (BackupCollection item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupCollectionsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupCollectionsResponse, BackupCollection> ListBackupCollectionsAsync(LocationName parent, string pageToken = null, int? pageSize = null, 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
parent LocationName

Required. The resource name of the backupCollection location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupCollectionsResponseBackupCollection

A pageable asynchronous sequence of BackupCollection resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListBackupCollectionsResponse, BackupCollection> response = cloudRedisClusterClient.ListBackupCollectionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (BackupCollection item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListBackupCollectionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (BackupCollection item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<BackupCollection> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (BackupCollection item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupCollectionsAsync(ListBackupCollectionsRequest, CallSettings)

public virtual 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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ListBackupCollectionsRequest request = new ListBackupCollectionsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListBackupCollectionsResponse, BackupCollection> response = cloudRedisClusterClient.ListBackupCollectionsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (BackupCollection item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListBackupCollectionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (BackupCollection item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<BackupCollection> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (BackupCollection item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupCollectionsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupCollectionsResponse, BackupCollection> ListBackupCollectionsAsync(string parent, string pageToken = null, int? pageSize = null, 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
parent string

Required. The resource name of the backupCollection location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupCollectionsResponseBackupCollection

A pageable asynchronous sequence of BackupCollection resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListBackupCollectionsResponse, BackupCollection> response = cloudRedisClusterClient.ListBackupCollectionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (BackupCollection item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListBackupCollectionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (BackupCollection item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<BackupCollection> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (BackupCollection item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackups(BackupCollectionName, string, int?, CallSettings)

public virtual PagedEnumerable<ListBackupsResponse, Backup> ListBackups(BackupCollectionName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all backups owned by a backup collection.

Parameters
Name Description
parent BackupCollectionName

Required. The resource name of the backupCollection using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupsResponseBackup

A pageable sequence of Backup resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
BackupCollectionName parent = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]");
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = cloudRedisClusterClient.ListBackups(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Backup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Backup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackups(ListBackupsRequest, CallSettings)

public virtual 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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
ListBackupsRequest request = new ListBackupsRequest
{
    ParentAsBackupCollectionName = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]"),
};
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = cloudRedisClusterClient.ListBackups(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Backup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Backup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackups(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListBackupsResponse, Backup> ListBackups(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all backups owned by a backup collection.

Parameters
Name Description
parent string

Required. The resource name of the backupCollection using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupsResponseBackup

A pageable sequence of Backup resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]";
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = cloudRedisClusterClient.ListBackups(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Backup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Backup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupsAsync(BackupCollectionName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(BackupCollectionName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all backups owned by a backup collection.

Parameters
Name Description
parent BackupCollectionName

Required. The resource name of the backupCollection using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupsResponseBackup

A pageable asynchronous sequence of Backup resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
BackupCollectionName parent = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]");
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = cloudRedisClusterClient.ListBackupsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Backup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListBackupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Backup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupsAsync(ListBackupsRequest, CallSettings)

public virtual 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.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ListBackupsRequest request = new ListBackupsRequest
{
    ParentAsBackupCollectionName = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]"),
};
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = cloudRedisClusterClient.ListBackupsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Backup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListBackupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Backup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all backups owned by a backup collection.

Parameters
Name Description
parent string

Required. The resource name of the backupCollection using the form: projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupsResponseBackup

A pageable asynchronous sequence of Backup resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]";
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = cloudRedisClusterClient.ListBackupsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Backup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListBackupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Backup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListClusters(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListClustersResponse, Cluster> ListClusters(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all Redis clusters owned by a project in either the specified location (region) or all locations.

The location should have the following format:

  • projects/{project_id}/locations/{location_id}

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

Parameters
Name Description
parent LocationName

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListClustersResponseCluster

A pageable sequence of Cluster resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListClustersResponse, Cluster> response = cloudRedisClusterClient.ListClusters(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Cluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Cluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Cluster> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Cluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListClusters(ListClustersRequest, CallSettings)

public virtual PagedEnumerable<ListClustersResponse, Cluster> ListClusters(ListClustersRequest request, CallSettings callSettings = null)

Lists all Redis clusters owned by a project in either the specified location (region) or all locations.

The location should have the following format:

  • projects/{project_id}/locations/{location_id}

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 ListClustersRequest

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
PagedEnumerableListClustersResponseCluster

A pageable sequence of Cluster resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
ListClustersRequest request = new ListClustersRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListClustersResponse, Cluster> response = cloudRedisClusterClient.ListClusters(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Cluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Cluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Cluster> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Cluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListClusters(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListClustersResponse, Cluster> ListClusters(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all Redis clusters owned by a project in either the specified location (region) or all locations.

The location should have the following format:

  • projects/{project_id}/locations/{location_id}

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

Parameters
Name Description
parent string

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListClustersResponseCluster

A pageable sequence of Cluster resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListClustersResponse, Cluster> response = cloudRedisClusterClient.ListClusters(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Cluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Cluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Cluster> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Cluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListClustersAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListClustersResponse, Cluster> ListClustersAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all Redis clusters owned by a project in either the specified location (region) or all locations.

The location should have the following format:

  • projects/{project_id}/locations/{location_id}

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

Parameters
Name Description
parent LocationName

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListClustersResponseCluster

A pageable asynchronous sequence of Cluster resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListClustersResponse, Cluster> response = cloudRedisClusterClient.ListClustersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Cluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Cluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Cluster> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Cluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListClustersAsync(ListClustersRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListClustersResponse, Cluster> ListClustersAsync(ListClustersRequest request, CallSettings callSettings = null)

Lists all Redis clusters owned by a project in either the specified location (region) or all locations.

The location should have the following format:

  • projects/{project_id}/locations/{location_id}

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 ListClustersRequest

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
PagedAsyncEnumerableListClustersResponseCluster

A pageable asynchronous sequence of Cluster resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ListClustersRequest request = new ListClustersRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListClustersResponse, Cluster> response = cloudRedisClusterClient.ListClustersAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Cluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Cluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Cluster> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Cluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListClustersAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListClustersResponse, Cluster> ListClustersAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all Redis clusters owned by a project in either the specified location (region) or all locations.

The location should have the following format:

  • projects/{project_id}/locations/{location_id}

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

Parameters
Name Description
parent string

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListClustersResponseCluster

A pageable asynchronous sequence of Cluster resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListClustersResponse, Cluster> response = cloudRedisClusterClient.ListClustersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Cluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Cluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Cluster> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Cluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTokenAuthUsers(ClusterName, string, int?, CallSettings)

public virtual PagedEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> ListTokenAuthUsers(ClusterName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the token auth users for a token based auth enabled cluster.

Parameters
Name Description
parent ClusterName

Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListTokenAuthUsersResponseTokenAuthUser

A pageable sequence of TokenAuthUser resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
PagedEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> response = cloudRedisClusterClient.ListTokenAuthUsers(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TokenAuthUser item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTokenAuthUsersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TokenAuthUser item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TokenAuthUser> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TokenAuthUser item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTokenAuthUsers(ListTokenAuthUsersRequest, CallSettings)

public virtual PagedEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> ListTokenAuthUsers(ListTokenAuthUsersRequest request, CallSettings callSettings = null)

Lists all the token auth users for a token based auth enabled cluster.

Parameters
Name Description
request ListTokenAuthUsersRequest

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
PagedEnumerableListTokenAuthUsersResponseTokenAuthUser

A pageable sequence of TokenAuthUser resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
ListTokenAuthUsersRequest request = new ListTokenAuthUsersRequest
{
    ParentAsClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> response = cloudRedisClusterClient.ListTokenAuthUsers(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (TokenAuthUser item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTokenAuthUsersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TokenAuthUser item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TokenAuthUser> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TokenAuthUser item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTokenAuthUsers(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> ListTokenAuthUsers(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the token auth users for a token based auth enabled cluster.

Parameters
Name Description
parent string

Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListTokenAuthUsersResponseTokenAuthUser

A pageable sequence of TokenAuthUser resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
PagedEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> response = cloudRedisClusterClient.ListTokenAuthUsers(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TokenAuthUser item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTokenAuthUsersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TokenAuthUser item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TokenAuthUser> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TokenAuthUser item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTokenAuthUsersAsync(ClusterName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> ListTokenAuthUsersAsync(ClusterName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the token auth users for a token based auth enabled cluster.

Parameters
Name Description
parent ClusterName

Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListTokenAuthUsersResponseTokenAuthUser

A pageable asynchronous sequence of TokenAuthUser resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
PagedAsyncEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> response = cloudRedisClusterClient.ListTokenAuthUsersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (TokenAuthUser item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListTokenAuthUsersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TokenAuthUser item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TokenAuthUser> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TokenAuthUser item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTokenAuthUsersAsync(ListTokenAuthUsersRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> ListTokenAuthUsersAsync(ListTokenAuthUsersRequest request, CallSettings callSettings = null)

Lists all the token auth users for a token based auth enabled cluster.

Parameters
Name Description
request ListTokenAuthUsersRequest

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
PagedAsyncEnumerableListTokenAuthUsersResponseTokenAuthUser

A pageable asynchronous sequence of TokenAuthUser resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ListTokenAuthUsersRequest request = new ListTokenAuthUsersRequest
{
    ParentAsClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> response = cloudRedisClusterClient.ListTokenAuthUsersAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (TokenAuthUser item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListTokenAuthUsersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TokenAuthUser item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TokenAuthUser> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TokenAuthUser item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTokenAuthUsersAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> ListTokenAuthUsersAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the token auth users for a token based auth enabled cluster.

Parameters
Name Description
parent string

Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListTokenAuthUsersResponseTokenAuthUser

A pageable asynchronous sequence of TokenAuthUser resources.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
PagedAsyncEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> response = cloudRedisClusterClient.ListTokenAuthUsersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (TokenAuthUser item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListTokenAuthUsersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TokenAuthUser item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TokenAuthUser> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TokenAuthUser item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceAddAuthToken(string, CallSettings)

public virtual Operation<TokenAuthUser, OperationMetadata> PollOnceAddAuthToken(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of AddAuthToken.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationTokenAuthUserOperationMetadata

The result of polling the operation.

PollOnceAddAuthTokenAsync(string, CallSettings)

public virtual Task<Operation<TokenAuthUser, OperationMetadata>> PollOnceAddAuthTokenAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of AddAuthToken.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationTokenAuthUserOperationMetadata

A task representing the result of polling the operation.

PollOnceAddTokenAuthUser(string, CallSettings)

public virtual Operation<Cluster, OperationMetadata> PollOnceAddTokenAuthUser(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of AddTokenAuthUser.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationClusterOperationMetadata

The result of polling the operation.

PollOnceAddTokenAuthUserAsync(string, CallSettings)

public virtual Task<Operation<Cluster, OperationMetadata>> PollOnceAddTokenAuthUserAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of AddTokenAuthUser.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationClusterOperationMetadata

A task representing the result of polling the operation.

PollOnceBackupCluster(string, CallSettings)

public virtual Operation<Cluster, Any> PollOnceBackupCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of BackupCluster.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationClusterAny

The result of polling the operation.

PollOnceBackupClusterAsync(string, CallSettings)

public virtual Task<Operation<Cluster, Any>> PollOnceBackupClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of BackupCluster.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationClusterAny

A task representing the result of polling the operation.

PollOnceCreateCluster(string, CallSettings)

public virtual Operation<Cluster, Any> PollOnceCreateCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateCluster.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationClusterAny

The result of polling the operation.

PollOnceCreateClusterAsync(string, CallSettings)

public virtual Task<Operation<Cluster, Any>> PollOnceCreateClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateCluster.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationClusterAny

A task representing the result of polling the operation.

PollOnceDeleteAclPolicy(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteAclPolicy(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteAclPolicy.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteAclPolicyAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteAclPolicyAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteAclPolicy.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteAuthToken(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteAuthToken(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteAuthToken.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteAuthTokenAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteAuthTokenAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteAuthToken.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteBackup(string, CallSettings)

public virtual Operation<Empty, Any> PollOnceDeleteBackup(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteBackup.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyAny

The result of polling the operation.

PollOnceDeleteBackupAsync(string, CallSettings)

public virtual Task<Operation<Empty, Any>> PollOnceDeleteBackupAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteBackup.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyAny

A task representing the result of polling the operation.

PollOnceDeleteCluster(string, CallSettings)

public virtual Operation<Empty, Any> PollOnceDeleteCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteCluster.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyAny

The result of polling the operation.

PollOnceDeleteClusterAsync(string, CallSettings)

public virtual Task<Operation<Empty, Any>> PollOnceDeleteClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteCluster.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyAny

A task representing the result of polling the operation.

PollOnceDeleteTokenAuthUser(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteTokenAuthUser(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteTokenAuthUser .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteTokenAuthUserAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteTokenAuthUserAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteTokenAuthUser.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceExportBackup(string, CallSettings)

public virtual Operation<Backup, Any> PollOnceExportBackup(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ExportBackup.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupAny

The result of polling the operation.

PollOnceExportBackupAsync(string, CallSettings)

public virtual Task<Operation<Backup, Any>> PollOnceExportBackupAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ExportBackup.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupAny

A task representing the result of polling the operation.

PollOnceRescheduleClusterMaintenance(string, CallSettings)

public virtual Operation<Cluster, Any> PollOnceRescheduleClusterMaintenance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of RescheduleClusterMaintenance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationClusterAny

The result of polling the operation.

PollOnceRescheduleClusterMaintenanceAsync(string, CallSettings)

public virtual Task<Operation<Cluster, Any>> PollOnceRescheduleClusterMaintenanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of RescheduleClusterMaintenance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationClusterAny

A task representing the result of polling the operation.

PollOnceUpdateAclPolicy(string, CallSettings)

public virtual Operation<AclPolicy, OperationMetadata> PollOnceUpdateAclPolicy(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateAclPolicy.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAclPolicyOperationMetadata

The result of polling the operation.

PollOnceUpdateAclPolicyAsync(string, CallSettings)

public virtual Task<Operation<AclPolicy, OperationMetadata>> PollOnceUpdateAclPolicyAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateAclPolicy.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAclPolicyOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateCluster(string, CallSettings)

public virtual Operation<Cluster, Any> PollOnceUpdateCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateCluster.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationClusterAny

The result of polling the operation.

PollOnceUpdateClusterAsync(string, CallSettings)

public virtual Task<Operation<Cluster, Any>> PollOnceUpdateClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateCluster.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationClusterAny

A task representing the result of polling the operation.

RescheduleClusterMaintenance(ClusterName, RescheduleType, Timestamp, CallSettings)

public virtual Operation<Cluster, Any> RescheduleClusterMaintenance(ClusterName name, RescheduleClusterMaintenanceRequest.Types.RescheduleType rescheduleType, Timestamp scheduleTime, CallSettings callSettings = null)

Reschedules upcoming maintenance event.

Parameters
Name Description
name ClusterName

Required. Redis Cluster instance resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

rescheduleType RescheduleClusterMaintenanceRequestTypesRescheduleType

Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.

scheduleTime Timestamp

Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationClusterAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
RescheduleClusterMaintenanceRequest.Types.RescheduleType rescheduleType = RescheduleClusterMaintenanceRequest.Types.RescheduleType.Unspecified;
Timestamp scheduleTime = new Timestamp();
// Make the request
Operation<Cluster, Any> response = cloudRedisClusterClient.RescheduleClusterMaintenance(name, rescheduleType, scheduleTime);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = cloudRedisClusterClient.PollOnceRescheduleClusterMaintenance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

RescheduleClusterMaintenance(RescheduleClusterMaintenanceRequest, CallSettings)

public virtual Operation<Cluster, Any> RescheduleClusterMaintenance(RescheduleClusterMaintenanceRequest request, CallSettings callSettings = null)

Reschedules upcoming maintenance event.

Parameters
Name Description
request RescheduleClusterMaintenanceRequest

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
OperationClusterAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
RescheduleClusterMaintenanceRequest request = new RescheduleClusterMaintenanceRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    RescheduleType = RescheduleClusterMaintenanceRequest.Types.RescheduleType.Unspecified,
    ScheduleTime = new Timestamp(),
};
// Make the request
Operation<Cluster, Any> response = cloudRedisClusterClient.RescheduleClusterMaintenance(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = cloudRedisClusterClient.PollOnceRescheduleClusterMaintenance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

RescheduleClusterMaintenance(string, RescheduleType, Timestamp, CallSettings)

public virtual Operation<Cluster, Any> RescheduleClusterMaintenance(string name, RescheduleClusterMaintenanceRequest.Types.RescheduleType rescheduleType, Timestamp scheduleTime, CallSettings callSettings = null)

Reschedules upcoming maintenance event.

Parameters
Name Description
name string

Required. Redis Cluster instance resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

rescheduleType RescheduleClusterMaintenanceRequestTypesRescheduleType

Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.

scheduleTime Timestamp

Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationClusterAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
RescheduleClusterMaintenanceRequest.Types.RescheduleType rescheduleType = RescheduleClusterMaintenanceRequest.Types.RescheduleType.Unspecified;
Timestamp scheduleTime = new Timestamp();
// Make the request
Operation<Cluster, Any> response = cloudRedisClusterClient.RescheduleClusterMaintenance(name, rescheduleType, scheduleTime);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = cloudRedisClusterClient.PollOnceRescheduleClusterMaintenance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

RescheduleClusterMaintenanceAsync(ClusterName, RescheduleType, Timestamp, CallSettings)

public virtual Task<Operation<Cluster, Any>> RescheduleClusterMaintenanceAsync(ClusterName name, RescheduleClusterMaintenanceRequest.Types.RescheduleType rescheduleType, Timestamp scheduleTime, CallSettings callSettings = null)

Reschedules upcoming maintenance event.

Parameters
Name Description
name ClusterName

Required. Redis Cluster instance resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

rescheduleType RescheduleClusterMaintenanceRequestTypesRescheduleType

Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.

scheduleTime Timestamp

Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
RescheduleClusterMaintenanceRequest.Types.RescheduleType rescheduleType = RescheduleClusterMaintenanceRequest.Types.RescheduleType.Unspecified;
Timestamp scheduleTime = new Timestamp();
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.RescheduleClusterMaintenanceAsync(name, rescheduleType, scheduleTime);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceRescheduleClusterMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

RescheduleClusterMaintenanceAsync(ClusterName, RescheduleType, Timestamp, CancellationToken)

public virtual Task<Operation<Cluster, Any>> RescheduleClusterMaintenanceAsync(ClusterName name, RescheduleClusterMaintenanceRequest.Types.RescheduleType rescheduleType, Timestamp scheduleTime, CancellationToken cancellationToken)

Reschedules upcoming maintenance event.

Parameters
Name Description
name ClusterName

Required. Redis Cluster instance resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

rescheduleType RescheduleClusterMaintenanceRequestTypesRescheduleType

Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.

scheduleTime Timestamp

Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
RescheduleClusterMaintenanceRequest.Types.RescheduleType rescheduleType = RescheduleClusterMaintenanceRequest.Types.RescheduleType.Unspecified;
Timestamp scheduleTime = new Timestamp();
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.RescheduleClusterMaintenanceAsync(name, rescheduleType, scheduleTime);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceRescheduleClusterMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

RescheduleClusterMaintenanceAsync(RescheduleClusterMaintenanceRequest, CallSettings)

public virtual Task<Operation<Cluster, Any>> RescheduleClusterMaintenanceAsync(RescheduleClusterMaintenanceRequest request, CallSettings callSettings = null)

Reschedules upcoming maintenance event.

Parameters
Name Description
request RescheduleClusterMaintenanceRequest

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
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
RescheduleClusterMaintenanceRequest request = new RescheduleClusterMaintenanceRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    RescheduleType = RescheduleClusterMaintenanceRequest.Types.RescheduleType.Unspecified,
    ScheduleTime = new Timestamp(),
};
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.RescheduleClusterMaintenanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceRescheduleClusterMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

RescheduleClusterMaintenanceAsync(RescheduleClusterMaintenanceRequest, CancellationToken)

public virtual Task<Operation<Cluster, Any>> RescheduleClusterMaintenanceAsync(RescheduleClusterMaintenanceRequest request, CancellationToken cancellationToken)

Reschedules upcoming maintenance event.

Parameters
Name Description
request RescheduleClusterMaintenanceRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
RescheduleClusterMaintenanceRequest request = new RescheduleClusterMaintenanceRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    RescheduleType = RescheduleClusterMaintenanceRequest.Types.RescheduleType.Unspecified,
    ScheduleTime = new Timestamp(),
};
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.RescheduleClusterMaintenanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceRescheduleClusterMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

RescheduleClusterMaintenanceAsync(string, RescheduleType, Timestamp, CallSettings)

public virtual Task<Operation<Cluster, Any>> RescheduleClusterMaintenanceAsync(string name, RescheduleClusterMaintenanceRequest.Types.RescheduleType rescheduleType, Timestamp scheduleTime, CallSettings callSettings = null)

Reschedules upcoming maintenance event.

Parameters
Name Description
name string

Required. Redis Cluster instance resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

rescheduleType RescheduleClusterMaintenanceRequestTypesRescheduleType

Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.

scheduleTime Timestamp

Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
RescheduleClusterMaintenanceRequest.Types.RescheduleType rescheduleType = RescheduleClusterMaintenanceRequest.Types.RescheduleType.Unspecified;
Timestamp scheduleTime = new Timestamp();
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.RescheduleClusterMaintenanceAsync(name, rescheduleType, scheduleTime);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceRescheduleClusterMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

RescheduleClusterMaintenanceAsync(string, RescheduleType, Timestamp, CancellationToken)

public virtual Task<Operation<Cluster, Any>> RescheduleClusterMaintenanceAsync(string name, RescheduleClusterMaintenanceRequest.Types.RescheduleType rescheduleType, Timestamp scheduleTime, CancellationToken cancellationToken)

Reschedules upcoming maintenance event.

Parameters
Name Description
name string

Required. Redis Cluster instance resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

rescheduleType RescheduleClusterMaintenanceRequestTypesRescheduleType

Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.

scheduleTime Timestamp

Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
RescheduleClusterMaintenanceRequest.Types.RescheduleType rescheduleType = RescheduleClusterMaintenanceRequest.Types.RescheduleType.Unspecified;
Timestamp scheduleTime = new Timestamp();
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.RescheduleClusterMaintenanceAsync(name, rescheduleType, scheduleTime);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceRescheduleClusterMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateAclPolicy(AclPolicy, FieldMask, CallSettings)

public virtual Operation<AclPolicy, OperationMetadata> UpdateAclPolicy(AclPolicy aclPolicy, FieldMask updateMask, CallSettings callSettings = null)

Updates the ACL policy.

The operation applies the updated ACL policy to all of the linked clusters. If Memorystore can apply the policy to all clusters, then the operation returns a SUCCESS status. If Memorystore can't apply the policy to all clusters, then to ensure eventual consistency, Memorystore uses reconciliation to apply the policy to the failed clusters.

Completed longrunning.Operation will contain the new ACL policy object in the response field.

Parameters
Name Description
aclPolicy AclPolicy

Required. The ACL policy to be updated.

updateMask FieldMask

Optional. Mask of fields to be updated. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from AclPolicy:

  • rules
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAclPolicyOperationMetadata

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
AclPolicy aclPolicy = new AclPolicy();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AclPolicy, OperationMetadata> response = cloudRedisClusterClient.UpdateAclPolicy(aclPolicy, updateMask);

// Poll until the returned long-running operation is complete
Operation<AclPolicy, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AclPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AclPolicy, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceUpdateAclPolicy(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AclPolicy retrievedResult = retrievedResponse.Result;
}

UpdateAclPolicy(UpdateAclPolicyRequest, CallSettings)

public virtual Operation<AclPolicy, OperationMetadata> UpdateAclPolicy(UpdateAclPolicyRequest request, CallSettings callSettings = null)

Updates the ACL policy.

The operation applies the updated ACL policy to all of the linked clusters. If Memorystore can apply the policy to all clusters, then the operation returns a SUCCESS status. If Memorystore can't apply the policy to all clusters, then to ensure eventual consistency, Memorystore uses reconciliation to apply the policy to the failed clusters.

Completed longrunning.Operation will contain the new ACL policy object in the response field.

Parameters
Name Description
request UpdateAclPolicyRequest

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
OperationAclPolicyOperationMetadata

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
UpdateAclPolicyRequest request = new UpdateAclPolicyRequest
{
    AclPolicy = new AclPolicy(),
    UpdateMask = new FieldMask(),
    RequestId = "",
};
// Make the request
Operation<AclPolicy, OperationMetadata> response = cloudRedisClusterClient.UpdateAclPolicy(request);

// Poll until the returned long-running operation is complete
Operation<AclPolicy, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AclPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AclPolicy, OperationMetadata> retrievedResponse = cloudRedisClusterClient.PollOnceUpdateAclPolicy(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AclPolicy retrievedResult = retrievedResponse.Result;
}

UpdateAclPolicyAsync(AclPolicy, FieldMask, CallSettings)

public virtual Task<Operation<AclPolicy, OperationMetadata>> UpdateAclPolicyAsync(AclPolicy aclPolicy, FieldMask updateMask, CallSettings callSettings = null)

Updates the ACL policy.

The operation applies the updated ACL policy to all of the linked clusters. If Memorystore can apply the policy to all clusters, then the operation returns a SUCCESS status. If Memorystore can't apply the policy to all clusters, then to ensure eventual consistency, Memorystore uses reconciliation to apply the policy to the failed clusters.

Completed longrunning.Operation will contain the new ACL policy object in the response field.

Parameters
Name Description
aclPolicy AclPolicy

Required. The ACL policy to be updated.

updateMask FieldMask

Optional. Mask of fields to be updated. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from AclPolicy:

  • rules
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAclPolicyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AclPolicy aclPolicy = new AclPolicy();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AclPolicy, OperationMetadata> response = await cloudRedisClusterClient.UpdateAclPolicyAsync(aclPolicy, updateMask);

// Poll until the returned long-running operation is complete
Operation<AclPolicy, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AclPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AclPolicy, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceUpdateAclPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AclPolicy retrievedResult = retrievedResponse.Result;
}

UpdateAclPolicyAsync(AclPolicy, FieldMask, CancellationToken)

public virtual Task<Operation<AclPolicy, OperationMetadata>> UpdateAclPolicyAsync(AclPolicy aclPolicy, FieldMask updateMask, CancellationToken cancellationToken)

Updates the ACL policy.

The operation applies the updated ACL policy to all of the linked clusters. If Memorystore can apply the policy to all clusters, then the operation returns a SUCCESS status. If Memorystore can't apply the policy to all clusters, then to ensure eventual consistency, Memorystore uses reconciliation to apply the policy to the failed clusters.

Completed longrunning.Operation will contain the new ACL policy object in the response field.

Parameters
Name Description
aclPolicy AclPolicy

Required. The ACL policy to be updated.

updateMask FieldMask

Optional. Mask of fields to be updated. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from AclPolicy:

  • rules
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAclPolicyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
AclPolicy aclPolicy = new AclPolicy();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AclPolicy, OperationMetadata> response = await cloudRedisClusterClient.UpdateAclPolicyAsync(aclPolicy, updateMask);

// Poll until the returned long-running operation is complete
Operation<AclPolicy, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AclPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AclPolicy, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceUpdateAclPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AclPolicy retrievedResult = retrievedResponse.Result;
}

UpdateAclPolicyAsync(UpdateAclPolicyRequest, CallSettings)

public virtual Task<Operation<AclPolicy, OperationMetadata>> UpdateAclPolicyAsync(UpdateAclPolicyRequest request, CallSettings callSettings = null)

Updates the ACL policy.

The operation applies the updated ACL policy to all of the linked clusters. If Memorystore can apply the policy to all clusters, then the operation returns a SUCCESS status. If Memorystore can't apply the policy to all clusters, then to ensure eventual consistency, Memorystore uses reconciliation to apply the policy to the failed clusters.

Completed longrunning.Operation will contain the new ACL policy object in the response field.

Parameters
Name Description
request UpdateAclPolicyRequest

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
TaskOperationAclPolicyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
UpdateAclPolicyRequest request = new UpdateAclPolicyRequest
{
    AclPolicy = new AclPolicy(),
    UpdateMask = new FieldMask(),
    RequestId = "",
};
// Make the request
Operation<AclPolicy, OperationMetadata> response = await cloudRedisClusterClient.UpdateAclPolicyAsync(request);

// Poll until the returned long-running operation is complete
Operation<AclPolicy, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AclPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AclPolicy, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceUpdateAclPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AclPolicy retrievedResult = retrievedResponse.Result;
}

UpdateAclPolicyAsync(UpdateAclPolicyRequest, CancellationToken)

public virtual Task<Operation<AclPolicy, OperationMetadata>> UpdateAclPolicyAsync(UpdateAclPolicyRequest request, CancellationToken cancellationToken)

Updates the ACL policy.

The operation applies the updated ACL policy to all of the linked clusters. If Memorystore can apply the policy to all clusters, then the operation returns a SUCCESS status. If Memorystore can't apply the policy to all clusters, then to ensure eventual consistency, Memorystore uses reconciliation to apply the policy to the failed clusters.

Completed longrunning.Operation will contain the new ACL policy object in the response field.

Parameters
Name Description
request UpdateAclPolicyRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAclPolicyOperationMetadata

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
UpdateAclPolicyRequest request = new UpdateAclPolicyRequest
{
    AclPolicy = new AclPolicy(),
    UpdateMask = new FieldMask(),
    RequestId = "",
};
// Make the request
Operation<AclPolicy, OperationMetadata> response = await cloudRedisClusterClient.UpdateAclPolicyAsync(request);

// Poll until the returned long-running operation is complete
Operation<AclPolicy, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AclPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AclPolicy, OperationMetadata> retrievedResponse = await cloudRedisClusterClient.PollOnceUpdateAclPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AclPolicy retrievedResult = retrievedResponse.Result;
}

UpdateCluster(Cluster, FieldMask, CallSettings)

public virtual Operation<Cluster, Any> UpdateCluster(Cluster cluster, FieldMask updateMask, CallSettings callSettings = null)

Updates the metadata and configuration of a specific Redis cluster.

Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
cluster Cluster

Required. Update description. Only fields specified in update_mask are updated.

updateMask FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [Cluster][google.cloud.redis.cluster.v1.Cluster]:

  • size_gb
  • replica_count
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationClusterAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
Cluster cluster = new Cluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Cluster, Any> response = cloudRedisClusterClient.UpdateCluster(cluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = cloudRedisClusterClient.PollOnceUpdateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

UpdateCluster(UpdateClusterRequest, CallSettings)

public virtual Operation<Cluster, Any> UpdateCluster(UpdateClusterRequest request, CallSettings callSettings = null)

Updates the metadata and configuration of a specific Redis cluster.

Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
request UpdateClusterRequest

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
OperationClusterAny

The RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = CloudRedisClusterClient.Create();
// Initialize request argument(s)
UpdateClusterRequest request = new UpdateClusterRequest
{
    UpdateMask = new FieldMask(),
    Cluster = new Cluster(),
    RequestId = "",
};
// Make the request
Operation<Cluster, Any> response = cloudRedisClusterClient.UpdateCluster(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = cloudRedisClusterClient.PollOnceUpdateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

UpdateClusterAsync(Cluster, FieldMask, CallSettings)

public virtual Task<Operation<Cluster, Any>> UpdateClusterAsync(Cluster cluster, FieldMask updateMask, CallSettings callSettings = null)

Updates the metadata and configuration of a specific Redis cluster.

Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
cluster Cluster

Required. Update description. Only fields specified in update_mask are updated.

updateMask FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [Cluster][google.cloud.redis.cluster.v1.Cluster]:

  • size_gb
  • replica_count
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
Cluster cluster = new Cluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.UpdateClusterAsync(cluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceUpdateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

UpdateClusterAsync(Cluster, FieldMask, CancellationToken)

public virtual Task<Operation<Cluster, Any>> UpdateClusterAsync(Cluster cluster, FieldMask updateMask, CancellationToken cancellationToken)

Updates the metadata and configuration of a specific Redis cluster.

Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
cluster Cluster

Required. Update description. Only fields specified in update_mask are updated.

updateMask FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [Cluster][google.cloud.redis.cluster.v1.Cluster]:

  • size_gb
  • replica_count
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
Cluster cluster = new Cluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.UpdateClusterAsync(cluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceUpdateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

UpdateClusterAsync(UpdateClusterRequest, CallSettings)

public virtual Task<Operation<Cluster, Any>> UpdateClusterAsync(UpdateClusterRequest request, CallSettings callSettings = null)

Updates the metadata and configuration of a specific Redis cluster.

Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
request UpdateClusterRequest

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
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
UpdateClusterRequest request = new UpdateClusterRequest
{
    UpdateMask = new FieldMask(),
    Cluster = new Cluster(),
    RequestId = "",
};
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.UpdateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceUpdateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

UpdateClusterAsync(UpdateClusterRequest, CancellationToken)

public virtual Task<Operation<Cluster, Any>> UpdateClusterAsync(UpdateClusterRequest request, CancellationToken cancellationToken)

Updates the metadata and configuration of a specific Redis cluster.

Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name Description
request UpdateClusterRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationClusterAny

A Task containing the RPC response.

Example
// Create client
CloudRedisClusterClient cloudRedisClusterClient = await CloudRedisClusterClient.CreateAsync();
// Initialize request argument(s)
UpdateClusterRequest request = new UpdateClusterRequest
{
    UpdateMask = new FieldMask(),
    Cluster = new Cluster(),
    RequestId = "",
};
// Make the request
Operation<Cluster, Any> response = await cloudRedisClusterClient.UpdateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, Any> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, Any> retrievedResponse = await cloudRedisClusterClient.PollOnceUpdateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}