Enumerations

DataProtectionMode

static

number

Value

DATA_PROTECTION_MODE_UNSPECIFIED

LIMITED_DATA_LOSS

Instance failover will be protected with data loss control. More specifically, the failover will only be performed if the current replication offset diff between master and replica is under a certain threshold.

FORCE_DATA_LOSS

Instance failover will be performed without data loss control.

State

static

number

Represents the different states of a Redis instance.

Value

STATE_UNSPECIFIED

Not set.

CREATING

Redis instance is being created.

READY

Redis instance has been created and is fully usable.

UPDATING

Redis instance configuration is being updated. Certain kinds of updates may cause the instance to become unusable while the update is in progress.

DELETING

Redis instance is being deleted.

REPAIRING

Redis instance is being repaired and may be unusable.

MAINTENANCE

Maintenance is being performed on this Redis instance.

IMPORTING

Redis instance is importing data (availability may be affected).

FAILING_OVER

Redis instance is failing over (availability may be affected).

Tier

static

number

Available service tiers to choose from

Value

TIER_UNSPECIFIED

Not set.

BASIC

BASIC tier: standalone instance

STANDARD_HA

STANDARD_HA tier: highly available primary/replica instances

Properties

DataProtectionMode

static

number

Value

DATA_PROTECTION_MODE_UNSPECIFIED

LIMITED_DATA_LOSS

Instance failover will be protected with data loss control. More specifically, the failover will only be performed if the current replication offset diff between master and replica is under a certain threshold.

FORCE_DATA_LOSS

Instance failover will be performed without data loss control.

State

static

number

Represents the different states of a Redis instance.

Value

STATE_UNSPECIFIED

Not set.

CREATING

Redis instance is being created.

READY

Redis instance has been created and is fully usable.

UPDATING

Redis instance configuration is being updated. Certain kinds of updates may cause the instance to become unusable while the update is in progress.

DELETING

Redis instance is being deleted.

REPAIRING

Redis instance is being repaired and may be unusable.

MAINTENANCE

Maintenance is being performed on this Redis instance.

IMPORTING

Redis instance is importing data (availability may be affected).

FAILING_OVER

Redis instance is failing over (availability may be affected).

Tier

static

number

Available service tiers to choose from

Value

TIER_UNSPECIFIED

Not set.

BASIC

BASIC tier: standalone instance

STANDARD_HA

STANDARD_HA tier: highly available primary/replica instances

Abstract types

CreateInstanceRequest

static

Request for CreateInstance.

Properties

Parameter

parent

string

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

instanceId

string

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

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

instance

Object

Required. A Redis resource

This object should have the same structure as [Instance]Instance

See also

google.cloud.redis.v1beta1.CreateInstanceRequest definition in proto format

DeleteInstanceRequest

static

Request for DeleteInstance.

Property

Parameter

name

string

Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region

See also

google.cloud.redis.v1beta1.DeleteInstanceRequest definition in proto format

FailoverInstanceRequest

static

Request for Failover.

Properties

Parameter

name

string

Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region

dataProtectionMode

number

Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default.

The number should be among the values of DataProtectionMode

See also

google.cloud.redis.v1beta1.FailoverInstanceRequest definition in proto format

GetInstanceRequest

static

Request for GetInstance.

Property

Parameter

name

string

Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region

See also

google.cloud.redis.v1beta1.GetInstanceRequest definition in proto format

Instance

static

A Google Cloud Redis instance.

Properties

Parameter

name

string

Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id}

Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details.

displayName

string

An arbitrary and optional user-provided name for the instance.

labels

Object with string properties

Resource labels to represent user provided metadata

locationId

string

Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternative_location_id] is also provided, it must be different from [location_id].

alternativeLocationId

string

Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [location_id].

redisVersion

string

Optional. The version of Redis software. If not provided, latest supported version will be used. Updating the version will perform an upgrade/downgrade to the new version. Currently, the supported values are:

  • REDIS_4_0 for Redis 4.0 compatibility
  • REDIS_3_2 for Redis 3.2 compatibility (default)

reservedIpRange

string

Optional. The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.

host

string

Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

port

number

Output only. The port number of the exposed Redis endpoint.

currentLocationId

string

Output only. The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [location_id] provided by the user at creation time. For Standard Tier instances, this can be either [location_id] or [alternative_location_id] and can change after a failover event.

createTime

Object

Output only. The time the instance was created.

This object should have the same structure as Timestamp

state

number

Output only. The current state of this instance.

The number should be among the values of State

statusMessage

string

Output only. Additional information about the current status of this instance, if available.

redisConfigs

Object with string properties

Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are:

Redis 3.2 and above:

  • maxmemory-policy
  • notify-keyspace-events

    Redis 4.0 and above:

  • activedefrag

  • lfu-log-factor
  • lfu-decay-time

tier

number

Required. The service tier of the instance.

The number should be among the values of Tier

memorySizeGb

number

Required. Redis memory size in GiB.

authorizedNetwork

string

Optional. The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.

See also

google.cloud.redis.v1beta1.Instance definition in proto format

ListInstancesRequest

static

Request for ListInstances.

Properties

Parameter

parent

string

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

pageSize

number

The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.

pageToken

string

The next_page_token value returned from a previous List request, if any.

See also

google.cloud.redis.v1beta1.ListInstancesRequest definition in proto format

ListInstancesResponse

static

Response for ListInstances.

Properties

Parameter

instances

Array of Object

A list of Redis instances in the project in the specified location, or across all locations.

If the location_id in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a dummy Redis entry is included in the response with the "name" field set to a value of the form projects/{project_id}/locations/{location_id}/instances/- and the "status" field set to ERROR and "status_message" field set to "location not available for ListInstances".

This object should have the same structure as Instance

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

unreachable

Array of string

Locations that could not be reached.

See also

google.cloud.redis.v1beta1.ListInstancesResponse definition in proto format

LocationMetadata

static

This location metadata represents additional configuration options for a given location where a Redis instance may be created. All fields are output only. It is returned as content of the google.cloud.location.Location.metadata field.

Property

Parameter

availableZones

Object with Object properties

Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by GCE. These keys can be specified in location_id or alternative_location_id fields when creating a Redis instance.

See also

google.cloud.redis.v1beta1.LocationMetadata definition in proto format

UpdateInstanceRequest

static

Request for UpdateInstance.

Properties

Parameter

updateMask

Object

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Instance:

  • displayName
  • labels
  • memorySizeGb
  • redisConfig

    This object should have the same structure as FieldMask

instance

Object

Required. Update description. Only fields specified in update_mask are updated.

This object should have the same structure as Instance

See also

google.cloud.redis.v1beta1.UpdateInstanceRequest definition in proto format

ZoneMetadata

static

Defines specific information for a particular zone. Currently empty and reserved for future use only.

See also

google.cloud.redis.v1beta1.ZoneMetadata definition in proto format