Constants
CloudRedis_ListInstances_FullMethodName, CloudRedis_GetInstance_FullMethodName, CloudRedis_GetInstanceAuthString_FullMethodName, CloudRedis_CreateInstance_FullMethodName, CloudRedis_UpdateInstance_FullMethodName, CloudRedis_UpgradeInstance_FullMethodName, CloudRedis_ImportInstance_FullMethodName, CloudRedis_ExportInstance_FullMethodName, CloudRedis_FailoverInstance_FullMethodName, CloudRedis_DeleteInstance_FullMethodName, CloudRedis_RescheduleMaintenance_FullMethodName
const
(
CloudRedis_ListInstances_FullMethodName
=
"/google.cloud.redis.v1.CloudRedis/ListInstances"
CloudRedis_GetInstance_FullMethodName
=
"/google.cloud.redis.v1.CloudRedis/GetInstance"
CloudRedis_GetInstanceAuthString_FullMethodName
=
"/google.cloud.redis.v1.CloudRedis/GetInstanceAuthString"
CloudRedis_CreateInstance_FullMethodName
=
"/google.cloud.redis.v1.CloudRedis/CreateInstance"
CloudRedis_UpdateInstance_FullMethodName
=
"/google.cloud.redis.v1.CloudRedis/UpdateInstance"
CloudRedis_UpgradeInstance_FullMethodName
=
"/google.cloud.redis.v1.CloudRedis/UpgradeInstance"
CloudRedis_ImportInstance_FullMethodName
=
"/google.cloud.redis.v1.CloudRedis/ImportInstance"
CloudRedis_ExportInstance_FullMethodName
=
"/google.cloud.redis.v1.CloudRedis/ExportInstance"
CloudRedis_FailoverInstance_FullMethodName
=
"/google.cloud.redis.v1.CloudRedis/FailoverInstance"
CloudRedis_DeleteInstance_FullMethodName
=
"/google.cloud.redis.v1.CloudRedis/DeleteInstance"
CloudRedis_RescheduleMaintenance_FullMethodName
=
"/google.cloud.redis.v1.CloudRedis/RescheduleMaintenance"
)
Variables
Instance_State_name, Instance_State_value
var
(
Instance_State_name
=
map
[
int32
]
string
{
0
:
"STATE_UNSPECIFIED"
,
1
:
"CREATING"
,
2
:
"READY"
,
3
:
"UPDATING"
,
4
:
"DELETING"
,
5
:
"REPAIRING"
,
6
:
"MAINTENANCE"
,
8
:
"IMPORTING"
,
9
:
"FAILING_OVER"
,
}
Instance_State_value
=
map
[
string
]
int32
{
"STATE_UNSPECIFIED"
:
0
,
"CREATING"
:
1
,
"READY"
:
2
,
"UPDATING"
:
3
,
"DELETING"
:
4
,
"REPAIRING"
:
5
,
"MAINTENANCE"
:
6
,
"IMPORTING"
:
8
,
"FAILING_OVER"
:
9
,
}
)
Enum value maps for Instance_State.
Instance_Tier_name, Instance_Tier_value
var
(
Instance_Tier_name
=
map
[
int32
]
string
{
0
:
"TIER_UNSPECIFIED"
,
1
:
"BASIC"
,
3
:
"STANDARD_HA"
,
}
Instance_Tier_value
=
map
[
string
]
int32
{
"TIER_UNSPECIFIED"
:
0
,
"BASIC"
:
1
,
"STANDARD_HA"
:
3
,
}
)
Enum value maps for Instance_Tier.
Instance_ConnectMode_name, Instance_ConnectMode_value
var
(
Instance_ConnectMode_name
=
map
[
int32
]
string
{
0
:
"CONNECT_MODE_UNSPECIFIED"
,
1
:
"DIRECT_PEERING"
,
2
:
"PRIVATE_SERVICE_ACCESS"
,
}
Instance_ConnectMode_value
=
map
[
string
]
int32
{
"CONNECT_MODE_UNSPECIFIED"
:
0
,
"DIRECT_PEERING"
:
1
,
"PRIVATE_SERVICE_ACCESS"
:
2
,
}
)
Enum value maps for Instance_ConnectMode.
Instance_TransitEncryptionMode_name, Instance_TransitEncryptionMode_value
var
(
Instance_TransitEncryptionMode_name
=
map
[
int32
]
string
{
0
:
"TRANSIT_ENCRYPTION_MODE_UNSPECIFIED"
,
1
:
"SERVER_AUTHENTICATION"
,
2
:
"DISABLED"
,
}
Instance_TransitEncryptionMode_value
=
map
[
string
]
int32
{
"TRANSIT_ENCRYPTION_MODE_UNSPECIFIED"
:
0
,
"SERVER_AUTHENTICATION"
:
1
,
"DISABLED"
:
2
,
}
)
Enum value maps for Instance_TransitEncryptionMode.
Instance_ReadReplicasMode_name, Instance_ReadReplicasMode_value
var
(
Instance_ReadReplicasMode_name
=
map
[
int32
]
string
{
0
:
"READ_REPLICAS_MODE_UNSPECIFIED"
,
1
:
"READ_REPLICAS_DISABLED"
,
2
:
"READ_REPLICAS_ENABLED"
,
}
Instance_ReadReplicasMode_value
=
map
[
string
]
int32
{
"READ_REPLICAS_MODE_UNSPECIFIED"
:
0
,
"READ_REPLICAS_DISABLED"
:
1
,
"READ_REPLICAS_ENABLED"
:
2
,
}
)
Enum value maps for Instance_ReadReplicasMode.
Instance_SuspensionReason_name, Instance_SuspensionReason_value
var
(
Instance_SuspensionReason_name
=
map
[
int32
]
string
{
0
:
"SUSPENSION_REASON_UNSPECIFIED"
,
1
:
"CUSTOMER_MANAGED_KEY_ISSUE"
,
}
Instance_SuspensionReason_value
=
map
[
string
]
int32
{
"SUSPENSION_REASON_UNSPECIFIED"
:
0
,
"CUSTOMER_MANAGED_KEY_ISSUE"
:
1
,
}
)
Enum value maps for Instance_SuspensionReason.
PersistenceConfig_PersistenceMode_name, PersistenceConfig_PersistenceMode_value
var
(
PersistenceConfig_PersistenceMode_name
=
map
[
int32
]
string
{
0
:
"PERSISTENCE_MODE_UNSPECIFIED"
,
1
:
"DISABLED"
,
2
:
"RDB"
,
}
PersistenceConfig_PersistenceMode_value
=
map
[
string
]
int32
{
"PERSISTENCE_MODE_UNSPECIFIED"
:
0
,
"DISABLED"
:
1
,
"RDB"
:
2
,
}
)
Enum value maps for PersistenceConfig_PersistenceMode.
PersistenceConfig_SnapshotPeriod_name, PersistenceConfig_SnapshotPeriod_value
var
(
PersistenceConfig_SnapshotPeriod_name
=
map
[
int32
]
string
{
0
:
"SNAPSHOT_PERIOD_UNSPECIFIED"
,
3
:
"ONE_HOUR"
,
4
:
"SIX_HOURS"
,
5
:
"TWELVE_HOURS"
,
6
:
"TWENTY_FOUR_HOURS"
,
}
PersistenceConfig_SnapshotPeriod_value
=
map
[
string
]
int32
{
"SNAPSHOT_PERIOD_UNSPECIFIED"
:
0
,
"ONE_HOUR"
:
3
,
"SIX_HOURS"
:
4
,
"TWELVE_HOURS"
:
5
,
"TWENTY_FOUR_HOURS"
:
6
,
}
)
Enum value maps for PersistenceConfig_SnapshotPeriod.
RescheduleMaintenanceRequest_RescheduleType_name, RescheduleMaintenanceRequest_RescheduleType_value
var
(
RescheduleMaintenanceRequest_RescheduleType_name
=
map
[
int32
]
string
{
0
:
"RESCHEDULE_TYPE_UNSPECIFIED"
,
1
:
"IMMEDIATE"
,
2
:
"NEXT_AVAILABLE_WINDOW"
,
3
:
"SPECIFIC_TIME"
,
}
RescheduleMaintenanceRequest_RescheduleType_value
=
map
[
string
]
int32
{
"RESCHEDULE_TYPE_UNSPECIFIED"
:
0
,
"IMMEDIATE"
:
1
,
"NEXT_AVAILABLE_WINDOW"
:
2
,
"SPECIFIC_TIME"
:
3
,
}
)
Enum value maps for RescheduleMaintenanceRequest_RescheduleType.
FailoverInstanceRequest_DataProtectionMode_name, FailoverInstanceRequest_DataProtectionMode_value
var
(
FailoverInstanceRequest_DataProtectionMode_name
=
map
[
int32
]
string
{
0
:
"DATA_PROTECTION_MODE_UNSPECIFIED"
,
1
:
"LIMITED_DATA_LOSS"
,
2
:
"FORCE_DATA_LOSS"
,
}
FailoverInstanceRequest_DataProtectionMode_value
=
map
[
string
]
int32
{
"DATA_PROTECTION_MODE_UNSPECIFIED"
:
0
,
"LIMITED_DATA_LOSS"
:
1
,
"FORCE_DATA_LOSS"
:
2
,
}
)
Enum value maps for FailoverInstanceRequest_DataProtectionMode.
CloudRedis_ServiceDesc
var
CloudRedis_ServiceDesc
=
grpc
.
ServiceDesc
{
ServiceName
:
"google.cloud.redis.v1.CloudRedis"
,
HandlerType
:
(
*
CloudRedisServer
)(
nil
),
Methods
:
[]
grpc
.
MethodDesc
{
{
MethodName
:
"ListInstances"
,
Handler
:
_CloudRedis_ListInstances_Handler
,
},
{
MethodName
:
"GetInstance"
,
Handler
:
_CloudRedis_GetInstance_Handler
,
},
{
MethodName
:
"GetInstanceAuthString"
,
Handler
:
_CloudRedis_GetInstanceAuthString_Handler
,
},
{
MethodName
:
"CreateInstance"
,
Handler
:
_CloudRedis_CreateInstance_Handler
,
},
{
MethodName
:
"UpdateInstance"
,
Handler
:
_CloudRedis_UpdateInstance_Handler
,
},
{
MethodName
:
"UpgradeInstance"
,
Handler
:
_CloudRedis_UpgradeInstance_Handler
,
},
{
MethodName
:
"ImportInstance"
,
Handler
:
_CloudRedis_ImportInstance_Handler
,
},
{
MethodName
:
"ExportInstance"
,
Handler
:
_CloudRedis_ExportInstance_Handler
,
},
{
MethodName
:
"FailoverInstance"
,
Handler
:
_CloudRedis_FailoverInstance_Handler
,
},
{
MethodName
:
"DeleteInstance"
,
Handler
:
_CloudRedis_DeleteInstance_Handler
,
},
{
MethodName
:
"RescheduleMaintenance"
,
Handler
:
_CloudRedis_RescheduleMaintenance_Handler
,
},
},
Streams
:
[]
grpc
.
StreamDesc
{},
Metadata
:
"google/cloud/redis/v1/cloud_redis.proto"
,
}
CloudRedis_ServiceDesc is the grpc.ServiceDesc for CloudRedis service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
File_google_cloud_redis_v1_cloud_redis_proto
var
File_google_cloud_redis_v1_cloud_redis_proto
protoreflect
.
FileDescriptor
Functions
func RegisterCloudRedisServer
func
RegisterCloudRedisServer
(
s
grpc
.
ServiceRegistrar
,
srv
CloudRedisServer
)
CloudRedisClient
type
CloudRedisClient
interface
{
// 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.
ListInstances
(
ctx
context
.
Context
,
in
*
ListInstancesRequest
,
opts
...
grpc
.
CallOption
)
(
*
ListInstancesResponse
,
error
)
// Gets the details of a specific Redis instance.
GetInstance
(
ctx
context
.
Context
,
in
*
GetInstanceRequest
,
opts
...
grpc
.
CallOption
)
(
*
Instance
,
error
)
// 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
// the details returned to GetInstance.
GetInstanceAuthString
(
ctx
context
.
Context
,
in
*
GetInstanceAuthStringRequest
,
opts
...
grpc
.
CallOption
)
(
*
InstanceAuthString
,
error
)
// Creates a Redis instance based on the specified tier and memory size.
//
// By default, the instance is accessible from the project's
// [default network](https://cloud.google.com/vpc/docs/vpc).
//
// 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.
CreateInstance
(
ctx
context
.
Context
,
in
*
CreateInstanceRequest
,
opts
...
grpc
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
// 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.
UpdateInstance
(
ctx
context
.
Context
,
in
*
UpdateInstanceRequest
,
opts
...
grpc
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
// Upgrades Redis instance to the newer Redis version specified in the
// request.
UpgradeInstance
(
ctx
context
.
Context
,
in
*
UpgradeInstanceRequest
,
opts
...
grpc
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
// 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.
ImportInstance
(
ctx
context
.
Context
,
in
*
ImportInstanceRequest
,
opts
...
grpc
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
// 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.
ExportInstance
(
ctx
context
.
Context
,
in
*
ExportInstanceRequest
,
opts
...
grpc
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
// Initiates a failover of the primary node to current replica node for a
// specific STANDARD tier Cloud Memorystore for Redis instance.
FailoverInstance
(
ctx
context
.
Context
,
in
*
FailoverInstanceRequest
,
opts
...
grpc
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
// Deletes a specific Redis instance. Instance stops serving and data is
// deleted.
DeleteInstance
(
ctx
context
.
Context
,
in
*
DeleteInstanceRequest
,
opts
...
grpc
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
// Reschedule maintenance for a given instance in a given project and
// location.
RescheduleMaintenance
(
ctx
context
.
Context
,
in
*
RescheduleMaintenanceRequest
,
opts
...
grpc
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
}
CloudRedisClient is the client API for CloudRedis service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream .
func NewCloudRedisClient
func
NewCloudRedisClient
(
cc
grpc
.
ClientConnInterface
)
CloudRedisClient
CloudRedisServer
type
CloudRedisServer
interface
{
// 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.
ListInstances
(
context
.
Context
,
*
ListInstancesRequest
)
(
*
ListInstancesResponse
,
error
)
// Gets the details of a specific Redis instance.
GetInstance
(
context
.
Context
,
*
GetInstanceRequest
)
(
*
Instance
,
error
)
// 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
// the details returned to GetInstance.
GetInstanceAuthString
(
context
.
Context
,
*
GetInstanceAuthStringRequest
)
(
*
InstanceAuthString
,
error
)
// Creates a Redis instance based on the specified tier and memory size.
//
// By default, the instance is accessible from the project's
// [default network](https://cloud.google.com/vpc/docs/vpc).
//
// 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.
CreateInstance
(
context
.
Context
,
*
CreateInstanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
// 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.
UpdateInstance
(
context
.
Context
,
*
UpdateInstanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
// Upgrades Redis instance to the newer Redis version specified in the
// request.
UpgradeInstance
(
context
.
Context
,
*
UpgradeInstanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
// 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.
ImportInstance
(
context
.
Context
,
*
ImportInstanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
// 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.
ExportInstance
(
context
.
Context
,
*
ExportInstanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
// Initiates a failover of the primary node to current replica node for a
// specific STANDARD tier Cloud Memorystore for Redis instance.
FailoverInstance
(
context
.
Context
,
*
FailoverInstanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
// Deletes a specific Redis instance. Instance stops serving and data is
// deleted.
DeleteInstance
(
context
.
Context
,
*
DeleteInstanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
// Reschedule maintenance for a given instance in a given project and
// location.
RescheduleMaintenance
(
context
.
Context
,
*
RescheduleMaintenanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
}
CloudRedisServer is the server API for CloudRedis service. All implementations should embed UnimplementedCloudRedisServer for forward compatibility
CreateInstanceRequest
type
CreateInstanceRequest
struct
{
// 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.
Parent
string
`protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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
InstanceId
string
`protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
// Required. A Redis [Instance] resource
Instance
*
Instance
`protobuf:"bytes,3,opt,name=instance,proto3" json:"instance,omitempty"`
// contains filtered or unexported fields
}
Request for [CreateInstance][google.cloud.redis.v1.CloudRedis.CreateInstance].
func (*CreateInstanceRequest) Descriptor
func
(
*
CreateInstanceRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use CreateInstanceRequest.ProtoReflect.Descriptor instead.
func (*CreateInstanceRequest) GetInstance
func
(
x
*
CreateInstanceRequest
)
GetInstance
()
*
Instance
func (*CreateInstanceRequest) GetInstanceId
func
(
x
*
CreateInstanceRequest
)
GetInstanceId
()
string
func (*CreateInstanceRequest) GetParent
func
(
x
*
CreateInstanceRequest
)
GetParent
()
string
func (*CreateInstanceRequest) ProtoMessage
func
(
*
CreateInstanceRequest
)
ProtoMessage
()
func (*CreateInstanceRequest) ProtoReflect
func
(
x
*
CreateInstanceRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*CreateInstanceRequest) Reset
func
(
x
*
CreateInstanceRequest
)
Reset
()
func (*CreateInstanceRequest) String
func
(
x
*
CreateInstanceRequest
)
String
()
string
DeleteInstanceRequest
type
DeleteInstanceRequest
struct
{
// 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.
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for [DeleteInstance][google.cloud.redis.v1.CloudRedis.DeleteInstance].
func (*DeleteInstanceRequest) Descriptor
func
(
*
DeleteInstanceRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use DeleteInstanceRequest.ProtoReflect.Descriptor instead.
func (*DeleteInstanceRequest) GetName
func
(
x
*
DeleteInstanceRequest
)
GetName
()
string
func (*DeleteInstanceRequest) ProtoMessage
func
(
*
DeleteInstanceRequest
)
ProtoMessage
()
func (*DeleteInstanceRequest) ProtoReflect
func
(
x
*
DeleteInstanceRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*DeleteInstanceRequest) Reset
func
(
x
*
DeleteInstanceRequest
)
Reset
()
func (*DeleteInstanceRequest) String
func
(
x
*
DeleteInstanceRequest
)
String
()
string
ExportInstanceRequest
type
ExportInstanceRequest
struct
{
// 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.
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Specify data to be exported.
OutputConfig
*
OutputConfig
`protobuf:"bytes,3,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
// contains filtered or unexported fields
}
Request for [Export][google.cloud.redis.v1.CloudRedis.ExportInstance].
func (*ExportInstanceRequest) Descriptor
func
(
*
ExportInstanceRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ExportInstanceRequest.ProtoReflect.Descriptor instead.
func (*ExportInstanceRequest) GetName
func
(
x
*
ExportInstanceRequest
)
GetName
()
string
func (*ExportInstanceRequest) GetOutputConfig
func
(
x
*
ExportInstanceRequest
)
GetOutputConfig
()
*
OutputConfig
func (*ExportInstanceRequest) ProtoMessage
func
(
*
ExportInstanceRequest
)
ProtoMessage
()
func (*ExportInstanceRequest) ProtoReflect
func
(
x
*
ExportInstanceRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*ExportInstanceRequest) Reset
func
(
x
*
ExportInstanceRequest
)
Reset
()
func (*ExportInstanceRequest) String
func
(
x
*
ExportInstanceRequest
)
String
()
string
FailoverInstanceRequest
type
FailoverInstanceRequest
struct
{
// 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.
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Available data protection modes that the user can choose. If it's
// unspecified, data protection mode will be LIMITED_DATA_LOSS by default.
DataProtectionMode
FailoverInstanceRequest_DataProtectionMode
`protobuf:"varint,2,opt,name=data_protection_mode,json=dataProtectionMode,proto3,enum=google.cloud.redis.v1.FailoverInstanceRequest_DataProtectionMode" json:"data_protection_mode,omitempty"`
// contains filtered or unexported fields
}
Request for [Failover][google.cloud.redis.v1.CloudRedis.FailoverInstance].
func (*FailoverInstanceRequest) Descriptor
func
(
*
FailoverInstanceRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use FailoverInstanceRequest.ProtoReflect.Descriptor instead.
func (*FailoverInstanceRequest) GetDataProtectionMode
func
(
x
*
FailoverInstanceRequest
)
GetDataProtectionMode
()
FailoverInstanceRequest_DataProtectionMode
func (*FailoverInstanceRequest) GetName
func
(
x
*
FailoverInstanceRequest
)
GetName
()
string
func (*FailoverInstanceRequest) ProtoMessage
func
(
*
FailoverInstanceRequest
)
ProtoMessage
()
func (*FailoverInstanceRequest) ProtoReflect
func
(
x
*
FailoverInstanceRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*FailoverInstanceRequest) Reset
func
(
x
*
FailoverInstanceRequest
)
Reset
()
func (*FailoverInstanceRequest) String
func
(
x
*
FailoverInstanceRequest
)
String
()
string
FailoverInstanceRequest_DataProtectionMode
type
FailoverInstanceRequest_DataProtectionMode
int32
Specifies different modes of operation in relation to the data retention.
FailoverInstanceRequest_DATA_PROTECTION_MODE_UNSPECIFIED, FailoverInstanceRequest_LIMITED_DATA_LOSS, FailoverInstanceRequest_FORCE_DATA_LOSS
const
(
// Defaults to LIMITED_DATA_LOSS if a data protection mode is not
// specified.
FailoverInstanceRequest_DATA_PROTECTION_MODE_UNSPECIFIED
FailoverInstanceRequest_DataProtectionMode
=
0
// Instance failover will be protected with data loss control. More
// specifically, the failover will only be performed if the current
// replication offset diff between primary and replica is under a certain
// threshold.
FailoverInstanceRequest_LIMITED_DATA_LOSS
FailoverInstanceRequest_DataProtectionMode
=
1
// Instance failover will be performed without data loss control.
FailoverInstanceRequest_FORCE_DATA_LOSS
FailoverInstanceRequest_DataProtectionMode
=
2
)
func (FailoverInstanceRequest_DataProtectionMode) Descriptor
func
(
FailoverInstanceRequest_DataProtectionMode
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (FailoverInstanceRequest_DataProtectionMode) Enum
func
(
x
FailoverInstanceRequest_DataProtectionMode
)
Enum
()
*
FailoverInstanceRequest_DataProtectionMode
func (FailoverInstanceRequest_DataProtectionMode) EnumDescriptor
func
(
FailoverInstanceRequest_DataProtectionMode
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use FailoverInstanceRequest_DataProtectionMode.Descriptor instead.
func (FailoverInstanceRequest_DataProtectionMode) Number
func
(
x
FailoverInstanceRequest_DataProtectionMode
)
Number
()
protoreflect
.
EnumNumber
func (FailoverInstanceRequest_DataProtectionMode) String
func
(
x
FailoverInstanceRequest_DataProtectionMode
)
String
()
string
func (FailoverInstanceRequest_DataProtectionMode) Type
func
(
FailoverInstanceRequest_DataProtectionMode
)
Type
()
protoreflect
.
EnumType
GcsDestination
type
GcsDestination
struct
{
// Required. Data destination URI (e.g.
// 'gs://my_bucket/my_object'). Existing files will be overwritten.
Uri
string
`protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// contains filtered or unexported fields
}
The Cloud Storage location for the output content
func (*GcsDestination) Descriptor
func
(
*
GcsDestination
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use GcsDestination.ProtoReflect.Descriptor instead.
func (*GcsDestination) GetUri
func
(
x
*
GcsDestination
)
GetUri
()
string
func (*GcsDestination) ProtoMessage
func
(
*
GcsDestination
)
ProtoMessage
()
func (*GcsDestination) ProtoReflect
func
(
x
*
GcsDestination
)
ProtoReflect
()
protoreflect
.
Message
func (*GcsDestination) Reset
func
(
x
*
GcsDestination
)
Reset
()
func (*GcsDestination) String
func
(
x
*
GcsDestination
)
String
()
string
GcsSource
type
GcsSource
struct
{
// Required. Source data URI. (e.g. 'gs://my_bucket/my_object').
Uri
string
`protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// contains filtered or unexported fields
}
The Cloud Storage location for the input content
func (*GcsSource) Descriptor
Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.
func (*GcsSource) GetUri
func (*GcsSource) ProtoMessage
func
(
*
GcsSource
)
ProtoMessage
()
func (*GcsSource) ProtoReflect
func
(
x
*
GcsSource
)
ProtoReflect
()
protoreflect
.
Message
func (*GcsSource) Reset
func
(
x
*
GcsSource
)
Reset
()
func (*GcsSource) String
GetInstanceAuthStringRequest
type
GetInstanceAuthStringRequest
struct
{
// 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.
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for [GetInstanceAuthString][google.cloud.redis.v1.CloudRedis.GetInstanceAuthString].
func (*GetInstanceAuthStringRequest) Descriptor
func
(
*
GetInstanceAuthStringRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use GetInstanceAuthStringRequest.ProtoReflect.Descriptor instead.
func (*GetInstanceAuthStringRequest) GetName
func
(
x
*
GetInstanceAuthStringRequest
)
GetName
()
string
func (*GetInstanceAuthStringRequest) ProtoMessage
func
(
*
GetInstanceAuthStringRequest
)
ProtoMessage
()
func (*GetInstanceAuthStringRequest) ProtoReflect
func
(
x
*
GetInstanceAuthStringRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*GetInstanceAuthStringRequest) Reset
func
(
x
*
GetInstanceAuthStringRequest
)
Reset
()
func (*GetInstanceAuthStringRequest) String
func
(
x
*
GetInstanceAuthStringRequest
)
String
()
string
GetInstanceRequest
type
GetInstanceRequest
struct
{
// 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.
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for [GetInstance][google.cloud.redis.v1.CloudRedis.GetInstance].
func (*GetInstanceRequest) Descriptor
func
(
*
GetInstanceRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use GetInstanceRequest.ProtoReflect.Descriptor instead.
func (*GetInstanceRequest) GetName
func
(
x
*
GetInstanceRequest
)
GetName
()
string
func (*GetInstanceRequest) ProtoMessage
func
(
*
GetInstanceRequest
)
ProtoMessage
()
func (*GetInstanceRequest) ProtoReflect
func
(
x
*
GetInstanceRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*GetInstanceRequest) Reset
func
(
x
*
GetInstanceRequest
)
Reset
()
func (*GetInstanceRequest) String
func
(
x
*
GetInstanceRequest
)
String
()
string
ImportInstanceRequest
type
ImportInstanceRequest
struct
{
// 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.
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Specify data to be imported.
InputConfig
*
InputConfig
`protobuf:"bytes,3,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
// contains filtered or unexported fields
}
Request for [Import][google.cloud.redis.v1.CloudRedis.ImportInstance].
func (*ImportInstanceRequest) Descriptor
func
(
*
ImportInstanceRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ImportInstanceRequest.ProtoReflect.Descriptor instead.
func (*ImportInstanceRequest) GetInputConfig
func
(
x
*
ImportInstanceRequest
)
GetInputConfig
()
*
InputConfig
func (*ImportInstanceRequest) GetName
func
(
x
*
ImportInstanceRequest
)
GetName
()
string
func (*ImportInstanceRequest) ProtoMessage
func
(
*
ImportInstanceRequest
)
ProtoMessage
()
func (*ImportInstanceRequest) ProtoReflect
func
(
x
*
ImportInstanceRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*ImportInstanceRequest) Reset
func
(
x
*
ImportInstanceRequest
)
Reset
()
func (*ImportInstanceRequest) String
func
(
x
*
ImportInstanceRequest
)
String
()
string
InputConfig
type
InputConfig
struct
{
// Required. Specify source location of input data
//
// Types that are assignable to Source:
//
// *InputConfig_GcsSource
Source
isInputConfig_Source
`protobuf_oneof:"source"`
// contains filtered or unexported fields
}
The input content
func (*InputConfig) Descriptor
func
(
*
InputConfig
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use InputConfig.ProtoReflect.Descriptor instead.
func (*InputConfig) GetGcsSource
func
(
x
*
InputConfig
)
GetGcsSource
()
*
GcsSource
func (*InputConfig) GetSource
func
(
m
*
InputConfig
)
GetSource
()
isInputConfig_Source
func (*InputConfig) ProtoMessage
func
(
*
InputConfig
)
ProtoMessage
()
func (*InputConfig) ProtoReflect
func
(
x
*
InputConfig
)
ProtoReflect
()
protoreflect
.
Message
func (*InputConfig) Reset
func
(
x
*
InputConfig
)
Reset
()
func (*InputConfig) String
func
(
x
*
InputConfig
)
String
()
string
InputConfig_GcsSource
type
InputConfig_GcsSource
struct
{
// Google Cloud Storage location where input content is located.
GcsSource
*
GcsSource
`protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}
Instance
type
Instance
struct
{
// 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][google.cloud.redis.v1.Instance.location_id] and
// [alternative_location_id][google.cloud.redis.v1.Instance.alternative_location_id]
// fields for more details.
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// An arbitrary and optional user-provided name for the instance.
DisplayName
string
`protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Resource labels to represent user provided metadata
Labels
map
[
string
]
string
`protobuf:"bytes,3,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. The zone where the instance will be provisioned. If not provided,
// the service will choose a zone from the specified region for the instance.
// For standard tier, additional nodes will be added across multiple zones for
// protection against zonal failures. If specified, at least one node will be
// provisioned in this zone.
LocationId
string
`protobuf:"bytes,4,opt,name=location_id,json=locationId,proto3" json:"location_id,omitempty"`
// Optional. If specified, at least one node will be provisioned in this zone
// in addition to the zone specified in location_id. Only applicable to
// standard tier. If provided, it must be a different zone from the one
// provided in [location_id]. Additional nodes beyond the first 2 will be
// placed in zones selected by the service.
AlternativeLocationId
string
`protobuf:"bytes,5,opt,name=alternative_location_id,json=alternativeLocationId,proto3" json:"alternative_location_id,omitempty"`
// Optional. The version of Redis software.
// If not provided, latest supported version will be used. Currently, the
// supported values are:
//
// - `REDIS_3_2` for Redis 3.2 compatibility
// - `REDIS_4_0` for Redis 4.0 compatibility (default)
// - `REDIS_5_0` for Redis 5.0 compatibility
// - `REDIS_6_X` for Redis 6.x compatibility
RedisVersion
string
`protobuf:"bytes,7,opt,name=redis_version,json=redisVersion,proto3" json:"redis_version,omitempty"`
// Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses
// that are reserved for this instance. Range must
// be unique and non-overlapping with existing subnets in an authorized
// network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP
// address ranges associated with this private service access connection.
// If not provided, the service will choose an unused /29 block, for
// example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED
// the default block size is /28.
ReservedIpRange
string
`protobuf:"bytes,9,opt,name=reserved_ip_range,json=reservedIpRange,proto3" json:"reserved_ip_range,omitempty"`
// Optional. Additional IP range for node placement. Required when enabling
// read replicas on an existing instance. For DIRECT_PEERING mode value must
// be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode
// value must be the name of an allocated address range associated with the
// private service access connection, or "auto".
SecondaryIpRange
string
`protobuf:"bytes,30,opt,name=secondary_ip_range,json=secondaryIpRange,proto3" json:"secondary_ip_range,omitempty"`
// Output only. Hostname or IP address of the exposed Redis endpoint used by
// clients to connect to the service.
Host
string
`protobuf:"bytes,10,opt,name=host,proto3" json:"host,omitempty"`
// Output only. The port number of the exposed Redis endpoint.
Port
int32
`protobuf:"varint,11,opt,name=port,proto3" json:"port,omitempty"`
// Output only. The current zone where the Redis primary node is located. In
// basic tier, this will always be the same as [location_id]. In
// standard tier, this can be the zone of any node in the instance.
CurrentLocationId
string
`protobuf:"bytes,12,opt,name=current_location_id,json=currentLocationId,proto3" json:"current_location_id,omitempty"`
// Output only. The time the instance was created.
CreateTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,13,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The current state of this instance.
State
Instance_State
`protobuf:"varint,14,opt,name=state,proto3,enum=google.cloud.redis.v1.Instance_State" json:"state,omitempty"`
// Output only. Additional information about the current status of this
// instance, if available.
StatusMessage
string
`protobuf:"bytes,15,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
// Optional. Redis configuration parameters, according to
// http://redis.io/topics/config. Currently, the only supported parameters
// are:
//
// Redis version 3.2 and newer:
//
// * maxmemory-policy
// * notify-keyspace-events
//
// Redis version 4.0 and newer:
//
// * activedefrag
// * lfu-decay-time
// * lfu-log-factor
// * maxmemory-gb
//
// Redis version 5.0 and newer:
//
// * stream-node-max-bytes
// * stream-node-max-entries
RedisConfigs
map
[
string
]
string
`protobuf:"bytes,16,rep,name=redis_configs,json=redisConfigs,proto3" json:"redis_configs,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Required. The service tier of the instance.
Tier
Instance_Tier
`protobuf:"varint,17,opt,name=tier,proto3,enum=google.cloud.redis.v1.Instance_Tier" json:"tier,omitempty"`
// Required. Redis memory size in GiB.
MemorySizeGb
int32
`protobuf:"varint,18,opt,name=memory_size_gb,json=memorySizeGb,proto3" json:"memory_size_gb,omitempty"`
// Optional. The full name of the Google Compute Engine
// [network](https://cloud.google.com/vpc/docs/vpc) to which the
// instance is connected. If left unspecified, the `default` network
// will be used.
AuthorizedNetwork
string
`protobuf:"bytes,20,opt,name=authorized_network,json=authorizedNetwork,proto3" json:"authorized_network,omitempty"`
// Output only. Cloud IAM identity used by import / export operations to
// transfer data to/from Cloud Storage. Format is
// "serviceAccount:
A Memorystore for Redis instance.
func (*Instance) Descriptor
Deprecated: Use Instance.ProtoReflect.Descriptor instead.
func (*Instance) GetAlternativeLocationId
func (*Instance) GetAuthEnabled
func (*Instance) GetAuthorizedNetwork
func (*Instance) GetAvailableMaintenanceVersions
func (*Instance) GetConnectMode
func
(
x
*
Instance
)
GetConnectMode
()
Instance_ConnectMode
func (*Instance) GetCreateTime
func
(
x
*
Instance
)
GetCreateTime
()
*
timestamppb
.
Timestamp
func (*Instance) GetCurrentLocationId
func (*Instance) GetCustomerManagedKey
func (*Instance) GetDisplayName
func (*Instance) GetHost
func (*Instance) GetLabels
func (*Instance) GetLocationId
func (*Instance) GetMaintenancePolicy
func
(
x
*
Instance
)
GetMaintenancePolicy
()
*
MaintenancePolicy
func (*Instance) GetMaintenanceSchedule
func
(
x
*
Instance
)
GetMaintenanceSchedule
()
*
MaintenanceSchedule
func (*Instance) GetMaintenanceVersion
func (*Instance) GetMemorySizeGb
func (*Instance) GetName
func (*Instance) GetNodes
func (*Instance) GetPersistenceConfig
func
(
x
*
Instance
)
GetPersistenceConfig
()
*
PersistenceConfig
func (*Instance) GetPersistenceIamIdentity
func (*Instance) GetPort
func (*Instance) GetReadEndpoint
func (*Instance) GetReadEndpointPort
func (*Instance) GetReadReplicasMode
func
(
x
*
Instance
)
GetReadReplicasMode
()
Instance_ReadReplicasMode
func (*Instance) GetRedisConfigs
func (*Instance) GetRedisVersion
func (*Instance) GetReplicaCount
func (*Instance) GetReservedIpRange
func (*Instance) GetSecondaryIpRange
func (*Instance) GetServerCaCerts
func
(
x
*
Instance
)
GetServerCaCerts
()
[]
*
TlsCertificate
func (*Instance) GetState
func
(
x
*
Instance
)
GetState
()
Instance_State
func (*Instance) GetStatusMessage
func (*Instance) GetSuspensionReasons
func
(
x
*
Instance
)
GetSuspensionReasons
()
[]
Instance_SuspensionReason
func (*Instance) GetTier
func
(
x
*
Instance
)
GetTier
()
Instance_Tier
func (*Instance) GetTransitEncryptionMode
func
(
x
*
Instance
)
GetTransitEncryptionMode
()
Instance_TransitEncryptionMode
func (*Instance) ProtoMessage
func
(
*
Instance
)
ProtoMessage
()
func (*Instance) ProtoReflect
func
(
x
*
Instance
)
ProtoReflect
()
protoreflect
.
Message
func (*Instance) Reset
func
(
x
*
Instance
)
Reset
()
func (*Instance) String
InstanceAuthString
type
InstanceAuthString
struct
{
// AUTH string set on the instance.
AuthString
string
`protobuf:"bytes,1,opt,name=auth_string,json=authString,proto3" json:"auth_string,omitempty"`
// contains filtered or unexported fields
}
Instance AUTH string details.
func (*InstanceAuthString) Descriptor
func
(
*
InstanceAuthString
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use InstanceAuthString.ProtoReflect.Descriptor instead.
func (*InstanceAuthString) GetAuthString
func
(
x
*
InstanceAuthString
)
GetAuthString
()
string
func (*InstanceAuthString) ProtoMessage
func
(
*
InstanceAuthString
)
ProtoMessage
()
func (*InstanceAuthString) ProtoReflect
func
(
x
*
InstanceAuthString
)
ProtoReflect
()
protoreflect
.
Message
func (*InstanceAuthString) Reset
func
(
x
*
InstanceAuthString
)
Reset
()
func (*InstanceAuthString) String
func
(
x
*
InstanceAuthString
)
String
()
string
Instance_ConnectMode
type
Instance_ConnectMode
int32
Available connection modes.
Instance_CONNECT_MODE_UNSPECIFIED, Instance_DIRECT_PEERING, Instance_PRIVATE_SERVICE_ACCESS
const
(
// Not set.
Instance_CONNECT_MODE_UNSPECIFIED
Instance_ConnectMode
=
0
// Connect via direct peering to the Memorystore for Redis hosted service.
Instance_DIRECT_PEERING
Instance_ConnectMode
=
1
// Connect your Memorystore for Redis instance using Private Service
// Access. Private services access provides an IP address range for multiple
// Google Cloud services, including Memorystore.
Instance_PRIVATE_SERVICE_ACCESS
Instance_ConnectMode
=
2
)
func (Instance_ConnectMode) Descriptor
func
(
Instance_ConnectMode
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (Instance_ConnectMode) Enum
func
(
x
Instance_ConnectMode
)
Enum
()
*
Instance_ConnectMode
func (Instance_ConnectMode) EnumDescriptor
func
(
Instance_ConnectMode
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use Instance_ConnectMode.Descriptor instead.
func (Instance_ConnectMode) Number
func
(
x
Instance_ConnectMode
)
Number
()
protoreflect
.
EnumNumber
func (Instance_ConnectMode) String
func
(
x
Instance_ConnectMode
)
String
()
string
func (Instance_ConnectMode) Type
func
(
Instance_ConnectMode
)
Type
()
protoreflect
.
EnumType
Instance_ReadReplicasMode
type
Instance_ReadReplicasMode
int32
Read replicas mode.
Instance_READ_REPLICAS_MODE_UNSPECIFIED, Instance_READ_REPLICAS_DISABLED, Instance_READ_REPLICAS_ENABLED
const
(
// If not set, Memorystore Redis backend will default to
// READ_REPLICAS_DISABLED.
Instance_READ_REPLICAS_MODE_UNSPECIFIED
Instance_ReadReplicasMode
=
0
// If disabled, read endpoint will not be provided and the instance cannot
// scale up or down the number of replicas.
Instance_READ_REPLICAS_DISABLED
Instance_ReadReplicasMode
=
1
// If enabled, read endpoint will be provided and the instance can scale
// up and down the number of replicas. Not valid for basic tier.
Instance_READ_REPLICAS_ENABLED
Instance_ReadReplicasMode
=
2
)
func (Instance_ReadReplicasMode) Descriptor
func
(
Instance_ReadReplicasMode
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (Instance_ReadReplicasMode) Enum
func
(
x
Instance_ReadReplicasMode
)
Enum
()
*
Instance_ReadReplicasMode
func (Instance_ReadReplicasMode) EnumDescriptor
func
(
Instance_ReadReplicasMode
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use Instance_ReadReplicasMode.Descriptor instead.
func (Instance_ReadReplicasMode) Number
func
(
x
Instance_ReadReplicasMode
)
Number
()
protoreflect
.
EnumNumber
func (Instance_ReadReplicasMode) String
func
(
x
Instance_ReadReplicasMode
)
String
()
string
func (Instance_ReadReplicasMode) Type
func
(
Instance_ReadReplicasMode
)
Type
()
protoreflect
.
EnumType
Instance_State
type
Instance_State
int32
Represents the different states of a Redis instance.
Instance_STATE_UNSPECIFIED, Instance_CREATING, Instance_READY, Instance_UPDATING, Instance_DELETING, Instance_REPAIRING, Instance_MAINTENANCE, Instance_IMPORTING, Instance_FAILING_OVER
const
(
// Not set.
Instance_STATE_UNSPECIFIED
Instance_State
=
0
// Redis instance is being created.
Instance_CREATING
Instance_State
=
1
// Redis instance has been created and is fully usable.
Instance_READY
Instance_State
=
2
// Redis instance configuration is being updated. Certain kinds of updates
// may cause the instance to become unusable while the update is in
// progress.
Instance_UPDATING
Instance_State
=
3
// Redis instance is being deleted.
Instance_DELETING
Instance_State
=
4
// Redis instance is being repaired and may be unusable.
Instance_REPAIRING
Instance_State
=
5
// Maintenance is being performed on this Redis instance.
Instance_MAINTENANCE
Instance_State
=
6
// Redis instance is importing data (availability may be affected).
Instance_IMPORTING
Instance_State
=
8
// Redis instance is failing over (availability may be affected).
Instance_FAILING_OVER
Instance_State
=
9
)
func (Instance_State) Descriptor
func
(
Instance_State
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (Instance_State) Enum
func
(
x
Instance_State
)
Enum
()
*
Instance_State
func (Instance_State) EnumDescriptor
func
(
Instance_State
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use Instance_State.Descriptor instead.
func (Instance_State) Number
func
(
x
Instance_State
)
Number
()
protoreflect
.
EnumNumber
func (Instance_State) String
func
(
x
Instance_State
)
String
()
string
func (Instance_State) Type
func
(
Instance_State
)
Type
()
protoreflect
.
EnumType
Instance_SuspensionReason
type
Instance_SuspensionReason
int32
Possible reasons for the instance to be in a "SUSPENDED" state.
Instance_SUSPENSION_REASON_UNSPECIFIED, Instance_CUSTOMER_MANAGED_KEY_ISSUE
const
(
// Not set.
Instance_SUSPENSION_REASON_UNSPECIFIED
Instance_SuspensionReason
=
0
// Something wrong with the CMEK key provided by customer.
Instance_CUSTOMER_MANAGED_KEY_ISSUE
Instance_SuspensionReason
=
1
)
func (Instance_SuspensionReason) Descriptor
func
(
Instance_SuspensionReason
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (Instance_SuspensionReason) Enum
func
(
x
Instance_SuspensionReason
)
Enum
()
*
Instance_SuspensionReason
func (Instance_SuspensionReason) EnumDescriptor
func
(
Instance_SuspensionReason
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use Instance_SuspensionReason.Descriptor instead.
func (Instance_SuspensionReason) Number
func
(
x
Instance_SuspensionReason
)
Number
()
protoreflect
.
EnumNumber
func (Instance_SuspensionReason) String
func
(
x
Instance_SuspensionReason
)
String
()
string
func (Instance_SuspensionReason) Type
func
(
Instance_SuspensionReason
)
Type
()
protoreflect
.
EnumType
Instance_Tier
type
Instance_Tier
int32
Available service tiers to choose from
Instance_TIER_UNSPECIFIED, Instance_BASIC, Instance_STANDARD_HA
const
(
// Not set.
Instance_TIER_UNSPECIFIED
Instance_Tier
=
0
// BASIC tier: standalone instance
Instance_BASIC
Instance_Tier
=
1
// STANDARD_HA tier: highly available primary/replica instances
Instance_STANDARD_HA
Instance_Tier
=
3
)
func (Instance_Tier) Descriptor
func
(
Instance_Tier
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (Instance_Tier) Enum
func
(
x
Instance_Tier
)
Enum
()
*
Instance_Tier
func (Instance_Tier) EnumDescriptor
func
(
Instance_Tier
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use Instance_Tier.Descriptor instead.
func (Instance_Tier) Number
func
(
x
Instance_Tier
)
Number
()
protoreflect
.
EnumNumber
func (Instance_Tier) String
func
(
x
Instance_Tier
)
String
()
string
func (Instance_Tier) Type
func
(
Instance_Tier
)
Type
()
protoreflect
.
EnumType
Instance_TransitEncryptionMode
type
Instance_TransitEncryptionMode
int32
Available TLS modes.
Instance_TRANSIT_ENCRYPTION_MODE_UNSPECIFIED, Instance_SERVER_AUTHENTICATION, Instance_DISABLED
const
(
// Not set.
Instance_TRANSIT_ENCRYPTION_MODE_UNSPECIFIED
Instance_TransitEncryptionMode
=
0
// Client to Server traffic encryption enabled with server authentication.
Instance_SERVER_AUTHENTICATION
Instance_TransitEncryptionMode
=
1
// TLS is disabled for the instance.
Instance_DISABLED
Instance_TransitEncryptionMode
=
2
)
func (Instance_TransitEncryptionMode) Descriptor
func
(
Instance_TransitEncryptionMode
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (Instance_TransitEncryptionMode) Enum
func
(
x
Instance_TransitEncryptionMode
)
Enum
()
*
Instance_TransitEncryptionMode
func (Instance_TransitEncryptionMode) EnumDescriptor
func
(
Instance_TransitEncryptionMode
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use Instance_TransitEncryptionMode.Descriptor instead.
func (Instance_TransitEncryptionMode) Number
func
(
x
Instance_TransitEncryptionMode
)
Number
()
protoreflect
.
EnumNumber
func (Instance_TransitEncryptionMode) String
func
(
x
Instance_TransitEncryptionMode
)
String
()
string
func (Instance_TransitEncryptionMode) Type
func
(
Instance_TransitEncryptionMode
)
Type
()
protoreflect
.
EnumType
ListInstancesRequest
type
ListInstancesRequest
struct
{
// 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.
Parent
string
`protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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`][google.cloud.redis.v1.ListInstancesResponse.next_page_token]
// to determine if there are more instances left to be queried.
PageSize
int32
`protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The `next_page_token` value returned from a previous
// [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances] request, if
// any.
PageToken
string
`protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
Request for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances].
func (*ListInstancesRequest) Descriptor
func
(
*
ListInstancesRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ListInstancesRequest.ProtoReflect.Descriptor instead.
func (*ListInstancesRequest) GetPageSize
func
(
x
*
ListInstancesRequest
)
GetPageSize
()
int32
func (*ListInstancesRequest) GetPageToken
func
(
x
*
ListInstancesRequest
)
GetPageToken
()
string
func (*ListInstancesRequest) GetParent
func
(
x
*
ListInstancesRequest
)
GetParent
()
string
func (*ListInstancesRequest) ProtoMessage
func
(
*
ListInstancesRequest
)
ProtoMessage
()
func (*ListInstancesRequest) ProtoReflect
func
(
x
*
ListInstancesRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*ListInstancesRequest) Reset
func
(
x
*
ListInstancesRequest
)
Reset
()
func (*ListInstancesRequest) String
func
(
x
*
ListInstancesRequest
)
String
()
string
ListInstancesResponse
type
ListInstancesResponse
struct
{
// 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 placeholder
// 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".
Instances
[]
*
Instance
`protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
// Token to retrieve the next page of results, or empty if there are no more
// results in the list.
NextPageToken
string
`protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Locations that could not be reached.
Unreachable
[]
string
`protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}
Response for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances].
func (*ListInstancesResponse) Descriptor
func
(
*
ListInstancesResponse
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ListInstancesResponse.ProtoReflect.Descriptor instead.
func (*ListInstancesResponse) GetInstances
func
(
x
*
ListInstancesResponse
)
GetInstances
()
[]
*
Instance
func (*ListInstancesResponse) GetNextPageToken
func
(
x
*
ListInstancesResponse
)
GetNextPageToken
()
string
func (*ListInstancesResponse) GetUnreachable
func
(
x
*
ListInstancesResponse
)
GetUnreachable
()
[]
string
func (*ListInstancesResponse) ProtoMessage
func
(
*
ListInstancesResponse
)
ProtoMessage
()
func (*ListInstancesResponse) ProtoReflect
func
(
x
*
ListInstancesResponse
)
ProtoReflect
()
protoreflect
.
Message
func (*ListInstancesResponse) Reset
func
(
x
*
ListInstancesResponse
)
Reset
()
func (*ListInstancesResponse) String
func
(
x
*
ListInstancesResponse
)
String
()
string
LocationMetadata
type
LocationMetadata
struct
{
// 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.
AvailableZones
map
[
string
]
*
ZoneMetadata
`protobuf:"bytes,1,rep,name=available_zones,json=availableZones,proto3" json:"available_zones,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
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.
func (*LocationMetadata) Descriptor
func
(
*
LocationMetadata
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use LocationMetadata.ProtoReflect.Descriptor instead.
func (*LocationMetadata) GetAvailableZones
func
(
x
*
LocationMetadata
)
GetAvailableZones
()
map
[
string
]
*
ZoneMetadata
func (*LocationMetadata) ProtoMessage
func
(
*
LocationMetadata
)
ProtoMessage
()
func (*LocationMetadata) ProtoReflect
func
(
x
*
LocationMetadata
)
ProtoReflect
()
protoreflect
.
Message
func (*LocationMetadata) Reset
func
(
x
*
LocationMetadata
)
Reset
()
func (*LocationMetadata) String
func
(
x
*
LocationMetadata
)
String
()
string
MaintenancePolicy
type
MaintenancePolicy
struct
{
// Output only. The time when the policy was created.
CreateTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time when the policy was last updated.
UpdateTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Optional. Description of what this policy is for. Create/Update methods
// return INVALID_ARGUMENT if the length is greater than 512.
Description
string
`protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Optional. Maintenance window that is applied to resources covered by this
// policy. Minimum 1. For the current version, the maximum number of
// weekly_window is expected to be one.
WeeklyMaintenanceWindow
[]
*
WeeklyMaintenanceWindow
`protobuf:"bytes,4,rep,name=weekly_maintenance_window,json=weeklyMaintenanceWindow,proto3" json:"weekly_maintenance_window,omitempty"`
// contains filtered or unexported fields
}
Maintenance policy for an instance.
func (*MaintenancePolicy) Descriptor
func
(
*
MaintenancePolicy
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use MaintenancePolicy.ProtoReflect.Descriptor instead.
func (*MaintenancePolicy) GetCreateTime
func
(
x
*
MaintenancePolicy
)
GetCreateTime
()
*
timestamppb
.
Timestamp
func (*MaintenancePolicy) GetDescription
func
(
x
*
MaintenancePolicy
)
GetDescription
()
string
func (*MaintenancePolicy) GetUpdateTime
func
(
x
*
MaintenancePolicy
)
GetUpdateTime
()
*
timestamppb
.
Timestamp
func (*MaintenancePolicy) GetWeeklyMaintenanceWindow
func
(
x
*
MaintenancePolicy
)
GetWeeklyMaintenanceWindow
()
[]
*
WeeklyMaintenanceWindow
func (*MaintenancePolicy) ProtoMessage
func
(
*
MaintenancePolicy
)
ProtoMessage
()
func (*MaintenancePolicy) ProtoReflect
func
(
x
*
MaintenancePolicy
)
ProtoReflect
()
protoreflect
.
Message
func (*MaintenancePolicy) Reset
func
(
x
*
MaintenancePolicy
)
Reset
()
func (*MaintenancePolicy) String
func
(
x
*
MaintenancePolicy
)
String
()
string
MaintenanceSchedule
type
MaintenanceSchedule
struct
{
// Output only. The start time of any upcoming scheduled maintenance for this
// instance.
StartTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Output only. The end time of any upcoming scheduled maintenance for this
// instance.
EndTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// If the scheduled maintenance can be rescheduled, default is true.
//
// Deprecated: Marked as deprecated in google/cloud/redis/v1/cloud_redis.proto.
CanReschedule
bool
`protobuf:"varint,3,opt,name=can_reschedule,json=canReschedule,proto3" json:"can_reschedule,omitempty"`
// Output only. The deadline that the maintenance schedule start time can not
// go beyond, including reschedule.
ScheduleDeadlineTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,5,opt,name=schedule_deadline_time,json=scheduleDeadlineTime,proto3" json:"schedule_deadline_time,omitempty"`
// contains filtered or unexported fields
}
Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated.
func (*MaintenanceSchedule) Descriptor
func
(
*
MaintenanceSchedule
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use MaintenanceSchedule.ProtoReflect.Descriptor instead.
func (*MaintenanceSchedule) GetCanReschedule
func
(
x
*
MaintenanceSchedule
)
GetCanReschedule
()
bool
Deprecated: Marked as deprecated in google/cloud/redis/v1/cloud_redis.proto.
func (*MaintenanceSchedule) GetEndTime
func
(
x
*
MaintenanceSchedule
)
GetEndTime
()
*
timestamppb
.
Timestamp
func (*MaintenanceSchedule) GetScheduleDeadlineTime
func
(
x
*
MaintenanceSchedule
)
GetScheduleDeadlineTime
()
*
timestamppb
.
Timestamp
func (*MaintenanceSchedule) GetStartTime
func
(
x
*
MaintenanceSchedule
)
GetStartTime
()
*
timestamppb
.
Timestamp
func (*MaintenanceSchedule) ProtoMessage
func
(
*
MaintenanceSchedule
)
ProtoMessage
()
func (*MaintenanceSchedule) ProtoReflect
func
(
x
*
MaintenanceSchedule
)
ProtoReflect
()
protoreflect
.
Message
func (*MaintenanceSchedule) Reset
func
(
x
*
MaintenanceSchedule
)
Reset
()
func (*MaintenanceSchedule) String
func
(
x
*
MaintenanceSchedule
)
String
()
string
NodeInfo
type
NodeInfo
struct
{
// Output only. Node identifying string. e.g. 'node-0', 'node-1'
Id
string
`protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// Output only. Location of the node.
Zone
string
`protobuf:"bytes,2,opt,name=zone,proto3" json:"zone,omitempty"`
// contains filtered or unexported fields
}
Node specific properties.
func (*NodeInfo) Descriptor
Deprecated: Use NodeInfo.ProtoReflect.Descriptor instead.
func (*NodeInfo) GetId
func (*NodeInfo) GetZone
func (*NodeInfo) ProtoMessage
func
(
*
NodeInfo
)
ProtoMessage
()
func (*NodeInfo) ProtoReflect
func
(
x
*
NodeInfo
)
ProtoReflect
()
protoreflect
.
Message
func (*NodeInfo) Reset
func
(
x
*
NodeInfo
)
Reset
()
func (*NodeInfo) String
OperationMetadata
type
OperationMetadata
struct
{
// Creation timestamp.
CreateTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// End timestamp.
EndTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Operation target.
Target
string
`protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
// Operation verb.
Verb
string
`protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
// Operation status details.
StatusDetail
string
`protobuf:"bytes,5,opt,name=status_detail,json=statusDetail,proto3" json:"status_detail,omitempty"`
// Specifies if cancellation was requested for the operation.
CancelRequested
bool
`protobuf:"varint,6,opt,name=cancel_requested,json=cancelRequested,proto3" json:"cancel_requested,omitempty"`
// API version.
ApiVersion
string
`protobuf:"bytes,7,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
// contains filtered or unexported fields
}
Represents the v1 metadata of the long-running operation.
func (*OperationMetadata) Descriptor
func
(
*
OperationMetadata
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.
func (*OperationMetadata) GetApiVersion
func
(
x
*
OperationMetadata
)
GetApiVersion
()
string
func (*OperationMetadata) GetCancelRequested
func
(
x
*
OperationMetadata
)
GetCancelRequested
()
bool
func (*OperationMetadata) GetCreateTime
func
(
x
*
OperationMetadata
)
GetCreateTime
()
*
timestamppb
.
Timestamp
func (*OperationMetadata) GetEndTime
func
(
x
*
OperationMetadata
)
GetEndTime
()
*
timestamppb
.
Timestamp
func (*OperationMetadata) GetStatusDetail
func
(
x
*
OperationMetadata
)
GetStatusDetail
()
string
func (*OperationMetadata) GetTarget
func
(
x
*
OperationMetadata
)
GetTarget
()
string
func (*OperationMetadata) GetVerb
func
(
x
*
OperationMetadata
)
GetVerb
()
string
func (*OperationMetadata) ProtoMessage
func
(
*
OperationMetadata
)
ProtoMessage
()
func (*OperationMetadata) ProtoReflect
func
(
x
*
OperationMetadata
)
ProtoReflect
()
protoreflect
.
Message
func (*OperationMetadata) Reset
func
(
x
*
OperationMetadata
)
Reset
()
func (*OperationMetadata) String
func
(
x
*
OperationMetadata
)
String
()
string
OutputConfig
type
OutputConfig
struct
{
// Required. Specify destination location of output data
//
// Types that are assignable to Destination:
//
// *OutputConfig_GcsDestination
Destination
isOutputConfig_Destination
`protobuf_oneof:"destination"`
// contains filtered or unexported fields
}
The output content
func (*OutputConfig) Descriptor
func
(
*
OutputConfig
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use OutputConfig.ProtoReflect.Descriptor instead.
func (*OutputConfig) GetDestination
func
(
m
*
OutputConfig
)
GetDestination
()
isOutputConfig_Destination
func (*OutputConfig) GetGcsDestination
func
(
x
*
OutputConfig
)
GetGcsDestination
()
*
GcsDestination
func (*OutputConfig) ProtoMessage
func
(
*
OutputConfig
)
ProtoMessage
()
func (*OutputConfig) ProtoReflect
func
(
x
*
OutputConfig
)
ProtoReflect
()
protoreflect
.
Message
func (*OutputConfig) Reset
func
(
x
*
OutputConfig
)
Reset
()
func (*OutputConfig) String
func
(
x
*
OutputConfig
)
String
()
string
OutputConfig_GcsDestination
type
OutputConfig_GcsDestination
struct
{
// Google Cloud Storage destination for output content.
GcsDestination
*
GcsDestination
`protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3,oneof"`
}
PersistenceConfig
type
PersistenceConfig
struct
{
// Optional. Controls whether Persistence features are enabled.
// If not provided, the existing value will be used.
PersistenceMode
PersistenceConfig_PersistenceMode
`protobuf:"varint,1,opt,name=persistence_mode,json=persistenceMode,proto3,enum=google.cloud.redis.v1.PersistenceConfig_PersistenceMode" json:"persistence_mode,omitempty"`
// 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.
RdbSnapshotPeriod
PersistenceConfig_SnapshotPeriod
`protobuf:"varint,2,opt,name=rdb_snapshot_period,json=rdbSnapshotPeriod,proto3,enum=google.cloud.redis.v1.PersistenceConfig_SnapshotPeriod" json:"rdb_snapshot_period,omitempty"`
// Output only. The next time that a snapshot attempt is scheduled to occur.
RdbNextSnapshotTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,4,opt,name=rdb_next_snapshot_time,json=rdbNextSnapshotTime,proto3" json:"rdb_next_snapshot_time,omitempty"`
// 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.
RdbSnapshotStartTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,5,opt,name=rdb_snapshot_start_time,json=rdbSnapshotStartTime,proto3" json:"rdb_snapshot_start_time,omitempty"`
// contains filtered or unexported fields
}
Configuration of the persistence functionality.
func (*PersistenceConfig) Descriptor
func
(
*
PersistenceConfig
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use PersistenceConfig.ProtoReflect.Descriptor instead.
func (*PersistenceConfig) GetPersistenceMode
func
(
x
*
PersistenceConfig
)
GetPersistenceMode
()
PersistenceConfig_PersistenceMode
func (*PersistenceConfig) GetRdbNextSnapshotTime
func
(
x
*
PersistenceConfig
)
GetRdbNextSnapshotTime
()
*
timestamppb
.
Timestamp
func (*PersistenceConfig) GetRdbSnapshotPeriod
func
(
x
*
PersistenceConfig
)
GetRdbSnapshotPeriod
()
PersistenceConfig_SnapshotPeriod
func (*PersistenceConfig) GetRdbSnapshotStartTime
func
(
x
*
PersistenceConfig
)
GetRdbSnapshotStartTime
()
*
timestamppb
.
Timestamp
func (*PersistenceConfig) ProtoMessage
func
(
*
PersistenceConfig
)
ProtoMessage
()
func (*PersistenceConfig) ProtoReflect
func
(
x
*
PersistenceConfig
)
ProtoReflect
()
protoreflect
.
Message
func (*PersistenceConfig) Reset
func
(
x
*
PersistenceConfig
)
Reset
()
func (*PersistenceConfig) String
func
(
x
*
PersistenceConfig
)
String
()
string
PersistenceConfig_PersistenceMode
type
PersistenceConfig_PersistenceMode
int32
Available Persistence modes.
PersistenceConfig_PERSISTENCE_MODE_UNSPECIFIED, PersistenceConfig_DISABLED, PersistenceConfig_RDB
const
(
// Not set.
PersistenceConfig_PERSISTENCE_MODE_UNSPECIFIED
PersistenceConfig_PersistenceMode
=
0
// Persistence is disabled for the instance,
// and any existing snapshots are deleted.
PersistenceConfig_DISABLED
PersistenceConfig_PersistenceMode
=
1
// RDB based Persistence is enabled.
PersistenceConfig_RDB
PersistenceConfig_PersistenceMode
=
2
)
func (PersistenceConfig_PersistenceMode) Descriptor
func
(
PersistenceConfig_PersistenceMode
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (PersistenceConfig_PersistenceMode) Enum
func
(
x
PersistenceConfig_PersistenceMode
)
Enum
()
*
PersistenceConfig_PersistenceMode
func (PersistenceConfig_PersistenceMode) EnumDescriptor
func
(
PersistenceConfig_PersistenceMode
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use PersistenceConfig_PersistenceMode.Descriptor instead.
func (PersistenceConfig_PersistenceMode) Number
func
(
x
PersistenceConfig_PersistenceMode
)
Number
()
protoreflect
.
EnumNumber
func (PersistenceConfig_PersistenceMode) String
func
(
x
PersistenceConfig_PersistenceMode
)
String
()
string
func (PersistenceConfig_PersistenceMode) Type
func
(
PersistenceConfig_PersistenceMode
)
Type
()
protoreflect
.
EnumType
PersistenceConfig_SnapshotPeriod
type
PersistenceConfig_SnapshotPeriod
int32
Available snapshot periods for scheduling.
PersistenceConfig_SNAPSHOT_PERIOD_UNSPECIFIED, PersistenceConfig_ONE_HOUR, PersistenceConfig_SIX_HOURS, PersistenceConfig_TWELVE_HOURS, PersistenceConfig_TWENTY_FOUR_HOURS
const
(
// Not set.
PersistenceConfig_SNAPSHOT_PERIOD_UNSPECIFIED
PersistenceConfig_SnapshotPeriod
=
0
// Snapshot every 1 hour.
PersistenceConfig_ONE_HOUR
PersistenceConfig_SnapshotPeriod
=
3
// Snapshot every 6 hours.
PersistenceConfig_SIX_HOURS
PersistenceConfig_SnapshotPeriod
=
4
// Snapshot every 12 hours.
PersistenceConfig_TWELVE_HOURS
PersistenceConfig_SnapshotPeriod
=
5
// Snapshot every 24 hours.
PersistenceConfig_TWENTY_FOUR_HOURS
PersistenceConfig_SnapshotPeriod
=
6
)
func (PersistenceConfig_SnapshotPeriod) Descriptor
func
(
PersistenceConfig_SnapshotPeriod
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (PersistenceConfig_SnapshotPeriod) Enum
func
(
x
PersistenceConfig_SnapshotPeriod
)
Enum
()
*
PersistenceConfig_SnapshotPeriod
func (PersistenceConfig_SnapshotPeriod) EnumDescriptor
func
(
PersistenceConfig_SnapshotPeriod
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use PersistenceConfig_SnapshotPeriod.Descriptor instead.
func (PersistenceConfig_SnapshotPeriod) Number
func
(
x
PersistenceConfig_SnapshotPeriod
)
Number
()
protoreflect
.
EnumNumber
func (PersistenceConfig_SnapshotPeriod) String
func
(
x
PersistenceConfig_SnapshotPeriod
)
String
()
string
func (PersistenceConfig_SnapshotPeriod) Type
func
(
PersistenceConfig_SnapshotPeriod
)
Type
()
protoreflect
.
EnumType
RescheduleMaintenanceRequest
type
RescheduleMaintenanceRequest
struct
{
// 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.
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as
// well.
RescheduleType
RescheduleMaintenanceRequest_RescheduleType
`protobuf:"varint,2,opt,name=reschedule_type,json=rescheduleType,proto3,enum=google.cloud.redis.v1.RescheduleMaintenanceRequest_RescheduleType" json:"reschedule_type,omitempty"`
// Optional. Timestamp when the maintenance shall be rescheduled to if
// reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for
// example `2012-11-15T16:19:00.094Z`.
ScheduleTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,3,opt,name=schedule_time,json=scheduleTime,proto3" json:"schedule_time,omitempty"`
// contains filtered or unexported fields
}
Request for [RescheduleMaintenance][google.cloud.redis.v1.CloudRedis.RescheduleMaintenance].
func (*RescheduleMaintenanceRequest) Descriptor
func
(
*
RescheduleMaintenanceRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use RescheduleMaintenanceRequest.ProtoReflect.Descriptor instead.
func (*RescheduleMaintenanceRequest) GetName
func
(
x
*
RescheduleMaintenanceRequest
)
GetName
()
string
func (*RescheduleMaintenanceRequest) GetRescheduleType
func
(
x
*
RescheduleMaintenanceRequest
)
GetRescheduleType
()
RescheduleMaintenanceRequest_RescheduleType
func (*RescheduleMaintenanceRequest) GetScheduleTime
func
(
x
*
RescheduleMaintenanceRequest
)
GetScheduleTime
()
*
timestamppb
.
Timestamp
func (*RescheduleMaintenanceRequest) ProtoMessage
func
(
*
RescheduleMaintenanceRequest
)
ProtoMessage
()
func (*RescheduleMaintenanceRequest) ProtoReflect
func
(
x
*
RescheduleMaintenanceRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*RescheduleMaintenanceRequest) Reset
func
(
x
*
RescheduleMaintenanceRequest
)
Reset
()
func (*RescheduleMaintenanceRequest) String
func
(
x
*
RescheduleMaintenanceRequest
)
String
()
string
RescheduleMaintenanceRequest_RescheduleType
type
RescheduleMaintenanceRequest_RescheduleType
int32
Reschedule options.
RescheduleMaintenanceRequest_RESCHEDULE_TYPE_UNSPECIFIED, RescheduleMaintenanceRequest_IMMEDIATE, RescheduleMaintenanceRequest_NEXT_AVAILABLE_WINDOW, RescheduleMaintenanceRequest_SPECIFIC_TIME
const
(
// Not set.
RescheduleMaintenanceRequest_RESCHEDULE_TYPE_UNSPECIFIED
RescheduleMaintenanceRequest_RescheduleType
=
0
// If the user wants to schedule the maintenance to happen now.
RescheduleMaintenanceRequest_IMMEDIATE
RescheduleMaintenanceRequest_RescheduleType
=
1
// If the user wants to use the existing maintenance policy to find the
// next available window.
RescheduleMaintenanceRequest_NEXT_AVAILABLE_WINDOW
RescheduleMaintenanceRequest_RescheduleType
=
2
// If the user wants to reschedule the maintenance to a specific time.
RescheduleMaintenanceRequest_SPECIFIC_TIME
RescheduleMaintenanceRequest_RescheduleType
=
3
)
func (RescheduleMaintenanceRequest_RescheduleType) Descriptor
func
(
RescheduleMaintenanceRequest_RescheduleType
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (RescheduleMaintenanceRequest_RescheduleType) Enum
func
(
x
RescheduleMaintenanceRequest_RescheduleType
)
Enum
()
*
RescheduleMaintenanceRequest_RescheduleType
func (RescheduleMaintenanceRequest_RescheduleType) EnumDescriptor
func
(
RescheduleMaintenanceRequest_RescheduleType
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use RescheduleMaintenanceRequest_RescheduleType.Descriptor instead.
func (RescheduleMaintenanceRequest_RescheduleType) Number
func
(
x
RescheduleMaintenanceRequest_RescheduleType
)
Number
()
protoreflect
.
EnumNumber
func (RescheduleMaintenanceRequest_RescheduleType) String
func
(
x
RescheduleMaintenanceRequest_RescheduleType
)
String
()
string
func (RescheduleMaintenanceRequest_RescheduleType) Type
func
(
RescheduleMaintenanceRequest_RescheduleType
)
Type
()
protoreflect
.
EnumType
TlsCertificate
type
TlsCertificate
struct
{
// Serial number, as extracted from the certificate.
SerialNumber
string
`protobuf:"bytes,1,opt,name=serial_number,json=serialNumber,proto3" json:"serial_number,omitempty"`
// PEM representation.
Cert
string
`protobuf:"bytes,2,opt,name=cert,proto3" json:"cert,omitempty"`
// Output only. The time when the certificate was created in [RFC
// 3339](https://tools.ietf.org/html/rfc3339) format, for example
// `2020-05-18T00:00:00.094Z`.
CreateTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time when the certificate expires in [RFC
// 3339](https://tools.ietf.org/html/rfc3339) format, for example
// `2020-05-18T00:00:00.094Z`.
ExpireTime
*
timestamppb
.
Timestamp
`protobuf:"bytes,4,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
// Sha1 Fingerprint of the certificate.
Sha1Fingerprint
string
`protobuf:"bytes,5,opt,name=sha1_fingerprint,json=sha1Fingerprint,proto3" json:"sha1_fingerprint,omitempty"`
// contains filtered or unexported fields
}
TlsCertificate Resource
func (*TlsCertificate) Descriptor
func
(
*
TlsCertificate
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use TlsCertificate.ProtoReflect.Descriptor instead.
func (*TlsCertificate) GetCert
func
(
x
*
TlsCertificate
)
GetCert
()
string
func (*TlsCertificate) GetCreateTime
func
(
x
*
TlsCertificate
)
GetCreateTime
()
*
timestamppb
.
Timestamp
func (*TlsCertificate) GetExpireTime
func
(
x
*
TlsCertificate
)
GetExpireTime
()
*
timestamppb
.
Timestamp
func (*TlsCertificate) GetSerialNumber
func
(
x
*
TlsCertificate
)
GetSerialNumber
()
string
func (*TlsCertificate) GetSha1Fingerprint
func
(
x
*
TlsCertificate
)
GetSha1Fingerprint
()
string
func (*TlsCertificate) ProtoMessage
func
(
*
TlsCertificate
)
ProtoMessage
()
func (*TlsCertificate) ProtoReflect
func
(
x
*
TlsCertificate
)
ProtoReflect
()
protoreflect
.
Message
func (*TlsCertificate) Reset
func
(
x
*
TlsCertificate
)
Reset
()
func (*TlsCertificate) String
func
(
x
*
TlsCertificate
)
String
()
string
UnimplementedCloudRedisServer
type
UnimplementedCloudRedisServer
struct
{
}
UnimplementedCloudRedisServer should be embedded to have forward compatible implementations.
func (UnimplementedCloudRedisServer) CreateInstance
func
(
UnimplementedCloudRedisServer
)
CreateInstance
(
context
.
Context
,
*
CreateInstanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
func (UnimplementedCloudRedisServer) DeleteInstance
func
(
UnimplementedCloudRedisServer
)
DeleteInstance
(
context
.
Context
,
*
DeleteInstanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
func (UnimplementedCloudRedisServer) ExportInstance
func
(
UnimplementedCloudRedisServer
)
ExportInstance
(
context
.
Context
,
*
ExportInstanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
func (UnimplementedCloudRedisServer) FailoverInstance
func
(
UnimplementedCloudRedisServer
)
FailoverInstance
(
context
.
Context
,
*
FailoverInstanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
func (UnimplementedCloudRedisServer) GetInstance
func
(
UnimplementedCloudRedisServer
)
GetInstance
(
context
.
Context
,
*
GetInstanceRequest
)
(
*
Instance
,
error
)
func (UnimplementedCloudRedisServer) GetInstanceAuthString
func
(
UnimplementedCloudRedisServer
)
GetInstanceAuthString
(
context
.
Context
,
*
GetInstanceAuthStringRequest
)
(
*
InstanceAuthString
,
error
)
func (UnimplementedCloudRedisServer) ImportInstance
func
(
UnimplementedCloudRedisServer
)
ImportInstance
(
context
.
Context
,
*
ImportInstanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
func (UnimplementedCloudRedisServer) ListInstances
func
(
UnimplementedCloudRedisServer
)
ListInstances
(
context
.
Context
,
*
ListInstancesRequest
)
(
*
ListInstancesResponse
,
error
)
func (UnimplementedCloudRedisServer) RescheduleMaintenance
func
(
UnimplementedCloudRedisServer
)
RescheduleMaintenance
(
context
.
Context
,
*
RescheduleMaintenanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
func (UnimplementedCloudRedisServer) UpdateInstance
func
(
UnimplementedCloudRedisServer
)
UpdateInstance
(
context
.
Context
,
*
UpdateInstanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
func (UnimplementedCloudRedisServer) UpgradeInstance
func
(
UnimplementedCloudRedisServer
)
UpgradeInstance
(
context
.
Context
,
*
UpgradeInstanceRequest
)
(
*
longrunningpb
.
Operation
,
error
)
UnsafeCloudRedisServer
type
UnsafeCloudRedisServer
interface
{
// contains filtered or unexported methods
}
UnsafeCloudRedisServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to CloudRedisServer will result in compilation errors.
UpdateInstanceRequest
type
UpdateInstanceRequest
struct
{
// 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.v1.Instance]:
//
// - `displayName`
// - `labels`
// - `memorySizeGb`
// - `redisConfig`
// - `replica_count`
UpdateMask
*
fieldmaskpb
.
FieldMask
`protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Required. Update description.
// Only fields specified in update_mask are updated.
Instance
*
Instance
`protobuf:"bytes,2,opt,name=instance,proto3" json:"instance,omitempty"`
// contains filtered or unexported fields
}
Request for [UpdateInstance][google.cloud.redis.v1.CloudRedis.UpdateInstance].
func (*UpdateInstanceRequest) Descriptor
func
(
*
UpdateInstanceRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use UpdateInstanceRequest.ProtoReflect.Descriptor instead.
func (*UpdateInstanceRequest) GetInstance
func
(
x
*
UpdateInstanceRequest
)
GetInstance
()
*
Instance
func (*UpdateInstanceRequest) GetUpdateMask
func
(
x
*
UpdateInstanceRequest
)
GetUpdateMask
()
*
fieldmaskpb
.
FieldMask
func (*UpdateInstanceRequest) ProtoMessage
func
(
*
UpdateInstanceRequest
)
ProtoMessage
()
func (*UpdateInstanceRequest) ProtoReflect
func
(
x
*
UpdateInstanceRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*UpdateInstanceRequest) Reset
func
(
x
*
UpdateInstanceRequest
)
Reset
()
func (*UpdateInstanceRequest) String
func
(
x
*
UpdateInstanceRequest
)
String
()
string
UpgradeInstanceRequest
type
UpgradeInstanceRequest
struct
{
// 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.
Name
string
`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Specifies the target version of Redis software to upgrade to.
RedisVersion
string
`protobuf:"bytes,2,opt,name=redis_version,json=redisVersion,proto3" json:"redis_version,omitempty"`
// contains filtered or unexported fields
}
Request for [UpgradeInstance][google.cloud.redis.v1.CloudRedis.UpgradeInstance].
func (*UpgradeInstanceRequest) Descriptor
func
(
*
UpgradeInstanceRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use UpgradeInstanceRequest.ProtoReflect.Descriptor instead.
func (*UpgradeInstanceRequest) GetName
func
(
x
*
UpgradeInstanceRequest
)
GetName
()
string
func (*UpgradeInstanceRequest) GetRedisVersion
func
(
x
*
UpgradeInstanceRequest
)
GetRedisVersion
()
string
func (*UpgradeInstanceRequest) ProtoMessage
func
(
*
UpgradeInstanceRequest
)
ProtoMessage
()
func (*UpgradeInstanceRequest) ProtoReflect
func
(
x
*
UpgradeInstanceRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*UpgradeInstanceRequest) Reset
func
(
x
*
UpgradeInstanceRequest
)
Reset
()
func (*UpgradeInstanceRequest) String
func
(
x
*
UpgradeInstanceRequest
)
String
()
string
WeeklyMaintenanceWindow
type
WeeklyMaintenanceWindow
struct
{
// Required. The day of week that maintenance updates occur.
Day
dayofweek
.
DayOfWeek
`protobuf:"varint,1,opt,name=day,proto3,enum=google.type.DayOfWeek" json:"day,omitempty"`
// Required. Start time of the window in UTC time.
StartTime
*
timeofday
.
TimeOfDay
`protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Output only. Duration of the maintenance window. The current window is
// fixed at 1 hour.
Duration
*
durationpb
.
Duration
`protobuf:"bytes,3,opt,name=duration,proto3" json:"duration,omitempty"`
// contains filtered or unexported fields
}
Time window in which disruptive maintenance updates occur. Non-disruptive updates can occur inside or outside this window.
func (*WeeklyMaintenanceWindow) Descriptor
func
(
*
WeeklyMaintenanceWindow
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use WeeklyMaintenanceWindow.ProtoReflect.Descriptor instead.
func (*WeeklyMaintenanceWindow) GetDay
func
(
x
*
WeeklyMaintenanceWindow
)
GetDay
()
dayofweek
.
DayOfWeek
func (*WeeklyMaintenanceWindow) GetDuration
func
(
x
*
WeeklyMaintenanceWindow
)
GetDuration
()
*
durationpb
.
Duration
func (*WeeklyMaintenanceWindow) GetStartTime
func
(
x
*
WeeklyMaintenanceWindow
)
GetStartTime
()
*
timeofday
.
TimeOfDay
func (*WeeklyMaintenanceWindow) ProtoMessage
func
(
*
WeeklyMaintenanceWindow
)
ProtoMessage
()
func (*WeeklyMaintenanceWindow) ProtoReflect
func
(
x
*
WeeklyMaintenanceWindow
)
ProtoReflect
()
protoreflect
.
Message
func (*WeeklyMaintenanceWindow) Reset
func
(
x
*
WeeklyMaintenanceWindow
)
Reset
()
func (*WeeklyMaintenanceWindow) String
func
(
x
*
WeeklyMaintenanceWindow
)
String
()
string
ZoneMetadata
type
ZoneMetadata
struct
{
// contains filtered or unexported fields
}
Defines specific information for a particular zone. Currently empty and reserved for future use only.
func (*ZoneMetadata) Descriptor
func
(
*
ZoneMetadata
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use ZoneMetadata.ProtoReflect.Descriptor instead.
func (*ZoneMetadata) ProtoMessage
func
(
*
ZoneMetadata
)
ProtoMessage
()
func (*ZoneMetadata) ProtoReflect
func
(
x
*
ZoneMetadata
)
ProtoReflect
()
protoreflect
.
Message
func (*ZoneMetadata) Reset
func
(
x
*
ZoneMetadata
)
Reset
()
func (*ZoneMetadata) String
func
(
x
*
ZoneMetadata
)
String
()
string
