txv1beta1

package
v0.0.0-...-32b03d7 Latest Latest
Warning

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

 Go to latest Published: Mar 25, 2021 License: Apache-2.0 Imports: 11 Imported by: 11

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var TxInfo_Status_name = map[int32]string{
	0:  "STATUS_INVALID",
	1:  "STATUS_DESTINATION_NOT_FOUND",
	2:  "STATUS_TRANSFER_NEW",
	3:  "STATUS_TRANSFER_AWAITING_ACCEPTANCE",
	4:  "STATUS_TRANSFER_ACCEPTED",
	5:  "STATUS_TRANSFER_IN_PROGRESS",
	6:  "STATUS_TRANSFER_COMPLETE",
	7:  "STATUS_TRANSFER_FAILED",
	8:  "STATUS_TRANSFER_CANCELLED",
	9:  "STATUS_TRANSFER_CANCEL_FAILED",
	10: "STATUS_TRANSFER_EXPIRED",
}
View Source 
var TxInfo_Status_value = map[string]int32{
	"STATUS_INVALID":                      0,
	"STATUS_DESTINATION_NOT_FOUND":        1,
	"STATUS_TRANSFER_NEW":                 2,
	"STATUS_TRANSFER_AWAITING_ACCEPTANCE": 3,
	"STATUS_TRANSFER_ACCEPTED":            4,
	"STATUS_TRANSFER_IN_PROGRESS":         5,
	"STATUS_TRANSFER_COMPLETE":            6,
	"STATUS_TRANSFER_FAILED":              7,
	"STATUS_TRANSFER_CANCELLED":           8,
	"STATUS_TRANSFER_CANCEL_FAILED":       9,
	"STATUS_TRANSFER_EXPIRED":             10,
}

Functions

func RegisterTxAPIServer 

func RegisterTxAPIServer(s *grpc.Server, srv TxAPIServer)

Types

type CancelTransferRequest 

type CancelTransferRequest struct {
	// REQUIRED.
	// The transfer identifier.
	TxId *TxId `protobuf:"bytes,1,opt,name=tx_id,json=txId,proto3" json:"tx_id,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque               *v1beta11.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

func (*CancelTransferRequest) Descriptor 

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

func (*CancelTransferRequest) GetOpaque 

func (m *CancelTransferRequest) GetOpaque() *v1beta11.Opaque

func (*CancelTransferRequest) GetTxId 

func (m *CancelTransferRequest) GetTxId() *TxId

func (*CancelTransferRequest) ProtoMessage 

func (*CancelTransferRequest) ProtoMessage()

func (*CancelTransferRequest) Reset 

func (m *CancelTransferRequest) Reset()

func (*CancelTransferRequest) String 

func (m *CancelTransferRequest) String() string

func (*CancelTransferRequest) XXX_DiscardUnknown 

func (m *CancelTransferRequest) XXX_DiscardUnknown()

func (*CancelTransferRequest) XXX_Marshal 

func (m *CancelTransferRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CancelTransferRequest) XXX_Merge 

func (m *CancelTransferRequest) XXX_Merge(src proto.Message)

func (*CancelTransferRequest) XXX_Size 

func (m *CancelTransferRequest) XXX_Size() int

func (*CancelTransferRequest) XXX_Unmarshal 

func (m *CancelTransferRequest) XXX_Unmarshal(b []byte) error

type CancelTransferResponse 

type CancelTransferResponse struct {
	// REQUIRED.
	// The response status.
	Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// REQUIRED.
	// TxInfo, includes ao. transfer id, status, description.
	TxInfo *TxInfo `protobuf:"bytes,2,opt,name=tx_info,json=txInfo,proto3" json:"tx_info,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque               *v1beta11.Opaque `protobuf:"bytes,3,opt,name=opaque,proto3" json:"opaque,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

func (*CancelTransferResponse) Descriptor 

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

func (*CancelTransferResponse) GetOpaque 

func (m *CancelTransferResponse) GetOpaque() *v1beta11.Opaque

func (*CancelTransferResponse) GetStatus 

func (m *CancelTransferResponse) GetStatus() *v1beta12.Status

func (*CancelTransferResponse) GetTxInfo 

func (m *CancelTransferResponse) GetTxInfo() *TxInfo

func (*CancelTransferResponse) ProtoMessage 

func (*CancelTransferResponse) ProtoMessage()

func (*CancelTransferResponse) Reset 

func (m *CancelTransferResponse) Reset()

func (*CancelTransferResponse) String 

func (m *CancelTransferResponse) String() string

func (*CancelTransferResponse) XXX_DiscardUnknown 

func (m *CancelTransferResponse) XXX_DiscardUnknown()

func (*CancelTransferResponse) XXX_Marshal 

func (m *CancelTransferResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CancelTransferResponse) XXX_Merge 

func (m *CancelTransferResponse) XXX_Merge(src proto.Message)

func (*CancelTransferResponse) XXX_Size 

func (m *CancelTransferResponse) XXX_Size() int

func (*CancelTransferResponse) XXX_Unmarshal 

func (m *CancelTransferResponse) XXX_Unmarshal(b []byte) error

type CreateTransferRequest 

type CreateTransferRequest struct {
	// REQUIRED.
	// Reference of the resource to be transfered.
	Ref *v1beta1.Reference `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	// REQUIRED.
	// The destination (receiver of the transfer)
	Grantee *v1beta1.Grantee `protobuf:"bytes,2,opt,name=grantee,proto3" json:"grantee,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque               *v1beta11.Opaque `protobuf:"bytes,3,opt,name=opaque,proto3" json:"opaque,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

func (*CreateTransferRequest) Descriptor 

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

func (*CreateTransferRequest) GetGrantee 

func (m *CreateTransferRequest) GetGrantee() *v1beta1.Grantee

func (*CreateTransferRequest) GetOpaque 

func (m *CreateTransferRequest) GetOpaque() *v1beta11.Opaque

func (*CreateTransferRequest) GetRef 

func (m *CreateTransferRequest) GetRef() *v1beta1.Reference

func (*CreateTransferRequest) ProtoMessage 

func (*CreateTransferRequest) ProtoMessage()

func (*CreateTransferRequest) Reset 

func (m *CreateTransferRequest) Reset()

func (*CreateTransferRequest) String 

func (m *CreateTransferRequest) String() string

func (*CreateTransferRequest) XXX_DiscardUnknown 

func (m *CreateTransferRequest) XXX_DiscardUnknown()

func (*CreateTransferRequest) XXX_Marshal 

func (m *CreateTransferRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateTransferRequest) XXX_Merge 

func (m *CreateTransferRequest) XXX_Merge(src proto.Message)

func (*CreateTransferRequest) XXX_Size 

func (m *CreateTransferRequest) XXX_Size() int

func (*CreateTransferRequest) XXX_Unmarshal 

func (m *CreateTransferRequest) XXX_Unmarshal(b []byte) error

type CreateTransferResponse 

type CreateTransferResponse struct {
	// REQUIRED.
	// The response status.
	Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// REQUIRED.
	// TxInfo, includes transfer id, status, description.
	TxInfo *TxInfo `protobuf:"bytes,2,opt,name=tx_info,json=txInfo,proto3" json:"tx_info,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque               *v1beta11.Opaque `protobuf:"bytes,3,opt,name=opaque,proto3" json:"opaque,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

func (*CreateTransferResponse) Descriptor 

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

func (*CreateTransferResponse) GetOpaque 

func (m *CreateTransferResponse) GetOpaque() *v1beta11.Opaque

func (*CreateTransferResponse) GetStatus 

func (m *CreateTransferResponse) GetStatus() *v1beta12.Status

func (*CreateTransferResponse) GetTxInfo 

func (m *CreateTransferResponse) GetTxInfo() *TxInfo

func (*CreateTransferResponse) ProtoMessage 

func (*CreateTransferResponse) ProtoMessage()

func (*CreateTransferResponse) Reset 

func (m *CreateTransferResponse) Reset()

func (*CreateTransferResponse) String 

func (m *CreateTransferResponse) String() string

func (*CreateTransferResponse) XXX_DiscardUnknown 

func (m *CreateTransferResponse) XXX_DiscardUnknown()

func (*CreateTransferResponse) XXX_Marshal 

func (m *CreateTransferResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateTransferResponse) XXX_Merge 

func (m *CreateTransferResponse) XXX_Merge(src proto.Message)

func (*CreateTransferResponse) XXX_Size 

func (m *CreateTransferResponse) XXX_Size() int

func (*CreateTransferResponse) XXX_Unmarshal 

func (m *CreateTransferResponse) XXX_Unmarshal(b []byte) error

type GetTransferStatusRequest 

type GetTransferStatusRequest struct {
	// REQUIRED.
	// The transfer identifier.
	TxId *TxId `protobuf:"bytes,1,opt,name=tx_id,json=txId,proto3" json:"tx_id,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque               *v1beta11.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

func (*GetTransferStatusRequest) Descriptor 

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

func (*GetTransferStatusRequest) GetOpaque 

func (m *GetTransferStatusRequest) GetOpaque() *v1beta11.Opaque

func (*GetTransferStatusRequest) GetTxId 

func (m *GetTransferStatusRequest) GetTxId() *TxId

func (*GetTransferStatusRequest) ProtoMessage 

func (*GetTransferStatusRequest) ProtoMessage()

func (*GetTransferStatusRequest) Reset 

func (m *GetTransferStatusRequest) Reset()

func (*GetTransferStatusRequest) String 

func (m *GetTransferStatusRequest) String() string

func (*GetTransferStatusRequest) XXX_DiscardUnknown 

func (m *GetTransferStatusRequest) XXX_DiscardUnknown()

func (*GetTransferStatusRequest) XXX_Marshal 

func (m *GetTransferStatusRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetTransferStatusRequest) XXX_Merge 

func (m *GetTransferStatusRequest) XXX_Merge(src proto.Message)

func (*GetTransferStatusRequest) XXX_Size 

func (m *GetTransferStatusRequest) XXX_Size() int

func (*GetTransferStatusRequest) XXX_Unmarshal 

func (m *GetTransferStatusRequest) XXX_Unmarshal(b []byte) error

type GetTransferStatusResponse 

type GetTransferStatusResponse struct {
	// REQUIRED.
	// The response status.
	Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// REQUIRED.
	// TxInfo, includes ao. transfer id, status, description.
	TxInfo *TxInfo `protobuf:"bytes,2,opt,name=tx_info,json=txInfo,proto3" json:"tx_info,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque               *v1beta11.Opaque `protobuf:"bytes,3,opt,name=opaque,proto3" json:"opaque,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

func (*GetTransferStatusResponse) Descriptor 

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

func (*GetTransferStatusResponse) GetOpaque 

func (m *GetTransferStatusResponse) GetOpaque() *v1beta11.Opaque

func (*GetTransferStatusResponse) GetStatus 

func (m *GetTransferStatusResponse) GetStatus() *v1beta12.Status

func (*GetTransferStatusResponse) GetTxInfo 

func (m *GetTransferStatusResponse) GetTxInfo() *TxInfo

func (*GetTransferStatusResponse) ProtoMessage 

func (*GetTransferStatusResponse) ProtoMessage()

func (*GetTransferStatusResponse) Reset 

func (m *GetTransferStatusResponse) Reset()

func (*GetTransferStatusResponse) String 

func (m *GetTransferStatusResponse) String() string

func (*GetTransferStatusResponse) XXX_DiscardUnknown 

func (m *GetTransferStatusResponse) XXX_DiscardUnknown()

func (*GetTransferStatusResponse) XXX_Marshal 

func (m *GetTransferStatusResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetTransferStatusResponse) XXX_Merge 

func (m *GetTransferStatusResponse) XXX_Merge(src proto.Message)

func (*GetTransferStatusResponse) XXX_Size 

func (m *GetTransferStatusResponse) XXX_Size() int

func (*GetTransferStatusResponse) XXX_Unmarshal 

func (m *GetTransferStatusResponse) XXX_Unmarshal(b []byte) error

type TxAPIClient 

type TxAPIClient interface {
	// Creates (requests the destination to accept) a transfer.
	// Returns a response containing a TxInfo (transfer info) object.
	CreateTransfer(ctx context.Context, in *CreateTransferRequest, opts ...grpc.CallOption) (*CreateTransferResponse, error)
	// Requests a transfer status.
	GetTransferStatus(ctx context.Context, in *GetTransferStatusRequest, opts ...grpc.CallOption) (*GetTransferStatusResponse, error)
	// Requests to cancel a transfer.
	CancelTransfer(ctx context.Context, in *CancelTransferRequest, opts ...grpc.CallOption) (*CancelTransferResponse, error)
}

TxAPIClient is the client API for TxAPI service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewTxAPIClient 

func NewTxAPIClient(cc *grpc.ClientConn) TxAPIClient

type TxAPIServer 

type TxAPIServer interface {
	// Creates (requests the destination to accept) a transfer.
	// Returns a response containing a TxInfo (transfer info) object.
	CreateTransfer(context.Context, *CreateTransferRequest) (*CreateTransferResponse, error)
	// Requests a transfer status.
	GetTransferStatus(context.Context, *GetTransferStatusRequest) (*GetTransferStatusResponse, error)
	// Requests to cancel a transfer.
	CancelTransfer(context.Context, *CancelTransferRequest) (*CancelTransferResponse, error)
}

TxAPIServer is the server API for TxAPI service.

type TxId 

type TxId struct {
	// REQUIRED.
	// The internal transfer id used by the service implementor
	// to uniquely identity the transfer in the internal
	// implementation of the service.
	OpaqueId             string   `protobuf:"bytes,1,opt,name=opaque_id,json=opaqueId,proto3" json:"opaque_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

TxId uniquely identifies a transfer in the transfer provider namespace.

func (*TxId) Descriptor 

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

func (*TxId) GetOpaqueId 

func (m *TxId) GetOpaqueId() string

func (*TxId) ProtoMessage 

func (*TxId) ProtoMessage()

func (*TxId) Reset 

func (m *TxId) Reset()

func (*TxId) String 

func (m *TxId) String() string

func (*TxId) XXX_DiscardUnknown 

func (m *TxId) XXX_DiscardUnknown()

func (*TxId) XXX_Marshal 

func (m *TxId) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TxId) XXX_Merge 

func (m *TxId) XXX_Merge(src proto.Message)

func (*TxId) XXX_Size 

func (m *TxId) XXX_Size() int

func (*TxId) XXX_Unmarshal 

func (m *TxId) XXX_Unmarshal(b []byte) error

type TxInfo 

type TxInfo struct {
	// REQUIRED.
	// The transfer identifier.
	Id *TxId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// REQUIRED.
	// Reference of the resource to be transfered.
	Ref *v1beta1.Reference `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"`
	// REQUIRED.
	// The transfer status. Eg.: STATUS_TRANSFER_FAILED.
	// Note: the description field may provide additional information on the transfer status.
	Status TxInfo_Status `protobuf:"varint,3,opt,name=status,proto3,enum=cs3.tx.v1beta1.TxInfo_Status" json:"status,omitempty"`
	// REQUIRED.
	// The destination (receiver of the transfer)
	Grantee *v1beta1.Grantee `protobuf:"bytes,4,opt,name=grantee,proto3" json:"grantee,omitempty"`
	// REQUIRED.
	// Uniquely identifies a principal who initiates the transfer creation.
	Creator *v1beta11.UserId `protobuf:"bytes,5,opt,name=creator,proto3" json:"creator,omitempty"`
	// REQUIRED.
	// Creation time of the transfer.
	Ctime *v1beta12.Timestamp `protobuf:"bytes,6,opt,name=ctime,proto3" json:"ctime,omitempty"`
	// OPTIONAL.
	// Information to describe the transfer status.
	// Eg. may contain information about a transfer failure.
	// Meant to be human-readable.
	Description          string   `protobuf:"bytes,7,opt,name=description,proto3" json:"description,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

TxInfo represents information about a transfer.

func (*TxInfo) Descriptor 

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

func (*TxInfo) GetCreator 

func (m *TxInfo) GetCreator() *v1beta11.UserId

func (*TxInfo) GetCtime 

func (m *TxInfo) GetCtime() *v1beta12.Timestamp

func (*TxInfo) GetDescription 

func (m *TxInfo) GetDescription() string

func (*TxInfo) GetGrantee 

func (m *TxInfo) GetGrantee() *v1beta1.Grantee

func (*TxInfo) GetId 

func (m *TxInfo) GetId() *TxId

func (*TxInfo) GetRef 

func (m *TxInfo) GetRef() *v1beta1.Reference

func (*TxInfo) GetStatus 

func (m *TxInfo) GetStatus() TxInfo_Status

func (*TxInfo) ProtoMessage 

func (*TxInfo) ProtoMessage()

func (*TxInfo) Reset 

func (m *TxInfo) Reset()

func (*TxInfo) String 

func (m *TxInfo) String() string

func (*TxInfo) XXX_DiscardUnknown 

func (m *TxInfo) XXX_DiscardUnknown()

func (*TxInfo) XXX_Marshal 

func (m *TxInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TxInfo) XXX_Merge 

func (m *TxInfo) XXX_Merge(src proto.Message)

func (*TxInfo) XXX_Size 

func (m *TxInfo) XXX_Size() int

func (*TxInfo) XXX_Unmarshal 

func (m *TxInfo) XXX_Unmarshal(b []byte) error

type TxInfo_Status 

type TxInfo_Status int32

Status represents transfer status. 

const (
	TxInfo_STATUS_INVALID TxInfo_Status = 0
	// The destination could not be found.
	TxInfo_STATUS_DESTINATION_NOT_FOUND TxInfo_Status = 1
	// A new data transfer
	TxInfo_STATUS_TRANSFER_NEW TxInfo_Status = 2
	// The data transfer is awaiting acceptance from the destination
	TxInfo_STATUS_TRANSFER_AWAITING_ACCEPTANCE TxInfo_Status = 3
	// The data transfer is accepted by the destination.
	TxInfo_STATUS_TRANSFER_ACCEPTED TxInfo_Status = 4
	// The data transfer has started and not yet completed.
	TxInfo_STATUS_TRANSFER_IN_PROGRESS TxInfo_Status = 5
	// The data transfer has completed.
	TxInfo_STATUS_TRANSFER_COMPLETE TxInfo_Status = 6
	// The data transfer has failed.
	TxInfo_STATUS_TRANSFER_FAILED TxInfo_Status = 7
	// The data transfer had been cancelled.
	TxInfo_STATUS_TRANSFER_CANCELLED TxInfo_Status = 8
	// The request for cancelling the data transfer has failed.
	TxInfo_STATUS_TRANSFER_CANCEL_FAILED TxInfo_Status = 9
	// The transfer has expired somewhere down the line.
	TxInfo_STATUS_TRANSFER_EXPIRED TxInfo_Status = 10
)

func (TxInfo_Status) EnumDescriptor 

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

func (TxInfo_Status) String 

func (x TxInfo_Status) String() string

type UnimplementedTxAPIServer 

type UnimplementedTxAPIServer struct {
}

UnimplementedTxAPIServer can be embedded to have forward compatible implementations.

func (*UnimplementedTxAPIServer) CancelTransfer 

func (*UnimplementedTxAPIServer) CancelTransfer(ctx context.Context, req *CancelTransferRequest) (*CancelTransferResponse, error)

func (*UnimplementedTxAPIServer) CreateTransfer 

func (*UnimplementedTxAPIServer) CreateTransfer(ctx context.Context, req *CreateTransferRequest) (*CreateTransferResponse, error)

func (*UnimplementedTxAPIServer) GetTransferStatus 

func (*UnimplementedTxAPIServer) GetTransferStatus(ctx context.Context, req *GetTransferStatusRequest) (*GetTransferStatusResponse, error)

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.