volumegroup

package
v0.2.4 Latest Latest
Warning

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

Go to latest
Published: Aug 19, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Controller_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "volumegroup.Controller",
	HandlerType: (*ControllerServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateVolumeGroup",
			Handler:    _Controller_CreateVolumeGroup_Handler,
		},
		{
			MethodName: "ModifyVolumeGroupMembership",
			Handler:    _Controller_ModifyVolumeGroupMembership_Handler,
		},
		{
			MethodName: "DeleteVolumeGroup",
			Handler:    _Controller_DeleteVolumeGroup_Handler,
		},
		{
			MethodName: "ListVolumeGroups",
			Handler:    _Controller_ListVolumeGroups_Handler,
		},
		{
			MethodName: "ControllerGetVolumeGroup",
			Handler:    _Controller_ControllerGetVolumeGroup_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "volumegroup/volumegroup.proto",
}

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

View Source
var File_volumegroup_volumegroup_proto protoreflect.FileDescriptor

Functions

func RegisterControllerServer

func RegisterControllerServer(s grpc.ServiceRegistrar, srv ControllerServer)

Types

type ControllerClient

type ControllerClient interface {
	// CreateVolumeGroup RPC call to create a volume group.
	CreateVolumeGroup(ctx context.Context, in *CreateVolumeGroupRequest, opts ...grpc.CallOption) (*CreateVolumeGroupResponse, error)
	// ModifyVolumeGroupMembership RPC call to modify a volume group.
	ModifyVolumeGroupMembership(ctx context.Context, in *ModifyVolumeGroupMembershipRequest, opts ...grpc.CallOption) (*ModifyVolumeGroupMembershipResponse, error)
	// DeleteVolumeGroup RPC call to delete a volume group.
	DeleteVolumeGroup(ctx context.Context, in *DeleteVolumeGroupRequest, opts ...grpc.CallOption) (*DeleteVolumeGroupResponse, error)
	// ListVolumeGroups RPC call to list volume groups.
	ListVolumeGroups(ctx context.Context, in *ListVolumeGroupsRequest, opts ...grpc.CallOption) (*ListVolumeGroupsResponse, error)
	// CreateVolumeGroup RPC call to get a volume group.
	ControllerGetVolumeGroup(ctx context.Context, in *ControllerGetVolumeGroupRequest, opts ...grpc.CallOption) (*ControllerGetVolumeGroupResponse, error)
}

ControllerClient is the client API for Controller service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewControllerClient

func NewControllerClient(cc grpc.ClientConnInterface) ControllerClient

type ControllerGetVolumeGroupRequest

type ControllerGetVolumeGroupRequest struct {

	// The ID of the volume group to fetch current volume group
	// information for.
	// This field is REQUIRED.
	VolumeGroupId string `protobuf:"bytes,1,opt,name=volume_group_id,json=volumeGroupId,proto3" json:"volume_group_id,omitempty"`
	// Secrets required by plugin to complete ControllerGetVolumeGroup
	// request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

ControllerGetVolumeGroupRequest holds the required information to get information on volume group

func (*ControllerGetVolumeGroupRequest) Descriptor deprecated

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

Deprecated: Use ControllerGetVolumeGroupRequest.ProtoReflect.Descriptor instead.

func (*ControllerGetVolumeGroupRequest) GetSecrets

func (x *ControllerGetVolumeGroupRequest) GetSecrets() map[string]string

func (*ControllerGetVolumeGroupRequest) GetVolumeGroupId

func (x *ControllerGetVolumeGroupRequest) GetVolumeGroupId() string

func (*ControllerGetVolumeGroupRequest) ProtoMessage

func (*ControllerGetVolumeGroupRequest) ProtoMessage()

func (*ControllerGetVolumeGroupRequest) ProtoReflect

func (*ControllerGetVolumeGroupRequest) Reset

func (*ControllerGetVolumeGroupRequest) String

type ControllerGetVolumeGroupResponse

type ControllerGetVolumeGroupResponse struct {

	// This field is REQUIRED
	VolumeGroup *VolumeGroup `protobuf:"bytes,1,opt,name=volume_group,json=volumeGroup,proto3" json:"volume_group,omitempty"`
	// contains filtered or unexported fields
}

ControllerGetVolumeGroupResponse holds the information to send when volumeGroup information was successfully gathered.

func (*ControllerGetVolumeGroupResponse) Descriptor deprecated

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

Deprecated: Use ControllerGetVolumeGroupResponse.ProtoReflect.Descriptor instead.

func (*ControllerGetVolumeGroupResponse) GetVolumeGroup

func (x *ControllerGetVolumeGroupResponse) GetVolumeGroup() *VolumeGroup

func (*ControllerGetVolumeGroupResponse) ProtoMessage

func (*ControllerGetVolumeGroupResponse) ProtoMessage()

func (*ControllerGetVolumeGroupResponse) ProtoReflect

func (*ControllerGetVolumeGroupResponse) Reset

func (*ControllerGetVolumeGroupResponse) String

type ControllerServer

type ControllerServer interface {
	// CreateVolumeGroup RPC call to create a volume group.
	CreateVolumeGroup(context.Context, *CreateVolumeGroupRequest) (*CreateVolumeGroupResponse, error)
	// ModifyVolumeGroupMembership RPC call to modify a volume group.
	ModifyVolumeGroupMembership(context.Context, *ModifyVolumeGroupMembershipRequest) (*ModifyVolumeGroupMembershipResponse, error)
	// DeleteVolumeGroup RPC call to delete a volume group.
	DeleteVolumeGroup(context.Context, *DeleteVolumeGroupRequest) (*DeleteVolumeGroupResponse, error)
	// ListVolumeGroups RPC call to list volume groups.
	ListVolumeGroups(context.Context, *ListVolumeGroupsRequest) (*ListVolumeGroupsResponse, error)
	// CreateVolumeGroup RPC call to get a volume group.
	ControllerGetVolumeGroup(context.Context, *ControllerGetVolumeGroupRequest) (*ControllerGetVolumeGroupResponse, error)
	// contains filtered or unexported methods
}

ControllerServer is the server API for Controller service. All implementations must embed UnimplementedControllerServer for forward compatibility

type CreateVolumeGroupRequest

type CreateVolumeGroupRequest struct {

	// suggested name for volume group (required for idempotency)
	// This field is REQUIRED.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// params passed from VolumeGroupClass
	// This field is OPTIONAL.
	Parameters map[string]string `` /* 161-byte string literal not displayed */
	// Secrets required by plugin to complete volume group creation
	// request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

CreateVolumeGroupRequest holds the required information to create a volume group

func (*CreateVolumeGroupRequest) Descriptor deprecated

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

Deprecated: Use CreateVolumeGroupRequest.ProtoReflect.Descriptor instead.

func (*CreateVolumeGroupRequest) GetName

func (x *CreateVolumeGroupRequest) GetName() string

func (*CreateVolumeGroupRequest) GetParameters

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

func (*CreateVolumeGroupRequest) GetSecrets

func (x *CreateVolumeGroupRequest) GetSecrets() map[string]string

func (*CreateVolumeGroupRequest) ProtoMessage

func (*CreateVolumeGroupRequest) ProtoMessage()

func (*CreateVolumeGroupRequest) ProtoReflect

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

func (*CreateVolumeGroupRequest) Reset

func (x *CreateVolumeGroupRequest) Reset()

func (*CreateVolumeGroupRequest) String

func (x *CreateVolumeGroupRequest) String() string

type CreateVolumeGroupResponse

type CreateVolumeGroupResponse struct {

	// Contains all attributes of the newly created volume group.
	// This field is REQUIRED.
	VolumeGroup *VolumeGroup `protobuf:"bytes,1,opt,name=volume_group,json=volumeGroup,proto3" json:"volume_group,omitempty"`
	// contains filtered or unexported fields
}

CreateVolumeGroupResponse holds the information to send when volumeGroup is successfully created.

func (*CreateVolumeGroupResponse) Descriptor deprecated

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

Deprecated: Use CreateVolumeGroupResponse.ProtoReflect.Descriptor instead.

func (*CreateVolumeGroupResponse) GetVolumeGroup

func (x *CreateVolumeGroupResponse) GetVolumeGroup() *VolumeGroup

func (*CreateVolumeGroupResponse) ProtoMessage

func (*CreateVolumeGroupResponse) ProtoMessage()

func (*CreateVolumeGroupResponse) ProtoReflect

func (*CreateVolumeGroupResponse) Reset

func (x *CreateVolumeGroupResponse) Reset()

func (*CreateVolumeGroupResponse) String

func (x *CreateVolumeGroupResponse) String() string

type DeleteVolumeGroupRequest

type DeleteVolumeGroupRequest struct {

	// The ID of the volume group to be deleted.
	// This field is REQUIRED.
	VolumeGroupId string `protobuf:"bytes,1,opt,name=volume_group_id,json=volumeGroupId,proto3" json:"volume_group_id,omitempty"`
	// Secrets required by plugin to complete volume group
	// deletion request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

DeleteVolumeGroupRequest holds the required information to delete a volume group

func (*DeleteVolumeGroupRequest) Descriptor deprecated

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

Deprecated: Use DeleteVolumeGroupRequest.ProtoReflect.Descriptor instead.

func (*DeleteVolumeGroupRequest) GetSecrets

func (x *DeleteVolumeGroupRequest) GetSecrets() map[string]string

func (*DeleteVolumeGroupRequest) GetVolumeGroupId

func (x *DeleteVolumeGroupRequest) GetVolumeGroupId() string

func (*DeleteVolumeGroupRequest) ProtoMessage

func (*DeleteVolumeGroupRequest) ProtoMessage()

func (*DeleteVolumeGroupRequest) ProtoReflect

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

func (*DeleteVolumeGroupRequest) Reset

func (x *DeleteVolumeGroupRequest) Reset()

func (*DeleteVolumeGroupRequest) String

func (x *DeleteVolumeGroupRequest) String() string

type DeleteVolumeGroupResponse

type DeleteVolumeGroupResponse struct {
	// contains filtered or unexported fields
}

DeleteVolumeGroupResponse holds the information to send when volumeGroup is successfully deleted.

func (*DeleteVolumeGroupResponse) Descriptor deprecated

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

Deprecated: Use DeleteVolumeGroupResponse.ProtoReflect.Descriptor instead.

func (*DeleteVolumeGroupResponse) ProtoMessage

func (*DeleteVolumeGroupResponse) ProtoMessage()

func (*DeleteVolumeGroupResponse) ProtoReflect

func (*DeleteVolumeGroupResponse) Reset

func (x *DeleteVolumeGroupResponse) Reset()

func (*DeleteVolumeGroupResponse) String

func (x *DeleteVolumeGroupResponse) String() string

type ListVolumeGroupsRequest

type ListVolumeGroupsRequest struct {

	// If specified (non-zero value), the Plugin MUST NOT return more
	// entries than this number in the response. If the actual number of
	// entries is more than this number, the Plugin MUST set `next_token`
	// in the response which can be used to get the next page of entries
	// in the subsequent `ListVolumeGroups` call. This field is OPTIONAL.
	// If not specified (zero value), it means there is no restriction on
	// the number of entries that can be returned.
	// The value of this field MUST NOT be negative.
	MaxEntries int32 `protobuf:"varint,1,opt,name=max_entries,json=maxEntries,proto3" json:"max_entries,omitempty"`
	// A token to specify where to start paginating. Set this field to
	// `next_token` returned by a previous `ListVolumeGroups` call to get
	// the next page of entries. This field is OPTIONAL.
	// An empty string is equal to an unspecified field value.
	StartingToken string `protobuf:"bytes,2,opt,name=starting_token,json=startingToken,proto3" json:"starting_token,omitempty"`
	// Secrets required by plugin to complete ListVolumeGroup request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

ListVolumeGroupsRequest holds the required information to get information on list of volume groups.

func (*ListVolumeGroupsRequest) Descriptor deprecated

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

Deprecated: Use ListVolumeGroupsRequest.ProtoReflect.Descriptor instead.

func (*ListVolumeGroupsRequest) GetMaxEntries

func (x *ListVolumeGroupsRequest) GetMaxEntries() int32

func (*ListVolumeGroupsRequest) GetSecrets

func (x *ListVolumeGroupsRequest) GetSecrets() map[string]string

func (*ListVolumeGroupsRequest) GetStartingToken

func (x *ListVolumeGroupsRequest) GetStartingToken() string

func (*ListVolumeGroupsRequest) ProtoMessage

func (*ListVolumeGroupsRequest) ProtoMessage()

func (*ListVolumeGroupsRequest) ProtoReflect

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

func (*ListVolumeGroupsRequest) Reset

func (x *ListVolumeGroupsRequest) Reset()

func (*ListVolumeGroupsRequest) String

func (x *ListVolumeGroupsRequest) String() string

type ListVolumeGroupsResponse

type ListVolumeGroupsResponse struct {

	// Represents each volume group entry
	Entries []*ListVolumeGroupsResponse_Entry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
	// This token allows you to get the next page of entries for
	// `ListVolumeGroups` request. If the number of entries is larger than
	// `max_entries`, use the `next_token` as a value for the
	// `starting_token` field in the next `ListVolumeGroups` request. This
	// field is OPTIONAL.
	// An empty string is equal to an unspecified field value.
	NextToken string `protobuf:"bytes,2,opt,name=next_token,json=nextToken,proto3" json:"next_token,omitempty"`
	// contains filtered or unexported fields
}

ListVolumeGroupsResponse holds the information to send when list of volumeGroups information was successfully gathered.

func (*ListVolumeGroupsResponse) Descriptor deprecated

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

Deprecated: Use ListVolumeGroupsResponse.ProtoReflect.Descriptor instead.

func (*ListVolumeGroupsResponse) GetEntries

func (*ListVolumeGroupsResponse) GetNextToken

func (x *ListVolumeGroupsResponse) GetNextToken() string

func (*ListVolumeGroupsResponse) ProtoMessage

func (*ListVolumeGroupsResponse) ProtoMessage()

func (*ListVolumeGroupsResponse) ProtoReflect

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

func (*ListVolumeGroupsResponse) Reset

func (x *ListVolumeGroupsResponse) Reset()

func (*ListVolumeGroupsResponse) String

func (x *ListVolumeGroupsResponse) String() string

type ListVolumeGroupsResponse_Entry

type ListVolumeGroupsResponse_Entry struct {

	// This field is REQUIRED
	VolumeGroup *VolumeGroup `protobuf:"bytes,1,opt,name=volume_group,json=volumeGroup,proto3" json:"volume_group,omitempty"`
	// contains filtered or unexported fields
}

Represents each volume group.

func (*ListVolumeGroupsResponse_Entry) Descriptor deprecated

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

Deprecated: Use ListVolumeGroupsResponse_Entry.ProtoReflect.Descriptor instead.

func (*ListVolumeGroupsResponse_Entry) GetVolumeGroup

func (x *ListVolumeGroupsResponse_Entry) GetVolumeGroup() *VolumeGroup

func (*ListVolumeGroupsResponse_Entry) ProtoMessage

func (*ListVolumeGroupsResponse_Entry) ProtoMessage()

func (*ListVolumeGroupsResponse_Entry) ProtoReflect

func (*ListVolumeGroupsResponse_Entry) Reset

func (x *ListVolumeGroupsResponse_Entry) Reset()

func (*ListVolumeGroupsResponse_Entry) String

type ModifyVolumeGroupMembershipRequest

type ModifyVolumeGroupMembershipRequest struct {

	// The ID of the volume group to be modified.
	// This field is REQUIRED.
	VolumeGroupId string `protobuf:"bytes,1,opt,name=volume_group_id,json=volumeGroupId,proto3" json:"volume_group_id,omitempty"`
	// Specify volume_ids that will be in the modified volume group.
	// This list will be compared with the volume_ids in the existing
	// group.
	// New ones will be added and missing ones will be removed.
	// If no volume_ids are provided, all existing volumes will
	// be removed from the group.
	// This field is OPTIONAL.
	VolumeIds []string `protobuf:"bytes,2,rep,name=volume_ids,json=volumeIds,proto3" json:"volume_ids,omitempty"`
	// Secrets required by plugin to complete volume group
	// modification request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

ModifyVolumeGroupMembershipRequest holds the required information to modify a volume group

func (*ModifyVolumeGroupMembershipRequest) Descriptor deprecated

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

Deprecated: Use ModifyVolumeGroupMembershipRequest.ProtoReflect.Descriptor instead.

func (*ModifyVolumeGroupMembershipRequest) GetSecrets

func (x *ModifyVolumeGroupMembershipRequest) GetSecrets() map[string]string

func (*ModifyVolumeGroupMembershipRequest) GetVolumeGroupId

func (x *ModifyVolumeGroupMembershipRequest) GetVolumeGroupId() string

func (*ModifyVolumeGroupMembershipRequest) GetVolumeIds

func (x *ModifyVolumeGroupMembershipRequest) GetVolumeIds() []string

func (*ModifyVolumeGroupMembershipRequest) ProtoMessage

func (*ModifyVolumeGroupMembershipRequest) ProtoMessage()

func (*ModifyVolumeGroupMembershipRequest) ProtoReflect

func (*ModifyVolumeGroupMembershipRequest) Reset

func (*ModifyVolumeGroupMembershipRequest) String

type ModifyVolumeGroupMembershipResponse

type ModifyVolumeGroupMembershipResponse struct {

	// Contains all attributes of the modified volume group.
	// This field is REQUIRED.
	VolumeGroup *VolumeGroup `protobuf:"bytes,1,opt,name=volume_group,json=volumeGroup,proto3" json:"volume_group,omitempty"`
	// contains filtered or unexported fields
}

ModifyVolumeGroupMembershipResponse holds the information to send when volumeGroup is successfully modified.

func (*ModifyVolumeGroupMembershipResponse) Descriptor deprecated

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

Deprecated: Use ModifyVolumeGroupMembershipResponse.ProtoReflect.Descriptor instead.

func (*ModifyVolumeGroupMembershipResponse) GetVolumeGroup

func (x *ModifyVolumeGroupMembershipResponse) GetVolumeGroup() *VolumeGroup

func (*ModifyVolumeGroupMembershipResponse) ProtoMessage

func (*ModifyVolumeGroupMembershipResponse) ProtoMessage()

func (*ModifyVolumeGroupMembershipResponse) ProtoReflect

func (*ModifyVolumeGroupMembershipResponse) Reset

func (*ModifyVolumeGroupMembershipResponse) String

type UnimplementedControllerServer

type UnimplementedControllerServer struct {
}

UnimplementedControllerServer must be embedded to have forward compatible implementations.

func (UnimplementedControllerServer) CreateVolumeGroup

func (UnimplementedControllerServer) DeleteVolumeGroup

func (UnimplementedControllerServer) ListVolumeGroups

type UnsafeControllerServer

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

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

type VolumeGroup

type VolumeGroup struct {

	// The identifier for this volume group, generated by the plugin.
	// This field is REQUIRED.
	VolumeGroupId string `protobuf:"bytes,1,opt,name=volume_group_id,json=volumeGroupId,proto3" json:"volume_group_id,omitempty"`
	// Opaque static properties of the volume group.
	// This field is OPTIONAL.
	VolumeGroupContext map[string]string `` /* 205-byte string literal not displayed */
	// Underlying volumes in this group. The same definition in CSI
	// Volume.
	// This field is OPTIONAL.
	// To support the creation of an empty group, this list can be empty.
	// However, this field is not empty in the following cases:
	// - Response from ListVolumeGroups or ControllerGetVolumeGroup if the
	//   VolumeGroup is not empty.
	// - Response from ModifyVolumeGroupMembership if the
	//   VolumeGroup is not empty after modification.
	Volumes []*csi.Volume `protobuf:"bytes,3,rep,name=volumes,proto3" json:"volumes,omitempty"`
	// contains filtered or unexported fields
}

Information about a specific volumeGroup.

func (*VolumeGroup) Descriptor deprecated

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

Deprecated: Use VolumeGroup.ProtoReflect.Descriptor instead.

func (*VolumeGroup) GetVolumeGroupContext

func (x *VolumeGroup) GetVolumeGroupContext() map[string]string

func (*VolumeGroup) GetVolumeGroupId

func (x *VolumeGroup) GetVolumeGroupId() string

func (*VolumeGroup) GetVolumes

func (x *VolumeGroup) GetVolumes() []*csi.Volume

func (*VolumeGroup) ProtoMessage

func (*VolumeGroup) ProtoMessage()

func (*VolumeGroup) ProtoReflect

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

func (*VolumeGroup) Reset

func (x *VolumeGroup) Reset()

func (*VolumeGroup) String

func (x *VolumeGroup) String() string

Jump to

Keyboard shortcuts

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