Package cloud.google.com/go/redis/apiv1beta1/redispb (v1.18.2)

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",
		10: "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":      10,
	}
)

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.

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.

File_google_cloud_redis_v1beta1_cloud_redis_proto

var File_google_cloud_redis_v1beta1_cloud_redis_proto protoreflect.FileDescriptor

Functions

func RegisterCloudRedisServer

func RegisterCloudRedisServer(s *grpc.Server, 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. The 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://godoc.org/google.golang.org/grpc#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. The 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.

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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.FailoverInstanceRequest_DataProtectionMode" json:"data_protection_mode,omitempty"`
	// contains filtered or unexported fields
}

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

func (*FailoverInstanceRequest) Descriptor

func (*FailoverInstanceRequest) Descriptor() ([]byte, []int)

Deprecated: Use FailoverInstanceRequest.ProtoReflect.Descriptor instead.

func (*FailoverInstanceRequest) GetDataProtectionMode

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) Enum

func (FailoverInstanceRequest_DataProtectionMode) EnumDescriptor

func (FailoverInstanceRequest_DataProtectionMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use FailoverInstanceRequest_DataProtectionMode.Descriptor instead.

func (FailoverInstanceRequest_DataProtectionMode) Number

func (FailoverInstanceRequest_DataProtectionMode) String

func (FailoverInstanceRequest_DataProtectionMode) Type

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

func (*GcsSource) Descriptor() ([]byte, []int)

Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.

func (*GcsSource) GetUri

func (x *GcsSource) GetUri() string

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

func (x *GcsSource) String() 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.v1beta1.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 (*GetInstanceAuthStringRequest) Reset

func (x *GetInstanceAuthStringRequest) Reset()

func (*GetInstanceAuthStringRequest) 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.v1beta1.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.v1beta1.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.v1beta1.Instance.location_id] and
	// [alternative_location_id][google.cloud.redis.v1beta1.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.v1beta1.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.v1beta1.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

func (*Instance) Descriptor() ([]byte, []int)

Deprecated: Use Instance.ProtoReflect.Descriptor instead.

func (*Instance) GetAlternativeLocationId

func (x *Instance) GetAlternativeLocationId() string

func (*Instance) GetAuthEnabled

func (x *Instance) GetAuthEnabled() bool

func (*Instance) GetAuthorizedNetwork

func (x *Instance) GetAuthorizedNetwork() string

func (*Instance) GetConnectMode

func (x *Instance) GetConnectMode() Instance_ConnectMode

func (*Instance) GetCreateTime

func (x *Instance) GetCreateTime() *timestamppb.Timestamp

func (*Instance) GetCurrentLocationId

func (x *Instance) GetCurrentLocationId() string

func (*Instance) GetDisplayName

func (x *Instance) GetDisplayName() string

func (*Instance) GetHost

func (x *Instance) GetHost() string

func (*Instance) GetLabels

func (x *Instance) GetLabels() map[string]string

func (*Instance) GetLocationId

func (x *Instance) GetLocationId() string

func (*Instance) GetMaintenancePolicy

func (x *Instance) GetMaintenancePolicy() *MaintenancePolicy

func (*Instance) GetMaintenanceSchedule

func (x *Instance) GetMaintenanceSchedule() *MaintenanceSchedule

func (*Instance) GetMemorySizeGb

func (x *Instance) GetMemorySizeGb() int32

func (*Instance) GetName

func (x *Instance) GetName() string

func (*Instance) GetNodes

func (x *Instance) GetNodes() []*NodeInfo

func (*Instance) GetPersistenceConfig

func (x *Instance) GetPersistenceConfig() *PersistenceConfig

func (*Instance) GetPersistenceIamIdentity

func (x *Instance) GetPersistenceIamIdentity() string

func (*Instance) GetPort

func (x *Instance) GetPort() int32

func (*Instance) GetReadEndpoint

func (x *Instance) GetReadEndpoint() string

func (*Instance) GetReadEndpointPort

func (x *Instance) GetReadEndpointPort() int32

func (*Instance) GetReadReplicasMode

func (x *Instance) GetReadReplicasMode() Instance_ReadReplicasMode

func (*Instance) GetRedisConfigs

func (x *Instance) GetRedisConfigs() map[string]string

func (*Instance) GetRedisVersion

func (x *Instance) GetRedisVersion() string

func (*Instance) GetReplicaCount

func (x *Instance) GetReplicaCount() int32

func (*Instance) GetReservedIpRange

func (x *Instance) GetReservedIpRange() string

func (*Instance) GetSecondaryIpRange

func (x *Instance) GetSecondaryIpRange() string

func (*Instance) GetServerCaCerts

func (x *Instance) GetServerCaCerts() []*TlsCertificate

func (*Instance) GetState

func (x *Instance) GetState() Instance_State

func (*Instance) GetStatusMessage

func (x *Instance) GetStatusMessage() string

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

func (x *Instance) String() 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) Enum

func (Instance_ConnectMode) EnumDescriptor

func (Instance_ConnectMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use Instance_ConnectMode.Descriptor instead.

func (Instance_ConnectMode) Number

func (Instance_ConnectMode) String

func (x Instance_ConnectMode) String() string

func (Instance_ConnectMode) Type

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) Enum

func (Instance_ReadReplicasMode) EnumDescriptor

func (Instance_ReadReplicasMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use Instance_ReadReplicasMode.Descriptor instead.

func (Instance_ReadReplicasMode) Number

func (Instance_ReadReplicasMode) String

func (x Instance_ReadReplicasMode) String() string

func (Instance_ReadReplicasMode) Type

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