volumegroupsnapshot

package module
v1.5.0 Latest Latest
Warning

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

Go to latest
Published: Feb 26, 2024 License: Apache-2.0 Imports: 9 Imported by: 7

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_volumeGroupSnapshot_proto protoreflect.FileDescriptor
View Source
var VolumeGroupSnapshot_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "volumegroupsnapshot.v1.VolumeGroupSnapshot",
	HandlerType: (*VolumeGroupSnapshotServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ProbeController",
			Handler:    _VolumeGroupSnapshot_ProbeController_Handler,
		},
		{
			MethodName: "CreateVolumeGroupSnapshot",
			Handler:    _VolumeGroupSnapshot_CreateVolumeGroupSnapshot_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "volumeGroupSnapshot.proto",
}

VolumeGroupSnapshot_ServiceDesc is the grpc.ServiceDesc for VolumeGroupSnapshot service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterVolumeGroupSnapshotServer

func RegisterVolumeGroupSnapshotServer(s grpc.ServiceRegistrar, srv VolumeGroupSnapshotServer)

Types

type CreateVolumeGroupSnapshotRequest

type CreateVolumeGroupSnapshotRequest struct {

	// volumeIDs to be snapped
	SourceVolumeIDs []string `protobuf:"bytes,1,rep,name=SourceVolumeIDs,proto3" json:"SourceVolumeIDs,omitempty"`
	// name of snapshot group
	Name        string `protobuf:"bytes,2,opt,name=Name,proto3" json:"Name,omitempty"`
	Description string `protobuf:"bytes,3,opt,name=Description,proto3" json:"Description,omitempty"`
	// parameters map from VolumeGroupSnapshot instance
	Parameters map[string]string `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*CreateVolumeGroupSnapshotRequest) Descriptor deprecated

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

Deprecated: Use CreateVolumeGroupSnapshotRequest.ProtoReflect.Descriptor instead.

func (*CreateVolumeGroupSnapshotRequest) GetDescription added in v1.2.0

func (x *CreateVolumeGroupSnapshotRequest) GetDescription() string

func (*CreateVolumeGroupSnapshotRequest) GetName

func (*CreateVolumeGroupSnapshotRequest) GetParameters

func (x *CreateVolumeGroupSnapshotRequest) GetParameters() map[string]string

func (*CreateVolumeGroupSnapshotRequest) GetSourceVolumeIDs

func (x *CreateVolumeGroupSnapshotRequest) GetSourceVolumeIDs() []string

func (*CreateVolumeGroupSnapshotRequest) ProtoMessage

func (*CreateVolumeGroupSnapshotRequest) ProtoMessage()

func (*CreateVolumeGroupSnapshotRequest) ProtoReflect

func (*CreateVolumeGroupSnapshotRequest) Reset

func (*CreateVolumeGroupSnapshotRequest) String

type CreateVolumeGroupSnapshotResponse

type CreateVolumeGroupSnapshotResponse struct {

	// snapshots in group
	Snapshots []*Snapshot `protobuf:"bytes,1,rep,name=Snapshots,proto3" json:"Snapshots,omitempty"`
	// snapshot group csi id on array
	SnapshotGroupID string `protobuf:"bytes,2,opt,name=SnapshotGroupID,proto3" json:"SnapshotGroupID,omitempty"`
	// time VGS was created
	CreationTime int64 `protobuf:"varint,3,opt,name=CreationTime,proto3" json:"CreationTime,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateVolumeGroupSnapshotResponse) Descriptor deprecated

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

Deprecated: Use CreateVolumeGroupSnapshotResponse.ProtoReflect.Descriptor instead.

func (*CreateVolumeGroupSnapshotResponse) GetCreationTime

func (x *CreateVolumeGroupSnapshotResponse) GetCreationTime() int64

func (*CreateVolumeGroupSnapshotResponse) GetSnapshotGroupID

func (x *CreateVolumeGroupSnapshotResponse) GetSnapshotGroupID() string

func (*CreateVolumeGroupSnapshotResponse) GetSnapshots

func (x *CreateVolumeGroupSnapshotResponse) GetSnapshots() []*Snapshot

func (*CreateVolumeGroupSnapshotResponse) ProtoMessage

func (*CreateVolumeGroupSnapshotResponse) ProtoMessage()

func (*CreateVolumeGroupSnapshotResponse) ProtoReflect

func (*CreateVolumeGroupSnapshotResponse) Reset

func (*CreateVolumeGroupSnapshotResponse) String

type Snapshot

type Snapshot struct {

	// Size of the source volume in bytes
	CapacityBytes int64 `protobuf:"varint,1,opt,name=capacity_bytes,json=capacityBytes,proto3" json:"capacity_bytes,omitempty"`
	// Snapshot ID - CSI snapshot ID. Should uniquely identify the snapshot for the driver.
	SnapId string `protobuf:"bytes,2,opt,name=snap_id,json=snapId,proto3" json:"snap_id,omitempty"`
	// ID of source volume
	SourceId string `protobuf:"bytes,3,opt,name=source_id,json=sourceId,proto3" json:"source_id,omitempty"`
	// bool value to determine if this snap is ready for use
	ReadyToUse bool `protobuf:"varint,4,opt,name=readyToUse,proto3" json:"readyToUse,omitempty"`
	// time snapshot was created
	CreationTime int64 `protobuf:"varint,5,opt,name=CreationTime,proto3" json:"CreationTime,omitempty"`
	// name of snapshot found in array
	Name string `protobuf:"bytes,6,opt,name=Name,proto3" json:"Name,omitempty"`
	// contains filtered or unexported fields
}

func (*Snapshot) Descriptor deprecated

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

Deprecated: Use Snapshot.ProtoReflect.Descriptor instead.

func (*Snapshot) GetCapacityBytes

func (x *Snapshot) GetCapacityBytes() int64

func (*Snapshot) GetCreationTime

func (x *Snapshot) GetCreationTime() int64

func (*Snapshot) GetName

func (x *Snapshot) GetName() string

func (*Snapshot) GetReadyToUse

func (x *Snapshot) GetReadyToUse() bool

func (*Snapshot) GetSnapId

func (x *Snapshot) GetSnapId() string

func (*Snapshot) GetSourceId

func (x *Snapshot) GetSourceId() string

func (*Snapshot) ProtoMessage

func (*Snapshot) ProtoMessage()

func (*Snapshot) ProtoReflect

func (x *Snapshot) ProtoReflect() protoreflect.Message

func (*Snapshot) Reset

func (x *Snapshot) Reset()

func (*Snapshot) String

func (x *Snapshot) String() string

type UnimplementedVolumeGroupSnapshotServer

type UnimplementedVolumeGroupSnapshotServer struct {
}

UnimplementedVolumeGroupSnapshotServer should be embedded to have forward compatible implementations.

func (UnimplementedVolumeGroupSnapshotServer) ProbeController added in v0.2.0

type UnsafeVolumeGroupSnapshotServer added in v0.2.0

type UnsafeVolumeGroupSnapshotServer interface {
	// contains filtered or unexported methods
}

UnsafeVolumeGroupSnapshotServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to VolumeGroupSnapshotServer will result in compilation errors.

type VolumeGroupSnapshotClient

type VolumeGroupSnapshotClient interface {
	// ProbeController is used to probe driver name by making grpc calls
	ProbeController(ctx context.Context, in *common.ProbeControllerRequest, opts ...grpc.CallOption) (*common.ProbeControllerResponse, error)
	// CreateVolumeGroupSnapshot will take in a CreateVolumeGroupSnapshotRequest that will contain:
	// 1. An array of volume IDs to be snapped for the volume snapshot group
	// 2. A name for the volume snapshot group
	// 3. Parameters for the VolumeGroupSnapshot instance
	// It will return a CreateVolumeGroupSnapshotResponse, which contains an array of snapshots, and an id for the group
	CreateVolumeGroupSnapshot(ctx context.Context, in *CreateVolumeGroupSnapshotRequest, opts ...grpc.CallOption) (*CreateVolumeGroupSnapshotResponse, error)
}

VolumeGroupSnapshotClient is the client API for VolumeGroupSnapshot 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.

type VolumeGroupSnapshotServer

type VolumeGroupSnapshotServer interface {
	// ProbeController is used to probe driver name by making grpc calls
	ProbeController(context.Context, *common.ProbeControllerRequest) (*common.ProbeControllerResponse, error)
	// CreateVolumeGroupSnapshot will take in a CreateVolumeGroupSnapshotRequest that will contain:
	// 1. An array of volume IDs to be snapped for the volume snapshot group
	// 2. A name for the volume snapshot group
	// 3. Parameters for the VolumeGroupSnapshot instance
	// It will return a CreateVolumeGroupSnapshotResponse, which contains an array of snapshots, and an id for the group
	CreateVolumeGroupSnapshot(context.Context, *CreateVolumeGroupSnapshotRequest) (*CreateVolumeGroupSnapshotResponse, error)
}

VolumeGroupSnapshotServer is the server API for VolumeGroupSnapshot service. All implementations should embed UnimplementedVolumeGroupSnapshotServer for forward compatibility

Jump to

Keyboard shortcuts

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