API documentation for redis_v1.types module.
Classes
Any
API documentation for redis_v1.types.Any class.
CancelOperationRequest
API documentation for redis_v1.types.CancelOperationRequest class.
CreateInstanceRequest
Request for CreateInstance. .. attribute:: 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.
Required. A Redis [Instance] resource
DeleteInstanceRequest
Request for DeleteInstance. .. attribute:: name
Required. Redis instance resource name using the form: proje
cts/{project_id}/locations/{location_id}/instances/{instance_i
d} where location_id refers to a GCP region.
DeleteOperationRequest
API documentation for redis_v1.types.DeleteOperationRequest class.
ExportInstanceRequest
Request for Export. .. attribute:: name
Required. Redis instance resource name using the form: proje
cts/{project_id}/locations/{location_id}/instances/{instance_i
d} where location_id refers to a GCP region.
FailoverInstanceRequest
Request for Failover. .. attribute:: name
Required. Redis instance resource name using the form: proje
cts/{project_id}/locations/{location_id}/instances/{instance_i
d} where location_id refers to a GCP region.
FieldMask
API documentation for redis_v1.types.FieldMask class.
GcsDestination
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.
GcsSource
The Cloud Storage location for the input content .. attribute:: uri
Required. Source data URI. (e.g. 'gs://my_bucket/my_object').
GetInstanceRequest
Request for GetInstance. .. attribute:: name
Required. Redis instance resource name using the form: proje
cts/{project_id}/locations/{location_id}/instances/{instance_i
d} where location_id refers to a GCP region.
GetOperationRequest
API documentation for redis_v1.types.GetOperationRequest class.
ImportInstanceRequest
Request for Import. .. attribute:: name
Required. Redis instance resource name using the form: proje
cts/{project_id}/locations/{location_id}/instances/{instance_i
d} where location_id refers to a GCP region.
InputConfig
The input content .. attribute:: source
Required. Specify source location of input data
Instance
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}/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][google.cloud.redis.v1.Instance.location_id]
and [alternative_location_id][google.cloud.redis.v1.Instance
.alternative_location_id] fields for more details.
Resource labels to represent user provided metadata
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].
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.
Output only. The port number of the exposed Redis endpoint.
Output only. The time the instance was created.
Output only. Additional information about the current status of this instance, if available.
Required. The service tier of the instance.
Optional. The full name of the Google Compute Engine network
</compute/docs/networks-and-firewalls#networks>__ to which
the instance is connected. If left unspecified, the
default network will be used.
Optional. The connect mode of Redis instance. If not provided, default one will be used. Current default: DIRECT_PEERING.
ListInstancesRequest
Request for ListInstances. .. attribute:: 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.
The next_page_token value returned from a previous [ListIn
stances][google.cloud.redis.v1.CloudRedis.ListInstances]
request, if any.
ListInstancesResponse
Response for ListInstances. .. attribute:: 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".
Locations that could not be reached.
ListOperationsRequest
API documentation for redis_v1.types.ListOperationsRequest class.
ListOperationsResponse
API documentation for redis_v1.types.ListOperationsResponse class.
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.
.. attribute:: 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.
Operation
API documentation for redis_v1.types.Operation class.
OperationInfo
API documentation for redis_v1.types.OperationInfo class.
OperationMetadata
Represents the v1 metadata of the long-running operation. .. attribute:: create_time
Creation timestamp.
Operation target.
Operation status details.
API version.
OutputConfig
The output content .. attribute:: destination
Required. Specify destination location of output data
Status
API documentation for redis_v1.types.Status class.
Timestamp
API documentation for redis_v1.types.Timestamp class.
UpdateInstanceRequest
Request for UpdateInstance. .. attribute:: 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: -
displayName - labels - memorySizeGb -
redisConfig
WaitOperationRequest
API documentation for redis_v1.types.WaitOperationRequest class.
ZoneMetadata
Defines specific information for a particular zone. Currently empty and reserved for future use only.