redis

package
v0.0.0-...-6cb3ea0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 7, 2021 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
var File_google_cloud_redis_v1beta1_cloud_redis_proto protoreflect.FileDescriptor

Functions

func RegisterCloudRedisServer

func RegisterCloudRedisServer(s *grpc.Server, srv CloudRedisServer)

Types

type 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)
	// 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) (*longrunning.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) (*longrunning.Operation, error)
	// Upgrades Redis instance to the newer Redis version specified in the
	// request.
	UpgradeInstance(ctx context.Context, in *UpgradeInstanceRequest, opts ...grpc.CallOption) (*longrunning.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) (*longrunning.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) (*longrunning.Operation, error)
	// Initiates a failover of the master node to current replica node for a
	// specific STANDARD tier Cloud Memorystore for Redis instance.
	FailoverInstance(ctx context.Context, in *FailoverInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Deletes a specific Redis instance.  Instance stops serving and data is
	// deleted.
	DeleteInstance(ctx context.Context, in *DeleteInstanceRequest, opts ...grpc.CallOption) (*longrunning.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

type 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)
	// 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) (*longrunning.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) (*longrunning.Operation, error)
	// Upgrades Redis instance to the newer Redis version specified in the
	// request.
	UpgradeInstance(context.Context, *UpgradeInstanceRequest) (*longrunning.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) (*longrunning.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) (*longrunning.Operation, error)
	// Initiates a failover of the master node to current replica node for a
	// specific STANDARD tier Cloud Memorystore for Redis instance.
	FailoverInstance(context.Context, *FailoverInstanceRequest) (*longrunning.Operation, error)
	// Deletes a specific Redis instance.  Instance stops serving and data is
	// deleted.
	DeleteInstance(context.Context, *DeleteInstanceRequest) (*longrunning.Operation, error)
}

CloudRedisServer is the server API for CloudRedis service.

type 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 deprecated

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

type 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 deprecated

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

type 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 deprecated

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

type 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 `` /* 193-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*FailoverInstanceRequest) Descriptor deprecated

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

type FailoverInstanceRequest_DataProtectionMode

type FailoverInstanceRequest_DataProtectionMode int32

Specifies different modes of operation in relation to the data retention.

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 master 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 deprecated

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

Deprecated: Use FailoverInstanceRequest_DataProtectionMode.Descriptor instead.

func (FailoverInstanceRequest_DataProtectionMode) Number

func (FailoverInstanceRequest_DataProtectionMode) String

func (FailoverInstanceRequest_DataProtectionMode) Type

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 deprecated

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

type 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

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

type 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 deprecated

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

type 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 deprecated

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

type 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 deprecated

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

type 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"`
}

type 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 `` /* 153-byte string literal not displayed */
	// Optional. The zone where the instance will be provisioned. If not provided,
	// the service will choose a zone for the instance. For STANDARD_HA tier,
	// instances will be created across two zones for protection against zonal
	// failures. If [alternative_location_id][google.cloud.redis.v1beta1.Instance.alternative_location_id] is also provided, it must be
	// different from [location_id][google.cloud.redis.v1beta1.Instance.location_id].
	LocationId string `protobuf:"bytes,4,opt,name=location_id,json=locationId,proto3" json:"location_id,omitempty"`
	// Optional. Only applicable to STANDARD_HA tier which protects the instance
	// against zonal failures by provisioning it across two zones. If provided, it
	// must be a different zone from the one provided in [location_id][google.cloud.redis.v1beta1.Instance.location_id].
	AlternativeLocationId string `` /* 126-byte string literal not displayed */
	// 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
	RedisVersion string `protobuf:"bytes,7,opt,name=redis_version,json=redisVersion,proto3" json:"redis_version,omitempty"`
	// Optional. The CIDR range of internal addresses that are reserved for this
	// instance. If not provided, the service will choose an unused /29 block,
	// for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
	// and non-overlapping with existing subnets in an authorized network.
	ReservedIpRange string `protobuf:"bytes,9,opt,name=reserved_ip_range,json=reservedIpRange,proto3" json:"reserved_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 endpoint is placed. For Basic
	// Tier instances, this will always be the same as the [location_id][google.cloud.redis.v1beta1.Instance.location_id]
	// provided by the user at creation time. For Standard Tier instances,
	// this can be either [location_id][google.cloud.redis.v1beta1.Instance.location_id] or [alternative_location_id][google.cloud.redis.v1beta1.Instance.alternative_location_id] and can
	// change after a failover event.
	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 `` /* 186-byte string literal not displayed */
	// 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:<service_account_email>". The value may change over time
	// for a given instance so should be checked before each import/export
	// operation.
	PersistenceIamIdentity string `` /* 130-byte string literal not displayed */
	// Optional. The connect mode of Redis instance.
	// If not provided, default one will be used.
	// Current default: DIRECT_PEERING.
	ConnectMode Instance_ConnectMode `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

A Google Cloud Redis instance.

func (*Instance) Descriptor deprecated

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

Deprecated: Use Instance.ProtoReflect.Descriptor instead.

func (*Instance) GetAlternativeLocationId

func (x *Instance) GetAlternativeLocationId() string

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

func (x *Instance) GetMemorySizeGb() int32

func (*Instance) GetName

func (x *Instance) GetName() string

func (*Instance) GetPersistenceIamIdentity

func (x *Instance) GetPersistenceIamIdentity() string

func (*Instance) GetPort

func (x *Instance) GetPort() int32

func (*Instance) GetRedisConfigs

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

func (*Instance) GetRedisVersion

func (x *Instance) GetRedisVersion() string

func (*Instance) GetReservedIpRange

func (x *Instance) GetReservedIpRange() string

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

type Instance_ConnectMode

type Instance_ConnectMode int32

Available connection modes.

const (
	// Not set.
	Instance_CONNECT_MODE_UNSPECIFIED Instance_ConnectMode = 0
	// Connect via directly peering with memorystore redis hosted service.
	Instance_DIRECT_PEERING Instance_ConnectMode = 1
	// Connect with google via private service access and share connection
	// across google managed services.
	Instance_PRIVATE_SERVICE_ACCESS Instance_ConnectMode = 2
)

func (Instance_ConnectMode) Descriptor

func (Instance_ConnectMode) Enum

func (Instance_ConnectMode) EnumDescriptor deprecated

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

type Instance_State

type Instance_State int32

Represents the different states of a Redis instance.

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

func (Instance_State) Descriptor

func (Instance_State) Enum

func (x Instance_State) Enum() *Instance_State

func (Instance_State) EnumDescriptor deprecated

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

Deprecated: Use Instance_State.Descriptor instead.

func (Instance_State) Number

func (Instance_State) String

func (x Instance_State) String() string

func (Instance_State) Type

type Instance_Tier

type Instance_Tier int32

Available service tiers to choose from

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

func (x Instance_Tier) Enum() *Instance_Tier

func (Instance_Tier) EnumDescriptor deprecated

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

Deprecated: Use Instance_Tier.Descriptor instead.

func (Instance_Tier) Number

func (Instance_Tier) String

func (x Instance_Tier) String() string

func (Instance_Tier) Type

type 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.v1beta1.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.v1beta1.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.v1beta1.CloudRedis.ListInstances].

func (*ListInstancesRequest) Descriptor deprecated

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

type 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 dummy Redis
	// entry is included in the response with the `name` field set to a value of
	// the form `projects/{project_id}/locations/{location_id}/instances/`- and
	// the `status` field set to ERROR and `status_message` field set to "location
	// not available for ListInstances".
	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.v1beta1.CloudRedis.ListInstances].

func (*ListInstancesResponse) Descriptor deprecated

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

type 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 `` /* 191-byte string literal not displayed */
	// 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 deprecated

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

type 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 deprecated

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

type 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"`
}

type UnimplementedCloudRedisServer

type UnimplementedCloudRedisServer struct {
}

UnimplementedCloudRedisServer can be embedded to have forward compatible implementations.

func (*UnimplementedCloudRedisServer) CreateInstance

func (*UnimplementedCloudRedisServer) DeleteInstance

func (*UnimplementedCloudRedisServer) ExportInstance

func (*UnimplementedCloudRedisServer) FailoverInstance

func (*UnimplementedCloudRedisServer) GetInstance

func (*UnimplementedCloudRedisServer) ImportInstance

func (*UnimplementedCloudRedisServer) ListInstances

func (*UnimplementedCloudRedisServer) UpdateInstance

func (*UnimplementedCloudRedisServer) UpgradeInstance

type 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.v1beta1.Instance]:
	//
	//  *   `displayName`
	//  *   `labels`
	//  *   `memorySizeGb`
	//  *   `redisConfig`
	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.v1beta1.CloudRedis.UpdateInstance].

func (*UpdateInstanceRequest) Descriptor deprecated

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

type 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.v1beta1.CloudRedis.UpgradeInstance].

func (*UpgradeInstanceRequest) Descriptor deprecated

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

type 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 deprecated

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL