Show / Hide Table of Contents

Namespace Google.Apis.CloudRedis.v1

Classes

CloudRedisBaseServiceRequest<TResponse>

A base abstract class for CloudRedis requests.

CloudRedisService

The CloudRedis Service.

CloudRedisService.Scope

Available OAuth 2.0 scopes for use with the Google Cloud Memorystore for Redis API.

CloudRedisService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Google Cloud Memorystore for Redis API.

ProjectsResource

The "projects" collection of methods.

ProjectsResource.LocationsResource

The "locations" collection of methods.

ProjectsResource.LocationsResource.AclPoliciesResource

The "aclPolicies" collection of methods.

ProjectsResource.LocationsResource.AclPoliciesResource.CreateRequest

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

ProjectsResource.LocationsResource.AclPoliciesResource.DeleteRequest

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

ProjectsResource.LocationsResource.AclPoliciesResource.GetRequest

Gets the details of a specific Redis Cluster ACL Policy.

ProjectsResource.LocationsResource.AclPoliciesResource.ListRequest

Lists all ACL Policies owned by a project in either the specified location (region) or all locations. The location should have the following format: * projects/{project_id}/locations/{location_id} If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

ProjectsResource.LocationsResource.AclPoliciesResource.PatchRequest

Updates the ACL policy. The operation applies the updated ACL policy to all of the linked clusters. If Memorystore can apply the policy to all clusters, then the operation returns a SUCCESS status. If Memorystore can't apply the policy to all clusters, then to ensure eventual consistency, Memorystore uses reconciliation to apply the policy to the failed clusters. Completed longrunning.Operation will contain the new ACL Policy object in the response field.

ProjectsResource.LocationsResource.BackupCollectionsResource

The "backupCollections" collection of methods.

ProjectsResource.LocationsResource.BackupCollectionsResource.BackupsResource

The "backups" collection of methods.

ProjectsResource.LocationsResource.BackupCollectionsResource.BackupsResource.DeleteRequest

Deletes a specific backup.

ProjectsResource.LocationsResource.BackupCollectionsResource.BackupsResource.ExportRequest

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

ProjectsResource.LocationsResource.BackupCollectionsResource.BackupsResource.GetRequest

Gets the details of a specific backup.

ProjectsResource.LocationsResource.BackupCollectionsResource.BackupsResource.ListRequest

Lists all backups owned by a backup collection.

ProjectsResource.LocationsResource.BackupCollectionsResource.GetRequest

Get a backup collection.

ProjectsResource.LocationsResource.BackupCollectionsResource.ListRequest

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.

ProjectsResource.LocationsResource.ClustersResource

The "clusters" collection of methods.

ProjectsResource.LocationsResource.ClustersResource.AddTokenAuthUserRequest

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

ProjectsResource.LocationsResource.ClustersResource.BackupRequest

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

ProjectsResource.LocationsResource.ClustersResource.CreateRequest

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

ProjectsResource.LocationsResource.ClustersResource.DeleteRequest

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

ProjectsResource.LocationsResource.ClustersResource.GetCertificateAuthorityRequest

Gets the details of certificate authority information for Redis cluster.

ProjectsResource.LocationsResource.ClustersResource.GetRequest

Gets the details of a specific Redis cluster.

ProjectsResource.LocationsResource.ClustersResource.ListRequest

Lists all Redis clusters owned by a project in either the specified location (region) or all locations. The location should have the following format: * projects/{project_id}/locations/{location_id} If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

ProjectsResource.LocationsResource.ClustersResource.PatchRequest

Updates the metadata and configuration of a specific Redis cluster. Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

ProjectsResource.LocationsResource.ClustersResource.RescheduleClusterMaintenanceRequest

Reschedules upcoming maintenance event.

ProjectsResource.LocationsResource.ClustersResource.TokenAuthUsersResource

The "tokenAuthUsers" collection of methods.

ProjectsResource.LocationsResource.ClustersResource.TokenAuthUsersResource.AddAuthTokenRequest

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

ProjectsResource.LocationsResource.ClustersResource.TokenAuthUsersResource.AuthTokensResource

The "authTokens" collection of methods.

ProjectsResource.LocationsResource.ClustersResource.TokenAuthUsersResource.AuthTokensResource.DeleteRequest

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

ProjectsResource.LocationsResource.ClustersResource.TokenAuthUsersResource.AuthTokensResource.GetRequest

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

ProjectsResource.LocationsResource.ClustersResource.TokenAuthUsersResource.AuthTokensResource.ListRequest

Lists all the auth tokens for a specific token auth user.

ProjectsResource.LocationsResource.ClustersResource.TokenAuthUsersResource.DeleteRequest

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

ProjectsResource.LocationsResource.ClustersResource.TokenAuthUsersResource.GetRequest

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

ProjectsResource.LocationsResource.ClustersResource.TokenAuthUsersResource.ListRequest

Lists all the token auth users for a token based auth enabled cluster.

ProjectsResource.LocationsResource.GetRequest

Gets information about a location.

ProjectsResource.LocationsResource.GetSharedRegionalCertificateAuthorityRequest

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

ProjectsResource.LocationsResource.InstancesResource

The "instances" collection of methods.

ProjectsResource.LocationsResource.InstancesResource.CreateRequest

Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's default network. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

ProjectsResource.LocationsResource.InstancesResource.DeleteRequest

Deletes a specific Redis instance. Instance stops serving and data is deleted.

ProjectsResource.LocationsResource.InstancesResource.ExportRequest

Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

ProjectsResource.LocationsResource.InstancesResource.FailoverRequest

Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

ProjectsResource.LocationsResource.InstancesResource.GetAuthStringRequest

Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.

ProjectsResource.LocationsResource.InstancesResource.GetRequest

Gets the details of a specific Redis instance.

ProjectsResource.LocationsResource.InstancesResource.ImportRequest

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

ProjectsResource.LocationsResource.InstancesResource.ListRequest

Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * projects/{project_id}/locations/{location_id} If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

ProjectsResource.LocationsResource.InstancesResource.PatchRequest

Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

ProjectsResource.LocationsResource.InstancesResource.RescheduleMaintenanceRequest

Reschedule maintenance for a given instance in a given project and location.

ProjectsResource.LocationsResource.InstancesResource.UpgradeRequest

Upgrades Redis instance to the newer Redis version specified in the request.

ProjectsResource.LocationsResource.ListRequest

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

ProjectsResource.LocationsResource.OperationsResource

The "operations" collection of methods.

ProjectsResource.LocationsResource.OperationsResource.CancelRequest

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

ProjectsResource.LocationsResource.OperationsResource.DeleteRequest

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

ProjectsResource.LocationsResource.OperationsResource.GetRequest

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

ProjectsResource.LocationsResource.OperationsResource.ListRequest

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Enums

CloudRedisBaseServiceRequest<TResponse>.AltEnum

Data format for response.

CloudRedisBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.

In this article
Back to top Generated by DocFX