public abstract class MemorystoreClientReference documentation and code samples for the Memorystore v1 API class MemorystoreClient.
Memorystore client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Memorystore.V1Assembly
Google.Cloud.Memorystore.V1.dll
Remarks
Service describing handlers for resources
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 |
|
BackupInstanceOperationsClient
public virtual OperationsClient BackupInstanceOperationsClient { get; }The long-running operations client for BackupInstance.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
CreateInstanceOperationsClient
public virtual OperationsClient CreateInstanceOperationsClient { get; }The long-running operations client for CreateInstance.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
DefaultEndpoint
public static string DefaultEndpoint { get; }The default endpoint for the Memorystore service, which is a host of "memorystore.googleapis.com" and a port of 443.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }The default Memorystore scopes.
| Property Value | |
|---|---|
| Type | Description |
IReadOnlyListstring |
|
The default Memorystore scopes are:
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 |
|
DeleteInstanceOperationsClient
public virtual OperationsClient DeleteInstanceOperationsClient { get; }The long-running operations client for DeleteInstance.
| 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 |
|
FinishMigrationOperationsClient
public virtual OperationsClient FinishMigrationOperationsClient { get; }The long-running operations client for FinishMigration.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
GrpcClient
public virtual Memorystore.MemorystoreClient GrpcClient { get; }The underlying gRPC Memorystore client
| Property Value | |
|---|---|
| Type | Description |
MemorystoreMemorystoreClient |
|
LocationsClient
public virtual LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient |
|
RescheduleMaintenanceOperationsClient
public virtual OperationsClient RescheduleMaintenanceOperationsClient { get; }The long-running operations client for RescheduleMaintenance.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }The service metadata associated with this client type.
| Property Value | |
|---|---|
| Type | Description |
ServiceMetadata |
|
StartMigrationOperationsClient
public virtual OperationsClient StartMigrationOperationsClient { get; }The long-running operations client for StartMigration.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
UpdateInstanceOperationsClient
public virtual OperationsClient UpdateInstanceOperationsClient { get; }The long-running operations client for UpdateInstance.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
Methods
AddAuthToken(AddAuthTokenRequest, CallSettings)
public virtual Operation<TokenAuthUser, OperationMetadata> AddAuthToken(AddAuthTokenRequest request, CallSettings callSettings = null)Adds a token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
AddAuthTokenRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTokenAuthUserOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
AddAuthTokenRequest request = new AddAuthTokenRequest
{
TokenAuthUserAsTokenAuthUserName = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]"),
AuthToken = new AuthToken(),
};
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = memorystoreClient.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 = memorystoreClient.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 token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
tokenAuthUser |
TokenAuthUserNameRequired. The name of the token auth user resource that this token will be added for. |
authToken |
AuthTokenRequired. The auth token to add. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTokenAuthUserOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
TokenAuthUserName tokenAuthUser = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]");
AuthToken authToken = new AuthToken();
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = memorystoreClient.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 = memorystoreClient.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 token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
tokenAuthUser |
stringRequired. The name of the token auth user resource that this token will be added for. |
authToken |
AuthTokenRequired. The auth token to add. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTokenAuthUserOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string tokenAuthUser = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]";
AuthToken authToken = new AuthToken();
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = memorystoreClient.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 = memorystoreClient.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 token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
AddAuthTokenRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTokenAuthUserOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
AddAuthTokenRequest request = new AddAuthTokenRequest
{
TokenAuthUserAsTokenAuthUserName = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]"),
AuthToken = new AuthToken(),
};
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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 token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
AddAuthTokenRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTokenAuthUserOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
AddAuthTokenRequest request = new AddAuthTokenRequest
{
TokenAuthUserAsTokenAuthUserName = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]"),
AuthToken = new AuthToken(),
};
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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 token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
tokenAuthUser |
TokenAuthUserNameRequired. The name of the token auth user resource that this token will be added for. |
authToken |
AuthTokenRequired. The auth token to add. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTokenAuthUserOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
TokenAuthUserName tokenAuthUser = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]");
AuthToken authToken = new AuthToken();
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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 token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
tokenAuthUser |
TokenAuthUserNameRequired. The name of the token auth user resource that this token will be added for. |
authToken |
AuthTokenRequired. The auth token to add. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTokenAuthUserOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
TokenAuthUserName tokenAuthUser = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]");
AuthToken authToken = new AuthToken();
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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 token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
tokenAuthUser |
stringRequired. The name of the token auth user resource that this token will be added for. |
authToken |
AuthTokenRequired. The auth token to add. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTokenAuthUserOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string tokenAuthUser = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]";
AuthToken authToken = new AuthToken();
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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 token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
tokenAuthUser |
stringRequired. The name of the token auth user resource that this token will be added for. |
authToken |
AuthTokenRequired. The auth token to add. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTokenAuthUserOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string tokenAuthUser = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]";
AuthToken authToken = new AuthToken();
// Make the request
Operation<TokenAuthUser, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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<Instance, OperationMetadata> AddTokenAuthUser(AddTokenAuthUserRequest request, CallSettings callSettings = null)Adds a token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
AddTokenAuthUserRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
AddTokenAuthUserRequest request = new AddTokenAuthUserRequest
{
InstanceAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
TokenAuthUser = "",
};
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.AddTokenAuthUser(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceAddTokenAuthUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
AddTokenAuthUser(InstanceName, string, CallSettings)
public virtual Operation<Instance, OperationMetadata> AddTokenAuthUser(InstanceName instance, string tokenAuthUser, CallSettings callSettings = null)Adds a token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
instance |
InstanceNameRequired. The instance resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/instances/{instance} |
tokenAuthUser |
stringRequired. The name of the token auth user to add. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
InstanceName instance = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
string tokenAuthUser = "";
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.AddTokenAuthUser(instance, tokenAuthUser);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceAddTokenAuthUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
AddTokenAuthUser(string, string, CallSettings)
public virtual Operation<Instance, OperationMetadata> AddTokenAuthUser(string instance, string tokenAuthUser, CallSettings callSettings = null)Adds a token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
instance |
stringRequired. The instance resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/instances/{instance} |
tokenAuthUser |
stringRequired. The name of the token auth user to add. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string instance = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
string tokenAuthUser = "";
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.AddTokenAuthUser(instance, tokenAuthUser);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceAddTokenAuthUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
AddTokenAuthUserAsync(AddTokenAuthUserRequest, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> AddTokenAuthUserAsync(AddTokenAuthUserRequest request, CallSettings callSettings = null)Adds a token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
AddTokenAuthUserRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
AddTokenAuthUserRequest request = new AddTokenAuthUserRequest
{
InstanceAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
TokenAuthUser = "",
};
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.AddTokenAuthUserAsync(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceAddTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
AddTokenAuthUserAsync(AddTokenAuthUserRequest, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> AddTokenAuthUserAsync(AddTokenAuthUserRequest request, CancellationToken cancellationToken)Adds a token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
AddTokenAuthUserRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
AddTokenAuthUserRequest request = new AddTokenAuthUserRequest
{
InstanceAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
TokenAuthUser = "",
};
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.AddTokenAuthUserAsync(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceAddTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
AddTokenAuthUserAsync(InstanceName, string, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> AddTokenAuthUserAsync(InstanceName instance, string tokenAuthUser, CallSettings callSettings = null)Adds a token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
instance |
InstanceNameRequired. The instance resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/instances/{instance} |
tokenAuthUser |
stringRequired. The name of the token auth user to add. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName instance = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
string tokenAuthUser = "";
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.AddTokenAuthUserAsync(instance, tokenAuthUser);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceAddTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
AddTokenAuthUserAsync(InstanceName, string, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> AddTokenAuthUserAsync(InstanceName instance, string tokenAuthUser, CancellationToken cancellationToken)Adds a token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
instance |
InstanceNameRequired. The instance resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/instances/{instance} |
tokenAuthUser |
stringRequired. The name of the token auth user to add. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName instance = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
string tokenAuthUser = "";
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.AddTokenAuthUserAsync(instance, tokenAuthUser);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceAddTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
AddTokenAuthUserAsync(string, string, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> AddTokenAuthUserAsync(string instance, string tokenAuthUser, CallSettings callSettings = null)Adds a token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
instance |
stringRequired. The instance resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/instances/{instance} |
tokenAuthUser |
stringRequired. The name of the token auth user to add. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string instance = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
string tokenAuthUser = "";
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.AddTokenAuthUserAsync(instance, tokenAuthUser);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceAddTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
AddTokenAuthUserAsync(string, string, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> AddTokenAuthUserAsync(string instance, string tokenAuthUser, CancellationToken cancellationToken)Adds a token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
instance |
stringRequired. The instance resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/instances/{instance} |
tokenAuthUser |
stringRequired. The name of the token auth user to add. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string instance = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
string tokenAuthUser = "";
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.AddTokenAuthUserAsync(instance, tokenAuthUser);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceAddTokenAuthUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
BackupInstance(BackupInstanceRequest, CallSettings)
public virtual Operation<Instance, OperationMetadata> BackupInstance(BackupInstanceRequest request, CallSettings callSettings = null)Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
| Parameters | |
|---|---|
| Name | Description |
request |
BackupInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
BackupInstanceRequest request = new BackupInstanceRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
Ttl = new Duration(),
BackupId = "",
};
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.BackupInstance(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceBackupInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
BackupInstance(InstanceName, CallSettings)
public virtual Operation<Instance, OperationMetadata> BackupInstance(InstanceName name, CallSettings callSettings = null)Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. Instance resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.BackupInstance(name);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceBackupInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
BackupInstance(string, CallSettings)
public virtual Operation<Instance, OperationMetadata> BackupInstance(string name, CallSettings callSettings = null)Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Instance resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.BackupInstance(name);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceBackupInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
BackupInstanceAsync(BackupInstanceRequest, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> BackupInstanceAsync(BackupInstanceRequest request, CallSettings callSettings = null)Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
| Parameters | |
|---|---|
| Name | Description |
request |
BackupInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
BackupInstanceRequest request = new BackupInstanceRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
Ttl = new Duration(),
BackupId = "",
};
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.BackupInstanceAsync(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceBackupInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
BackupInstanceAsync(BackupInstanceRequest, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> BackupInstanceAsync(BackupInstanceRequest request, CancellationToken cancellationToken)Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
| Parameters | |
|---|---|
| Name | Description |
request |
BackupInstanceRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
BackupInstanceRequest request = new BackupInstanceRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
Ttl = new Duration(),
BackupId = "",
};
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.BackupInstanceAsync(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceBackupInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
BackupInstanceAsync(InstanceName, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> BackupInstanceAsync(InstanceName name, CallSettings callSettings = null)Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. Instance resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.BackupInstanceAsync(name);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceBackupInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
BackupInstanceAsync(InstanceName, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> BackupInstanceAsync(InstanceName name, CancellationToken cancellationToken)Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. Instance resource name using the form:
|
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.BackupInstanceAsync(name);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceBackupInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
BackupInstanceAsync(string, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> BackupInstanceAsync(string name, CallSettings callSettings = null)Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Instance resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.BackupInstanceAsync(name);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceBackupInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
BackupInstanceAsync(string, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> BackupInstanceAsync(string name, CancellationToken cancellationToken)Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Instance resource name using the form:
|
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.BackupInstanceAsync(name);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceBackupInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
Create()
public static MemorystoreClient Create()Synchronously creates a MemorystoreClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MemorystoreClientBuilder.
| Returns | |
|---|---|
| Type | Description |
MemorystoreClient |
The created MemorystoreClient. |
CreateAsync(CancellationToken)
public static Task<MemorystoreClient> CreateAsync(CancellationToken cancellationToken = default)Asynchronously creates a MemorystoreClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MemorystoreClientBuilder.
| Parameter | |
|---|---|
| Name | Description |
cancellationToken |
CancellationTokenThe CancellationToken to use while creating the client. |
| Returns | |
|---|---|
| Type | Description |
TaskMemorystoreClient |
The task representing the created MemorystoreClient. |
CreateInstance(LocationName, Instance, string, CallSettings)
public virtual Operation<Instance, OperationMetadata> CreateInstance(LocationName parent, Instance instance, string instanceId, CallSettings callSettings = null)Creates a new Instance in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
LocationNameRequired. The parent resource where this instance will be created. Format: projects/{project}/locations/{location} |
instance |
InstanceRequired. The instance to create. |
instanceId |
stringRequired. The ID to use for the instance, which will become the final component of the instance's resource name. This value is subject to the following restrictions:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Instance instance = new Instance();
string instanceId = "";
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.CreateInstance(parent, instance, instanceId);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceCreateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
CreateInstance(CreateInstanceRequest, CallSettings)
public virtual Operation<Instance, OperationMetadata> CreateInstance(CreateInstanceRequest request, CallSettings callSettings = null)Creates a new Instance in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
CreateInstanceRequest request = new CreateInstanceRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
InstanceId = "",
Instance = new Instance(),
RequestId = "",
};
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.CreateInstance(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceCreateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
CreateInstance(string, Instance, string, CallSettings)
public virtual Operation<Instance, OperationMetadata> CreateInstance(string parent, Instance instance, string instanceId, CallSettings callSettings = null)Creates a new Instance in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
stringRequired. The parent resource where this instance will be created. Format: projects/{project}/locations/{location} |
instance |
InstanceRequired. The instance to create. |
instanceId |
stringRequired. The ID to use for the instance, which will become the final component of the instance's resource name. This value is subject to the following restrictions:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Instance instance = new Instance();
string instanceId = "";
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.CreateInstance(parent, instance, instanceId);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceCreateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
CreateInstanceAsync(LocationName, Instance, string, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> CreateInstanceAsync(LocationName parent, Instance instance, string instanceId, CallSettings callSettings = null)Creates a new Instance in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
LocationNameRequired. The parent resource where this instance will be created. Format: projects/{project}/locations/{location} |
instance |
InstanceRequired. The instance to create. |
instanceId |
stringRequired. The ID to use for the instance, which will become the final component of the instance's resource name. This value is subject to the following restrictions:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Instance instance = new Instance();
string instanceId = "";
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.CreateInstanceAsync(parent, instance, instanceId);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
CreateInstanceAsync(LocationName, Instance, string, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> CreateInstanceAsync(LocationName parent, Instance instance, string instanceId, CancellationToken cancellationToken)Creates a new Instance in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
LocationNameRequired. The parent resource where this instance will be created. Format: projects/{project}/locations/{location} |
instance |
InstanceRequired. The instance to create. |
instanceId |
stringRequired. The ID to use for the instance, which will become the final component of the instance's resource name. This value is subject to the following restrictions:
|
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Instance instance = new Instance();
string instanceId = "";
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.CreateInstanceAsync(parent, instance, instanceId);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
CreateInstanceAsync(CreateInstanceRequest, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> CreateInstanceAsync(CreateInstanceRequest request, CallSettings callSettings = null)Creates a new Instance in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
CreateInstanceRequest request = new CreateInstanceRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
InstanceId = "",
Instance = new Instance(),
RequestId = "",
};
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.CreateInstanceAsync(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
CreateInstanceAsync(CreateInstanceRequest, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> CreateInstanceAsync(CreateInstanceRequest request, CancellationToken cancellationToken)Creates a new Instance in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateInstanceRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
CreateInstanceRequest request = new CreateInstanceRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
InstanceId = "",
Instance = new Instance(),
RequestId = "",
};
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.CreateInstanceAsync(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
CreateInstanceAsync(string, Instance, string, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> CreateInstanceAsync(string parent, Instance instance, string instanceId, CallSettings callSettings = null)Creates a new Instance in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
stringRequired. The parent resource where this instance will be created. Format: projects/{project}/locations/{location} |
instance |
InstanceRequired. The instance to create. |
instanceId |
stringRequired. The ID to use for the instance, which will become the final component of the instance's resource name. This value is subject to the following restrictions:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Instance instance = new Instance();
string instanceId = "";
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.CreateInstanceAsync(parent, instance, instanceId);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
CreateInstanceAsync(string, Instance, string, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> CreateInstanceAsync(string parent, Instance instance, string instanceId, CancellationToken cancellationToken)Creates a new Instance in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
stringRequired. The parent resource where this instance will be created. Format: projects/{project}/locations/{location} |
instance |
InstanceRequired. The instance to create. |
instanceId |
stringRequired. The ID to use for the instance, which will become the final component of the instance's resource name. This value is subject to the following restrictions:
|
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Instance instance = new Instance();
string instanceId = "";
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.CreateInstanceAsync(parent, instance, instanceId);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
DeleteAuthToken(AuthTokenName, CallSettings)
public virtual Operation<Empty, OperationMetadata> DeleteAuthToken(AuthTokenName name, CallSettings callSettings = null)Deletes a token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
name |
AuthTokenNameRequired. The name of the token auth user resource that this token will be deleted from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{name} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
AuthTokenName name = AuthTokenName.FromProjectLocationInstanceTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]");
// Make the request
Operation<Empty, OperationMetadata> response = memorystoreClient.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 = memorystoreClient.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)Deletes a token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAuthTokenRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
DeleteAuthTokenRequest request = new DeleteAuthTokenRequest
{
AuthTokenName = AuthTokenName.FromProjectLocationInstanceTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = memorystoreClient.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 = memorystoreClient.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)Deletes a token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the token auth user resource that this token will be deleted from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{name} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]/authTokens/[AUTH_TOKEN]";
// Make the request
Operation<Empty, OperationMetadata> response = memorystoreClient.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 = memorystoreClient.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)Deletes a token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
name |
AuthTokenNameRequired. The name of the token auth user resource that this token will be deleted from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{name} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
AuthTokenName name = AuthTokenName.FromProjectLocationInstanceTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]");
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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)Deletes a token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
name |
AuthTokenNameRequired. The name of the token auth user resource that this token will be deleted from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{name} |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
AuthTokenName name = AuthTokenName.FromProjectLocationInstanceTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]");
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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)Deletes a token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAuthTokenRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
DeleteAuthTokenRequest request = new DeleteAuthTokenRequest
{
AuthTokenName = AuthTokenName.FromProjectLocationInstanceTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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)Deletes a token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAuthTokenRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
DeleteAuthTokenRequest request = new DeleteAuthTokenRequest
{
AuthTokenName = AuthTokenName.FromProjectLocationInstanceTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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)Deletes a token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the token auth user resource that this token will be deleted from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{name} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]/authTokens/[AUTH_TOKEN]";
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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)Deletes a token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the token auth user resource that this token will be deleted from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{name} |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]/authTokens/[AUTH_TOKEN]";
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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, OperationMetadata> DeleteBackup(BackupName name, CallSettings callSettings = null)Deletes a specific backup.
| Parameters | |
|---|---|
| Name | Description |
name |
BackupNameRequired. Instance backup resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]");
// Make the request
Operation<Empty, OperationMetadata> response = memorystoreClient.DeleteBackup(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 = memorystoreClient.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, OperationMetadata> DeleteBackup(DeleteBackupRequest request, CallSettings callSettings = null)Deletes a specific backup.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteBackupRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = memorystoreClient.DeleteBackup(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 = memorystoreClient.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, OperationMetadata> DeleteBackup(string name, CallSettings callSettings = null)Deletes a specific backup.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Instance backup resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]/backups/[BACKUP]";
// Make the request
Operation<Empty, OperationMetadata> response = memorystoreClient.DeleteBackup(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 = memorystoreClient.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, OperationMetadata>> DeleteBackupAsync(BackupName name, CallSettings callSettings = null)Deletes a specific backup.
| Parameters | |
|---|---|
| Name | Description |
name |
BackupNameRequired. Instance backup resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]");
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.DeleteBackupAsync(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 memorystoreClient.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, OperationMetadata>> DeleteBackupAsync(BackupName name, CancellationToken cancellationToken)Deletes a specific backup.
| Parameters | |
|---|---|
| Name | Description |
name |
BackupNameRequired. Instance backup resource name using the form:
|
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]");
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.DeleteBackupAsync(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 memorystoreClient.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, OperationMetadata>> DeleteBackupAsync(DeleteBackupRequest request, CallSettings callSettings = null)Deletes a specific backup.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteBackupRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.DeleteBackupAsync(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 memorystoreClient.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, OperationMetadata>> DeleteBackupAsync(DeleteBackupRequest request, CancellationToken cancellationToken)Deletes a specific backup.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteBackupRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.DeleteBackupAsync(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 memorystoreClient.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, OperationMetadata>> DeleteBackupAsync(string name, CallSettings callSettings = null)Deletes a specific backup.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Instance backup resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]/backups/[BACKUP]";
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.DeleteBackupAsync(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 memorystoreClient.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, OperationMetadata>> DeleteBackupAsync(string name, CancellationToken cancellationToken)Deletes a specific backup.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Instance backup resource name using the form:
|
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]/backups/[BACKUP]";
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.DeleteBackupAsync(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 memorystoreClient.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;
}
DeleteInstance(DeleteInstanceRequest, CallSettings)
public virtual Operation<Empty, OperationMetadata> DeleteInstance(DeleteInstanceRequest request, CallSettings callSettings = null)Deletes a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
DeleteInstanceRequest request = new DeleteInstanceRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = memorystoreClient.DeleteInstance(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 = memorystoreClient.PollOnceDeleteInstance(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;
}
DeleteInstance(InstanceName, CallSettings)
public virtual Operation<Empty, OperationMetadata> DeleteInstance(InstanceName name, CallSettings callSettings = null)Deletes a single Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. The name of the instance to delete. Format: projects/{project}/locations/{location}/instances/{instance} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
Operation<Empty, OperationMetadata> response = memorystoreClient.DeleteInstance(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 = memorystoreClient.PollOnceDeleteInstance(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;
}
DeleteInstance(string, CallSettings)
public virtual Operation<Empty, OperationMetadata> DeleteInstance(string name, CallSettings callSettings = null)Deletes a single Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the instance to delete. Format: projects/{project}/locations/{location}/instances/{instance} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
Operation<Empty, OperationMetadata> response = memorystoreClient.DeleteInstance(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 = memorystoreClient.PollOnceDeleteInstance(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;
}
DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(DeleteInstanceRequest request, CallSettings callSettings = null)Deletes a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
DeleteInstanceRequest request = new DeleteInstanceRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.DeleteInstanceAsync(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 memorystoreClient.PollOnceDeleteInstanceAsync(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;
}
DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(DeleteInstanceRequest request, CancellationToken cancellationToken)Deletes a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteInstanceRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
DeleteInstanceRequest request = new DeleteInstanceRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.DeleteInstanceAsync(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 memorystoreClient.PollOnceDeleteInstanceAsync(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;
}
DeleteInstanceAsync(InstanceName, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(InstanceName name, CallSettings callSettings = null)Deletes a single Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. The name of the instance to delete. Format: projects/{project}/locations/{location}/instances/{instance} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.DeleteInstanceAsync(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 memorystoreClient.PollOnceDeleteInstanceAsync(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;
}
DeleteInstanceAsync(InstanceName, CancellationToken)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(InstanceName name, CancellationToken cancellationToken)Deletes a single Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. The name of the instance to delete. Format: projects/{project}/locations/{location}/instances/{instance} |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.DeleteInstanceAsync(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 memorystoreClient.PollOnceDeleteInstanceAsync(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;
}
DeleteInstanceAsync(string, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(string name, CallSettings callSettings = null)Deletes a single Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the instance to delete. Format: projects/{project}/locations/{location}/instances/{instance} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.DeleteInstanceAsync(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 memorystoreClient.PollOnceDeleteInstanceAsync(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;
}
DeleteInstanceAsync(string, CancellationToken)
public virtual Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(string name, CancellationToken cancellationToken)Deletes a single Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the instance to delete. Format: projects/{project}/locations/{location}/instances/{instance} |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.DeleteInstanceAsync(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 memorystoreClient.PollOnceDeleteInstanceAsync(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 instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteTokenAuthUserRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
DeleteTokenAuthUserRequest request = new DeleteTokenAuthUserRequest
{
TokenAuthUserName = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]"),
RequestId = "",
Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = memorystoreClient.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 = memorystoreClient.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 instance.
| Parameters | |
|---|---|
| Name | Description |
name |
TokenAuthUserNameRequired. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
TokenAuthUserName name = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]");
// Make the request
Operation<Empty, OperationMetadata> response = memorystoreClient.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 = memorystoreClient.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 instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
Operation<Empty, OperationMetadata> response = memorystoreClient.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 = memorystoreClient.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 instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteTokenAuthUserRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
DeleteTokenAuthUserRequest request = new DeleteTokenAuthUserRequest
{
TokenAuthUserName = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]"),
RequestId = "",
Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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 instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteTokenAuthUserRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
DeleteTokenAuthUserRequest request = new DeleteTokenAuthUserRequest
{
TokenAuthUserName = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]"),
RequestId = "",
Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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 instance.
| Parameters | |
|---|---|
| Name | Description |
name |
TokenAuthUserNameRequired. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
TokenAuthUserName name = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]");
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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 instance.
| Parameters | |
|---|---|
| Name | Description |
name |
TokenAuthUserNameRequired. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
TokenAuthUserName name = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]");
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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 instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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 instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
Operation<Empty, OperationMetadata> response = await memorystoreClient.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 memorystoreClient.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, OperationMetadata> ExportBackup(ExportBackupRequest request, CallSettings callSettings = null)Exports a specific backup to a customer target Cloud Storage URI.
| Parameters | |
|---|---|
| Name | Description |
request |
ExportBackupRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationBackupOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
ExportBackupRequest request = new ExportBackupRequest
{
BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
GcsBucket = "",
};
// Make the request
Operation<Backup, OperationMetadata> response = memorystoreClient.ExportBackup(request);
// Poll until the returned long-running operation is complete
Operation<Backup, OperationMetadata> 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, OperationMetadata> retrievedResponse = memorystoreClient.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, OperationMetadata>> ExportBackupAsync(ExportBackupRequest request, CallSettings callSettings = null)Exports a specific backup to a customer target Cloud Storage URI.
| Parameters | |
|---|---|
| Name | Description |
request |
ExportBackupRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
ExportBackupRequest request = new ExportBackupRequest
{
BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
GcsBucket = "",
};
// Make the request
Operation<Backup, OperationMetadata> response = await memorystoreClient.ExportBackupAsync(request);
// Poll until the returned long-running operation is complete
Operation<Backup, OperationMetadata> 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, OperationMetadata> retrievedResponse = await memorystoreClient.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, OperationMetadata>> ExportBackupAsync(ExportBackupRequest request, CancellationToken cancellationToken)Exports a specific backup to a customer target Cloud Storage URI.
| Parameters | |
|---|---|
| Name | Description |
request |
ExportBackupRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
ExportBackupRequest request = new ExportBackupRequest
{
BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
GcsBucket = "",
};
// Make the request
Operation<Backup, OperationMetadata> response = await memorystoreClient.ExportBackupAsync(request);
// Poll until the returned long-running operation is complete
Operation<Backup, OperationMetadata> 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, OperationMetadata> retrievedResponse = await memorystoreClient.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;
}
FinishMigration(FinishMigrationRequest, CallSettings)
public virtual Operation<Instance, OperationMetadata> FinishMigration(FinishMigrationRequest request, CallSettings callSettings = null)Finalizes the migration process.
After the successful completion of this operation, the target instance will:
- Stop replicating from the source instance.
- Allow both reads and writes.
| Parameters | |
|---|---|
| Name | Description |
request |
FinishMigrationRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
FinishMigrationRequest request = new FinishMigrationRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
Force = false,
};
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.FinishMigration(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceFinishMigration(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
FinishMigration(InstanceName, bool, CallSettings)
public virtual Operation<Instance, OperationMetadata> FinishMigration(InstanceName name, bool force, CallSettings callSettings = null)Finalizes the migration process.
After the successful completion of this operation, the target instance will:
- Stop replicating from the source instance.
- Allow both reads and writes.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. The resource name of the instance to finalize migration on. Format: projects/{project}/locations/{location}/instances/{instance} |
force |
boolOptional. By default, the |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
bool force = false;
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.FinishMigration(name, force);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceFinishMigration(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
FinishMigration(string, bool, CallSettings)
public virtual Operation<Instance, OperationMetadata> FinishMigration(string name, bool force, CallSettings callSettings = null)Finalizes the migration process.
After the successful completion of this operation, the target instance will:
- Stop replicating from the source instance.
- Allow both reads and writes.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The resource name of the instance to finalize migration on. Format: projects/{project}/locations/{location}/instances/{instance} |
force |
boolOptional. By default, the |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
bool force = false;
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.FinishMigration(name, force);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceFinishMigration(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
FinishMigrationAsync(FinishMigrationRequest, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> FinishMigrationAsync(FinishMigrationRequest request, CallSettings callSettings = null)Finalizes the migration process.
After the successful completion of this operation, the target instance will:
- Stop replicating from the source instance.
- Allow both reads and writes.
| Parameters | |
|---|---|
| Name | Description |
request |
FinishMigrationRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
FinishMigrationRequest request = new FinishMigrationRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
Force = false,
};
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.FinishMigrationAsync(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceFinishMigrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
FinishMigrationAsync(FinishMigrationRequest, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> FinishMigrationAsync(FinishMigrationRequest request, CancellationToken cancellationToken)Finalizes the migration process.
After the successful completion of this operation, the target instance will:
- Stop replicating from the source instance.
- Allow both reads and writes.
| Parameters | |
|---|---|
| Name | Description |
request |
FinishMigrationRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
FinishMigrationRequest request = new FinishMigrationRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
Force = false,
};
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.FinishMigrationAsync(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceFinishMigrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
FinishMigrationAsync(InstanceName, bool, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> FinishMigrationAsync(InstanceName name, bool force, CallSettings callSettings = null)Finalizes the migration process.
After the successful completion of this operation, the target instance will:
- Stop replicating from the source instance.
- Allow both reads and writes.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. The resource name of the instance to finalize migration on. Format: projects/{project}/locations/{location}/instances/{instance} |
force |
boolOptional. By default, the |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
bool force = false;
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.FinishMigrationAsync(name, force);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceFinishMigrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
FinishMigrationAsync(InstanceName, bool, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> FinishMigrationAsync(InstanceName name, bool force, CancellationToken cancellationToken)Finalizes the migration process.
After the successful completion of this operation, the target instance will:
- Stop replicating from the source instance.
- Allow both reads and writes.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. The resource name of the instance to finalize migration on. Format: projects/{project}/locations/{location}/instances/{instance} |
force |
boolOptional. By default, the |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
bool force = false;
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.FinishMigrationAsync(name, force);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceFinishMigrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
FinishMigrationAsync(string, bool, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> FinishMigrationAsync(string name, bool force, CallSettings callSettings = null)Finalizes the migration process.
After the successful completion of this operation, the target instance will:
- Stop replicating from the source instance.
- Allow both reads and writes.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The resource name of the instance to finalize migration on. Format: projects/{project}/locations/{location}/instances/{instance} |
force |
boolOptional. By default, the |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
bool force = false;
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.FinishMigrationAsync(name, force);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceFinishMigrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
FinishMigrationAsync(string, bool, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> FinishMigrationAsync(string name, bool force, CancellationToken cancellationToken)Finalizes the migration process.
After the successful completion of this operation, the target instance will:
- Stop replicating from the source instance.
- Allow both reads and writes.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The resource name of the instance to finalize migration on. Format: projects/{project}/locations/{location}/instances/{instance} |
force |
boolOptional. By default, the |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
bool force = false;
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.FinishMigrationAsync(name, force);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceFinishMigrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
GetAuthToken(AuthTokenName, CallSettings)
public virtual AuthToken GetAuthToken(AuthTokenName name, CallSettings callSettings = null)Gets a token based auth enabled instance's auth token for a given user.
| Parameters | |
|---|---|
| Name | Description |
name |
AuthTokenNameRequired. The name of token auth user for a token auth enabled instance. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AuthToken |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
AuthTokenName name = AuthTokenName.FromProjectLocationInstanceTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]");
// Make the request
AuthToken response = memorystoreClient.GetAuthToken(name);
GetAuthToken(GetAuthTokenRequest, CallSettings)
public virtual AuthToken GetAuthToken(GetAuthTokenRequest request, CallSettings callSettings = null)Gets a token based auth enabled instance's auth token for a given user.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAuthTokenRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AuthToken |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
GetAuthTokenRequest request = new GetAuthTokenRequest
{
AuthTokenName = AuthTokenName.FromProjectLocationInstanceTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]"),
};
// Make the request
AuthToken response = memorystoreClient.GetAuthToken(request);
GetAuthToken(string, CallSettings)
public virtual AuthToken GetAuthToken(string name, CallSettings callSettings = null)Gets a token based auth enabled instance's auth token for a given user.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of token auth user for a token auth enabled instance. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AuthToken |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]/authTokens/[AUTH_TOKEN]";
// Make the request
AuthToken response = memorystoreClient.GetAuthToken(name);
GetAuthTokenAsync(AuthTokenName, CallSettings)
public virtual Task<AuthToken> GetAuthTokenAsync(AuthTokenName name, CallSettings callSettings = null)Gets a token based auth enabled instance's auth token for a given user.
| Parameters | |
|---|---|
| Name | Description |
name |
AuthTokenNameRequired. The name of token auth user for a token auth enabled instance. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAuthToken |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
AuthTokenName name = AuthTokenName.FromProjectLocationInstanceTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]");
// Make the request
AuthToken response = await memorystoreClient.GetAuthTokenAsync(name);
GetAuthTokenAsync(AuthTokenName, CancellationToken)
public virtual Task<AuthToken> GetAuthTokenAsync(AuthTokenName name, CancellationToken cancellationToken)Gets a token based auth enabled instance's auth token for a given user.
| Parameters | |
|---|---|
| Name | Description |
name |
AuthTokenNameRequired. The name of token auth user for a token auth enabled instance. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskAuthToken |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
AuthTokenName name = AuthTokenName.FromProjectLocationInstanceTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]");
// Make the request
AuthToken response = await memorystoreClient.GetAuthTokenAsync(name);
GetAuthTokenAsync(GetAuthTokenRequest, CallSettings)
public virtual Task<AuthToken> GetAuthTokenAsync(GetAuthTokenRequest request, CallSettings callSettings = null)Gets a token based auth enabled instance's auth token for a given user.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAuthTokenRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAuthToken |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
GetAuthTokenRequest request = new GetAuthTokenRequest
{
AuthTokenName = AuthTokenName.FromProjectLocationInstanceTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]"),
};
// Make the request
AuthToken response = await memorystoreClient.GetAuthTokenAsync(request);
GetAuthTokenAsync(GetAuthTokenRequest, CancellationToken)
public virtual Task<AuthToken> GetAuthTokenAsync(GetAuthTokenRequest request, CancellationToken cancellationToken)Gets a token based auth enabled instance's auth token for a given user.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAuthTokenRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskAuthToken |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
GetAuthTokenRequest request = new GetAuthTokenRequest
{
AuthTokenName = AuthTokenName.FromProjectLocationInstanceTokenAuthUserAuthToken("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]", "[AUTH_TOKEN]"),
};
// Make the request
AuthToken response = await memorystoreClient.GetAuthTokenAsync(request);
GetAuthTokenAsync(string, CallSettings)
public virtual Task<AuthToken> GetAuthTokenAsync(string name, CallSettings callSettings = null)Gets a token based auth enabled instance's auth token for a given user.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of token auth user for a token auth enabled instance. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAuthToken |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]/authTokens/[AUTH_TOKEN]";
// Make the request
AuthToken response = await memorystoreClient.GetAuthTokenAsync(name);
GetAuthTokenAsync(string, CancellationToken)
public virtual Task<AuthToken> GetAuthTokenAsync(string name, CancellationToken cancellationToken)Gets a token based auth enabled instance's auth token for a given user.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of token auth user for a token auth enabled instance. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskAuthToken |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]/authTokens/[AUTH_TOKEN]";
// Make the request
AuthToken response = await memorystoreClient.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 |
BackupNameRequired. Instance backup resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Backup |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]");
// Make the request
Backup response = memorystoreClient.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 |
GetBackupRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Backup |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
GetBackupRequest request = new GetBackupRequest
{
BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
};
// Make the request
Backup response = memorystoreClient.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 |
stringRequired. Instance backup resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Backup |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]/backups/[BACKUP]";
// Make the request
Backup response = memorystoreClient.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 |
BackupNameRequired. Instance backup resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]");
// Make the request
Backup response = await memorystoreClient.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 |
BackupNameRequired. Instance backup resource name using the form:
|
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]");
// Make the request
Backup response = await memorystoreClient.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 |
GetBackupRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
GetBackupRequest request = new GetBackupRequest
{
BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
};
// Make the request
Backup response = await memorystoreClient.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 |
GetBackupRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
GetBackupRequest request = new GetBackupRequest
{
BackupName = BackupName.FromProjectLocationBackupCollectionBackup("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]"),
};
// Make the request
Backup response = await memorystoreClient.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 |
stringRequired. Instance backup resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]/backups/[BACKUP]";
// Make the request
Backup response = await memorystoreClient.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 |
stringRequired. Instance backup resource name using the form:
|
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]/backups/[BACKUP]";
// Make the request
Backup response = await memorystoreClient.GetBackupAsync(name);
GetBackupCollection(BackupCollectionName, CallSettings)
public virtual BackupCollection GetBackupCollection(BackupCollectionName name, CallSettings callSettings = null)Get a backup collection.
| Parameters | |
|---|---|
| Name | Description |
name |
BackupCollectionNameRequired. Instance backupCollection resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
BackupCollection |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
BackupCollectionName name = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]");
// Make the request
BackupCollection response = memorystoreClient.GetBackupCollection(name);
GetBackupCollection(GetBackupCollectionRequest, CallSettings)
public virtual BackupCollection GetBackupCollection(GetBackupCollectionRequest request, CallSettings callSettings = null)Get a backup collection.
| Parameters | |
|---|---|
| Name | Description |
request |
GetBackupCollectionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
BackupCollection |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
GetBackupCollectionRequest request = new GetBackupCollectionRequest
{
BackupCollectionName = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]"),
};
// Make the request
BackupCollection response = memorystoreClient.GetBackupCollection(request);
GetBackupCollection(string, CallSettings)
public virtual BackupCollection GetBackupCollection(string name, CallSettings callSettings = null)Get a backup collection.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Instance backupCollection resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
BackupCollection |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]";
// Make the request
BackupCollection response = memorystoreClient.GetBackupCollection(name);
GetBackupCollectionAsync(BackupCollectionName, CallSettings)
public virtual Task<BackupCollection> GetBackupCollectionAsync(BackupCollectionName name, CallSettings callSettings = null)Get a backup collection.
| Parameters | |
|---|---|
| Name | Description |
name |
BackupCollectionNameRequired. Instance backupCollection resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskBackupCollection |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
BackupCollectionName name = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]");
// Make the request
BackupCollection response = await memorystoreClient.GetBackupCollectionAsync(name);
GetBackupCollectionAsync(BackupCollectionName, CancellationToken)
public virtual Task<BackupCollection> GetBackupCollectionAsync(BackupCollectionName name, CancellationToken cancellationToken)Get a backup collection.
| Parameters | |
|---|---|
| Name | Description |
name |
BackupCollectionNameRequired. Instance backupCollection resource name using the form:
|
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskBackupCollection |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
BackupCollectionName name = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]");
// Make the request
BackupCollection response = await memorystoreClient.GetBackupCollectionAsync(name);
GetBackupCollectionAsync(GetBackupCollectionRequest, CallSettings)
public virtual Task<BackupCollection> GetBackupCollectionAsync(GetBackupCollectionRequest request, CallSettings callSettings = null)Get a backup collection.
| Parameters | |
|---|---|
| Name | Description |
request |
GetBackupCollectionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskBackupCollection |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
GetBackupCollectionRequest request = new GetBackupCollectionRequest
{
BackupCollectionName = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]"),
};
// Make the request
BackupCollection response = await memorystoreClient.GetBackupCollectionAsync(request);
GetBackupCollectionAsync(GetBackupCollectionRequest, CancellationToken)
public virtual Task<BackupCollection> GetBackupCollectionAsync(GetBackupCollectionRequest request, CancellationToken cancellationToken)Get a backup collection.
| Parameters | |
|---|---|
| Name | Description |
request |
GetBackupCollectionRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskBackupCollection |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
GetBackupCollectionRequest request = new GetBackupCollectionRequest
{
BackupCollectionName = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]"),
};
// Make the request
BackupCollection response = await memorystoreClient.GetBackupCollectionAsync(request);
GetBackupCollectionAsync(string, CallSettings)
public virtual Task<BackupCollection> GetBackupCollectionAsync(string name, CallSettings callSettings = null)Get a backup collection.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Instance backupCollection resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskBackupCollection |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]";
// Make the request
BackupCollection response = await memorystoreClient.GetBackupCollectionAsync(name);
GetBackupCollectionAsync(string, CancellationToken)
public virtual Task<BackupCollection> GetBackupCollectionAsync(string name, CancellationToken cancellationToken)Get a backup collection.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Instance backupCollection resource name using the form:
|
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskBackupCollection |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]";
// Make the request
BackupCollection response = await memorystoreClient.GetBackupCollectionAsync(name);
GetCertificateAuthority(GetCertificateAuthorityRequest, CallSettings)
public virtual CertificateAuthority GetCertificateAuthority(GetCertificateAuthorityRequest request, CallSettings callSettings = null)Gets details about the certificate authority for an Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetCertificateAuthorityRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
CertificateAuthority |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
GetCertificateAuthorityRequest request = new GetCertificateAuthorityRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
CertificateAuthority response = memorystoreClient.GetCertificateAuthority(request);
GetCertificateAuthority(InstanceName, CallSettings)
public virtual CertificateAuthority GetCertificateAuthority(InstanceName name, CallSettings callSettings = null)Gets details about the certificate authority for an Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. The name of the certificate authority. Format: projects/{project}/locations/{location}/instances/{instance}/certificateAuthority |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
CertificateAuthority |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
CertificateAuthority response = memorystoreClient.GetCertificateAuthority(name);
GetCertificateAuthority(string, CallSettings)
public virtual CertificateAuthority GetCertificateAuthority(string name, CallSettings callSettings = null)Gets details about the certificate authority for an Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the certificate authority. Format: projects/{project}/locations/{location}/instances/{instance}/certificateAuthority |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
CertificateAuthority |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
CertificateAuthority response = memorystoreClient.GetCertificateAuthority(name);
GetCertificateAuthorityAsync(GetCertificateAuthorityRequest, CallSettings)
public virtual Task<CertificateAuthority> GetCertificateAuthorityAsync(GetCertificateAuthorityRequest request, CallSettings callSettings = null)Gets details about the certificate authority for an Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetCertificateAuthorityRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskCertificateAuthority |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
GetCertificateAuthorityRequest request = new GetCertificateAuthorityRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
CertificateAuthority response = await memorystoreClient.GetCertificateAuthorityAsync(request);
GetCertificateAuthorityAsync(GetCertificateAuthorityRequest, CancellationToken)
public virtual Task<CertificateAuthority> GetCertificateAuthorityAsync(GetCertificateAuthorityRequest request, CancellationToken cancellationToken)Gets details about the certificate authority for an Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetCertificateAuthorityRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskCertificateAuthority |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
GetCertificateAuthorityRequest request = new GetCertificateAuthorityRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
CertificateAuthority response = await memorystoreClient.GetCertificateAuthorityAsync(request);
GetCertificateAuthorityAsync(InstanceName, CallSettings)
public virtual Task<CertificateAuthority> GetCertificateAuthorityAsync(InstanceName name, CallSettings callSettings = null)Gets details about the certificate authority for an Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. The name of the certificate authority. Format: projects/{project}/locations/{location}/instances/{instance}/certificateAuthority |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskCertificateAuthority |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
CertificateAuthority response = await memorystoreClient.GetCertificateAuthorityAsync(name);
GetCertificateAuthorityAsync(InstanceName, CancellationToken)
public virtual Task<CertificateAuthority> GetCertificateAuthorityAsync(InstanceName name, CancellationToken cancellationToken)Gets details about the certificate authority for an Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. The name of the certificate authority. Format: projects/{project}/locations/{location}/instances/{instance}/certificateAuthority |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskCertificateAuthority |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
CertificateAuthority response = await memorystoreClient.GetCertificateAuthorityAsync(name);
GetCertificateAuthorityAsync(string, CallSettings)
public virtual Task<CertificateAuthority> GetCertificateAuthorityAsync(string name, CallSettings callSettings = null)Gets details about the certificate authority for an Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the certificate authority. Format: projects/{project}/locations/{location}/instances/{instance}/certificateAuthority |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskCertificateAuthority |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
CertificateAuthority response = await memorystoreClient.GetCertificateAuthorityAsync(name);
GetCertificateAuthorityAsync(string, CancellationToken)
public virtual Task<CertificateAuthority> GetCertificateAuthorityAsync(string name, CancellationToken cancellationToken)Gets details about the certificate authority for an Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the certificate authority. Format: projects/{project}/locations/{location}/instances/{instance}/certificateAuthority |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskCertificateAuthority |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
CertificateAuthority response = await memorystoreClient.GetCertificateAuthorityAsync(name);
GetInstance(GetInstanceRequest, CallSettings)
public virtual Instance GetInstance(GetInstanceRequest request, CallSettings callSettings = null)Gets details of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Instance |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
GetInstanceRequest request = new GetInstanceRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
Instance response = memorystoreClient.GetInstance(request);
GetInstance(InstanceName, CallSettings)
public virtual Instance GetInstance(InstanceName name, CallSettings callSettings = null)Gets details of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. The name of the instance to retrieve. Format: projects/{project}/locations/{location}/instances/{instance} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Instance |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
Instance response = memorystoreClient.GetInstance(name);
GetInstance(string, CallSettings)
public virtual Instance GetInstance(string name, CallSettings callSettings = null)Gets details of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the instance to retrieve. Format: projects/{project}/locations/{location}/instances/{instance} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Instance |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
Instance response = memorystoreClient.GetInstance(name);
GetInstanceAsync(GetInstanceRequest, CallSettings)
public virtual Task<Instance> GetInstanceAsync(GetInstanceRequest request, CallSettings callSettings = null)Gets details of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskInstance |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
GetInstanceRequest request = new GetInstanceRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
Instance response = await memorystoreClient.GetInstanceAsync(request);
GetInstanceAsync(GetInstanceRequest, CancellationToken)
public virtual Task<Instance> GetInstanceAsync(GetInstanceRequest request, CancellationToken cancellationToken)Gets details of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetInstanceRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskInstance |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
GetInstanceRequest request = new GetInstanceRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
Instance response = await memorystoreClient.GetInstanceAsync(request);
GetInstanceAsync(InstanceName, CallSettings)
public virtual Task<Instance> GetInstanceAsync(InstanceName name, CallSettings callSettings = null)Gets details of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. The name of the instance to retrieve. Format: projects/{project}/locations/{location}/instances/{instance} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskInstance |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
Instance response = await memorystoreClient.GetInstanceAsync(name);
GetInstanceAsync(InstanceName, CancellationToken)
public virtual Task<Instance> GetInstanceAsync(InstanceName name, CancellationToken cancellationToken)Gets details of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. The name of the instance to retrieve. Format: projects/{project}/locations/{location}/instances/{instance} |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskInstance |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
Instance response = await memorystoreClient.GetInstanceAsync(name);
GetInstanceAsync(string, CallSettings)
public virtual Task<Instance> GetInstanceAsync(string name, CallSettings callSettings = null)Gets details of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the instance to retrieve. Format: projects/{project}/locations/{location}/instances/{instance} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskInstance |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
Instance response = await memorystoreClient.GetInstanceAsync(name);
GetInstanceAsync(string, CancellationToken)
public virtual Task<Instance> GetInstanceAsync(string name, CancellationToken cancellationToken)Gets details of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the instance to retrieve. Format: projects/{project}/locations/{location}/instances/{instance} |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskInstance |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
Instance response = await memorystoreClient.GetInstanceAsync(name);
GetSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest, CallSettings)
public virtual SharedRegionalCertificateAuthority GetSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest request, CallSettings callSettings = null)Gets the details of shared regional certificate authority information for Memorystore instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSharedRegionalCertificateAuthorityRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SharedRegionalCertificateAuthority |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
GetSharedRegionalCertificateAuthorityRequest request = new GetSharedRegionalCertificateAuthorityRequest
{
SharedRegionalCertificateAuthorityName = SharedRegionalCertificateAuthorityName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
SharedRegionalCertificateAuthority response = memorystoreClient.GetSharedRegionalCertificateAuthority(request);
GetSharedRegionalCertificateAuthority(SharedRegionalCertificateAuthorityName, CallSettings)
public virtual SharedRegionalCertificateAuthority GetSharedRegionalCertificateAuthority(SharedRegionalCertificateAuthorityName name, CallSettings callSettings = null)Gets the details of shared regional certificate authority information for Memorystore instance.
| Parameters | |
|---|---|
| Name | Description |
name |
SharedRegionalCertificateAuthorityNameRequired. Regional certificate authority resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SharedRegionalCertificateAuthority |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
SharedRegionalCertificateAuthorityName name = SharedRegionalCertificateAuthorityName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
SharedRegionalCertificateAuthority response = memorystoreClient.GetSharedRegionalCertificateAuthority(name);
GetSharedRegionalCertificateAuthority(string, CallSettings)
public virtual SharedRegionalCertificateAuthority GetSharedRegionalCertificateAuthority(string name, CallSettings callSettings = null)Gets the details of shared regional certificate authority information for Memorystore instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Regional certificate authority resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SharedRegionalCertificateAuthority |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/sharedRegionalCertificateAuthority";
// Make the request
SharedRegionalCertificateAuthority response = memorystoreClient.GetSharedRegionalCertificateAuthority(name);
GetSharedRegionalCertificateAuthorityAsync(GetSharedRegionalCertificateAuthorityRequest, CallSettings)
public virtual Task<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthorityAsync(GetSharedRegionalCertificateAuthorityRequest request, CallSettings callSettings = null)Gets the details of shared regional certificate authority information for Memorystore instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSharedRegionalCertificateAuthorityRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSharedRegionalCertificateAuthority |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
GetSharedRegionalCertificateAuthorityRequest request = new GetSharedRegionalCertificateAuthorityRequest
{
SharedRegionalCertificateAuthorityName = SharedRegionalCertificateAuthorityName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
SharedRegionalCertificateAuthority response = await memorystoreClient.GetSharedRegionalCertificateAuthorityAsync(request);
GetSharedRegionalCertificateAuthorityAsync(GetSharedRegionalCertificateAuthorityRequest, CancellationToken)
public virtual Task<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthorityAsync(GetSharedRegionalCertificateAuthorityRequest request, CancellationToken cancellationToken)Gets the details of shared regional certificate authority information for Memorystore instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSharedRegionalCertificateAuthorityRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskSharedRegionalCertificateAuthority |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
GetSharedRegionalCertificateAuthorityRequest request = new GetSharedRegionalCertificateAuthorityRequest
{
SharedRegionalCertificateAuthorityName = SharedRegionalCertificateAuthorityName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
SharedRegionalCertificateAuthority response = await memorystoreClient.GetSharedRegionalCertificateAuthorityAsync(request);
GetSharedRegionalCertificateAuthorityAsync(SharedRegionalCertificateAuthorityName, CallSettings)
public virtual Task<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthorityAsync(SharedRegionalCertificateAuthorityName name, CallSettings callSettings = null)Gets the details of shared regional certificate authority information for Memorystore instance.
| Parameters | |
|---|---|
| Name | Description |
name |
SharedRegionalCertificateAuthorityNameRequired. Regional certificate authority resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSharedRegionalCertificateAuthority |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
SharedRegionalCertificateAuthorityName name = SharedRegionalCertificateAuthorityName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
SharedRegionalCertificateAuthority response = await memorystoreClient.GetSharedRegionalCertificateAuthorityAsync(name);
GetSharedRegionalCertificateAuthorityAsync(SharedRegionalCertificateAuthorityName, CancellationToken)
public virtual Task<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthorityAsync(SharedRegionalCertificateAuthorityName name, CancellationToken cancellationToken)Gets the details of shared regional certificate authority information for Memorystore instance.
| Parameters | |
|---|---|
| Name | Description |
name |
SharedRegionalCertificateAuthorityNameRequired. Regional certificate authority resource name using the form:
|
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskSharedRegionalCertificateAuthority |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
SharedRegionalCertificateAuthorityName name = SharedRegionalCertificateAuthorityName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
SharedRegionalCertificateAuthority response = await memorystoreClient.GetSharedRegionalCertificateAuthorityAsync(name);
GetSharedRegionalCertificateAuthorityAsync(string, CallSettings)
public virtual Task<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthorityAsync(string name, CallSettings callSettings = null)Gets the details of shared regional certificate authority information for Memorystore instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Regional certificate authority resource name using the form:
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSharedRegionalCertificateAuthority |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/sharedRegionalCertificateAuthority";
// Make the request
SharedRegionalCertificateAuthority response = await memorystoreClient.GetSharedRegionalCertificateAuthorityAsync(name);
GetSharedRegionalCertificateAuthorityAsync(string, CancellationToken)
public virtual Task<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthorityAsync(string name, CancellationToken cancellationToken)Gets the details of shared regional certificate authority information for Memorystore instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Regional certificate authority resource name using the form:
|
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskSharedRegionalCertificateAuthority |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/sharedRegionalCertificateAuthority";
// Make the request
SharedRegionalCertificateAuthority response = await memorystoreClient.GetSharedRegionalCertificateAuthorityAsync(name);
GetTokenAuthUser(GetTokenAuthUserRequest, CallSettings)
public virtual TokenAuthUser GetTokenAuthUser(GetTokenAuthUserRequest request, CallSettings callSettings = null)Gets a specific token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTokenAuthUserRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TokenAuthUser |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
GetTokenAuthUserRequest request = new GetTokenAuthUserRequest
{
TokenAuthUserName = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]"),
};
// Make the request
TokenAuthUser response = memorystoreClient.GetTokenAuthUser(request);
GetTokenAuthUser(TokenAuthUserName, CallSettings)
public virtual TokenAuthUser GetTokenAuthUser(TokenAuthUserName name, CallSettings callSettings = null)Gets a specific token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
name |
TokenAuthUserNameRequired. The name of token auth user for a basic auth enabled instance. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TokenAuthUser |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
TokenAuthUserName name = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]");
// Make the request
TokenAuthUser response = memorystoreClient.GetTokenAuthUser(name);
GetTokenAuthUser(string, CallSettings)
public virtual TokenAuthUser GetTokenAuthUser(string name, CallSettings callSettings = null)Gets a specific token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of token auth user for a basic auth enabled instance. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TokenAuthUser |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
TokenAuthUser response = memorystoreClient.GetTokenAuthUser(name);
GetTokenAuthUserAsync(GetTokenAuthUserRequest, CallSettings)
public virtual Task<TokenAuthUser> GetTokenAuthUserAsync(GetTokenAuthUserRequest request, CallSettings callSettings = null)Gets a specific token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTokenAuthUserRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTokenAuthUser |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
GetTokenAuthUserRequest request = new GetTokenAuthUserRequest
{
TokenAuthUserName = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]"),
};
// Make the request
TokenAuthUser response = await memorystoreClient.GetTokenAuthUserAsync(request);
GetTokenAuthUserAsync(GetTokenAuthUserRequest, CancellationToken)
public virtual Task<TokenAuthUser> GetTokenAuthUserAsync(GetTokenAuthUserRequest request, CancellationToken cancellationToken)Gets a specific token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTokenAuthUserRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTokenAuthUser |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
GetTokenAuthUserRequest request = new GetTokenAuthUserRequest
{
TokenAuthUserName = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]"),
};
// Make the request
TokenAuthUser response = await memorystoreClient.GetTokenAuthUserAsync(request);
GetTokenAuthUserAsync(TokenAuthUserName, CallSettings)
public virtual Task<TokenAuthUser> GetTokenAuthUserAsync(TokenAuthUserName name, CallSettings callSettings = null)Gets a specific token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
name |
TokenAuthUserNameRequired. The name of token auth user for a basic auth enabled instance. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTokenAuthUser |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
TokenAuthUserName name = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]");
// Make the request
TokenAuthUser response = await memorystoreClient.GetTokenAuthUserAsync(name);
GetTokenAuthUserAsync(TokenAuthUserName, CancellationToken)
public virtual Task<TokenAuthUser> GetTokenAuthUserAsync(TokenAuthUserName name, CancellationToken cancellationToken)Gets a specific token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
name |
TokenAuthUserNameRequired. The name of token auth user for a basic auth enabled instance. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTokenAuthUser |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
TokenAuthUserName name = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]");
// Make the request
TokenAuthUser response = await memorystoreClient.GetTokenAuthUserAsync(name);
GetTokenAuthUserAsync(string, CallSettings)
public virtual Task<TokenAuthUser> GetTokenAuthUserAsync(string name, CallSettings callSettings = null)Gets a specific token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of token auth user for a basic auth enabled instance. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTokenAuthUser |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
TokenAuthUser response = await memorystoreClient.GetTokenAuthUserAsync(name);
GetTokenAuthUserAsync(string, CancellationToken)
public virtual Task<TokenAuthUser> GetTokenAuthUserAsync(string name, CancellationToken cancellationToken)Gets a specific token auth user for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of token auth user for a basic auth enabled instance. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTokenAuthUser |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
TokenAuthUser response = await memorystoreClient.GetTokenAuthUserAsync(name);
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 |
ListAuthTokensRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListAuthTokensResponseAuthToken |
A pageable sequence of AuthToken resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
ListAuthTokensRequest request = new ListAuthTokensRequest
{
ParentAsTokenAuthUserName = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]"),
Filter = "",
OrderBy = "",
};
// Make the request
PagedEnumerable<ListAuthTokensResponse, AuthToken> response = memorystoreClient.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 |
TokenAuthUserNameRequired. The parent to list auth tokens from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListAuthTokensResponseAuthToken |
A pageable sequence of AuthToken resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
TokenAuthUserName parent = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]");
// Make the request
PagedEnumerable<ListAuthTokensResponse, AuthToken> response = memorystoreClient.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 |
stringRequired. The parent to list auth tokens from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListAuthTokensResponseAuthToken |
A pageable sequence of AuthToken resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
PagedEnumerable<ListAuthTokensResponse, AuthToken> response = memorystoreClient.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 |
ListAuthTokensRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListAuthTokensResponseAuthToken |
A pageable asynchronous sequence of AuthToken resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
ListAuthTokensRequest request = new ListAuthTokensRequest
{
ParentAsTokenAuthUserName = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]"),
Filter = "",
OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListAuthTokensResponse, AuthToken> response = memorystoreClient.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 |
TokenAuthUserNameRequired. The parent to list auth tokens from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListAuthTokensResponseAuthToken |
A pageable asynchronous sequence of AuthToken resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
TokenAuthUserName parent = TokenAuthUserName.FromProjectLocationInstanceTokenAuthUser("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[TOKEN_AUTH_USER]");
// Make the request
PagedAsyncEnumerable<ListAuthTokensResponse, AuthToken> response = memorystoreClient.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 |
stringRequired. The parent to list auth tokens from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user} |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListAuthTokensResponseAuthToken |
A pageable asynchronous sequence of AuthToken resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/tokenAuthUsers/[TOKEN_AUTH_USER]";
// Make the request
PagedAsyncEnumerable<ListAuthTokensResponse, AuthToken> response = memorystoreClient.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 |
LocationNameRequired. The resource name of the backupCollection location using the
form:
|
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListBackupCollectionsResponseBackupCollection |
A pageable sequence of BackupCollection resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListBackupCollectionsResponse, BackupCollection> response = memorystoreClient.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 |
ListBackupCollectionsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListBackupCollectionsResponseBackupCollection |
A pageable sequence of BackupCollection resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
ListBackupCollectionsRequest request = new ListBackupCollectionsRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListBackupCollectionsResponse, BackupCollection> response = memorystoreClient.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 |
stringRequired. The resource name of the backupCollection location using the
form:
|
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListBackupCollectionsResponseBackupCollection |
A pageable sequence of BackupCollection resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListBackupCollectionsResponse, BackupCollection> response = memorystoreClient.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 |
LocationNameRequired. The resource name of the backupCollection location using the
form:
|
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListBackupCollectionsResponseBackupCollection |
A pageable asynchronous sequence of BackupCollection resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListBackupCollectionsResponse, BackupCollection> response = memorystoreClient.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 |
ListBackupCollectionsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListBackupCollectionsResponseBackupCollection |
A pageable asynchronous sequence of BackupCollection resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
ListBackupCollectionsRequest request = new ListBackupCollectionsRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListBackupCollectionsResponse, BackupCollection> response = memorystoreClient.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 |
stringRequired. The resource name of the backupCollection location using the
form:
|
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListBackupCollectionsResponseBackupCollection |
A pageable asynchronous sequence of BackupCollection resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListBackupCollectionsResponse, BackupCollection> response = memorystoreClient.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 |
BackupCollectionNameRequired. The resource name of the backupCollection using the form:
|
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListBackupsResponseBackup |
A pageable sequence of Backup resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
BackupCollectionName parent = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]");
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = memorystoreClient.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 |
ListBackupsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListBackupsResponseBackup |
A pageable sequence of Backup resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
ListBackupsRequest request = new ListBackupsRequest
{
ParentAsBackupCollectionName = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]"),
};
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = memorystoreClient.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 |
stringRequired. The resource name of the backupCollection using the form:
|
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListBackupsResponseBackup |
A pageable sequence of Backup resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]";
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = memorystoreClient.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 |
BackupCollectionNameRequired. The resource name of the backupCollection using the form:
|
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListBackupsResponseBackup |
A pageable asynchronous sequence of Backup resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
BackupCollectionName parent = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]");
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = memorystoreClient.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 |
ListBackupsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListBackupsResponseBackup |
A pageable asynchronous sequence of Backup resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
ListBackupsRequest request = new ListBackupsRequest
{
ParentAsBackupCollectionName = BackupCollectionName.FromProjectLocationBackupCollection("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]"),
};
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = memorystoreClient.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 |
stringRequired. The resource name of the backupCollection using the form:
|
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListBackupsResponseBackup |
A pageable asynchronous sequence of Backup resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/backupCollections/[BACKUP_COLLECTION]";
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = memorystoreClient.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;
ListInstances(LocationName, string, int?, CallSettings)
public virtual PagedEnumerable<ListInstancesResponse, Instance> ListInstances(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists Instances in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
LocationNameRequired. The parent to list instances from. Format: projects/{project}/locations/{location} |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListInstancesResponseInstance |
A pageable sequence of Instance resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListInstancesResponse, Instance> response = memorystoreClient.ListInstances(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Instance 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 (ListInstancesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Instance 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<Instance> 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 (Instance 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;
ListInstances(ListInstancesRequest, CallSettings)
public virtual PagedEnumerable<ListInstancesResponse, Instance> ListInstances(ListInstancesRequest request, CallSettings callSettings = null)Lists Instances in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListInstancesRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListInstancesResponseInstance |
A pageable sequence of Instance resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
ListInstancesRequest request = new ListInstancesRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Filter = "",
OrderBy = "",
};
// Make the request
PagedEnumerable<ListInstancesResponse, Instance> response = memorystoreClient.ListInstances(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Instance 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 (ListInstancesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Instance 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<Instance> 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 (Instance 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;
ListInstances(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListInstancesResponse, Instance> ListInstances(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists Instances in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
stringRequired. The parent to list instances from. Format: projects/{project}/locations/{location} |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListInstancesResponseInstance |
A pageable sequence of Instance resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListInstancesResponse, Instance> response = memorystoreClient.ListInstances(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Instance 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 (ListInstancesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Instance 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<Instance> 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 (Instance 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;
ListInstancesAsync(LocationName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListInstancesResponse, Instance> ListInstancesAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists Instances in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
LocationNameRequired. The parent to list instances from. Format: projects/{project}/locations/{location} |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListInstancesResponseInstance |
A pageable asynchronous sequence of Instance resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListInstancesResponse, Instance> response = memorystoreClient.ListInstancesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await foreach (Instance 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 (ListInstancesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Instance 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<Instance> 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 (Instance 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;
ListInstancesAsync(ListInstancesRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListInstancesResponse, Instance> ListInstancesAsync(ListInstancesRequest request, CallSettings callSettings = null)Lists Instances in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListInstancesRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListInstancesResponseInstance |
A pageable asynchronous sequence of Instance resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
ListInstancesRequest request = new ListInstancesRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Filter = "",
OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListInstancesResponse, Instance> response = memorystoreClient.ListInstancesAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await foreach (Instance 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 (ListInstancesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Instance 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<Instance> 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 (Instance 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;
ListInstancesAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListInstancesResponse, Instance> ListInstancesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists Instances in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
stringRequired. The parent to list instances from. Format: projects/{project}/locations/{location} |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListInstancesResponseInstance |
A pageable asynchronous sequence of Instance resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListInstancesResponse, Instance> response = memorystoreClient.ListInstancesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await foreach (Instance 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 (ListInstancesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Instance 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<Instance> 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 (Instance 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(InstanceName, string, int?, CallSettings)
public virtual PagedEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> ListTokenAuthUsers(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists all the token auth users for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
parent |
InstanceNameRequired. The parent to list token auth users from. Format: projects/{project}/locations/{location}/instances/{instance} |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListTokenAuthUsersResponseTokenAuthUser |
A pageable sequence of TokenAuthUser resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
PagedEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> response = memorystoreClient.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 instance.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTokenAuthUsersRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListTokenAuthUsersResponseTokenAuthUser |
A pageable sequence of TokenAuthUser resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
ListTokenAuthUsersRequest request = new ListTokenAuthUsersRequest
{
ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
Filter = "",
OrderBy = "",
};
// Make the request
PagedEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> response = memorystoreClient.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 instance.
| Parameters | |
|---|---|
| Name | Description |
parent |
stringRequired. The parent to list token auth users from. Format: projects/{project}/locations/{location}/instances/{instance} |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListTokenAuthUsersResponseTokenAuthUser |
A pageable sequence of TokenAuthUser resources. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
PagedEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> response = memorystoreClient.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(InstanceName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> ListTokenAuthUsersAsync(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists all the token auth users for a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
parent |
InstanceNameRequired. The parent to list token auth users from. Format: projects/{project}/locations/{location}/instances/{instance} |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListTokenAuthUsersResponseTokenAuthUser |
A pageable asynchronous sequence of TokenAuthUser resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
PagedAsyncEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> response = memorystoreClient.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 instance.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTokenAuthUsersRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListTokenAuthUsersResponseTokenAuthUser |
A pageable asynchronous sequence of TokenAuthUser resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
ListTokenAuthUsersRequest request = new ListTokenAuthUsersRequest
{
ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
Filter = "",
OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> response = memorystoreClient.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 instance.
| Parameters | |
|---|---|
| Name | Description |
parent |
stringRequired. The parent to list token auth users from. Format: projects/{project}/locations/{location}/instances/{instance} |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListTokenAuthUsersResponseTokenAuthUser |
A pageable asynchronous sequence of TokenAuthUser resources. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
PagedAsyncEnumerable<ListTokenAuthUsersResponse, TokenAuthUser> response = memorystoreClient.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 |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf 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 |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf 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<Instance, OperationMetadata> PollOnceAddTokenAuthUser(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of AddTokenAuthUser.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The result of polling the operation. |
PollOnceAddTokenAuthUserAsync(string, CallSettings)
public virtual Task<Operation<Instance, 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 |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A task representing the result of polling the operation. |
PollOnceBackupInstance(string, CallSettings)
public virtual Operation<Instance, OperationMetadata> PollOnceBackupInstance(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of BackupInstance.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The result of polling the operation. |
PollOnceBackupInstanceAsync(string, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> PollOnceBackupInstanceAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
BackupInstance.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A task representing the result of polling the operation. |
PollOnceCreateInstance(string, CallSettings)
public virtual Operation<Instance, OperationMetadata> PollOnceCreateInstance(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of CreateInstance.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The result of polling the operation. |
PollOnceCreateInstanceAsync(string, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> PollOnceCreateInstanceAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
CreateInstance.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
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 |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf 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 |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf 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, OperationMetadata> PollOnceDeleteBackup(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of DeleteBackup.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The result of polling the operation. |
PollOnceDeleteBackupAsync(string, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteBackupAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
DeleteBackup.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A task representing the result of polling the operation. |
PollOnceDeleteInstance(string, CallSettings)
public virtual Operation<Empty, OperationMetadata> PollOnceDeleteInstance(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of DeleteInstance.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The result of polling the operation. |
PollOnceDeleteInstanceAsync(string, CallSettings)
public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteInstanceAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
DeleteInstance.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
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 |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf 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 |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf 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, OperationMetadata> PollOnceExportBackup(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of ExportBackup.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationBackupOperationMetadata |
The result of polling the operation. |
PollOnceExportBackupAsync(string, CallSettings)
public virtual Task<Operation<Backup, OperationMetadata>> PollOnceExportBackupAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
ExportBackup.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupOperationMetadata |
A task representing the result of polling the operation. |
PollOnceFinishMigration(string, CallSettings)
public virtual Operation<Instance, OperationMetadata> PollOnceFinishMigration(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of FinishMigration.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The result of polling the operation. |
PollOnceFinishMigrationAsync(string, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> PollOnceFinishMigrationAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
FinishMigration.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A task representing the result of polling the operation. |
PollOnceRescheduleMaintenance(string, CallSettings)
public virtual Operation<Instance, OperationMetadata> PollOnceRescheduleMaintenance(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of RescheduleMaintenance
.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The result of polling the operation. |
PollOnceRescheduleMaintenanceAsync(string, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> PollOnceRescheduleMaintenanceAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
RescheduleMaintenance.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A task representing the result of polling the operation. |
PollOnceStartMigration(string, CallSettings)
public virtual Operation<Instance, OperationMetadata> PollOnceStartMigration(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of StartMigration.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The result of polling the operation. |
PollOnceStartMigrationAsync(string, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> PollOnceStartMigrationAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
StartMigration.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A task representing the result of polling the operation. |
PollOnceUpdateInstance(string, CallSettings)
public virtual Operation<Instance, OperationMetadata> PollOnceUpdateInstance(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of UpdateInstance.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The result of polling the operation. |
PollOnceUpdateInstanceAsync(string, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> PollOnceUpdateInstanceAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
UpdateInstance.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A task representing the result of polling the operation. |
RescheduleMaintenance(InstanceName, RescheduleType, Timestamp, CallSettings)
public virtual Operation<Instance, OperationMetadata> RescheduleMaintenance(InstanceName name, RescheduleMaintenanceRequest.Types.RescheduleType rescheduleType, Timestamp scheduleTime, CallSettings callSettings = null)Reschedules upcoming maintenance event.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. Name of the instance to reschedule maintenance for:
|
rescheduleType |
RescheduleMaintenanceRequestTypesRescheduleTypeRequired. If reschedule type is SPECIFIC_TIME, schedule_time must be set. |
scheduleTime |
TimestampOptional. Timestamp when the maintenance shall be rescheduled to if
reschedule_type=SPECIFIC_TIME, in RFC 3339 format.
Example: |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
RescheduleMaintenanceRequest.Types.RescheduleType rescheduleType = RescheduleMaintenanceRequest.Types.RescheduleType.Unspecified;
Timestamp scheduleTime = new Timestamp();
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.RescheduleMaintenance(name, rescheduleType, scheduleTime);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceRescheduleMaintenance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
RescheduleMaintenance(RescheduleMaintenanceRequest, CallSettings)
public virtual Operation<Instance, OperationMetadata> RescheduleMaintenance(RescheduleMaintenanceRequest request, CallSettings callSettings = null)Reschedules upcoming maintenance event.
| Parameters | |
|---|---|
| Name | Description |
request |
RescheduleMaintenanceRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
RescheduleMaintenanceRequest request = new RescheduleMaintenanceRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
RescheduleType = RescheduleMaintenanceRequest.Types.RescheduleType.Unspecified,
ScheduleTime = new Timestamp(),
};
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.RescheduleMaintenance(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceRescheduleMaintenance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
RescheduleMaintenance(string, RescheduleType, Timestamp, CallSettings)
public virtual Operation<Instance, OperationMetadata> RescheduleMaintenance(string name, RescheduleMaintenanceRequest.Types.RescheduleType rescheduleType, Timestamp scheduleTime, CallSettings callSettings = null)Reschedules upcoming maintenance event.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Name of the instance to reschedule maintenance for:
|
rescheduleType |
RescheduleMaintenanceRequestTypesRescheduleTypeRequired. If reschedule type is SPECIFIC_TIME, schedule_time must be set. |
scheduleTime |
TimestampOptional. Timestamp when the maintenance shall be rescheduled to if
reschedule_type=SPECIFIC_TIME, in RFC 3339 format.
Example: |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
RescheduleMaintenanceRequest.Types.RescheduleType rescheduleType = RescheduleMaintenanceRequest.Types.RescheduleType.Unspecified;
Timestamp scheduleTime = new Timestamp();
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.RescheduleMaintenance(name, rescheduleType, scheduleTime);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceRescheduleMaintenance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
RescheduleMaintenanceAsync(InstanceName, RescheduleType, Timestamp, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> RescheduleMaintenanceAsync(InstanceName name, RescheduleMaintenanceRequest.Types.RescheduleType rescheduleType, Timestamp scheduleTime, CallSettings callSettings = null)Reschedules upcoming maintenance event.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. Name of the instance to reschedule maintenance for:
|
rescheduleType |
RescheduleMaintenanceRequestTypesRescheduleTypeRequired. If reschedule type is SPECIFIC_TIME, schedule_time must be set. |
scheduleTime |
TimestampOptional. Timestamp when the maintenance shall be rescheduled to if
reschedule_type=SPECIFIC_TIME, in RFC 3339 format.
Example: |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
RescheduleMaintenanceRequest.Types.RescheduleType rescheduleType = RescheduleMaintenanceRequest.Types.RescheduleType.Unspecified;
Timestamp scheduleTime = new Timestamp();
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.RescheduleMaintenanceAsync(name, rescheduleType, scheduleTime);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceRescheduleMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
RescheduleMaintenanceAsync(InstanceName, RescheduleType, Timestamp, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> RescheduleMaintenanceAsync(InstanceName name, RescheduleMaintenanceRequest.Types.RescheduleType rescheduleType, Timestamp scheduleTime, CancellationToken cancellationToken)Reschedules upcoming maintenance event.
| Parameters | |
|---|---|
| Name | Description |
name |
InstanceNameRequired. Name of the instance to reschedule maintenance for:
|
rescheduleType |
RescheduleMaintenanceRequestTypesRescheduleTypeRequired. If reschedule type is SPECIFIC_TIME, schedule_time must be set. |
scheduleTime |
TimestampOptional. Timestamp when the maintenance shall be rescheduled to if
reschedule_type=SPECIFIC_TIME, in RFC 3339 format.
Example: |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
RescheduleMaintenanceRequest.Types.RescheduleType rescheduleType = RescheduleMaintenanceRequest.Types.RescheduleType.Unspecified;
Timestamp scheduleTime = new Timestamp();
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.RescheduleMaintenanceAsync(name, rescheduleType, scheduleTime);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceRescheduleMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
RescheduleMaintenanceAsync(RescheduleMaintenanceRequest, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> RescheduleMaintenanceAsync(RescheduleMaintenanceRequest request, CallSettings callSettings = null)Reschedules upcoming maintenance event.
| Parameters | |
|---|---|
| Name | Description |
request |
RescheduleMaintenanceRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
RescheduleMaintenanceRequest request = new RescheduleMaintenanceRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
RescheduleType = RescheduleMaintenanceRequest.Types.RescheduleType.Unspecified,
ScheduleTime = new Timestamp(),
};
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.RescheduleMaintenanceAsync(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceRescheduleMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
RescheduleMaintenanceAsync(RescheduleMaintenanceRequest, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> RescheduleMaintenanceAsync(RescheduleMaintenanceRequest request, CancellationToken cancellationToken)Reschedules upcoming maintenance event.
| Parameters | |
|---|---|
| Name | Description |
request |
RescheduleMaintenanceRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
RescheduleMaintenanceRequest request = new RescheduleMaintenanceRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
RescheduleType = RescheduleMaintenanceRequest.Types.RescheduleType.Unspecified,
ScheduleTime = new Timestamp(),
};
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.RescheduleMaintenanceAsync(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceRescheduleMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
RescheduleMaintenanceAsync(string, RescheduleType, Timestamp, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> RescheduleMaintenanceAsync(string name, RescheduleMaintenanceRequest.Types.RescheduleType rescheduleType, Timestamp scheduleTime, CallSettings callSettings = null)Reschedules upcoming maintenance event.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Name of the instance to reschedule maintenance for:
|
rescheduleType |
RescheduleMaintenanceRequestTypesRescheduleTypeRequired. If reschedule type is SPECIFIC_TIME, schedule_time must be set. |
scheduleTime |
TimestampOptional. Timestamp when the maintenance shall be rescheduled to if
reschedule_type=SPECIFIC_TIME, in RFC 3339 format.
Example: |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
RescheduleMaintenanceRequest.Types.RescheduleType rescheduleType = RescheduleMaintenanceRequest.Types.RescheduleType.Unspecified;
Timestamp scheduleTime = new Timestamp();
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.RescheduleMaintenanceAsync(name, rescheduleType, scheduleTime);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceRescheduleMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
RescheduleMaintenanceAsync(string, RescheduleType, Timestamp, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> RescheduleMaintenanceAsync(string name, RescheduleMaintenanceRequest.Types.RescheduleType rescheduleType, Timestamp scheduleTime, CancellationToken cancellationToken)Reschedules upcoming maintenance event.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. Name of the instance to reschedule maintenance for:
|
rescheduleType |
RescheduleMaintenanceRequestTypesRescheduleTypeRequired. If reschedule type is SPECIFIC_TIME, schedule_time must be set. |
scheduleTime |
TimestampOptional. Timestamp when the maintenance shall be rescheduled to if
reschedule_type=SPECIFIC_TIME, in RFC 3339 format.
Example: |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
RescheduleMaintenanceRequest.Types.RescheduleType rescheduleType = RescheduleMaintenanceRequest.Types.RescheduleType.Unspecified;
Timestamp scheduleTime = new Timestamp();
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.RescheduleMaintenanceAsync(name, rescheduleType, scheduleTime);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceRescheduleMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance 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. |
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.
StartMigration(StartMigrationRequest, CallSettings)
public virtual Operation<Instance, OperationMetadata> StartMigration(StartMigrationRequest request, CallSettings callSettings = null)Initiates the migration of a source instance to the target Memorystore instance.
After the successful completion of this operation, the target instance will:
- Set up replication with the source instance and replicate any writes to the source instance.
- Only allow reads.
| Parameters | |
|---|---|
| Name | Description |
request |
StartMigrationRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
StartMigrationRequest request = new StartMigrationRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
SelfManagedSource = new SelfManagedSource(),
};
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.StartMigration(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceStartMigration(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
StartMigrationAsync(StartMigrationRequest, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> StartMigrationAsync(StartMigrationRequest request, CallSettings callSettings = null)Initiates the migration of a source instance to the target Memorystore instance.
After the successful completion of this operation, the target instance will:
- Set up replication with the source instance and replicate any writes to the source instance.
- Only allow reads.
| Parameters | |
|---|---|
| Name | Description |
request |
StartMigrationRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
StartMigrationRequest request = new StartMigrationRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
SelfManagedSource = new SelfManagedSource(),
};
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.StartMigrationAsync(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceStartMigrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
StartMigrationAsync(StartMigrationRequest, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> StartMigrationAsync(StartMigrationRequest request, CancellationToken cancellationToken)Initiates the migration of a source instance to the target Memorystore instance.
After the successful completion of this operation, the target instance will:
- Set up replication with the source instance and replicate any writes to the source instance.
- Only allow reads.
| Parameters | |
|---|---|
| Name | Description |
request |
StartMigrationRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
StartMigrationRequest request = new StartMigrationRequest
{
InstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
SelfManagedSource = new SelfManagedSource(),
};
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.StartMigrationAsync(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceStartMigrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
UpdateInstance(Instance, FieldMask, CallSettings)
public virtual Operation<Instance, OperationMetadata> UpdateInstance(Instance instance, FieldMask updateMask, CallSettings callSettings = null)Updates the parameters of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
instance |
InstanceRequired. The instance to update. |
updateMask |
FieldMaskOptional. The list of fields to be updated on the instance. At least one field must be specified. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
Instance instance = new Instance();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.UpdateInstance(instance, updateMask);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceUpdateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
UpdateInstance(UpdateInstanceRequest, CallSettings)
public virtual Operation<Instance, OperationMetadata> UpdateInstance(UpdateInstanceRequest request, CallSettings callSettings = null)Updates the parameters of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceOperationMetadata |
The RPC response. |
// Create client
MemorystoreClient memorystoreClient = MemorystoreClient.Create();
// Initialize request argument(s)
UpdateInstanceRequest request = new UpdateInstanceRequest
{
UpdateMask = new FieldMask(),
Instance = new Instance(),
RequestId = "",
};
// Make the request
Operation<Instance, OperationMetadata> response = memorystoreClient.UpdateInstance(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = memorystoreClient.PollOnceUpdateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
UpdateInstanceAsync(Instance, FieldMask, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> UpdateInstanceAsync(Instance instance, FieldMask updateMask, CallSettings callSettings = null)Updates the parameters of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
instance |
InstanceRequired. The instance to update. |
updateMask |
FieldMaskOptional. The list of fields to be updated on the instance. At least one field must be specified. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
Instance instance = new Instance();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.UpdateInstanceAsync(instance, updateMask);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceUpdateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
UpdateInstanceAsync(Instance, FieldMask, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> UpdateInstanceAsync(Instance instance, FieldMask updateMask, CancellationToken cancellationToken)Updates the parameters of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
instance |
InstanceRequired. The instance to update. |
updateMask |
FieldMaskOptional. The list of fields to be updated on the instance. At least one field must be specified. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
Instance instance = new Instance();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.UpdateInstanceAsync(instance, updateMask);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceUpdateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)
public virtual Task<Operation<Instance, OperationMetadata>> UpdateInstanceAsync(UpdateInstanceRequest request, CallSettings callSettings = null)Updates the parameters of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
UpdateInstanceRequest request = new UpdateInstanceRequest
{
UpdateMask = new FieldMask(),
Instance = new Instance(),
RequestId = "",
};
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.UpdateInstanceAsync(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceUpdateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}
UpdateInstanceAsync(UpdateInstanceRequest, CancellationToken)
public virtual Task<Operation<Instance, OperationMetadata>> UpdateInstanceAsync(UpdateInstanceRequest request, CancellationToken cancellationToken)Updates the parameters of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateInstanceRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceOperationMetadata |
A Task containing the RPC response. |
// Create client
MemorystoreClient memorystoreClient = await MemorystoreClient.CreateAsync();
// Initialize request argument(s)
UpdateInstanceRequest request = new UpdateInstanceRequest
{
UpdateMask = new FieldMask(),
Instance = new Instance(),
RequestId = "",
};
// Make the request
Operation<Instance, OperationMetadata> response = await memorystoreClient.UpdateInstanceAsync(request);
// Poll until the returned long-running operation is complete
Operation<Instance, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance 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<Instance, OperationMetadata> retrievedResponse = await memorystoreClient.PollOnceUpdateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Instance retrievedResult = retrievedResponse.Result;
}