feat: [Cloud Memorystore for Redis] Add CMEK key field

feat: [Cloud Memorystore for Redis] Add suspension_reasons field
feat: [Cloud Memorystore for Redis] Add persistence support
feat: [Cloud Memorystore for Redis] Add self service update maintenance version support

PiperOrigin-RevId: 529822563
pull/802/head
Google APIs 2 years ago committed by Copybara-Service
parent 1ebad326d2
commit 6a0ac6d06d
  1. 7
      google/cloud/redis/v1/BUILD.bazel
  2. 294
      google/cloud/redis/v1/cloud_redis.proto
  3. 2
      google/cloud/redis/v1/redis_v1.yaml

@ -43,6 +43,7 @@ proto_library_with_info(
deps = [ deps = [
":redis_proto", ":redis_proto",
"//google/cloud:common_resources_proto", "//google/cloud:common_resources_proto",
"//google/cloud/location:location_proto",
], ],
) )
@ -77,12 +78,14 @@ java_gapic_library(
rest_numeric_enums = True, rest_numeric_enums = True,
service_yaml = "redis_v1.yaml", service_yaml = "redis_v1.yaml",
test_deps = [ test_deps = [
"//google/cloud/location:location_java_grpc",
":redis_java_grpc", ":redis_java_grpc",
], ],
transport = "grpc+rest", transport = "grpc+rest",
deps = [ deps = [
":redis_java_proto", ":redis_java_proto",
"//google/api:api_java_proto", "//google/api:api_java_proto",
"//google/cloud/location:location_java_proto",
], ],
) )
@ -144,6 +147,7 @@ go_gapic_library(
transport = "grpc+rest", transport = "grpc+rest",
deps = [ deps = [
":redis_go_proto", ":redis_go_proto",
"//google/cloud/location:location_go_proto",
"//google/longrunning:longrunning_go_proto", "//google/longrunning:longrunning_go_proto",
"@com_google_cloud_go_longrunning//:go_default_library", "@com_google_cloud_go_longrunning//:go_default_library",
"@com_google_cloud_go_longrunning//autogen:go_default_library", "@com_google_cloud_go_longrunning//autogen:go_default_library",
@ -187,6 +191,8 @@ py_gapic_library(
rest_numeric_enums = True, rest_numeric_enums = True,
service_yaml = "redis_v1.yaml", service_yaml = "redis_v1.yaml",
transport = "grpc+rest", transport = "grpc+rest",
deps = [
],
) )
py_test( py_test(
@ -233,6 +239,7 @@ php_gapic_library(
name = "redis_php_gapic", name = "redis_php_gapic",
srcs = [":redis_proto_with_info"], srcs = [":redis_proto_with_info"],
grpc_service_config = "redis_grpc_service_config.json", grpc_service_config = "redis_grpc_service_config.json",
migration_mode = "PRE_MIGRATION_SURFACE_ONLY",
rest_numeric_enums = True, rest_numeric_enums = True,
service_yaml = "redis_v1.yaml", service_yaml = "redis_v1.yaml",
transport = "grpc+rest", transport = "grpc+rest",

@ -1,4 +1,4 @@
// Copyright 2022 Google LLC // Copyright 2023 Google LLC
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -22,6 +22,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto"; import "google/api/resource.proto";
import "google/longrunning/operations.proto"; import "google/longrunning/operations.proto";
import "google/protobuf/duration.proto"; import "google/protobuf/duration.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto"; import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto"; import "google/protobuf/timestamp.proto";
import "google/type/dayofweek.proto"; import "google/type/dayofweek.proto";
@ -49,7 +50,8 @@ option java_package = "com.google.cloud.redis.v1";
// * `projects/redpepper-1290/locations/us-central1/instances/my-redis` // * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
service CloudRedis { service CloudRedis {
option (google.api.default_host) = "redis.googleapis.com"; option (google.api.default_host) = "redis.googleapis.com";
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
// Lists all Redis instances owned by a project in either the specified // Lists all Redis instances owned by a project in either the specified
// location (region) or all locations. // location (region) or all locations.
@ -78,7 +80,8 @@ service CloudRedis {
// Gets the AUTH string for a Redis instance. If AUTH is not enabled for the // Gets the AUTH string for a Redis instance. If AUTH is not enabled for the
// instance the response will be empty. This information is not included in // instance the response will be empty. This information is not included in
// the details returned to GetInstance. // the details returned to GetInstance.
rpc GetInstanceAuthString(GetInstanceAuthStringRequest) returns (InstanceAuthString) { rpc GetInstanceAuthString(GetInstanceAuthStringRequest)
returns (InstanceAuthString) {
option (google.api.http) = { option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/instances/*}/authString" get: "/v1/{name=projects/*/locations/*/instances/*}/authString"
}; };
@ -97,7 +100,8 @@ service CloudRedis {
// //
// The returned operation is automatically deleted after a few hours, so there // The returned operation is automatically deleted after a few hours, so there
// is no need to call DeleteOperation. // is no need to call DeleteOperation.
rpc CreateInstance(CreateInstanceRequest) returns (google.longrunning.Operation) { rpc CreateInstance(CreateInstanceRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = { option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/instances" post: "/v1/{parent=projects/*/locations/*}/instances"
body: "instance" body: "instance"
@ -114,7 +118,8 @@ service CloudRedis {
// Completed longrunning.Operation will contain the new instance object // Completed longrunning.Operation will contain the new instance object
// in the response field. The returned operation is automatically deleted // in the response field. The returned operation is automatically deleted
// after a few hours, so there is no need to call DeleteOperation. // after a few hours, so there is no need to call DeleteOperation.
rpc UpdateInstance(UpdateInstanceRequest) returns (google.longrunning.Operation) { rpc UpdateInstance(UpdateInstanceRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = { option (google.api.http) = {
patch: "/v1/{instance.name=projects/*/locations/*/instances/*}" patch: "/v1/{instance.name=projects/*/locations/*/instances/*}"
body: "instance" body: "instance"
@ -128,7 +133,8 @@ service CloudRedis {
// Upgrades Redis instance to the newer Redis version specified in the // Upgrades Redis instance to the newer Redis version specified in the
// request. // request.
rpc UpgradeInstance(UpgradeInstanceRequest) returns (google.longrunning.Operation) { rpc UpgradeInstance(UpgradeInstanceRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = { option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/instances/*}:upgrade" post: "/v1/{name=projects/*/locations/*/instances/*}:upgrade"
body: "*" body: "*"
@ -148,7 +154,8 @@ service CloudRedis {
// //
// The returned operation is automatically deleted after a few hours, so // The returned operation is automatically deleted after a few hours, so
// there is no need to call DeleteOperation. // there is no need to call DeleteOperation.
rpc ImportInstance(ImportInstanceRequest) returns (google.longrunning.Operation) { rpc ImportInstance(ImportInstanceRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = { option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/instances/*}:import" post: "/v1/{name=projects/*/locations/*/instances/*}:import"
body: "*" body: "*"
@ -166,7 +173,8 @@ service CloudRedis {
// //
// The returned operation is automatically deleted after a few hours, so // The returned operation is automatically deleted after a few hours, so
// there is no need to call DeleteOperation. // there is no need to call DeleteOperation.
rpc ExportInstance(ExportInstanceRequest) returns (google.longrunning.Operation) { rpc ExportInstance(ExportInstanceRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = { option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/instances/*}:export" post: "/v1/{name=projects/*/locations/*/instances/*}:export"
body: "*" body: "*"
@ -180,7 +188,8 @@ service CloudRedis {
// Initiates a failover of the primary node to current replica node for a // Initiates a failover of the primary node to current replica node for a
// specific STANDARD tier Cloud Memorystore for Redis instance. // specific STANDARD tier Cloud Memorystore for Redis instance.
rpc FailoverInstance(FailoverInstanceRequest) returns (google.longrunning.Operation) { rpc FailoverInstance(FailoverInstanceRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = { option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/instances/*}:failover" post: "/v1/{name=projects/*/locations/*/instances/*}:failover"
body: "*" body: "*"
@ -194,7 +203,8 @@ service CloudRedis {
// Deletes a specific Redis instance. Instance stops serving and data is // Deletes a specific Redis instance. Instance stops serving and data is
// deleted. // deleted.
rpc DeleteInstance(DeleteInstanceRequest) returns (google.longrunning.Operation) { rpc DeleteInstance(DeleteInstanceRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = { option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/instances/*}" delete: "/v1/{name=projects/*/locations/*/instances/*}"
}; };
@ -207,12 +217,14 @@ service CloudRedis {
// Reschedule maintenance for a given instance in a given project and // Reschedule maintenance for a given instance in a given project and
// location. // location.
rpc RescheduleMaintenance(RescheduleMaintenanceRequest) returns (google.longrunning.Operation) { rpc RescheduleMaintenance(RescheduleMaintenanceRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = { option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/instances/*}:rescheduleMaintenance" post: "/v1/{name=projects/*/locations/*/instances/*}:rescheduleMaintenance"
body: "*" body: "*"
}; };
option (google.api.method_signature) = "name, reschedule_type, schedule_time"; option (google.api.method_signature) =
"name, reschedule_type, schedule_time";
option (google.longrunning.operation_info) = { option (google.longrunning.operation_info) = {
response_type: "google.cloud.redis.v1.Instance" response_type: "google.cloud.redis.v1.Instance"
metadata_type: "google.cloud.redis.v1.OperationMetadata" metadata_type: "google.cloud.redis.v1.OperationMetadata"
@ -321,6 +333,15 @@ message Instance {
READ_REPLICAS_ENABLED = 2; READ_REPLICAS_ENABLED = 2;
} }
// Possible reasons for the instance to be in a "SUSPENDED" state.
enum SuspensionReason {
// Not set.
SUSPENSION_REASON_UNSPECIFIED = 0;
// Something wrong with the CMEK key provided by customer.
CUSTOMER_MANAGED_KEY_ISSUE = 1;
}
// Required. Unique name of the resource in this scope including project and // Required. Unique name of the resource in this scope including project and
// location using the form: // location using the form:
// `projects/{project_id}/locations/{location_id}/instances/{instance_id}` // `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
@ -328,8 +349,10 @@ message Instance {
// Note: Redis instances are managed and addressed at regional level so // Note: Redis instances are managed and addressed at regional level so
// location_id here refers to a GCP region; however, users may choose which // 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 // 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 // should be provisioned in. Refer to
// [alternative_location_id][google.cloud.redis.v1.Instance.alternative_location_id] fields for more details. // [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.
string name = 1 [(google.api.field_behavior) = REQUIRED]; string name = 1 [(google.api.field_behavior) = REQUIRED];
// An arbitrary and optional user-provided name for the instance. // An arbitrary and optional user-provided name for the instance.
@ -372,11 +395,11 @@ message Instance {
// the default block size is /28. // the default block size is /28.
string reserved_ip_range = 9 [(google.api.field_behavior) = OPTIONAL]; string reserved_ip_range = 9 [(google.api.field_behavior) = OPTIONAL];
// Optional. Additional IP range for node placement. Required when enabling read // Optional. Additional IP range for node placement. Required when enabling
// replicas on an existing instance. For DIRECT_PEERING mode value must be a // read replicas on an existing instance. For DIRECT_PEERING mode value must
// CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value // be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode
// must be the name of an allocated address range associated with the private // value must be the name of an allocated address range associated with the
// service access connection, or "auto". // private service access connection, or "auto".
string secondary_ip_range = 30 [(google.api.field_behavior) = OPTIONAL]; string secondary_ip_range = 30 [(google.api.field_behavior) = OPTIONAL];
// Output only. Hostname or IP address of the exposed Redis endpoint used by // Output only. Hostname or IP address of the exposed Redis endpoint used by
@ -392,7 +415,8 @@ message Instance {
string current_location_id = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; string current_location_id = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time the instance was created. // Output only. The time the instance was created.
google.protobuf.Timestamp create_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; google.protobuf.Timestamp create_time = 13
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The current state of this instance. // Output only. The current state of this instance.
State state = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; State state = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
@ -421,7 +445,8 @@ message Instance {
// //
// * stream-node-max-bytes // * stream-node-max-bytes
// * stream-node-max-entries // * stream-node-max-entries
map<string, string> redis_configs = 16 [(google.api.field_behavior) = OPTIONAL]; map<string, string> redis_configs = 16
[(google.api.field_behavior) = OPTIONAL];
// Required. The service tier of the instance. // Required. The service tier of the instance.
Tier tier = 17 [(google.api.field_behavior) = REQUIRED]; Tier tier = 17 [(google.api.field_behavior) = REQUIRED];
@ -440,43 +465,42 @@ message Instance {
// "serviceAccount:<service_account_email>". The value may change over time // "serviceAccount:<service_account_email>". The value may change over time
// for a given instance so should be checked before each import/export // for a given instance so should be checked before each import/export
// operation. // operation.
string persistence_iam_identity = 21 [(google.api.field_behavior) = OUTPUT_ONLY]; string persistence_iam_identity = 21
[(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. The network connect mode of the Redis instance. // Optional. The network connect mode of the Redis instance.
// If not provided, the connect mode defaults to DIRECT_PEERING. // If not provided, the connect mode defaults to DIRECT_PEERING.
ConnectMode connect_mode = 22 [(google.api.field_behavior) = OPTIONAL]; ConnectMode connect_mode = 22 [(google.api.field_behavior) = OPTIONAL];
// Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to // Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If
// "true" AUTH is enabled on the instance. Default value is "false" meaning // set to "true" AUTH is enabled on the instance. Default value is "false"
// AUTH is disabled. // meaning AUTH is disabled.
bool auth_enabled = 23 [(google.api.field_behavior) = OPTIONAL]; bool auth_enabled = 23 [(google.api.field_behavior) = OPTIONAL];
// Output only. List of server CA certificates for the instance. // Output only. List of server CA certificates for the instance.
repeated TlsCertificate server_ca_certs = 25 [(google.api.field_behavior) = OUTPUT_ONLY]; repeated TlsCertificate server_ca_certs = 25
[(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. The TLS mode of the Redis instance. // Optional. The TLS mode of the Redis instance.
// If not provided, TLS is disabled for the instance. // If not provided, TLS is disabled for the instance.
TransitEncryptionMode transit_encryption_mode = 26 [(google.api.field_behavior) = OPTIONAL]; TransitEncryptionMode transit_encryption_mode = 26
[(google.api.field_behavior) = OPTIONAL];
// 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.
// Optional. The maintenance policy for the instance. If not provided, // Optional. The maintenance policy for the instance. If not provided,
// maintenance events can be performed at any time. // maintenance events can be performed at any time.
MaintenancePolicy maintenance_policy = 27 [(google.api.field_behavior) = OPTIONAL]; MaintenancePolicy maintenance_policy = 27
[(google.api.field_behavior) = OPTIONAL];
// Output only. Date and time of upcoming maintenance events which have been // Output only. Date and time of upcoming maintenance events which have been
// scheduled. // scheduled.
MaintenanceSchedule maintenance_schedule = 28 [(google.api.field_behavior) = OUTPUT_ONLY]; MaintenanceSchedule maintenance_schedule = 28
[(google.api.field_behavior) = OUTPUT_ONLY];
// 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 // Optional. The number of replica nodes. The valid range for the Standard
// enabled for a Standard Tier instance, the only valid value is 1 and the // Tier with read replicas enabled is [1-5] and defaults to 2. If read
// default is 1. The valid value for basic tier is 0 and the default is also // replicas are not enabled for a Standard Tier instance, the only valid value
// 0. // is 1 and the default is 1. The valid value for basic tier is 0 and the
// default is also 0.
int32 replica_count = 31 [(google.api.field_behavior) = OPTIONAL]; int32 replica_count = 31 [(google.api.field_behavior) = OPTIONAL];
// Output only. Info per node. // Output only. Info per node.
@ -492,11 +516,92 @@ message Instance {
// endpoint. Standard tier only. Write requests should target 'port'. // endpoint. Standard tier only. Write requests should target 'port'.
int32 read_endpoint_port = 34 [(google.api.field_behavior) = OUTPUT_ONLY]; int32 read_endpoint_port = 34 [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. // Optional. Read replicas mode for the instance. Defaults to
ReadReplicasMode read_replicas_mode = 35 [(google.api.field_behavior) = OPTIONAL]; // READ_REPLICAS_DISABLED.
ReadReplicasMode read_replicas_mode = 35
[(google.api.field_behavior) = OPTIONAL];
// Optional. The KMS key reference that the customer provides when trying to
// create the instance.
string customer_managed_key = 36 [(google.api.field_behavior) = OPTIONAL];
// Optional. Persistence configuration parameters
PersistenceConfig persistence_config = 37
[(google.api.field_behavior) = OPTIONAL];
// Optional. reasons that causes instance in "SUSPENDED" state.
repeated SuspensionReason suspension_reasons = 38
[(google.api.field_behavior) = OPTIONAL];
// Optional. The self service update maintenance version.
// The version is date based such as "20210712_00_00".
string maintenance_version = 39 [(google.api.field_behavior) = OPTIONAL];
// Optional. The available maintenance versions that an instance could update
// to.
repeated string available_maintenance_versions = 40
[(google.api.field_behavior) = OPTIONAL];
} }
// Request for [RescheduleMaintenance][google.cloud.redis.v1.CloudRedis.RescheduleMaintenance]. // Configuration of the persistence functionality.
message PersistenceConfig {
// Available Persistence modes.
enum PersistenceMode {
// Not set.
PERSISTENCE_MODE_UNSPECIFIED = 0;
// Persistence is disabled for the instance,
// and any existing snapshots are deleted.
DISABLED = 1;
// RDB based Persistence is enabled.
RDB = 2;
}
// Available snapshot periods for scheduling.
enum SnapshotPeriod {
// Not set.
SNAPSHOT_PERIOD_UNSPECIFIED = 0;
// Snapshot every 1 hour.
ONE_HOUR = 3;
// Snapshot every 6 hours.
SIX_HOURS = 4;
// Snapshot every 12 hours.
TWELVE_HOURS = 5;
// Snapshot every 24 hours.
TWENTY_FOUR_HOURS = 6;
}
// Optional. Controls whether Persistence features are enabled.
// If not provided, the existing value will be used.
PersistenceMode persistence_mode = 1 [(google.api.field_behavior) = OPTIONAL];
// 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.
SnapshotPeriod rdb_snapshot_period = 2
[(google.api.field_behavior) = OPTIONAL];
// Output only. The next time that a snapshot attempt is scheduled to occur.
google.protobuf.Timestamp rdb_next_snapshot_time = 4
[(google.api.field_behavior) = OUTPUT_ONLY];
// 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.
google.protobuf.Timestamp rdb_snapshot_start_time = 5
[(google.api.field_behavior) = OPTIONAL];
}
// Request for
// [RescheduleMaintenance][google.cloud.redis.v1.CloudRedis.RescheduleMaintenance].
message RescheduleMaintenanceRequest { message RescheduleMaintenanceRequest {
// Reschedule options. // Reschedule options.
enum RescheduleType { enum RescheduleType {
@ -519,27 +624,29 @@ message RescheduleMaintenanceRequest {
// where `location_id` refers to a GCP region. // where `location_id` refers to a GCP region.
string name = 1 [ string name = 1 [
(google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { (google.api.resource_reference) = { type: "redis.googleapis.com/Instance" }
type: "redis.googleapis.com/Instance"
}
]; ];
// Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well. // Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as
// well.
RescheduleType reschedule_type = 2 [(google.api.field_behavior) = REQUIRED]; RescheduleType reschedule_type = 2 [(google.api.field_behavior) = REQUIRED];
// Optional. Timestamp when the maintenance shall be rescheduled to if // Optional. Timestamp when the maintenance shall be rescheduled to if
// reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for // reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for
// example `2012-11-15T16:19:00.094Z`. // example `2012-11-15T16:19:00.094Z`.
google.protobuf.Timestamp schedule_time = 3 [(google.api.field_behavior) = OPTIONAL]; google.protobuf.Timestamp schedule_time = 3
[(google.api.field_behavior) = OPTIONAL];
} }
// Maintenance policy for an instance. // Maintenance policy for an instance.
message MaintenancePolicy { message MaintenancePolicy {
// Output only. The time when the policy was created. // Output only. The time when the policy was created.
google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; google.protobuf.Timestamp create_time = 1
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time when the policy was last updated. // Output only. The time when the policy was last updated.
google.protobuf.Timestamp update_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; google.protobuf.Timestamp update_time = 2
[(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. Description of what this policy is for. Create/Update methods // Optional. Description of what this policy is for. Create/Update methods
// return INVALID_ARGUMENT if the length is greater than 512. // return INVALID_ARGUMENT if the length is greater than 512.
@ -548,7 +655,8 @@ message MaintenancePolicy {
// Optional. Maintenance window that is applied to resources covered by this // Optional. Maintenance window that is applied to resources covered by this
// policy. Minimum 1. For the current version, the maximum number of // policy. Minimum 1. For the current version, the maximum number of
// weekly_window is expected to be one. // weekly_window is expected to be one.
repeated WeeklyMaintenanceWindow weekly_maintenance_window = 4 [(google.api.field_behavior) = OPTIONAL]; repeated WeeklyMaintenanceWindow weekly_maintenance_window = 4
[(google.api.field_behavior) = OPTIONAL];
} }
// Time window in which disruptive maintenance updates occur. Non-disruptive // Time window in which disruptive maintenance updates occur. Non-disruptive
@ -560,25 +668,32 @@ message WeeklyMaintenanceWindow {
// Required. Start time of the window in UTC time. // Required. Start time of the window in UTC time.
google.type.TimeOfDay start_time = 2 [(google.api.field_behavior) = REQUIRED]; google.type.TimeOfDay start_time = 2 [(google.api.field_behavior) = REQUIRED];
// Output only. Duration of the maintenance window. The current window is fixed at 1 hour. // Output only. Duration of the maintenance window. The current window is
google.protobuf.Duration duration = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // fixed at 1 hour.
google.protobuf.Duration duration = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
} }
// Upcoming maintenance schedule. If no maintenance is scheduled, fields are not // Upcoming maintenance schedule. If no maintenance is scheduled, fields are not
// populated. // populated.
message MaintenanceSchedule { message MaintenanceSchedule {
// Output only. The start time of any upcoming scheduled maintenance for this instance. // Output only. The start time of any upcoming scheduled maintenance for this
google.protobuf.Timestamp start_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // instance.
google.protobuf.Timestamp start_time = 1
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The end time of any upcoming scheduled maintenance for this instance. // Output only. The end time of any upcoming scheduled maintenance for this
google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // instance.
google.protobuf.Timestamp end_time = 2
[(google.api.field_behavior) = OUTPUT_ONLY];
// If the scheduled maintenance can be rescheduled, default is true. // If the scheduled maintenance can be rescheduled, default is true.
bool can_reschedule = 3 [deprecated = true]; bool can_reschedule = 3 [deprecated = true];
// Output only. The deadline that the maintenance schedule start time can not go beyond, // Output only. The deadline that the maintenance schedule start time can not
// including reschedule. // go beyond, including reschedule.
google.protobuf.Timestamp schedule_deadline_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; google.protobuf.Timestamp schedule_deadline_time = 5
[(google.api.field_behavior) = OUTPUT_ONLY];
} }
// Request for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances]. // Request for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances].
@ -603,7 +718,8 @@ message ListInstancesRequest {
int32 page_size = 2; int32 page_size = 2;
// The `next_page_token` value returned from a previous // The `next_page_token` value returned from a previous
// [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances] request, if any. // [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances] request, if
// any.
string page_token = 3; string page_token = 3;
} }
@ -637,22 +753,19 @@ message GetInstanceRequest {
// where `location_id` refers to a GCP region. // where `location_id` refers to a GCP region.
string name = 1 [ string name = 1 [
(google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { (google.api.resource_reference) = { type: "redis.googleapis.com/Instance" }
type: "redis.googleapis.com/Instance"
}
]; ];
} }
// Request for [GetInstanceAuthString][google.cloud.redis.v1.CloudRedis.GetInstanceAuthString]. // Request for
// [GetInstanceAuthString][google.cloud.redis.v1.CloudRedis.GetInstanceAuthString].
message GetInstanceAuthStringRequest { message GetInstanceAuthStringRequest {
// Required. Redis instance resource name using the form: // Required. Redis instance resource name using the form:
// `projects/{project_id}/locations/{location_id}/instances/{instance_id}` // `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
// where `location_id` refers to a GCP region. // where `location_id` refers to a GCP region.
string name = 1 [ string name = 1 [
(google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { (google.api.resource_reference) = { type: "redis.googleapis.com/Instance" }
type: "redis.googleapis.com/Instance"
}
]; ];
} }
@ -662,7 +775,8 @@ message InstanceAuthString {
string auth_string = 1; string auth_string = 1;
} }
// Request for [CreateInstance][google.cloud.redis.v1.CloudRedis.CreateInstance]. // Request for
// [CreateInstance][google.cloud.redis.v1.CloudRedis.CreateInstance].
message CreateInstanceRequest { message CreateInstanceRequest {
// Required. The resource name of the instance location using the form: // Required. The resource name of the instance location using the form:
// `projects/{project_id}/locations/{location_id}` // `projects/{project_id}/locations/{location_id}`
@ -688,7 +802,8 @@ message CreateInstanceRequest {
Instance instance = 3 [(google.api.field_behavior) = REQUIRED]; Instance instance = 3 [(google.api.field_behavior) = REQUIRED];
} }
// Request for [UpdateInstance][google.cloud.redis.v1.CloudRedis.UpdateInstance]. // Request for
// [UpdateInstance][google.cloud.redis.v1.CloudRedis.UpdateInstance].
message UpdateInstanceRequest { message UpdateInstanceRequest {
// Required. Mask of fields to update. At least one path must be supplied in // 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 // this field. The elements of the repeated paths field may only include these
@ -699,39 +814,38 @@ message UpdateInstanceRequest {
// * `memorySizeGb` // * `memorySizeGb`
// * `redisConfig` // * `redisConfig`
// * `replica_count` // * `replica_count`
google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; google.protobuf.FieldMask update_mask = 1
[(google.api.field_behavior) = REQUIRED];
// Required. Update description. // Required. Update description.
// Only fields specified in update_mask are updated. // Only fields specified in update_mask are updated.
Instance instance = 2 [(google.api.field_behavior) = REQUIRED]; Instance instance = 2 [(google.api.field_behavior) = REQUIRED];
} }
// Request for [UpgradeInstance][google.cloud.redis.v1.CloudRedis.UpgradeInstance]. // Request for
// [UpgradeInstance][google.cloud.redis.v1.CloudRedis.UpgradeInstance].
message UpgradeInstanceRequest { message UpgradeInstanceRequest {
// Required. Redis instance resource name using the form: // Required. Redis instance resource name using the form:
// `projects/{project_id}/locations/{location_id}/instances/{instance_id}` // `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
// where `location_id` refers to a GCP region. // where `location_id` refers to a GCP region.
string name = 1 [ string name = 1 [
(google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { (google.api.resource_reference) = { type: "redis.googleapis.com/Instance" }
type: "redis.googleapis.com/Instance"
}
]; ];
// Required. Specifies the target version of Redis software to upgrade to. // Required. Specifies the target version of Redis software to upgrade to.
string redis_version = 2 [(google.api.field_behavior) = REQUIRED]; string redis_version = 2 [(google.api.field_behavior) = REQUIRED];
} }
// Request for [DeleteInstance][google.cloud.redis.v1.CloudRedis.DeleteInstance]. // Request for
// [DeleteInstance][google.cloud.redis.v1.CloudRedis.DeleteInstance].
message DeleteInstanceRequest { message DeleteInstanceRequest {
// Required. Redis instance resource name using the form: // Required. Redis instance resource name using the form:
// `projects/{project_id}/locations/{location_id}/instances/{instance_id}` // `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
// where `location_id` refers to a GCP region. // where `location_id` refers to a GCP region.
string name = 1 [ string name = 1 [
(google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { (google.api.resource_reference) = { type: "redis.googleapis.com/Instance" }
type: "redis.googleapis.com/Instance"
}
]; ];
} }
@ -811,14 +925,13 @@ message FailoverInstanceRequest {
// where `location_id` refers to a GCP region. // where `location_id` refers to a GCP region.
string name = 1 [ string name = 1 [
(google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { (google.api.resource_reference) = { type: "redis.googleapis.com/Instance" }
type: "redis.googleapis.com/Instance"
}
]; ];
// Optional. Available data protection modes that the user can choose. If it's // Optional. Available data protection modes that the user can choose. If it's
// unspecified, data protection mode will be LIMITED_DATA_LOSS by default. // unspecified, data protection mode will be LIMITED_DATA_LOSS by default.
DataProtectionMode data_protection_mode = 2 [(google.api.field_behavior) = OPTIONAL]; DataProtectionMode data_protection_mode = 2
[(google.api.field_behavior) = OPTIONAL];
} }
// Represents the v1 metadata of the long-running operation. // Represents the v1 metadata of the long-running operation.
@ -854,14 +967,13 @@ message LocationMetadata {
// by the lowercase ID of each zone, as defined by GCE. These keys can be // 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 // specified in `location_id` or `alternative_location_id` fields when
// creating a Redis instance. // creating a Redis instance.
map<string, ZoneMetadata> available_zones = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; map<string, ZoneMetadata> available_zones = 1
[(google.api.field_behavior) = OUTPUT_ONLY];
} }
// Defines specific information for a particular zone. Currently empty and // Defines specific information for a particular zone. Currently empty and
// reserved for future use only. // reserved for future use only.
message ZoneMetadata { message ZoneMetadata {}
}
// TlsCertificate Resource // TlsCertificate Resource
message TlsCertificate { message TlsCertificate {
@ -874,12 +986,14 @@ message TlsCertificate {
// Output only. The time when the certificate was created in [RFC // Output only. The time when the certificate was created in [RFC
// 3339](https://tools.ietf.org/html/rfc3339) format, for example // 3339](https://tools.ietf.org/html/rfc3339) format, for example
// `2020-05-18T00:00:00.094Z`. // `2020-05-18T00:00:00.094Z`.
google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; google.protobuf.Timestamp create_time = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time when the certificate expires in [RFC // Output only. The time when the certificate expires in [RFC
// 3339](https://tools.ietf.org/html/rfc3339) format, for example // 3339](https://tools.ietf.org/html/rfc3339) format, for example
// `2020-05-18T00:00:00.094Z`. // `2020-05-18T00:00:00.094Z`.
google.protobuf.Timestamp expire_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; google.protobuf.Timestamp expire_time = 4
[(google.api.field_behavior) = OUTPUT_ONLY];
// Sha1 Fingerprint of the certificate. // Sha1 Fingerprint of the certificate.
string sha1_fingerprint = 5; string sha1_fingerprint = 5;

@ -4,7 +4,9 @@ name: redis.googleapis.com
title: Google Cloud Memorystore for Redis API title: Google Cloud Memorystore for Redis API
apis: apis:
- name: google.cloud.location.Locations
- name: google.cloud.redis.v1.CloudRedis - name: google.cloud.redis.v1.CloudRedis
- name: google.longrunning.Operations
types: types:
- name: google.cloud.redis.v1.LocationMetadata - name: google.cloud.redis.v1.LocationMetadata

Loading…
Cancel
Save