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)

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)

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)

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)

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)

Bases: proto.enums.Enum

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

Values:

DATA_PROTECTION_MODE_UNSPECIFIED (0):

Defaults to LIMITED_DATA_LOSS if a data protection mode is not specified.

LIMITED_DATA_LOSS (1):

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

FORCE_DATA_LOSS (2):

Instance failover will be performed without data loss control.

class google.cloud.redis_v1.types.GcsDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The Cloud Storage location for the output content

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)

Bases: proto.message.Message

The Cloud Storage location for the input content

uri

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

Type

str

class google.cloud.redis_v1.types.GetInstanceAuthStringRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

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.GetInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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)

Bases: proto.message.Message

The input content

gcs_source

Google Cloud Storage location where input content is located.

This field is a member of oneof source.

Type

google.cloud.redis_v1.types.GcsSource

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

Bases: proto.message.Message

A Memorystore for Redis instance.

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

MutableMapping[str, str]

location_id

Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.

Type

str

alternative_location_id

Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service.

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

• REDIS_6_X for Redis 6.x compatibility

Type

str

reserved_ip_range

Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.

Type

str

secondary_ip_range

Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or “auto”. For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or “auto”.

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 primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance.

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

MutableMapping[str, str]

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

auth_enabled

Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to “true” AUTH is enabled on the instance. Default value is “false” meaning AUTH is disabled.

Type

bool

server_ca_certs

Output only. List of server CA certificates for the instance.

Type

MutableSequence[google.cloud.redis_v1.types.TlsCertificate]

transit_encryption_mode

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.

Type

google.cloud.redis_v1.types.Instance.TransitEncryptionMode

maintenance_policy

Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.

Type

google.cloud.redis_v1.types.MaintenancePolicy

maintenance_schedule

Output only. Date and time of upcoming maintenance events which have been scheduled.

Type

google.cloud.redis_v1.types.MaintenanceSchedule

replica_count

Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.

Type

int

nodes

Output only. Info per node.

Type

MutableSequence[google.cloud.redis_v1.types.NodeInfo]

read_endpoint

Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target ‘host’.

Type

str

read_endpoint_port

Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target ‘port’.

Type

int

read_replicas_mode

Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.

Type

google.cloud.redis_v1.types.Instance.ReadReplicasMode

customer_managed_key

Optional. The KMS key reference that the customer provides when trying to create the instance.

Type

str

persistence_config

Optional. Persistence configuration parameters

Type

google.cloud.redis_v1.types.PersistenceConfig

suspension_reasons

Optional. reasons that causes instance in “SUSPENDED” state.

Type

MutableSequence[google.cloud.redis_v1.types.Instance.SuspensionReason]

maintenance_version

Optional. The self service update maintenance version. The version is date based such as “20210712_00_00”.

Type

str

available_maintenance_versions

Optional. The available maintenance versions that an instance could update to.

Type

MutableSequence[str]

class ConnectMode(value)

Bases: proto.enums.Enum

Available connection modes.

Values:

CONNECT_MODE_UNSPECIFIED (0):

Not set.

DIRECT_PEERING (1):

Connect via direct peering to the Memorystore for Redis hosted service.

PRIVATE_SERVICE_ACCESS (2):

Connect your Memorystore for Redis instance using Private Service Access. Private services access provides an IP address range for multiple Google Cloud services, including Memorystore.

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

Bases: proto.message.Message

class ReadReplicasMode(value)

Bases: proto.enums.Enum

Read replicas mode.

Values:

READ_REPLICAS_MODE_UNSPECIFIED (0):

If not set, Memorystore Redis backend will default to READ_REPLICAS_DISABLED.

READ_REPLICAS_DISABLED (1):

If disabled, read endpoint will not be provided and the instance cannot scale up or down the number of replicas.

READ_REPLICAS_ENABLED (2):

If enabled, read endpoint will be provided and the instance can scale up and down the number of replicas. Not valid for basic tier.

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

Bases: proto.message.Message

class State(value)

Bases: proto.enums.Enum

Represents the different states of a Redis instance.

Values:

STATE_UNSPECIFIED (0):

Not set.

CREATING (1):

Redis instance is being created.

READY (2):

Redis instance has been created and is fully usable.

UPDATING (3):

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

DELETING (4):

Redis instance is being deleted.

REPAIRING (5):

Redis instance is being repaired and may be unusable.

MAINTENANCE (6):

Maintenance is being performed on this Redis instance.

IMPORTING (8):

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

FAILING_OVER (9):

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

class SuspensionReason(value)

Bases: proto.enums.Enum

Possible reasons for the instance to be in a “SUSPENDED” state.

Values:

SUSPENSION_REASON_UNSPECIFIED (0):

Not set.

CUSTOMER_MANAGED_KEY_ISSUE (1):

Something wrong with the CMEK key provided by customer.

class Tier(value)

Bases: proto.enums.Enum

Available service tiers to choose from

Values:

TIER_UNSPECIFIED (0):

Not set.

BASIC (1):

BASIC tier: standalone instance

STANDARD_HA (3):

STANDARD_HA tier: highly available primary/replica instances

class TransitEncryptionMode(value)

Bases: proto.enums.Enum

Available TLS modes.

Values:

TRANSIT_ENCRYPTION_MODE_UNSPECIFIED (0):

Not set.

SERVER_AUTHENTICATION (1):

Client to Server traffic encryption enabled with server authentication.

DISABLED (2):

TLS is disabled for the instance.

class google.cloud.redis_v1.types.InstanceAuthString(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Instance AUTH string details.

auth_string

AUTH string set on the instance.

Type

str

class google.cloud.redis_v1.types.ListInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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 placeholder 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

MutableSequence[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

MutableSequence[str]

class google.cloud.redis_v1.types.LocationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

MutableMapping[str, google.cloud.redis_v1.types.ZoneMetadata]

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

Bases: proto.message.Message

class google.cloud.redis_v1.types.MaintenancePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Maintenance policy for an instance.

create_time

Output only. The time when the policy was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The time when the policy was last updated.

Type

google.protobuf.timestamp_pb2.Timestamp

description

Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.

Type

str

weekly_maintenance_window

Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_window is expected to be one.

Type

MutableSequence[google.cloud.redis_v1.types.WeeklyMaintenanceWindow]

class google.cloud.redis_v1.types.MaintenanceSchedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated.

start_time

Output only. The start time of any upcoming scheduled maintenance for this instance.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. The end time of any upcoming scheduled maintenance for this instance.

Type

google.protobuf.timestamp_pb2.Timestamp

can_reschedule

If the scheduled maintenance can be rescheduled, default is true.

Type

bool

schedule_deadline_time

Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.redis_v1.types.NodeInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Node specific properties.

id

Output only. Node identifying string. e.g. ‘node-0’, ‘node-1’

Type

str

zone

Output only. Location of the node.

Type

str

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

Bases: proto.message.Message

Represents the v1 metadata of the long-running operation.

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)

Bases: proto.message.Message

The output content

gcs_destination

Google Cloud Storage destination for output content.

This field is a member of oneof destination.

Type

google.cloud.redis_v1.types.GcsDestination

class google.cloud.redis_v1.types.PersistenceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration of the persistence functionality.

persistence_mode

Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.

Type

google.cloud.redis_v1.types.PersistenceConfig.PersistenceMode

rdb_snapshot_period

Optional. Period between RDB snapshots. Snapshots will be attempted every period starting from the provided snapshot start time. For example, a start time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45, 18:45, and 00:45 the next day, and so on. If not provided, TWENTY_FOUR_HOURS will be used as default.

Type

google.cloud.redis_v1.types.PersistenceConfig.SnapshotPeriod

rdb_next_snapshot_time

Output only. The next time that a snapshot attempt is scheduled to occur.

Type

google.protobuf.timestamp_pb2.Timestamp

rdb_snapshot_start_time

Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.

Type

google.protobuf.timestamp_pb2.Timestamp

class PersistenceMode(value)

Bases: proto.enums.Enum

Available Persistence modes.

Values:

PERSISTENCE_MODE_UNSPECIFIED (0):

Not set.

DISABLED (1):

Persistence is disabled for the instance, and any existing snapshots are deleted.

RDB (2):

RDB based Persistence is enabled.

class SnapshotPeriod(value)

Bases: proto.enums.Enum

Available snapshot periods for scheduling.

Values:

SNAPSHOT_PERIOD_UNSPECIFIED (0):

Not set.

ONE_HOUR (3):

Snapshot every 1 hour.

SIX_HOURS (4):

Snapshot every 6 hours.

TWELVE_HOURS (5):

Snapshot every 12 hours.

TWENTY_FOUR_HOURS (6):

Snapshot every 24 hours.

class google.cloud.redis_v1.types.RescheduleMaintenanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

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

reschedule_type

Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.

Type

google.cloud.redis_v1.types.RescheduleMaintenanceRequest.RescheduleType

schedule_time

Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Type

google.protobuf.timestamp_pb2.Timestamp

class RescheduleType(value)

Bases: proto.enums.Enum

Reschedule options.

Values:

RESCHEDULE_TYPE_UNSPECIFIED (0):

Not set.

IMMEDIATE (1):

If the user wants to schedule the maintenance to happen now.

NEXT_AVAILABLE_WINDOW (2):

If the user wants to use the existing maintenance policy to find the next available window.

SPECIFIC_TIME (3):

If the user wants to reschedule the maintenance to a specific time.

class google.cloud.redis_v1.types.TlsCertificate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

TlsCertificate Resource

serial_number

Serial number, as extracted from the certificate.

Type

str

cert

PEM representation.

Type

str

create_time

Output only. The time when the certificate was created in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.

Type

google.protobuf.timestamp_pb2.Timestamp

expire_time

Output only. The time when the certificate expires in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.

Type

google.protobuf.timestamp_pb2.Timestamp

sha1_fingerprint

Sha1 Fingerprint of the certificate.

Type

str

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

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

• replica_count

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)

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.WeeklyMaintenanceWindow(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Time window in which disruptive maintenance updates occur. Non-disruptive updates can occur inside or outside this window.

day

Required. The day of week that maintenance updates occur.

Type

google.type.dayofweek_pb2.DayOfWeek

start_time

Required. Start time of the window in UTC time.

Type

google.type.timeofday_pb2.TimeOfDay

duration

Output only. Duration of the maintenance window. The current window is fixed at 1 hour.

Type

google.protobuf.duration_pb2.Duration

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

Bases: proto.message.Message

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