Creates and manages Redis instances on the Google Cloud Platform.
Lists information about the supported locations for this service.
Name | Data Type | Description |
---|---|---|
name
|
string |
The resource that owns the locations collection, if applicable. |
Name | Data Type | Description |
---|---|---|
pageToken
|
string |
The standard list page token. |
pageSize
|
integer |
The standard list page size. |
filter
|
string |
The standard list filter. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ListLocationsResponse | |||||||||||||||||||||||||||||||||
Properties
|
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding
to use different resource name schemes, such as users/*/operations
. To
override the binding, API services can add a binding such as
"/v1/{name=users/*}/operations"
to their service configuration.
For backwards compatibility, the default name includes the operations
collection id, however overriding users must ensure the name binding
is the parent resource, without the operations collection id.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the operation's parent resource. |
Name | Data Type | Description |
---|---|---|
pageToken
|
string |
The standard list page token. |
pageSize
|
integer |
The standard list page size. |
filter
|
string |
The standard list filter. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ListOperationsResponse | |||||||||||||||||||||||||||||||||
Properties
|
Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED
.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the operation resource to be cancelled. |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
|
Empty | |||||
|
Export Redis instance data into a Redis RDB format file in Cloud Storage.
Redis will continue serving during this operation.
The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
Name | Data Type | Description |
---|---|---|
name
|
string |
Required. Redis instance resource name using the form:
|
Name | Data Type | Description | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ExportInstanceRequest | ||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | ||||||||||||||||||||||||||||||||||||
Properties
|
Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
Name | Data Type | Description |
---|---|---|
name
|
string |
Required. Redis instance resource name using the form:
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
FailoverInstanceRequest | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | ||||||||||||||||||||||||||||||||||||
Properties
|
Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file.
The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
Name | Data Type | Description |
---|---|---|
name
|
string |
Required. Redis instance resource name using the form:
|
Name | Data Type | Description | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ImportInstanceRequest | ||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | ||||||||||||||||||||||||||||||||||||
Properties
|
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the operation resource to be deleted. |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
|
Empty | |||||
|
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the operation resource. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | ||||||||||||||||||||||||||||||||||||
Properties
|
Updates the metadata and configuration of a specific Redis instance.
Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
Name | Data Type | Description |
---|---|---|
name
|
string |
Required. Unique name of the resource in this scope including project and
location using the form:
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. |
Name | Data Type | Description |
---|---|---|
updateMask
|
string |
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:
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Instance | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | ||||||||||||||||||||||||||||||||||||
Properties
|
Lists all Redis instances owned by a project in either the specified location (region) or all locations.
The location should have the following format:
projects/{project_id}/locations/{location_id}
If location_id
is specified as -
(wildcard), then all regions
available to the project are queried, and the results are aggregated.
Name | Data Type | Description |
---|---|---|
parent
|
string |
Required. The resource name of the instance location using the form:
|
Name | Data Type | Description |
---|---|---|
pageToken
|
string |
The |
pageSize
|
integer |
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
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ListInstancesResponse | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Creates a Redis instance based on the specified tier and memory size.
By default, the instance is accessible from the project's default network.
The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field.
The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
Name | Data Type | Description |
---|---|---|
parent
|
string |
Required. The resource name of the instance location using the form:
|
Name | Data Type | Description |
---|---|---|
instanceId
|
string |
Required. The logical name of the Redis instance in the customer project with the following restrictions:
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Instance | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | ||||||||||||||||||||||||||||||||||||
Properties
|
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}
The JSON representation for Empty
is empty JSON object {}
.
Name | Data Type | Description |
---|---|---|
Empty
|
object |
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
The JSON representation for |
Request for Export.
Name | Data Type | Description | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
outputConfig
|
OutputConfig |
Required. Specify data to be exported. |
|||||||||||||||||
Properties
|
Request for Failover.
Name | Data Type | Description |
---|---|---|
dataProtectionMode
|
string Allowed values: - DATA_PROTECTION_MODE_UNSPECIFIED - LIMITED_DATA_LOSS - FORCE_DATA_LOSS |
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 Cloud Storage location for the output content
Name | Data Type | Description |
---|---|---|
uri
|
string |
Required. Data destination URI (e.g. 'gs://my_bucket/my_object'). Existing files will be overwritten. |
The Cloud Storage location for the input content
Name | Data Type | Description |
---|---|---|
uri
|
string |
Required. Source data URI. (e.g. 'gs://my_bucket/my_object'). |
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.
Name | Data Type | Description |
---|---|---|
availableZones
|
object |
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 |
Represents the v1 metadata of the long-running operation.
Name | Data Type | Description |
---|---|---|
verb
|
string |
Operation verb. |
target
|
string |
Operation target. |
statusDetail
|
string |
Operation status details. |
endTime
|
string |
End timestamp. |
createTime
|
string |
Creation timestamp. |
cancelRequested
|
boolean |
Specifies if cancellation was requested for the operation. |
apiVersion
|
string |
API version. |
Defines specific information for a particular zone. Currently empty and reserved for future use only.
Name | Data Type | Description |
---|---|---|
GoogleCloudRedisV1ZoneMetadata
|
object |
Defines specific information for a particular zone. Currently empty and reserved for future use only. |
Request for Import.
Name | Data Type | Description | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
inputConfig
|
InputConfig |
Required. Specify data to be imported. |
|||||||||||||||||
Properties
|
The input content
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
gcsSource
|
GcsSource |
Google Cloud Storage location where input content is located. |
|||||||
Properties
|
A Google Cloud Redis instance.
Name | Data Type | Description |
---|---|---|
tier
|
string Allowed values: - TIER_UNSPECIFIED - BASIC - STANDARD_HA |
Required. The service tier of the instance. |
statusMessage
|
string |
Output only. Additional information about the current status of this instance, if available. |
state
|
string Allowed values: - STATE_UNSPECIFIED - CREATING - READY - UPDATING - DELETING - REPAIRING - MAINTENANCE - IMPORTING - FAILING_OVER |
Output only. The current state of this instance. |
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. |
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:
|
redisConfigs
|
object |
Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis 3.2 and above:
|
port
|
integer |
Output only. The port number of the exposed Redis endpoint. |
persistenceIamIdentity
|
string |
Output only. Cloud IAM identity used by import / export operations to
transfer data to/from Cloud Storage. Format is
"serviceAccount: |
name
|
string |
Required. Unique name of the resource in this scope including project and
location using the form:
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. |
memorySizeGb
|
integer |
Required. Redis memory size in GiB. |
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. |
labels
|
object |
Resource labels to represent user provided metadata |
host
|
string |
Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service. |
displayName
|
string |
An arbitrary and optional user-provided name for the instance. |
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
|
string |
Output only. The time the instance was created. |
authorizedNetwork
|
string |
Optional. The full name of the Google Compute Engine
network to which the
instance is connected. If left unspecified, the |
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. |
Response for ListInstances.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
unreachable
|
array [string] |
Locations that could not be reached. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextPageToken
|
string |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instances
|
array [Instance] |
A list of Redis instances in the project in the specified location, or across all locations. If the |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
The response message for Locations.ListLocations.
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
The standard List next-page token. |
|||||||||||||||||||
locations
|
array [Location] |
A list of locations that matches the specified filter in the request. |
|||||||||||||||||||
Properties
|
The response message for Operations.ListOperations.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
operations
|
array [Operation] |
A list of operations that matches the specified filter in the request. |
|||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||
nextPageToken
|
string |
The standard List next-page token. |
A resource that represents Google Cloud Platform location.
Name | Data Type | Description |
---|---|---|
name
|
string |
Full resource name for the region. For example: "projects/example-project/locations/us-east1". |
metadata
|
object |
Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in |
locationId
|
string |
Resource ID for the region. For example: "us-east1". |
labels
|
object |
Cross-service attributes for the location. For example
|
displayName
|
string |
The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
This resource represents a long-running operation that is the result of a network API call.
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
response
|
object |
The normal response of the operation in case of success. If the original
method returns no data on success, such as |
|||||||||||||
name
|
string |
The server-assigned name, which is only unique within the same service that
originally returns it. If you use the default HTTP mapping, the
|
|||||||||||||
metadata
|
object |
{
} |
|||||||||||||
error
|
Status |
The error result of the operation in case of failure or cancellation. |
|||||||||||||
Properties
|
|||||||||||||||
done
|
boolean |
If the value is |
The output content
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
gcsDestination
|
GcsDestination |
Google Cloud Storage destination for output content. |
|||||||
Properties
|
The Status
type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It is
used by gRPC. Each Status
message contains
three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the API Design Guide.
Name | Data Type | Description |
---|---|---|
message
|
string |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
details
|
array [object] |
A list of messages that carry the error details. There is a common set of message types for APIs to use. |
code
|
integer |
The status code, which should be an enum value of google.rpc.Code. |
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 accessCode authentication
Flow:authorizationCode
https://accounts.google.com/o/oauth2/auth
https://accounts.google.com/o/oauth2/token
https://www.googleapis.com/auth/cloud-platform
: View and manage your data across Google Cloud Platform services
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 implicit authentication
Flow:implicit
https://accounts.google.com/o/oauth2/auth
https://www.googleapis.com/auth/cloud-platform
: View and manage your data across Google Cloud Platform servicesName | Google |
External URL | https://google.com |
OAS (OpenAPI Specification) | v3.0.0 |