Types for Google Cloud Memorystore for Redis API Client#
-
class
google.cloud.redis_v1beta1.types.
Any
# -
type_url
# Field google.protobuf.Any.type_url
-
value
# Field google.protobuf.Any.value
-
-
class
google.cloud.redis_v1beta1.types.
CancelOperationRequest
# -
name
# Field google.longrunning.CancelOperationRequest.name
-
-
class
google.cloud.redis_v1beta1.types.
CreateInstanceRequest
# Request for [CreateInstance][google.cloud.redis.v1beta1.CloudRedis.CreateInstance].
-
parent
# Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
wherelocation_id
refers to a GCP region.
-
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
-
instance
# Required. A Redis [Instance] resource
-
instance
Field google.cloud.redis.v1beta1.CreateInstanceRequest.instance
-
instance_id
Field google.cloud.redis.v1beta1.CreateInstanceRequest.instance_id
-
parent
Field google.cloud.redis.v1beta1.CreateInstanceRequest.parent
-
-
class
google.cloud.redis_v1beta1.types.
DeleteInstanceRequest
# Request for [DeleteInstance][google.cloud.redis.v1beta1.CloudRedis.DeleteInstance].
-
name
# Required. Redis instance resource name using the form:
proje cts/{project_id}/locations/{location_id}/instances/{instance_i d}
wherelocation_id
refers to a GCP region.
-
name
Field google.cloud.redis.v1beta1.DeleteInstanceRequest.name
-
-
class
google.cloud.redis_v1beta1.types.
DeleteOperationRequest
# -
name
# Field google.longrunning.DeleteOperationRequest.name
-
-
class
google.cloud.redis_v1beta1.types.
ExportInstanceRequest
# Request for [Export][google.cloud.redis.v1beta1.CloudRedis.ExportInstance].
-
name
# Required. Redis instance resource name using the form:
proje cts/{project_id}/locations/{location_id}/instances/{instance_i d}
wherelocation_id
refers to a GCP region.
-
output_config
# Required. Specify data to be exported.
-
name
Field google.cloud.redis.v1beta1.ExportInstanceRequest.name
-
output_config
Field google.cloud.redis.v1beta1.ExportInstanceRequest.output_config
-
-
class
google.cloud.redis_v1beta1.types.
FailoverInstanceRequest
# Request for [Failover][google.cloud.redis.v1beta1.CloudRedis.FailoverInstance].
-
name
# Required. Redis instance resource name using the form:
proje cts/{project_id}/locations/{location_id}/instances/{instance_i d}
wherelocation_id
refers to a GCP region.
-
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.
-
data_protection_mode
Field google.cloud.redis.v1beta1.FailoverInstanceRequest.data_protection_mode
-
name
Field google.cloud.redis.v1beta1.FailoverInstanceRequest.name
-
-
class
google.cloud.redis_v1beta1.types.
GcsDestination
# 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.
-
uri
Field google.cloud.redis.v1beta1.GcsDestination.uri
-
-
class
google.cloud.redis_v1beta1.types.
GcsSource
# The Cloud Storage location for the input content
-
uri
# Required. Source data URI. (e.g. ‘gs://my_bucket/my_object’).
-
uri
Field google.cloud.redis.v1beta1.GcsSource.uri
-
-
class
google.cloud.redis_v1beta1.types.
GetInstanceRequest
# Request for [GetInstance][google.cloud.redis.v1beta1.CloudRedis.GetInstance].
-
name
# Required. Redis instance resource name using the form:
proje cts/{project_id}/locations/{location_id}/instances/{instance_i d}
wherelocation_id
refers to a GCP region.
-
name
Field google.cloud.redis.v1beta1.GetInstanceRequest.name
-
-
class
google.cloud.redis_v1beta1.types.
GetOperationRequest
# -
name
# Field google.longrunning.GetOperationRequest.name
-
-
class
google.cloud.redis_v1beta1.types.
ImportInstanceRequest
# Request for [Import][google.cloud.redis.v1beta1.CloudRedis.ImportInstance].
-
name
# Required. Redis instance resource name using the form:
proje cts/{project_id}/locations/{location_id}/instances/{instance_i d}
wherelocation_id
refers to a GCP region.
-
input_config
# Required. Specify data to be imported.
-
input_config
Field google.cloud.redis.v1beta1.ImportInstanceRequest.input_config
-
name
Field google.cloud.redis.v1beta1.ImportInstanceRequest.name
-
-
class
google.cloud.redis_v1beta1.types.
InputConfig
# The input content
-
source
# Required. Specify source location of input data
-
gcs_source
# Google Cloud Storage location where input content is located.
-
gcs_source
Field google.cloud.redis.v1beta1.InputConfig.gcs_source
-
-
class
google.cloud.redis_v1beta1.types.
Instance
# A Google Cloud Redis instance.
-
name
# Required. Unique name of the resource in this scope including project and location using the form:
projects/{project_id}/l ocations/{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.
-
display_name
# An arbitrary and optional user-provided name for the instance.
-
labels
# Resource labels to represent user provided metadata
-
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] is also provided, it must be different from [location_id].
-
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].
-
redis_version
# 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 (default) -REDIS_3_2
for Redis 3.2 compatibility
-
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.
-
host
# Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
-
port
# Output only. The port number of the exposed Redis endpoint.
-
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] 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.
-
create_time
# Output only. The time the instance was created.
-
state
# Output only. The current state of this instance.
-
status_message
# Output only. Additional information about the current status of this instance, if available.
-
redis_configs
# 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
# Required. The service tier of the instance.
-
memory_size_gb
# Required. Redis memory size in GiB.
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.
-
persistence_iam_identity
# Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is “serviceAccount:”. The value may change over time for a given instance so should be checked before each import/export operation.
-
class
LabelsEntry
# -
key
# Field google.cloud.redis.v1beta1.Instance.LabelsEntry.key
-
value
# Field google.cloud.redis.v1beta1.Instance.LabelsEntry.value
-
-
class
RedisConfigsEntry
# -
key
# Field google.cloud.redis.v1beta1.Instance.RedisConfigsEntry.key
-
value
# Field google.cloud.redis.v1beta1.Instance.RedisConfigsEntry.value
-
-
alternative_location_id
Field google.cloud.redis.v1beta1.Instance.alternative_location_id
-
authorized_network
Field google.cloud.redis.v1beta1.Instance.authorized_network
-
create_time
Field google.cloud.redis.v1beta1.Instance.create_time
-
current_location_id
Field google.cloud.redis.v1beta1.Instance.current_location_id
-
display_name
Field google.cloud.redis.v1beta1.Instance.display_name
-
host
Field google.cloud.redis.v1beta1.Instance.host
-
labels
Field google.cloud.redis.v1beta1.Instance.labels
-
location_id
Field google.cloud.redis.v1beta1.Instance.location_id
-
memory_size_gb
Field google.cloud.redis.v1beta1.Instance.memory_size_gb
-
name
Field google.cloud.redis.v1beta1.Instance.name
-
persistence_iam_identity
Field google.cloud.redis.v1beta1.Instance.persistence_iam_identity
-
port
Field google.cloud.redis.v1beta1.Instance.port
-
redis_configs
Field google.cloud.redis.v1beta1.Instance.redis_configs
-
redis_version
Field google.cloud.redis.v1beta1.Instance.redis_version
-
reserved_ip_range
Field google.cloud.redis.v1beta1.Instance.reserved_ip_range
-
state
Field google.cloud.redis.v1beta1.Instance.state
-
status_message
Field google.cloud.redis.v1beta1.Instance.status_message
-
tier
Field google.cloud.redis.v1beta1.Instance.tier
-
-
class
google.cloud.redis_v1beta1.types.
ListInstancesRequest
# Request for [ListInstances][google.cloud.redis.v1beta1.CloudRedis.ListInstances].
-
parent
# Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
wherelocation_id
refers to a GCP region.
-
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][CloudRedis.ListInstancesResponse.next_page_token] to determine if there are more instances left to be queried.
-
page_token
# The next_page_token value returned from a previous List request, if any.
-
page_size
Field google.cloud.redis.v1beta1.ListInstancesRequest.page_size
-
page_token
Field google.cloud.redis.v1beta1.ListInstancesRequest.page_token
-
parent
Field google.cloud.redis.v1beta1.ListInstancesRequest.parent
-
-
class
google.cloud.redis_v1beta1.types.
ListInstancesResponse
# Response for [ListInstances][google.cloud.redis.v1beta1.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”.
-
next_page_token
# Token to retrieve the next page of results, or empty if there are no more results in the list.
-
unreachable
# Locations that could not be reached.
-
instances
Field google.cloud.redis.v1beta1.ListInstancesResponse.instances
-
next_page_token
Field google.cloud.redis.v1beta1.ListInstancesResponse.next_page_token
-
unreachable
Field google.cloud.redis.v1beta1.ListInstancesResponse.unreachable
-
-
class
google.cloud.redis_v1beta1.types.
ListOperationsRequest
# -
filter
# Field google.longrunning.ListOperationsRequest.filter
-
name
# Field google.longrunning.ListOperationsRequest.name
-
page_size
# Field google.longrunning.ListOperationsRequest.page_size
-
page_token
# Field google.longrunning.ListOperationsRequest.page_token
-
-
class
google.cloud.redis_v1beta1.types.
ListOperationsResponse
# -
next_page_token
# Field google.longrunning.ListOperationsResponse.next_page_token
-
operations
# Field google.longrunning.ListOperationsResponse.operations
-
-
class
google.cloud.redis_v1beta1.types.
LocationMetadata
# 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
oralternative_location_id
fields when creating a Redis instance.
-
class
AvailableZonesEntry
# -
key
# Field google.cloud.redis.v1beta1.LocationMetadata.AvailableZonesEntry.key
-
value
# Field google.cloud.redis.v1beta1.LocationMetadata.AvailableZonesEntry.value
-
-
available_zones
Field google.cloud.redis.v1beta1.LocationMetadata.available_zones
-
-
class
google.cloud.redis_v1beta1.types.
Operation
# -
deserialize
()# Creates new method instance from given serialized data.
-
done
# Field google.longrunning.Operation.done
-
error
# Field google.longrunning.Operation.error
-
metadata
# Field google.longrunning.Operation.metadata
-
name
# Field google.longrunning.Operation.name
-
response
# Field google.longrunning.Operation.response
-
-
class
google.cloud.redis_v1beta1.types.
OperationInfo
# -
metadata_type
# Field google.longrunning.OperationInfo.metadata_type
-
response_type
# Field google.longrunning.OperationInfo.response_type
-
-
class
google.cloud.redis_v1beta1.types.
OutputConfig
# The output content
-
destination
# Required. Specify destination location of output data
-
gcs_destination
# Google Cloud Storage destination for output content.
-
gcs_destination
Field google.cloud.redis.v1beta1.OutputConfig.gcs_destination
-
-
class
google.cloud.redis_v1beta1.types.
Status
# -
code
# Field google.rpc.Status.code
-
details
# Field google.rpc.Status.details
-
message
# Field google.rpc.Status.message
-
-
class
google.cloud.redis_v1beta1.types.
Timestamp
# -
nanos
# Field google.protobuf.Timestamp.nanos
-
seconds
# Field google.protobuf.Timestamp.seconds
-
-
class
google.cloud.redis_v1beta1.types.
UpdateInstanceRequest
# Request for [UpdateInstance][google.cloud.redis.v1beta1.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.v1beta1.Instance]: -
displayName
-labels
-memorySizeGb
-redisConfig
-
instance
# Required. Update description. Only fields specified in update_mask are updated.
-
instance
Field google.cloud.redis.v1beta1.UpdateInstanceRequest.instance
-
update_mask
Field google.cloud.redis.v1beta1.UpdateInstanceRequest.update_mask
-
-
class
google.cloud.redis_v1beta1.types.
ZoneMetadata
# Defines specific information for a particular zone. Currently empty and reserved for future use only.