package google.cloud.redis.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Configures and manages Cloud Memorystore for Redis instances Google Cloud Memorystore for Redis v1beta1 The `redis.googleapis.com` service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis instances: * The service works with a collection of cloud projects, named: `/projects/*` * Each project has a collection of available locations, named: `/locations/*` * Each location has a collection of Redis instances, named: `/instances/*` * As such, Redis instances are resources of the form: `/projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note that location_id must be refering to a GCP `region`; for example: * `projects/redpepper-1290/locations/us-central1/instances/my-redis`

• rpc ListInstances (ListInstancesRequest, ListInstancesResponse)

  cloud_redis.proto:60

  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.

  message ListInstancesRequest

  cloud_redis.proto:338

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

  • string parent = 1

    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.

  • int32 page_size = 2

    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.

  • string page_token = 3

    The next_page_token value returned from a previous List request, if any.

  message ListInstancesResponse

  cloud_redis.proto:364

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

  • repeated Instance instances = 1

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

  • string next_page_token = 2

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

  • repeated string unreachable = 3

    Locations that could not be reached.

• rpc GetInstance (GetInstanceRequest, Instance)

  cloud_redis.proto:68

  Gets the details of a specific Redis instance.

  message GetInstanceRequest

  cloud_redis.proto:386

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

  • string name = 1

    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.

• rpc CreateInstance (CreateInstanceRequest, longrunning.Operation)

  cloud_redis.proto:87

  Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's [default network](/compute/docs/networks-and-firewalls#networks). 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.

  message CreateInstanceRequest

  cloud_redis.proto:399

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

  • string parent = 1

    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.

  • string instance_id = 2

    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

  • optional Instance instance = 3

    Required. A Redis [Instance] resource

• rpc UpdateInstance (UpdateInstanceRequest, longrunning.Operation)

  cloud_redis.proto:104

  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.

  message UpdateInstanceRequest

  cloud_redis.proto:425

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

  • optional protobuf.FieldMask update_mask = 1

    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`

  • optional Instance instance = 2

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

• rpc ImportInstance (ImportInstanceRequest, longrunning.Operation)

  cloud_redis.proto:124

  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.

  message ImportInstanceRequest

  cloud_redis.proto:470

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

  • string name = 1

    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.

  • optional InputConfig input_config = 3

    Required. Specify data to be imported.

• rpc ExportInstance (ExportInstanceRequest, longrunning.Operation)

  cloud_redis.proto:142

  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.

  message ExportInstanceRequest

  cloud_redis.proto:497

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

  • string name = 1

    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.

  • optional OutputConfig output_config = 3

    Required. Specify data to be exported.

• rpc FailoverInstance (FailoverInstanceRequest, longrunning.Operation)

  cloud_redis.proto:156

  Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

  message FailoverInstanceRequest

  cloud_redis.proto:508

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

  • string name = 1

    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.

  • FailoverInstanceRequest.DataProtectionMode data_protection_mode = 2

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

• rpc DeleteInstance (DeleteInstanceRequest, longrunning.Operation)

  cloud_redis.proto:170

  Deletes a specific Redis instance. Instance stops serving and data is deleted.

  message DeleteInstanceRequest

  cloud_redis.proto:442

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

  • string name = 1

    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.

Used in: FailoverInstanceRequest

• 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 master and replica is under a certain threshold.

• FORCE_DATA_LOSS = 2

  Instance failover will be performed without data loss control.

The Cloud Storage location for the output content

Used in: OutputConfig

• string uri = 1

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

The Cloud Storage location for the input content

Used in: InputConfig

• string uri = 1

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

The input content

Used in: ImportInstanceRequest

• oneof source

  Required. Specify source location of input data

  • GcsSource gcs_source = 1

    Google Cloud Storage location where input content is located.

A Google Cloud Redis instance.

Used as response type in: CloudRedis.GetInstance

Used as field type in: CreateInstanceRequest, ListInstancesResponse, UpdateInstanceRequest

• string name = 1

  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] and [alternative_location_id] fields for more details.

• string display_name = 2

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

• map<string, string> labels = 3

  Resource labels to represent user provided metadata

• string location_id = 4

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

• string alternative_location_id = 5

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

• string redis_version = 7

  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

• string reserved_ip_range = 9

  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.

• string host = 10

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

• int32 port = 11

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

• string current_location_id = 12

  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.

• optional protobuf.Timestamp create_time = 13

  Output only. The time the instance was created.

• Instance.State state = 14

  Output only. The current state of this instance.

• string status_message = 15

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

• map<string, string> redis_configs = 16

  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

• Instance.Tier tier = 17

  Required. The service tier of the instance.

• int32 memory_size_gb = 18

  Required. Redis memory size in GiB.

• string authorized_network = 20

  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.

• string persistence_iam_identity = 21

  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.

Represents the different states of a Redis instance.

Used in: Instance

• 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 = 10

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

Available service tiers to choose from

Used in: Instance

• TIER_UNSPECIFIED = 0

  Not set.

• BASIC = 1

  BASIC tier: standalone instance

• STANDARD_HA = 3

  STANDARD_HA tier: highly available primary/replica instances

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.

• map<string, ZoneMetadata> available_zones = 1

  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.

The output content

Used in: ExportInstanceRequest

• oneof destination

  Required. Specify destination location of output data

  • GcsDestination gcs_destination = 1

    Google Cloud Storage destination for output content.

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

Used in: LocationMetadata

(message has no fields)