@Generated("by gapic-generator-java")
Package com.google.cloud.redis.v1beta1
A client to Google Cloud Memorystore for Redis API
The interfaces provided are listed below, along with usage samples.
======================= CloudRedisClient =======================
Service Description: Configures and manages Cloud Memorystore for Redis instances
Google Cloud Memorystore for Redis v1beta1
The `redis.googleapis.com` service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis instances:
- The service works with a collection of cloud projects, named: `/projects/*`
- Each project has a collection of available locations, named: `/locations/*`
- Each location has a collection of Redis instances, named: `/instances/*`
- As such, Redis instances are resources of the form: `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
Note that location_id must be referring to a GCP `region`; for example:
- `projects/redpepper-1290/locations/us-central1/instances/my-redis`
Sample for CloudRedisClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
Instance response = cloudRedisClient.getInstance(name);
}
-
Interface Summary Interface Description CloudRedisGrpc.AsyncService Configures and manages Cloud Memorystore for Redis instances Google Cloud Memorystore for Redis v1beta1 The `redis.googleapis.com` service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis instances: * The service works with a collection of cloud projects, named: `/projects/*` * Each project has a collection of available locations, named: `/locations/*` * Each location has a collection of Redis instances, named: `/instances/*` * As such, Redis instances are resources of the form: `/projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note that location_id must be referring to a GCP `region`; for example: * `projects/redpepper-1290/locations/us-central1/instances/my-redis`CreateInstanceRequestOrBuilder DeleteInstanceRequestOrBuilder ExportInstanceRequestOrBuilder FailoverInstanceRequestOrBuilder GcsDestinationOrBuilder GcsSourceOrBuilder GetInstanceAuthStringRequestOrBuilder GetInstanceRequestOrBuilder ImportInstanceRequestOrBuilder InputConfigOrBuilder InstanceAuthStringOrBuilder InstanceOrBuilder ListInstancesRequestOrBuilder ListInstancesResponseOrBuilder LocationMetadataOrBuilder MaintenancePolicyOrBuilder MaintenanceScheduleOrBuilder NodeInfoOrBuilder OutputConfigOrBuilder PersistenceConfigOrBuilder RescheduleMaintenanceRequestOrBuilder TlsCertificateOrBuilder UpdateInstanceRequestOrBuilder UpgradeInstanceRequestOrBuilder WeeklyMaintenanceWindowOrBuilder ZoneMetadataOrBuilder -
Class Summary Class Description CloudRedisClient Service Description: Configures and manages Cloud Memorystore for Redis instancesCloudRedisClient.ListInstancesFixedSizeCollection CloudRedisClient.ListInstancesPage CloudRedisClient.ListInstancesPagedResponse CloudRedisGrpc Configures and manages Cloud Memorystore for Redis instances Google Cloud Memorystore for Redis v1beta1 The `redis.googleapis.com` service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis instances: * The service works with a collection of cloud projects, named: `/projects/*` * Each project has a collection of available locations, named: `/locations/*` * Each location has a collection of Redis instances, named: `/instances/*` * As such, Redis instances are resources of the form: `/projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note that location_id must be referring to a GCP `region`; for example: * `projects/redpepper-1290/locations/us-central1/instances/my-redis`CloudRedisGrpc.CloudRedisBlockingStub A stub to allow clients to do synchronous rpc calls to service CloudRedis.CloudRedisGrpc.CloudRedisFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service CloudRedis.CloudRedisGrpc.CloudRedisImplBase Base class for the server implementation of the service CloudRedis.CloudRedisGrpc.CloudRedisStub A stub to allow clients to do asynchronous rpc calls to service CloudRedis.CloudRedisServiceBetaProto CloudRedisSettings Settings class to configure an instance ofCloudRedisClient
.CloudRedisSettings.Builder Builder for CloudRedisSettings.CreateInstanceRequest Request for [CreateInstance][google.cloud.redis.v1beta1.CloudRedis.CreateInstance].CreateInstanceRequest.Builder Request for [CreateInstance][google.cloud.redis.v1beta1.CloudRedis.CreateInstance].DeleteInstanceRequest Request for [DeleteInstance][google.cloud.redis.v1beta1.CloudRedis.DeleteInstance].DeleteInstanceRequest.Builder Request for [DeleteInstance][google.cloud.redis.v1beta1.CloudRedis.DeleteInstance].ExportInstanceRequest Request for [Export][google.cloud.redis.v1beta1.CloudRedis.ExportInstance].ExportInstanceRequest.Builder Request for [Export][google.cloud.redis.v1beta1.CloudRedis.ExportInstance].FailoverInstanceRequest Request for [Failover][google.cloud.redis.v1beta1.CloudRedis.FailoverInstance].FailoverInstanceRequest.Builder Request for [Failover][google.cloud.redis.v1beta1.CloudRedis.FailoverInstance].GcsDestination The Cloud Storage location for the output contentGcsDestination.Builder The Cloud Storage location for the output contentGcsSource The Cloud Storage location for the input contentGcsSource.Builder The Cloud Storage location for the input contentGetInstanceAuthStringRequest Request for [GetInstanceAuthString][google.cloud.redis.v1beta1.CloudRedis.GetInstanceAuthString].GetInstanceAuthStringRequest.Builder Request for [GetInstanceAuthString][google.cloud.redis.v1beta1.CloudRedis.GetInstanceAuthString].GetInstanceRequest Request for [GetInstance][google.cloud.redis.v1beta1.CloudRedis.GetInstance].GetInstanceRequest.Builder Request for [GetInstance][google.cloud.redis.v1beta1.CloudRedis.GetInstance].ImportInstanceRequest Request for [Import][google.cloud.redis.v1beta1.CloudRedis.ImportInstance].ImportInstanceRequest.Builder Request for [Import][google.cloud.redis.v1beta1.CloudRedis.ImportInstance].InputConfig The input contentInputConfig.Builder The input contentInstance A Memorystore for Redis instance.Instance.Builder A Memorystore for Redis instance.InstanceAuthString Instance AUTH string details.InstanceAuthString.Builder Instance AUTH string details.InstanceName InstanceName.Builder Builder for projects/{project}/locations/{location}/instances/{instance}.ListInstancesRequest Request for [ListInstances][google.cloud.redis.v1beta1.CloudRedis.ListInstances].ListInstancesRequest.Builder Request for [ListInstances][google.cloud.redis.v1beta1.CloudRedis.ListInstances].ListInstancesResponse Response for [ListInstances][google.cloud.redis.v1beta1.CloudRedis.ListInstances].ListInstancesResponse.Builder Response for [ListInstances][google.cloud.redis.v1beta1.CloudRedis.ListInstances].LocationMetadata This location metadata represents additional configuration options for a given location where a Redis instance may be created.LocationMetadata.Builder This location metadata represents additional configuration options for a given location where a Redis instance may be created.LocationName LocationName.Builder Builder for projects/{project}/locations/{location}.MaintenancePolicy Maintenance policy for an instance.MaintenancePolicy.Builder Maintenance policy for an instance.MaintenanceSchedule Upcoming maintenance schedule.MaintenanceSchedule.Builder Upcoming maintenance schedule.NodeInfo Node specific properties.NodeInfo.Builder Node specific properties.OutputConfig The output contentOutputConfig.Builder The output contentPersistenceConfig Configuration of the persistence functionality.PersistenceConfig.Builder Configuration of the persistence functionality.RescheduleMaintenanceRequest Request for [RescheduleMaintenance][google.cloud.redis.v1beta1.CloudRedis.RescheduleMaintenance].RescheduleMaintenanceRequest.Builder Request for [RescheduleMaintenance][google.cloud.redis.v1beta1.CloudRedis.RescheduleMaintenance].TlsCertificate TlsCertificate ResourceTlsCertificate.Builder TlsCertificate ResourceUpdateInstanceRequest Request for [UpdateInstance][google.cloud.redis.v1beta1.CloudRedis.UpdateInstance].UpdateInstanceRequest.Builder Request for [UpdateInstance][google.cloud.redis.v1beta1.CloudRedis.UpdateInstance].UpgradeInstanceRequest Request for [UpgradeInstance][google.cloud.redis.v1beta1.CloudRedis.UpgradeInstance].UpgradeInstanceRequest.Builder Request for [UpgradeInstance][google.cloud.redis.v1beta1.CloudRedis.UpgradeInstance].WeeklyMaintenanceWindow Time window in which disruptive maintenance updates occur.WeeklyMaintenanceWindow.Builder Time window in which disruptive maintenance updates occur.ZoneMetadata Defines specific information for a particular zone.ZoneMetadata.Builder Defines specific information for a particular zone. -
Enum Summary Enum Description FailoverInstanceRequest.DataProtectionMode Specifies different modes of operation in relation to the data retention.InputConfig.SourceCase Instance.ConnectMode Available connection modes.Instance.ReadReplicasMode Read replicas mode.Instance.State Represents the different states of a Redis instance.Instance.Tier Available service tiers to choose fromInstance.TransitEncryptionMode Available TLS modes.OutputConfig.DestinationCase PersistenceConfig.PersistenceMode Available Persistence modes.PersistenceConfig.SnapshotPeriod Available snapshot periods for scheduling.RescheduleMaintenanceRequest.RescheduleType Reschedule options.