proto

package
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Dec 29, 2017 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package proto is a generated protocol buffer package.

It is generated from these files: 

dock.proto

It has these top-level messages: 

CreateVolumeOpts
DeleteVolumeOpts
CreateVolumeSnapshotOpts
DeleteVolumeSnapshotOpts
CreateAttachmentOpts
DeleteAttachmentOpts
HostInfo
GenericResponse

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterDockServer 

func RegisterDockServer(s *grpc.Server, srv DockServer)

Types

type CreateAttachmentOpts 

type CreateAttachmentOpts struct {
	// The uuid of the volume attachment, optional.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// The uuid of the volume, required.
	VolumeId string `protobuf:"bytes,2,opt,name=volumeId" json:"volumeId,omitempty"`
	// This field indicates if the volume is attached locally, optional.
	DoLocalAttach bool `protobuf:"varint,3,opt,name=doLocalAttach" json:"doLocalAttach,omitempty"`
	// This field indicates if the volume is attached multiple times, optional.
	MultiPath bool `protobuf:"varint,4,opt,name=multiPath" json:"multiPath,omitempty"`
	// The infomation of the host node on which the volume will be attached.
	HostInfo *HostInfo `protobuf:"bytes,5,opt,name=hostInfo" json:"hostInfo,omitempty"`
	// The metadata of the volume attachment, optional.
	Metadata map[string]string `` /* 136-byte string literal not displayed */
	// The dock infomation on which the request will be executed
	DockId string `protobuf:"bytes,7,opt,name=dockId" json:"dockId,omitempty"`
	// The storage driver type.
	DriverName string `protobuf:"bytes,8,opt,name=driverName" json:"driverName,omitempty"`
}

CreateAttachmentOpts is a structure which indicates all required properties for creating a volume attachment.

func (*CreateAttachmentOpts) Descriptor 

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

func (*CreateAttachmentOpts) GetDoLocalAttach 

func (m *CreateAttachmentOpts) GetDoLocalAttach() bool

func (*CreateAttachmentOpts) GetDockId 

func (m *CreateAttachmentOpts) GetDockId() string

func (*CreateAttachmentOpts) GetDriverName 

func (m *CreateAttachmentOpts) GetDriverName() string

func (*CreateAttachmentOpts) GetHostInfo 

func (m *CreateAttachmentOpts) GetHostInfo() *HostInfo

func (*CreateAttachmentOpts) GetId 

func (m *CreateAttachmentOpts) GetId() string

func (*CreateAttachmentOpts) GetMetadata 

func (m *CreateAttachmentOpts) GetMetadata() map[string]string

func (*CreateAttachmentOpts) GetMultiPath 

func (m *CreateAttachmentOpts) GetMultiPath() bool

func (*CreateAttachmentOpts) GetVolumeId 

func (m *CreateAttachmentOpts) GetVolumeId() string

func (*CreateAttachmentOpts) ProtoMessage 

func (*CreateAttachmentOpts) ProtoMessage()

func (*CreateAttachmentOpts) Reset 

func (m *CreateAttachmentOpts) Reset()

func (*CreateAttachmentOpts) String 

func (m *CreateAttachmentOpts) String() string

type CreateVolumeOpts 

type CreateVolumeOpts struct {
	// The uuid of the volume, optional when creating.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// The name of the volume, required.
	Name string `protobuf:"bytes,2,opt,name=name" json:"name,omitempty"`
	// The requested capacity of the volume, required.
	Size int64 `protobuf:"varint,3,opt,name=size" json:"size,omitempty"`
	// The description of the volume, optional.
	Description string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	// When create volume from snapshot, this field is required.
	SnapshotId string `protobuf:"bytes,5,opt,name=snapshotId" json:"snapshotId,omitempty"`
	// The locality that volume belongs to, required.
	AvailabilityZone string `protobuf:"bytes,6,opt,name=availabilityZone" json:"availabilityZone,omitempty"`
	// The service level that volume belongs to, required.
	ProfileId string `protobuf:"bytes,7,opt,name=profileId" json:"profileId,omitempty"`
	// The uuid of the pool on which volume will be created, required.
	PoolId string `protobuf:"bytes,8,opt,name=poolId" json:"poolId,omitempty"`
	// The name of the pool on which volume will be created, required.
	PoolName string `protobuf:"bytes,9,opt,name=poolName" json:"poolName,omitempty"`
	// The metadata of the volume, optional.
	Metadata map[string]string `` /* 137-byte string literal not displayed */
	// The dock infomation on which the request will be executed
	DockId string `protobuf:"bytes,11,opt,name=dockId" json:"dockId,omitempty"`
	// The storage driver type.
	DriverName string `protobuf:"bytes,12,opt,name=driverName" json:"driverName,omitempty"`
}

CreateVolumeOpts is a structure which indicates all required properties for creating a volume.

func (*CreateVolumeOpts) Descriptor 

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

func (*CreateVolumeOpts) GetAvailabilityZone 

func (m *CreateVolumeOpts) GetAvailabilityZone() string

func (*CreateVolumeOpts) GetDescription 

func (m *CreateVolumeOpts) GetDescription() string

func (*CreateVolumeOpts) GetDockId 

func (m *CreateVolumeOpts) GetDockId() string

func (*CreateVolumeOpts) GetDriverName 

func (m *CreateVolumeOpts) GetDriverName() string

func (*CreateVolumeOpts) GetId 

func (m *CreateVolumeOpts) GetId() string

func (*CreateVolumeOpts) GetMetadata 

func (m *CreateVolumeOpts) GetMetadata() map[string]string

func (*CreateVolumeOpts) GetName 

func (m *CreateVolumeOpts) GetName() string

func (*CreateVolumeOpts) GetPoolId 

func (m *CreateVolumeOpts) GetPoolId() string

func (*CreateVolumeOpts) GetPoolName 

func (m *CreateVolumeOpts) GetPoolName() string

func (*CreateVolumeOpts) GetProfileId 

func (m *CreateVolumeOpts) GetProfileId() string

func (*CreateVolumeOpts) GetSize 

func (m *CreateVolumeOpts) GetSize() int64

func (*CreateVolumeOpts) GetSnapshotId 

func (m *CreateVolumeOpts) GetSnapshotId() string

func (*CreateVolumeOpts) ProtoMessage 

func (*CreateVolumeOpts) ProtoMessage()

func (*CreateVolumeOpts) Reset 

func (m *CreateVolumeOpts) Reset()

func (*CreateVolumeOpts) String 

func (m *CreateVolumeOpts) String() string

type CreateVolumeSnapshotOpts 

type CreateVolumeSnapshotOpts struct {
	// The uuid of the volume snapshot, optional.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// The name of the volume snapshot, required.
	Name string `protobuf:"bytes,2,opt,name=name" json:"name,omitempty"`
	// The size of the volume that snapshot belongs to, required.
	Size int64 `protobuf:"varint,3,opt,name=size" json:"size,omitempty"`
	// The description of the volume snapshot, optional.
	Description string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	// The uuid of the volume that snapshot belongs to, required.
	VolumeId string `protobuf:"bytes,5,opt,name=volumeId" json:"volumeId,omitempty"`
	// The metadata of the volume snapshot, optional.
	Metadata map[string]string `` /* 136-byte string literal not displayed */
	// The dock infomation on which the request will be executed
	DockId string `protobuf:"bytes,7,opt,name=dockId" json:"dockId,omitempty"`
	// The storage driver type.
	DriverName string `protobuf:"bytes,8,opt,name=driverName" json:"driverName,omitempty"`
}

CreateVolumeSnapshotOpts is a structure which indicates all required properties for creating a volume snapshot.

func (*CreateVolumeSnapshotOpts) Descriptor 

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

func (*CreateVolumeSnapshotOpts) GetDescription 

func (m *CreateVolumeSnapshotOpts) GetDescription() string

func (*CreateVolumeSnapshotOpts) GetDockId 

func (m *CreateVolumeSnapshotOpts) GetDockId() string

func (*CreateVolumeSnapshotOpts) GetDriverName 

func (m *CreateVolumeSnapshotOpts) GetDriverName() string

func (*CreateVolumeSnapshotOpts) GetId 

func (m *CreateVolumeSnapshotOpts) GetId() string

func (*CreateVolumeSnapshotOpts) GetMetadata 

func (m *CreateVolumeSnapshotOpts) GetMetadata() map[string]string

func (*CreateVolumeSnapshotOpts) GetName 

func (m *CreateVolumeSnapshotOpts) GetName() string

func (*CreateVolumeSnapshotOpts) GetSize 

func (m *CreateVolumeSnapshotOpts) GetSize() int64

func (*CreateVolumeSnapshotOpts) GetVolumeId 

func (m *CreateVolumeSnapshotOpts) GetVolumeId() string

func (*CreateVolumeSnapshotOpts) ProtoMessage 

func (*CreateVolumeSnapshotOpts) ProtoMessage()

func (*CreateVolumeSnapshotOpts) Reset 

func (m *CreateVolumeSnapshotOpts) Reset()

func (*CreateVolumeSnapshotOpts) String 

func (m *CreateVolumeSnapshotOpts) String() string

type DeleteAttachmentOpts 

type DeleteAttachmentOpts struct {
	// The uuid of the volume attachment, optional.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// The uuid of the volume, required.
	VolumeId string `protobuf:"bytes,2,opt,name=volumeId" json:"volumeId,omitempty"`
	// The infomation of the host node on which the volume will be attached.
	HostInfo *HostInfo `protobuf:"bytes,3,opt,name=hostInfo" json:"hostInfo,omitempty"`
	// The metadata of the volume attachment, optional.
	Metadata map[string]string `` /* 136-byte string literal not displayed */
	// The dock infomation on which the request will be executed
	DockId string `protobuf:"bytes,5,opt,name=dockId" json:"dockId,omitempty"`
	// The storage driver type.
	DriverName string `protobuf:"bytes,6,opt,name=driverName" json:"driverName,omitempty"`
}

DeleteAttachmentOpts is a structure which indicates all required properties for deleting a volume attachment.

func (*DeleteAttachmentOpts) Descriptor 

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

func (*DeleteAttachmentOpts) GetDockId 

func (m *DeleteAttachmentOpts) GetDockId() string

func (*DeleteAttachmentOpts) GetDriverName 

func (m *DeleteAttachmentOpts) GetDriverName() string

func (*DeleteAttachmentOpts) GetHostInfo 

func (m *DeleteAttachmentOpts) GetHostInfo() *HostInfo

func (*DeleteAttachmentOpts) GetId 

func (m *DeleteAttachmentOpts) GetId() string

func (*DeleteAttachmentOpts) GetMetadata 

func (m *DeleteAttachmentOpts) GetMetadata() map[string]string

func (*DeleteAttachmentOpts) GetVolumeId 

func (m *DeleteAttachmentOpts) GetVolumeId() string

func (*DeleteAttachmentOpts) ProtoMessage 

func (*DeleteAttachmentOpts) ProtoMessage()

func (*DeleteAttachmentOpts) Reset 

func (m *DeleteAttachmentOpts) Reset()

func (*DeleteAttachmentOpts) String 

func (m *DeleteAttachmentOpts) String() string

type DeleteVolumeOpts 

type DeleteVolumeOpts struct {
	// The uuid of the volume, required.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// The metadata of the volume, optional.
	Metadata map[string]string `` /* 136-byte string literal not displayed */
	// The dock infomation on which the request will be executed.
	DockId string `protobuf:"bytes,3,opt,name=dockId" json:"dockId,omitempty"`
	// The storage driver type.
	DriverName string `protobuf:"bytes,4,opt,name=driverName" json:"driverName,omitempty"`
}

DeleteVolumeOpts is a structure which indicates all required properties for deleting a volume.

func (*DeleteVolumeOpts) Descriptor 

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

func (*DeleteVolumeOpts) GetDockId 

func (m *DeleteVolumeOpts) GetDockId() string

func (*DeleteVolumeOpts) GetDriverName 

func (m *DeleteVolumeOpts) GetDriverName() string

func (*DeleteVolumeOpts) GetId 

func (m *DeleteVolumeOpts) GetId() string

func (*DeleteVolumeOpts) GetMetadata 

func (m *DeleteVolumeOpts) GetMetadata() map[string]string

func (*DeleteVolumeOpts) ProtoMessage 

func (*DeleteVolumeOpts) ProtoMessage()

func (*DeleteVolumeOpts) Reset 

func (m *DeleteVolumeOpts) Reset()

func (*DeleteVolumeOpts) String 

func (m *DeleteVolumeOpts) String() string

type DeleteVolumeSnapshotOpts 

type DeleteVolumeSnapshotOpts struct {
	// The uuid of the volume snapshot, required.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// The uuid of the volume that snapshot belongs to, required.
	VolumeId string `protobuf:"bytes,2,opt,name=volumeId" json:"volumeId,omitempty"`
	// The metadata of the volume snapshot, optional.
	Metadata map[string]string `` /* 136-byte string literal not displayed */
	// The dock infomation on which the request will be executed
	DockId string `protobuf:"bytes,4,opt,name=dockId" json:"dockId,omitempty"`
	// The storage driver type.
	DriverName string `protobuf:"bytes,5,opt,name=driverName" json:"driverName,omitempty"`
}

DeleteVolumeSnapshotOpts is a structure which indicates all required properties for deleting a volume snapshot.

func (*DeleteVolumeSnapshotOpts) Descriptor 

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

func (*DeleteVolumeSnapshotOpts) GetDockId 

func (m *DeleteVolumeSnapshotOpts) GetDockId() string

func (*DeleteVolumeSnapshotOpts) GetDriverName 

func (m *DeleteVolumeSnapshotOpts) GetDriverName() string

func (*DeleteVolumeSnapshotOpts) GetId 

func (m *DeleteVolumeSnapshotOpts) GetId() string

func (*DeleteVolumeSnapshotOpts) GetMetadata 

func (m *DeleteVolumeSnapshotOpts) GetMetadata() map[string]string

func (*DeleteVolumeSnapshotOpts) GetVolumeId 

func (m *DeleteVolumeSnapshotOpts) GetVolumeId() string

func (*DeleteVolumeSnapshotOpts) ProtoMessage 

func (*DeleteVolumeSnapshotOpts) ProtoMessage()

func (*DeleteVolumeSnapshotOpts) Reset 

func (m *DeleteVolumeSnapshotOpts) Reset()

func (*DeleteVolumeSnapshotOpts) String 

func (m *DeleteVolumeSnapshotOpts) String() string

type DockClient 

type DockClient interface {
	// Create a volume
	CreateVolume(ctx context.Context, in *CreateVolumeOpts, opts ...grpc.CallOption) (*GenericResponse, error)
	// Delete a volume
	DeleteVolume(ctx context.Context, in *DeleteVolumeOpts, opts ...grpc.CallOption) (*GenericResponse, error)
	// Create a volume snapshot
	CreateVolumeSnapshot(ctx context.Context, in *CreateVolumeSnapshotOpts, opts ...grpc.CallOption) (*GenericResponse, error)
	// Delete a volume snapshot
	DeleteVolumeSnapshot(ctx context.Context, in *DeleteVolumeSnapshotOpts, opts ...grpc.CallOption) (*GenericResponse, error)
	// Create a volume attachment
	CreateAttachment(ctx context.Context, in *CreateAttachmentOpts, opts ...grpc.CallOption) (*GenericResponse, error)
	// Delete a volume attachment
	DeleteAttachment(ctx context.Context, in *DeleteAttachmentOpts, opts ...grpc.CallOption) (*GenericResponse, error)
}

func NewDockClient 

func NewDockClient(cc *grpc.ClientConn) DockClient

type DockServer 

type DockServer interface {
	// Create a volume
	CreateVolume(context.Context, *CreateVolumeOpts) (*GenericResponse, error)
	// Delete a volume
	DeleteVolume(context.Context, *DeleteVolumeOpts) (*GenericResponse, error)
	// Create a volume snapshot
	CreateVolumeSnapshot(context.Context, *CreateVolumeSnapshotOpts) (*GenericResponse, error)
	// Delete a volume snapshot
	DeleteVolumeSnapshot(context.Context, *DeleteVolumeSnapshotOpts) (*GenericResponse, error)
	// Create a volume attachment
	CreateAttachment(context.Context, *CreateAttachmentOpts) (*GenericResponse, error)
	// Delete a volume attachment
	DeleteAttachment(context.Context, *DeleteAttachmentOpts) (*GenericResponse, error)
}

type GenericResponse 

type GenericResponse struct {
	// Types that are valid to be assigned to Reply:
	//	*GenericResponse_Result_
	//	*GenericResponse_Error_
	Reply isGenericResponse_Reply `protobuf_oneof:"reply"`
}

Generic response, it return: 1. Return result with message when create/update resource successfully. 2. Return result without message when delete resource successfully. 3. Return Error with error code and message when operate unsuccessfully.

func (*GenericResponse) Descriptor 

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

func (*GenericResponse) GetError 

func (m *GenericResponse) GetError() *GenericResponse_Error

func (*GenericResponse) GetReply 

func (m *GenericResponse) GetReply() isGenericResponse_Reply

func (*GenericResponse) GetResult 

func (m *GenericResponse) GetResult() *GenericResponse_Result

func (*GenericResponse) ProtoMessage 

func (*GenericResponse) ProtoMessage()

func (*GenericResponse) Reset 

func (m *GenericResponse) Reset()

func (*GenericResponse) String 

func (m *GenericResponse) String() string

func (*GenericResponse) XXX_OneofFuncs 

func (*GenericResponse) XXX_OneofFuncs() (func(msg proto1.Message, b *proto1.Buffer) error, func(msg proto1.Message, tag, wire int, b *proto1.Buffer) (bool, error), func(msg proto1.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type GenericResponse_Error 

type GenericResponse_Error struct {
	Code        string `protobuf:"bytes,1,opt,name=code" json:"code,omitempty"`
	Description string `protobuf:"bytes,2,opt,name=description" json:"description,omitempty"`
}

func (*GenericResponse_Error) Descriptor 

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

func (*GenericResponse_Error) GetCode 

func (m *GenericResponse_Error) GetCode() string

func (*GenericResponse_Error) GetDescription 

func (m *GenericResponse_Error) GetDescription() string

func (*GenericResponse_Error) ProtoMessage 

func (*GenericResponse_Error) ProtoMessage()

func (*GenericResponse_Error) Reset 

func (m *GenericResponse_Error) Reset()

func (*GenericResponse_Error) String 

func (m *GenericResponse_Error) String() string

type GenericResponse_Error_ 

type GenericResponse_Error_ struct {
	Error *GenericResponse_Error `protobuf:"bytes,2,opt,name=error,oneof"`
}

type GenericResponse_Result 

type GenericResponse_Result struct {
	Message string `protobuf:"bytes,1,opt,name=message" json:"message,omitempty"`
}

func (*GenericResponse_Result) Descriptor 

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

func (*GenericResponse_Result) GetMessage 

func (m *GenericResponse_Result) GetMessage() string

func (*GenericResponse_Result) ProtoMessage 

func (*GenericResponse_Result) ProtoMessage()

func (*GenericResponse_Result) Reset 

func (m *GenericResponse_Result) Reset()

func (*GenericResponse_Result) String 

func (m *GenericResponse_Result) String() string

type GenericResponse_Result_ 

type GenericResponse_Result_ struct {
	Result *GenericResponse_Result `protobuf:"bytes,1,opt,name=result,oneof"`
}

type HostInfo 

type HostInfo struct {
	// The platform of the host, such as "x86_64"
	Platform string `protobuf:"bytes,1,opt,name=platform" json:"platform,omitempty"`
	// The type of OS, such as "linux","windows", etc.
	OsType string `protobuf:"bytes,2,opt,name=osType" json:"osType,omitempty"`
	// The name of the host
	Host string `protobuf:"bytes,3,opt,name=host" json:"host,omitempty"`
	// The ip address of the host
	Ip string `protobuf:"bytes,4,opt,name=ip" json:"ip,omitempty"`
	// The initiator infomation, such as: "iqn.2017.com.redhat:e08039b48d5c"
	Initiator string `protobuf:"bytes,5,opt,name=initiator" json:"initiator,omitempty"`
}

func (*HostInfo) Descriptor 

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

func (*HostInfo) GetHost 

func (m *HostInfo) GetHost() string

func (*HostInfo) GetInitiator 

func (m *HostInfo) GetInitiator() string

func (*HostInfo) GetIp 

func (m *HostInfo) GetIp() string

func (*HostInfo) GetOsType 

func (m *HostInfo) GetOsType() string

func (*HostInfo) GetPlatform 

func (m *HostInfo) GetPlatform() string

func (*HostInfo) ProtoMessage 

func (*HostInfo) ProtoMessage()

func (*HostInfo) Reset 

func (m *HostInfo) Reset()

func (*HostInfo) String 

func (m *HostInfo) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.