As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Redis v1 API

class google.cloud.redis_v1.types.CreateInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for [CreateInstance][google.cloud.redis.v1.CloudRedis.CreateInstance].

parent

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.

Type

str

instance_id

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

Type

str

instance

Required. A Redis [Instance] resource

Type

google.cloud.redis_v1.types.Instance

class google.cloud.redis_v1.types.DeleteInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for [DeleteInstance][google.cloud.redis.v1.CloudRedis.DeleteInstance].

name

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.

Type

str

class google.cloud.redis_v1.types.ExportInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for [Export][google.cloud.redis.v1.CloudRedis.ExportInstance].

name

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.

Type

str

output_config

Required. Specify data to be exported.

Type

google.cloud.redis_v1.types.OutputConfig

class google.cloud.redis_v1.types.FailoverInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for [Failover][google.cloud.redis.v1.CloudRedis.FailoverInstance].

name

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.

Type

str

data_protection_mode

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

Type

google.cloud.redis_v1.types.FailoverInstanceRequest.DataProtectionMode

class DataProtectionMode(value)[source]

Bases: proto.enums.Enum

Specifies different modes of operation in relation to the data retention.

DATA_PROTECTION_MODE_UNSPECIFIED = 0
FORCE_DATA_LOSS = 2
LIMITED_DATA_LOSS = 1
class google.cloud.redis_v1.types.GcsDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The Cloud Storage location for the output content .. attribute:: uri

Required. Data destination URI (e.g. ‘gs://my_bucket/my_object’). Existing files will be overwritten.

type

str

class google.cloud.redis_v1.types.GcsSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The Cloud Storage location for the input content .. attribute:: uri

Required. Source data URI. (e.g. ‘gs://my_bucket/my_object’).

type

str

class google.cloud.redis_v1.types.GetInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for [GetInstance][google.cloud.redis.v1.CloudRedis.GetInstance].

name

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.

Type

str

class google.cloud.redis_v1.types.ImportInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for [Import][google.cloud.redis.v1.CloudRedis.ImportInstance].

name

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.

Type

str

input_config

Required. Specify data to be imported.

Type

google.cloud.redis_v1.types.InputConfig

class google.cloud.redis_v1.types.InputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The input content .. attribute:: gcs_source

Google Cloud Storage location where input content is located.

type

google.cloud.redis_v1.types.GcsSource

class google.cloud.redis_v1.types.Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A Google Cloud Redis instance. .. attribute:: name

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][google.cloud.redis.v1.Instance.location_id] and [alternative_location_id][google.cloud.redis.v1.Instance.alternative_location_id] fields for more details.

type

str

display_name

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

Type

str

labels

Resource labels to represent user provided metadata

Type

Sequence[google.cloud.redis_v1.types.Instance.LabelsEntry]

location_id

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][google.cloud.redis.v1.Instance.alternative_location_id] is also provided, it must be different from [location_id][google.cloud.redis.v1.Instance.location_id].

Type

str

alternative_location_id

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][google.cloud.redis.v1.Instance.location_id].

Type

str

redis_version

Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are:

  • REDIS_3_2 for Redis 3.2 compatibility

  • REDIS_4_0 for Redis 4.0 compatibility (default)

  • REDIS_5_0 for Redis 5.0 compatibility

Type

str

reserved_ip_range

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.

Type

str

host

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

Type

str

port

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

Type

int

current_location_id

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][google.cloud.redis.v1.Instance.location_id] provided by the user at creation time. For Standard Tier instances, this can be either [location_id][google.cloud.redis.v1.Instance.location_id] or [alternative_location_id][google.cloud.redis.v1.Instance.alternative_location_id] and can change after a failover event.

Type

str

create_time

Output only. The time the instance was created.

Type

google.protobuf.timestamp_pb2.Timestamp

state

Output only. The current state of this instance.

Type

google.cloud.redis_v1.types.Instance.State

status_message

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

Type

str

redis_configs

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

Redis version 3.2 and newer:

  • maxmemory-policy

  • notify-keyspace-events

Redis version 4.0 and newer:

  • activedefrag

  • lfu-decay-time

  • lfu-log-factor

  • maxmemory-gb

Redis version 5.0 and newer:

  • stream-node-max-bytes

  • stream-node-max-entries

Type

Sequence[google.cloud.redis_v1.types.Instance.RedisConfigsEntry]

tier

Required. The service tier of the instance.

Type

google.cloud.redis_v1.types.Instance.Tier

memory_size_gb

Required. Redis memory size in GiB.

Type

int

authorized_network

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.

Type

str

persistence_iam_identity

Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is “serviceAccount:<service_account_email>”. The value may change over time for a given instance so should be checked before each import/export operation.

Type

str

connect_mode

Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.

Type

google.cloud.redis_v1.types.Instance.ConnectMode

class ConnectMode(value)[source]

Bases: proto.enums.Enum

Available connection modes.

CONNECT_MODE_UNSPECIFIED = 0
DIRECT_PEERING = 1
PRIVATE_SERVICE_ACCESS = 2
class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class RedisConfigsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class State(value)[source]

Bases: proto.enums.Enum

Represents the different states of a Redis instance.

CREATING = 1
DELETING = 4
FAILING_OVER = 9
IMPORTING = 8
MAINTENANCE = 6
READY = 2
REPAIRING = 5
STATE_UNSPECIFIED = 0
UPDATING = 3
class Tier(value)[source]

Bases: proto.enums.Enum

Available service tiers to choose from

BASIC = 1
STANDARD_HA = 3
TIER_UNSPECIFIED = 0
class google.cloud.redis_v1.types.ListInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances].

parent

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.

Type

str

page_size

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][google.cloud.redis.v1.ListInstancesResponse.next_page_token] to determine if there are more instances left to be queried.

Type

int

page_token

The next_page_token value returned from a previous [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances] request, if any.

Type

str

class google.cloud.redis_v1.types.ListInstancesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances].

instances

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”.

Type

Sequence[google.cloud.redis_v1.types.Instance]

next_page_token

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

Type

str

unreachable

Locations that could not be reached.

Type

Sequence[str]

property raw_page
class google.cloud.redis_v1.types.LocationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

available_zones

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.

Type

Sequence[google.cloud.redis_v1.types.LocationMetadata.AvailableZonesEntry]

class AvailableZonesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.redis_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the v1 metadata of the long-running operation. .. attribute:: create_time

Creation timestamp.

type

google.protobuf.timestamp_pb2.Timestamp

end_time

End timestamp.

Type

google.protobuf.timestamp_pb2.Timestamp

target

Operation target.

Type

str

verb

Operation verb.

Type

str

status_detail

Operation status details.

Type

str

cancel_requested

Specifies if cancellation was requested for the operation.

Type

bool

api_version

API version.

Type

str

class google.cloud.redis_v1.types.OutputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The output content .. attribute:: gcs_destination

Google Cloud Storage destination for output content.

type

google.cloud.redis_v1.types.GcsDestination

class google.cloud.redis_v1.types.UpdateInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for [UpdateInstance][google.cloud.redis.v1.CloudRedis.UpdateInstance].

update_mask

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][google.cloud.redis.v1.Instance]:

  • displayName

  • labels

  • memorySizeGb

  • redisConfig

Type

google.protobuf.field_mask_pb2.FieldMask

instance

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

Type

google.cloud.redis_v1.types.Instance

class google.cloud.redis_v1.types.UpgradeInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for [UpgradeInstance][google.cloud.redis.v1.CloudRedis.UpgradeInstance].

name

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.

Type

str

redis_version

Required. Specifies the target version of Redis software to upgrade to.

Type

str

class google.cloud.redis_v1.types.ZoneMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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