trait CloudRedis[F[_]] extends AnyRef
Configures and manages Cloud Memorystore for Redis instances
Google Cloud Memorystore for Redis v1
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
- Source
- CloudRedis.scala
- Alphabetic
- By Inheritance
- CloudRedis
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def createInstance(request: CreateInstanceRequest, ctx: Headers): F[Operation]
Creates a Redis instance based on the specified tier and memory size.
Creates a Redis instance based on the specified tier and memory size.
By default, the instance is accessible from the project's [default network](https://cloud.google.com/vpc/docs/vpc).
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.
- abstract def deleteInstance(request: DeleteInstanceRequest, ctx: Headers): F[Operation]
Deletes a specific Redis instance.
Deletes a specific Redis instance. Instance stops serving and data is deleted.
- abstract def exportInstance(request: ExportInstanceRequest, ctx: Headers): F[Operation]
Export Redis instance data into a Redis RDB format file in Cloud Storage.
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.
- abstract def failoverInstance(request: FailoverInstanceRequest, ctx: Headers): F[Operation]
Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
- abstract def getInstance(request: GetInstanceRequest, ctx: Headers): F[Instance]
Gets the details of a specific Redis instance.
- abstract def getInstanceAuthString(request: GetInstanceAuthStringRequest, ctx: Headers): F[InstanceAuthString]
Gets the AUTH string for a Redis instance.
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.
- abstract def importInstance(request: ImportInstanceRequest, ctx: Headers): F[Operation]
Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
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.
- abstract def listInstances(request: ListInstancesRequest, ctx: Headers): F[ListInstancesResponse]
Lists all Redis instances owned by a project in either the specified location (region) or all locations.
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_idis specified as-(wildcard), then all regions available to the project are queried, and the results are aggregated. - abstract def rescheduleMaintenance(request: RescheduleMaintenanceRequest, ctx: Headers): F[Operation]
Reschedule maintenance for a given instance in a given project and location.
- abstract def updateInstance(request: UpdateInstanceRequest, ctx: Headers): F[Operation]
Updates the metadata and configuration of a specific Redis instance.
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.
- abstract def upgradeInstance(request: UpgradeInstanceRequest, ctx: Headers): F[Operation]
Upgrades Redis instance to the newer Redis version specified in the request.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()