txv1beta1

package
v0.0.0-...-3ad35d1 Latest Latest
Warning

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

 Go to latest Published: Nov 5, 2024 License: Apache-2.0 Imports: 13 Imported by: 11

Documentation

Index

Constants

View Source 
const (
	TxAPI_CreateTransfer_FullMethodName    = "/cs3.tx.v1beta1.TxAPI/CreateTransfer"
	TxAPI_GetTransferStatus_FullMethodName = "/cs3.tx.v1beta1.TxAPI/GetTransferStatus"
	TxAPI_CancelTransfer_FullMethodName    = "/cs3.tx.v1beta1.TxAPI/CancelTransfer"
	TxAPI_ListTransfers_FullMethodName     = "/cs3.tx.v1beta1.TxAPI/ListTransfers"
	TxAPI_RetryTransfer_FullMethodName     = "/cs3.tx.v1beta1.TxAPI/RetryTransfer"
)

Variables

View Source 
var (
	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",
	}
	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,
	}
)

Enum value maps for Status.

View Source 
var (
	ListTransfersRequest_Filter_Type_name = map[int32]string{
		0: "TYPE_INVALID",
		1: "TYPE_STATUS",
		2: "TYPE_SHARE_ID",
		3: "TYPE_TX_ID",
	}
	ListTransfersRequest_Filter_Type_value = map[string]int32{
		"TYPE_INVALID":  0,
		"TYPE_STATUS":   1,
		"TYPE_SHARE_ID": 2,
		"TYPE_TX_ID":    3,
	}
)

Enum value maps for ListTransfersRequest_Filter_Type.

View Source 
var File_cs3_tx_v1beta1_resources_proto protoreflect.FileDescriptor
View Source 
var File_cs3_tx_v1beta1_tx_api_proto protoreflect.FileDescriptor
View Source 
var TxAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cs3.tx.v1beta1.TxAPI",
	HandlerType: (*TxAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateTransfer",
			Handler:    _TxAPI_CreateTransfer_Handler,
		},
		{
			MethodName: "GetTransferStatus",
			Handler:    _TxAPI_GetTransferStatus_Handler,
		},
		{
			MethodName: "CancelTransfer",
			Handler:    _TxAPI_CancelTransfer_Handler,
		},
		{
			MethodName: "ListTransfers",
			Handler:    _TxAPI_ListTransfers_Handler,
		},
		{
			MethodName: "RetryTransfer",
			Handler:    _TxAPI_RetryTransfer_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cs3/tx/v1beta1/tx_api.proto",
}

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

Functions

func RegisterTxAPIServer 

func RegisterTxAPIServer(s grpc.ServiceRegistrar, 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"`
	// contains filtered or unexported fields
}

func (*CancelTransferRequest) Descriptor deprecated 

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

Deprecated: Use CancelTransferRequest.ProtoReflect.Descriptor instead.

func (*CancelTransferRequest) GetOpaque 

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

func (*CancelTransferRequest) GetTxId 

func (x *CancelTransferRequest) GetTxId() *TxId

func (*CancelTransferRequest) ProtoMessage 

func (*CancelTransferRequest) ProtoMessage()

func (*CancelTransferRequest) ProtoReflect 

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

func (*CancelTransferRequest) Reset 

func (x *CancelTransferRequest) Reset()

func (*CancelTransferRequest) String 

func (x *CancelTransferRequest) String() string

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"`
	// contains filtered or unexported fields
}

func (*CancelTransferResponse) Descriptor deprecated 

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

Deprecated: Use CancelTransferResponse.ProtoReflect.Descriptor instead.

func (*CancelTransferResponse) GetOpaque 

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

func (*CancelTransferResponse) GetStatus 

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

func (*CancelTransferResponse) GetTxInfo 

func (x *CancelTransferResponse) GetTxInfo() *TxInfo

func (*CancelTransferResponse) ProtoMessage 

func (*CancelTransferResponse) ProtoMessage()

func (*CancelTransferResponse) ProtoReflect 

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

func (*CancelTransferResponse) Reset 

func (x *CancelTransferResponse) Reset()

func (*CancelTransferResponse) String 

func (x *CancelTransferResponse) String() string

type CreateTransferRequest 

type CreateTransferRequest struct {

	// REQUIRED.
	// The source target URI. Should include at the minimum all the info needed to access the source.
	// https://golang.org/pkg/net/url/#URL provides a quick view of the format.
	SrcTargetUri string `protobuf:"bytes,1,opt,name=src_target_uri,json=srcTargetUri,proto3" json:"src_target_uri,omitempty"`
	// REQUIRED.
	// The destination target URI. Should include at the minimum all the info needed to access the destination.
	// https://golang.org/pkg/net/url/#URL provides a quick view of the format.
	DestTargetUri string `protobuf:"bytes,2,opt,name=dest_target_uri,json=destTargetUri,proto3" json:"dest_target_uri,omitempty"`
	// REQUIRED.
	// The share Id of the share this transfer is based on.
	ShareId *v1beta1.ShareId `protobuf:"bytes,3,opt,name=share_id,json=shareId,proto3" json:"share_id,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta11.Opaque `protobuf:"bytes,4,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateTransferRequest) Descriptor deprecated 

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

Deprecated: Use CreateTransferRequest.ProtoReflect.Descriptor instead.

func (*CreateTransferRequest) GetDestTargetUri 

func (x *CreateTransferRequest) GetDestTargetUri() string

func (*CreateTransferRequest) GetOpaque 

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

func (*CreateTransferRequest) GetShareId 

func (x *CreateTransferRequest) GetShareId() *v1beta1.ShareId

func (*CreateTransferRequest) GetSrcTargetUri 

func (x *CreateTransferRequest) GetSrcTargetUri() string

func (*CreateTransferRequest) ProtoMessage 

func (*CreateTransferRequest) ProtoMessage()

func (*CreateTransferRequest) ProtoReflect 

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

func (*CreateTransferRequest) Reset 

func (x *CreateTransferRequest) Reset()

func (*CreateTransferRequest) String 

func (x *CreateTransferRequest) String() string

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"`
	// contains filtered or unexported fields
}

func (*CreateTransferResponse) Descriptor deprecated 

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

Deprecated: Use CreateTransferResponse.ProtoReflect.Descriptor instead.

func (*CreateTransferResponse) GetOpaque 

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

func (*CreateTransferResponse) GetStatus 

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

func (*CreateTransferResponse) GetTxInfo 

func (x *CreateTransferResponse) GetTxInfo() *TxInfo

func (*CreateTransferResponse) ProtoMessage 

func (*CreateTransferResponse) ProtoMessage()

func (*CreateTransferResponse) ProtoReflect 

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

func (*CreateTransferResponse) Reset 

func (x *CreateTransferResponse) Reset()

func (*CreateTransferResponse) String 

func (x *CreateTransferResponse) String() string

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"`
	// contains filtered or unexported fields
}

func (*GetTransferStatusRequest) Descriptor deprecated 

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

Deprecated: Use GetTransferStatusRequest.ProtoReflect.Descriptor instead.

func (*GetTransferStatusRequest) GetOpaque 

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

func (*GetTransferStatusRequest) GetTxId 

func (x *GetTransferStatusRequest) GetTxId() *TxId

func (*GetTransferStatusRequest) ProtoMessage 

func (*GetTransferStatusRequest) ProtoMessage()

func (*GetTransferStatusRequest) ProtoReflect 

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

func (*GetTransferStatusRequest) Reset 

func (x *GetTransferStatusRequest) Reset()

func (*GetTransferStatusRequest) String 

func (x *GetTransferStatusRequest) String() string

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"`
	// contains filtered or unexported fields
}

func (*GetTransferStatusResponse) Descriptor deprecated 

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

Deprecated: Use GetTransferStatusResponse.ProtoReflect.Descriptor instead.

func (*GetTransferStatusResponse) GetOpaque 

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

func (*GetTransferStatusResponse) GetStatus 

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

func (*GetTransferStatusResponse) GetTxInfo 

func (x *GetTransferStatusResponse) GetTxInfo() *TxInfo

func (*GetTransferStatusResponse) ProtoMessage 

func (*GetTransferStatusResponse) ProtoMessage()

func (*GetTransferStatusResponse) ProtoReflect 

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

func (*GetTransferStatusResponse) Reset 

func (x *GetTransferStatusResponse) Reset()

func (*GetTransferStatusResponse) String 

func (x *GetTransferStatusResponse) String() string

type ListTransfersRequest 

type ListTransfersRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta11.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// OPTIONAL.
	// The list of filters to apply if any.
	Filters []*ListTransfersRequest_Filter `protobuf:"bytes,2,rep,name=filters,proto3" json:"filters,omitempty"`
	// contains filtered or unexported fields
}

func (*ListTransfersRequest) Descriptor deprecated 

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

Deprecated: Use ListTransfersRequest.ProtoReflect.Descriptor instead.

func (*ListTransfersRequest) GetFilters 

func (x *ListTransfersRequest) GetFilters() []*ListTransfersRequest_Filter

func (*ListTransfersRequest) GetOpaque 

func (x *ListTransfersRequest) GetOpaque() *v1beta11.Opaque

func (*ListTransfersRequest) ProtoMessage 

func (*ListTransfersRequest) ProtoMessage()

func (*ListTransfersRequest) ProtoReflect 

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

func (*ListTransfersRequest) Reset 

func (x *ListTransfersRequest) Reset()

func (*ListTransfersRequest) String 

func (x *ListTransfersRequest) String() string

type ListTransfersRequest_Filter 

type ListTransfersRequest_Filter struct {

	// REQUIRED.
	Type ListTransfersRequest_Filter_Type `protobuf:"varint,1,opt,name=type,proto3,enum=cs3.tx.v1beta1.ListTransfersRequest_Filter_Type" json:"type,omitempty"`
	// REQUIRED.
	//
	// Types that are assignable to Term:
	//
	//	*ListTransfersRequest_Filter_Status
	//	*ListTransfersRequest_Filter_ShareId
	//	*ListTransfersRequest_Filter_TxId
	Term isListTransfersRequest_Filter_Term `protobuf_oneof:"term"`
	// contains filtered or unexported fields
}

REQUIRED. Represents a filter to apply to the request.

func (*ListTransfersRequest_Filter) Descriptor deprecated 

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

Deprecated: Use ListTransfersRequest_Filter.ProtoReflect.Descriptor instead.

func (*ListTransfersRequest_Filter) GetShareId 

func (x *ListTransfersRequest_Filter) GetShareId() *v1beta1.ShareId

func (*ListTransfersRequest_Filter) GetStatus 

func (x *ListTransfersRequest_Filter) GetStatus() Status

func (*ListTransfersRequest_Filter) GetTerm 

func (m *ListTransfersRequest_Filter) GetTerm() isListTransfersRequest_Filter_Term

func (*ListTransfersRequest_Filter) GetTxId 

func (x *ListTransfersRequest_Filter) GetTxId() *TxId

func (*ListTransfersRequest_Filter) GetType 

func (x *ListTransfersRequest_Filter) GetType() ListTransfersRequest_Filter_Type

func (*ListTransfersRequest_Filter) ProtoMessage 

func (*ListTransfersRequest_Filter) ProtoMessage()

func (*ListTransfersRequest_Filter) ProtoReflect 

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

func (*ListTransfersRequest_Filter) Reset 

func (x *ListTransfersRequest_Filter) Reset()

func (*ListTransfersRequest_Filter) String 

func (x *ListTransfersRequest_Filter) String() string

type ListTransfersRequest_Filter_ShareId 

type ListTransfersRequest_Filter_ShareId struct {
	ShareId *v1beta1.ShareId `protobuf:"bytes,3,opt,name=share_id,json=shareId,proto3,oneof"`
}

type ListTransfersRequest_Filter_Status 

type ListTransfersRequest_Filter_Status struct {
	Status Status `protobuf:"varint,2,opt,name=status,proto3,enum=cs3.tx.v1beta1.Status,oneof"`
}

type ListTransfersRequest_Filter_TxId 

type ListTransfersRequest_Filter_TxId struct {
	TxId *TxId `protobuf:"bytes,4,opt,name=tx_id,json=txId,proto3,oneof"`
}

type ListTransfersRequest_Filter_Type 

type ListTransfersRequest_Filter_Type int32

The filter type. 

const (
	ListTransfersRequest_Filter_TYPE_INVALID  ListTransfersRequest_Filter_Type = 0
	ListTransfersRequest_Filter_TYPE_STATUS   ListTransfersRequest_Filter_Type = 1
	ListTransfersRequest_Filter_TYPE_SHARE_ID ListTransfersRequest_Filter_Type = 2
	ListTransfersRequest_Filter_TYPE_TX_ID    ListTransfersRequest_Filter_Type = 3
)

func (ListTransfersRequest_Filter_Type) Descriptor 

func (ListTransfersRequest_Filter_Type) Descriptor() protoreflect.EnumDescriptor

func (ListTransfersRequest_Filter_Type) Enum 

func (x ListTransfersRequest_Filter_Type) Enum() *ListTransfersRequest_Filter_Type

func (ListTransfersRequest_Filter_Type) EnumDescriptor deprecated 

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

Deprecated: Use ListTransfersRequest_Filter_Type.Descriptor instead.

func (ListTransfersRequest_Filter_Type) Number 

func (x ListTransfersRequest_Filter_Type) Number() protoreflect.EnumNumber

func (ListTransfersRequest_Filter_Type) String 

func (x ListTransfersRequest_Filter_Type) String() string

func (ListTransfersRequest_Filter_Type) Type 

func (ListTransfersRequest_Filter_Type) Type() protoreflect.EnumType

type ListTransfersResponse 

type ListTransfersResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// REQUIRED.
	// List of TxInfo types representing transfers.
	Transfers []*TxInfo `protobuf:"bytes,2,rep,name=transfers,proto3" json:"transfers,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta11.Opaque `protobuf:"bytes,3,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// contains filtered or unexported fields
}

func (*ListTransfersResponse) Descriptor deprecated 

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

Deprecated: Use ListTransfersResponse.ProtoReflect.Descriptor instead.

func (*ListTransfersResponse) GetOpaque 

func (x *ListTransfersResponse) GetOpaque() *v1beta11.Opaque

func (*ListTransfersResponse) GetStatus 

func (x *ListTransfersResponse) GetStatus() *v1beta12.Status

func (*ListTransfersResponse) GetTransfers 

func (x *ListTransfersResponse) GetTransfers() []*TxInfo

func (*ListTransfersResponse) ProtoMessage 

func (*ListTransfersResponse) ProtoMessage()

func (*ListTransfersResponse) ProtoReflect 

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

func (*ListTransfersResponse) Reset 

func (x *ListTransfersResponse) Reset()

func (*ListTransfersResponse) String 

func (x *ListTransfersResponse) String() string

type RetryTransferRequest 

type RetryTransferRequest 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"`
	// contains filtered or unexported fields
}

func (*RetryTransferRequest) Descriptor deprecated 

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

Deprecated: Use RetryTransferRequest.ProtoReflect.Descriptor instead.

func (*RetryTransferRequest) GetOpaque 

func (x *RetryTransferRequest) GetOpaque() *v1beta11.Opaque

func (*RetryTransferRequest) GetTxId 

func (x *RetryTransferRequest) GetTxId() *TxId

func (*RetryTransferRequest) ProtoMessage 

func (*RetryTransferRequest) ProtoMessage()

func (*RetryTransferRequest) ProtoReflect 

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

func (*RetryTransferRequest) Reset 

func (x *RetryTransferRequest) Reset()

func (*RetryTransferRequest) String 

func (x *RetryTransferRequest) String() string

type RetryTransferResponse 

type RetryTransferResponse 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"`
	// contains filtered or unexported fields
}

func (*RetryTransferResponse) Descriptor deprecated 

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

Deprecated: Use RetryTransferResponse.ProtoReflect.Descriptor instead.

func (*RetryTransferResponse) GetOpaque 

func (x *RetryTransferResponse) GetOpaque() *v1beta11.Opaque

func (*RetryTransferResponse) GetStatus 

func (x *RetryTransferResponse) GetStatus() *v1beta12.Status

func (*RetryTransferResponse) GetTxInfo 

func (x *RetryTransferResponse) GetTxInfo() *TxInfo

func (*RetryTransferResponse) ProtoMessage 

func (*RetryTransferResponse) ProtoMessage()

func (*RetryTransferResponse) ProtoReflect 

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

func (*RetryTransferResponse) Reset 

func (x *RetryTransferResponse) Reset()

func (*RetryTransferResponse) String 

func (x *RetryTransferResponse) String() string

type Status 

type Status int32

Status represents transfer status. 

const (
	Status_STATUS_INVALID Status = 0
	// The destination could not be found.
	Status_STATUS_DESTINATION_NOT_FOUND Status = 1
	// A new data transfer
	Status_STATUS_TRANSFER_NEW Status = 2
	// The data transfer is awaiting acceptance from the destination
	Status_STATUS_TRANSFER_AWAITING_ACCEPTANCE Status = 3
	// The data transfer is accepted by the destination.
	Status_STATUS_TRANSFER_ACCEPTED Status = 4
	// The data transfer has started and not yet completed.
	Status_STATUS_TRANSFER_IN_PROGRESS Status = 5
	// The data transfer has completed.
	Status_STATUS_TRANSFER_COMPLETE Status = 6
	// The data transfer has failed.
	Status_STATUS_TRANSFER_FAILED Status = 7
	// The data transfer had been cancelled.
	Status_STATUS_TRANSFER_CANCELLED Status = 8
	// The request for cancelling the data transfer has failed.
	Status_STATUS_TRANSFER_CANCEL_FAILED Status = 9
	// The transfer has expired somewhere down the line.
	Status_STATUS_TRANSFER_EXPIRED Status = 10
)

func (Status) Descriptor 

func (Status) Descriptor() protoreflect.EnumDescriptor

func (Status) Enum 

func (x Status) Enum() *Status

func (Status) EnumDescriptor deprecated 

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

Deprecated: Use Status.Descriptor instead.

func (Status) Number 

func (x Status) Number() protoreflect.EnumNumber

func (Status) String 

func (x Status) String() string

func (Status) Type 

func (Status) Type() protoreflect.EnumType

type TxAPIClient 

type TxAPIClient interface {
	// Requests creation of a transfer.
	// Returns a CreateTransferResponse.
	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)
	// Requests a list of transfers received by the authenticated principle.
	// If a filter is specified, only transfers satisfying the filter MUST be returned.
	ListTransfers(ctx context.Context, in *ListTransfersRequest, opts ...grpc.CallOption) (*ListTransfersResponse, error)
	// Requests retrying a transfer.
	RetryTransfer(ctx context.Context, in *RetryTransferRequest, opts ...grpc.CallOption) (*RetryTransferResponse, error)
}

TxAPIClient is the client API for TxAPI 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 NewTxAPIClient 

func NewTxAPIClient(cc grpc.ClientConnInterface) TxAPIClient

type TxAPIServer 

type TxAPIServer interface {
	// Requests creation of a transfer.
	// Returns a CreateTransferResponse.
	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)
	// Requests a list of transfers received by the authenticated principle.
	// If a filter is specified, only transfers satisfying the filter MUST be returned.
	ListTransfers(context.Context, *ListTransfersRequest) (*ListTransfersResponse, error)
	// Requests retrying a transfer.
	RetryTransfer(context.Context, *RetryTransferRequest) (*RetryTransferResponse, error)
}

TxAPIServer is the server API for TxAPI service. All implementations should embed UnimplementedTxAPIServer for forward compatibility

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"`
	// contains filtered or unexported fields
}

TxId uniquely identifies a transfer in the transfer provider namespace.

func (*TxId) Descriptor deprecated 

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

Deprecated: Use TxId.ProtoReflect.Descriptor instead.

func (*TxId) GetOpaqueId 

func (x *TxId) GetOpaqueId() string

func (*TxId) ProtoMessage 

func (*TxId) ProtoMessage()

func (*TxId) ProtoReflect 

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

func (*TxId) Reset 

func (x *TxId) Reset()

func (*TxId) String 

func (x *TxId) String() string

type TxInfo 

type TxInfo struct {

	// REQUIRED.
	// The transfer identifier.
	Id *TxId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// REQUIRED.
	// The transfer status. Eg.: STATUS_TRANSFER_FAILED.
	// Note: the description field may provide additional information on the transfer status.
	Status Status `protobuf:"varint,2,opt,name=status,proto3,enum=cs3.tx.v1beta1.Status" json:"status,omitempty"`
	// REQUIRED.
	// The destination (receiver of the transfer)
	Grantee *v1beta1.Grantee `protobuf:"bytes,3,opt,name=grantee,proto3" json:"grantee,omitempty"`
	// REQUIRED.
	// Uniquely identifies a principal who initiates the transfer creation.
	Creator *v1beta11.UserId `protobuf:"bytes,4,opt,name=creator,proto3" json:"creator,omitempty"`
	// REQUIRED.
	// Creation time of the transfer.
	Ctime *v1beta12.Timestamp `protobuf:"bytes,5,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,6,opt,name=description,proto3" json:"description,omitempty"`
	// REQUIRED.
	// Opaque unique identifier of the share on which the transfer is based.
	ShareId *v1beta13.ShareId `protobuf:"bytes,7,opt,name=share_id,json=shareId,proto3" json:"share_id,omitempty"`
	// contains filtered or unexported fields
}

TxInfo represents information about a transfer.

func (*TxInfo) Descriptor deprecated 

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

Deprecated: Use TxInfo.ProtoReflect.Descriptor instead.

func (*TxInfo) GetCreator 

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

func (*TxInfo) GetCtime 

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

func (*TxInfo) GetDescription 

func (x *TxInfo) GetDescription() string

func (*TxInfo) GetGrantee 

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

func (*TxInfo) GetId 

func (x *TxInfo) GetId() *TxId

func (*TxInfo) GetShareId 

func (x *TxInfo) GetShareId() *v1beta13.ShareId

func (*TxInfo) GetStatus 

func (x *TxInfo) GetStatus() Status

func (*TxInfo) ProtoMessage 

func (*TxInfo) ProtoMessage()

func (*TxInfo) ProtoReflect 

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

func (*TxInfo) Reset 

func (x *TxInfo) Reset()

func (*TxInfo) String 

func (x *TxInfo) String() string

type UnimplementedTxAPIServer 

type UnimplementedTxAPIServer struct {
}

UnimplementedTxAPIServer should be embedded to have forward compatible implementations.

func (UnimplementedTxAPIServer) CancelTransfer 

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

func (UnimplementedTxAPIServer) CreateTransfer 

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

func (UnimplementedTxAPIServer) GetTransferStatus 

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

func (UnimplementedTxAPIServer) ListTransfers 

func (UnimplementedTxAPIServer) ListTransfers(context.Context, *ListTransfersRequest) (*ListTransfersResponse, error)

func (UnimplementedTxAPIServer) RetryTransfer 

func (UnimplementedTxAPIServer) RetryTransfer(context.Context, *RetryTransferRequest) (*RetryTransferResponse, error)

type UnsafeTxAPIServer 

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

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

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.