api

package
v0.0.1 Latest Latest
Warning

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

Go to latest
Published: Dec 19, 2022 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	DataMovementCreateResponse_Status_name = map[int32]string{
		0: "SUCCESS",
		1: "FAILED",
		2: "INVALID",
	}
	DataMovementCreateResponse_Status_value = map[string]int32{
		"SUCCESS": 0,
		"FAILED":  1,
		"INVALID": 2,
	}
)

Enum value maps for DataMovementCreateResponse_Status.

View Source
var (
	DataMovementStatusResponse_State_name = map[int32]string{
		0: "PENDING",
		1: "STARTING",
		2: "RUNNING",
		3: "COMPLETED",
		4: "CANCELLING",
		5: "UNKNOWN_STATE",
	}
	DataMovementStatusResponse_State_value = map[string]int32{
		"PENDING":       0,
		"STARTING":      1,
		"RUNNING":       2,
		"COMPLETED":     3,
		"CANCELLING":    4,
		"UNKNOWN_STATE": 5,
	}
)

Enum value maps for DataMovementStatusResponse_State.

View Source
var (
	DataMovementStatusResponse_Status_name = map[int32]string{
		0: "INVALID",
		1: "NOT_FOUND",
		2: "SUCCESS",
		3: "FAILED",
		4: "CANCELLED",
		5: "UNKNOWN_STATUS",
	}
	DataMovementStatusResponse_Status_value = map[string]int32{
		"INVALID":        0,
		"NOT_FOUND":      1,
		"SUCCESS":        2,
		"FAILED":         3,
		"CANCELLED":      4,
		"UNKNOWN_STATUS": 5,
	}
)

Enum value maps for DataMovementStatusResponse_Status.

View Source
var (
	DataMovementDeleteResponse_Status_name = map[int32]string{
		0: "INVALID",
		1: "NOT_FOUND",
		2: "SUCCESS",
		3: "ACTIVE",
		4: "UNKNOWN",
	}
	DataMovementDeleteResponse_Status_value = map[string]int32{
		"INVALID":   0,
		"NOT_FOUND": 1,
		"SUCCESS":   2,
		"ACTIVE":    3,
		"UNKNOWN":   4,
	}
)

Enum value maps for DataMovementDeleteResponse_Status.

View Source
var (
	DataMovementCancelResponse_Status_name = map[int32]string{
		0: "INVALID",
		1: "NOT_FOUND",
		2: "SUCCESS",
		3: "FAILED",
	}
	DataMovementCancelResponse_Status_value = map[string]int32{
		"INVALID":   0,
		"NOT_FOUND": 1,
		"SUCCESS":   2,
		"FAILED":    3,
	}
)

Enum value maps for DataMovementCancelResponse_Status.

View Source
var DataMover_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "datamovement.DataMover",
	HandlerType: (*DataMoverServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Create",
			Handler:    _DataMover_Create_Handler,
		},
		{
			MethodName: "Status",
			Handler:    _DataMover_Status_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _DataMover_Delete_Handler,
		},
		{
			MethodName: "List",
			Handler:    _DataMover_List_Handler,
		},
		{
			MethodName: "Cancel",
			Handler:    _DataMover_Cancel_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api/datamovement.proto",
}

DataMover_ServiceDesc is the grpc.ServiceDesc for DataMover 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_api_datamovement_proto protoreflect.FileDescriptor

Functions

func RegisterDataMoverServer

func RegisterDataMoverServer(s grpc.ServiceRegistrar, srv DataMoverServer)

Types

type DataMovementCancelRequest

type DataMovementCancelRequest struct {
	Workflow *DataMovementWorkflow `protobuf:"bytes,1,opt,name=workflow,proto3" json:"workflow,omitempty"`
	Uid      string                `protobuf:"bytes,2,opt,name=uid,proto3" json:"uid,omitempty"`
	// contains filtered or unexported fields
}

The data movement cancel request permits users to iniatiate a cancellation of a data movement request that is in progress.

func (*DataMovementCancelRequest) Descriptor deprecated

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

Deprecated: Use DataMovementCancelRequest.ProtoReflect.Descriptor instead.

func (*DataMovementCancelRequest) GetUid

func (x *DataMovementCancelRequest) GetUid() string

func (*DataMovementCancelRequest) GetWorkflow

func (*DataMovementCancelRequest) ProtoMessage

func (*DataMovementCancelRequest) ProtoMessage()

func (*DataMovementCancelRequest) ProtoReflect

func (*DataMovementCancelRequest) Reset

func (x *DataMovementCancelRequest) Reset()

func (*DataMovementCancelRequest) String

func (x *DataMovementCancelRequest) String() string

type DataMovementCancelResponse

type DataMovementCancelResponse struct {
	Status  DataMovementCancelResponse_Status `protobuf:"varint,1,opt,name=status,proto3,enum=datamovement.DataMovementCancelResponse_Status" json:"status,omitempty"`
	Message string                            `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

The data movement cancel response returns the status of the cancel request. The cancel process will begin upon success. This response does not indicate that that cancel process has completed, but rather that it has been initiated.

func (*DataMovementCancelResponse) Descriptor deprecated

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

Deprecated: Use DataMovementCancelResponse.ProtoReflect.Descriptor instead.

func (*DataMovementCancelResponse) GetMessage

func (x *DataMovementCancelResponse) GetMessage() string

func (*DataMovementCancelResponse) GetStatus

func (*DataMovementCancelResponse) ProtoMessage

func (*DataMovementCancelResponse) ProtoMessage()

func (*DataMovementCancelResponse) ProtoReflect

func (*DataMovementCancelResponse) Reset

func (x *DataMovementCancelResponse) Reset()

func (*DataMovementCancelResponse) String

func (x *DataMovementCancelResponse) String() string

type DataMovementCancelResponse_Status

type DataMovementCancelResponse_Status int32
const (
	DataMovementCancelResponse_INVALID   DataMovementCancelResponse_Status = 0
	DataMovementCancelResponse_NOT_FOUND DataMovementCancelResponse_Status = 1
	DataMovementCancelResponse_SUCCESS   DataMovementCancelResponse_Status = 2
	DataMovementCancelResponse_FAILED    DataMovementCancelResponse_Status = 3
)

func (DataMovementCancelResponse_Status) Descriptor

func (DataMovementCancelResponse_Status) Enum

func (DataMovementCancelResponse_Status) EnumDescriptor deprecated

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

Deprecated: Use DataMovementCancelResponse_Status.Descriptor instead.

func (DataMovementCancelResponse_Status) Number

func (DataMovementCancelResponse_Status) String

func (DataMovementCancelResponse_Status) Type

type DataMovementCommandStatus

type DataMovementCommandStatus struct {
	Command         string `protobuf:"bytes,1,opt,name=command,proto3" json:"command,omitempty"`
	Progress        int32  `protobuf:"varint,2,opt,name=progress,proto3" json:"progress,omitempty"`
	ElapsedTime     string `protobuf:"bytes,3,opt,name=elapsedTime,proto3" json:"elapsedTime,omitempty"`
	LastMessage     string `protobuf:"bytes,4,opt,name=lastMessage,proto3" json:"lastMessage,omitempty"`
	LastMessageTime string `protobuf:"bytes,5,opt,name=lastMessageTime,proto3" json:"lastMessageTime,omitempty"`
	// contains filtered or unexported fields
}

Data Movement workflows contain a CommandStatus object in the Status object. This information relays the current state of the data movement progress. It includes the command, the progress percentage (e.g. 0-100%), elapsed time of the data movement (duration string, e.g. 5s), the last received message from the data movment command, and the time of that last message.

func (*DataMovementCommandStatus) Descriptor deprecated

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

Deprecated: Use DataMovementCommandStatus.ProtoReflect.Descriptor instead.

func (*DataMovementCommandStatus) GetCommand

func (x *DataMovementCommandStatus) GetCommand() string

func (*DataMovementCommandStatus) GetElapsedTime

func (x *DataMovementCommandStatus) GetElapsedTime() string

func (*DataMovementCommandStatus) GetLastMessage

func (x *DataMovementCommandStatus) GetLastMessage() string

func (*DataMovementCommandStatus) GetLastMessageTime

func (x *DataMovementCommandStatus) GetLastMessageTime() string

func (*DataMovementCommandStatus) GetProgress

func (x *DataMovementCommandStatus) GetProgress() int32

func (*DataMovementCommandStatus) ProtoMessage

func (*DataMovementCommandStatus) ProtoMessage()

func (*DataMovementCommandStatus) ProtoReflect

func (*DataMovementCommandStatus) Reset

func (x *DataMovementCommandStatus) Reset()

func (*DataMovementCommandStatus) String

func (x *DataMovementCommandStatus) String() string

type DataMovementCreateRequest

type DataMovementCreateRequest struct {
	Workflow    *DataMovementWorkflow `protobuf:"bytes,1,opt,name=workflow,proto3" json:"workflow,omitempty"`
	Source      string                `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	Destination string                `protobuf:"bytes,3,opt,name=destination,proto3" json:"destination,omitempty"`
	Dryrun      bool                  `protobuf:"varint,4,opt,name=dryrun,proto3" json:"dryrun,omitempty"`
	// contains filtered or unexported fields
}

The data movement create request message containing the source and destination files or directories. The NNF Data Mover will perform a copy from source to the destination. Specify dryrun to instantiate a new data movement request where the copy is simulated and not executed

func (*DataMovementCreateRequest) Descriptor deprecated

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

Deprecated: Use DataMovementCreateRequest.ProtoReflect.Descriptor instead.

func (*DataMovementCreateRequest) GetDestination

func (x *DataMovementCreateRequest) GetDestination() string

func (*DataMovementCreateRequest) GetDryrun

func (x *DataMovementCreateRequest) GetDryrun() bool

func (*DataMovementCreateRequest) GetSource

func (x *DataMovementCreateRequest) GetSource() string

func (*DataMovementCreateRequest) GetWorkflow

func (*DataMovementCreateRequest) ProtoMessage

func (*DataMovementCreateRequest) ProtoMessage()

func (*DataMovementCreateRequest) ProtoReflect

func (*DataMovementCreateRequest) Reset

func (x *DataMovementCreateRequest) Reset()

func (*DataMovementCreateRequest) String

func (x *DataMovementCreateRequest) String() string

type DataMovementCreateResponse

type DataMovementCreateResponse struct {
	Uid     string                            `protobuf:"bytes,1,opt,name=uid,proto3" json:"uid,omitempty"`
	Status  DataMovementCreateResponse_Status `protobuf:"varint,2,opt,name=status,proto3,enum=datamovement.DataMovementCreateResponse_Status" json:"status,omitempty"`
	Message string                            `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

The data movement create response message contains a unique identifier amont all data movement requests for the lifetime of the active job. The UID can be used to query for status of the request using the data movement status request message.

func (*DataMovementCreateResponse) Descriptor deprecated

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

Deprecated: Use DataMovementCreateResponse.ProtoReflect.Descriptor instead.

func (*DataMovementCreateResponse) GetMessage

func (x *DataMovementCreateResponse) GetMessage() string

func (*DataMovementCreateResponse) GetStatus

func (*DataMovementCreateResponse) GetUid

func (x *DataMovementCreateResponse) GetUid() string

func (*DataMovementCreateResponse) ProtoMessage

func (*DataMovementCreateResponse) ProtoMessage()

func (*DataMovementCreateResponse) ProtoReflect

func (*DataMovementCreateResponse) Reset

func (x *DataMovementCreateResponse) Reset()

func (*DataMovementCreateResponse) String

func (x *DataMovementCreateResponse) String() string

type DataMovementCreateResponse_Status

type DataMovementCreateResponse_Status int32
const (
	DataMovementCreateResponse_SUCCESS DataMovementCreateResponse_Status = 0
	DataMovementCreateResponse_FAILED  DataMovementCreateResponse_Status = 1
	DataMovementCreateResponse_INVALID DataMovementCreateResponse_Status = 2
)

func (DataMovementCreateResponse_Status) Descriptor

func (DataMovementCreateResponse_Status) Enum

func (DataMovementCreateResponse_Status) EnumDescriptor deprecated

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

Deprecated: Use DataMovementCreateResponse_Status.Descriptor instead.

func (DataMovementCreateResponse_Status) Number

func (DataMovementCreateResponse_Status) String

func (DataMovementCreateResponse_Status) Type

type DataMovementDeleteRequest

type DataMovementDeleteRequest struct {
	Workflow *DataMovementWorkflow `protobuf:"bytes,1,opt,name=workflow,proto3" json:"workflow,omitempty"`
	Uid      string                `protobuf:"bytes,2,opt,name=uid,proto3" json:"uid,omitempty"`
	// contains filtered or unexported fields
}

The data movement delete request permits users to delete a completed data movement request (any request with a status of COMPLETED) by specifying the request's unique identifier.

func (*DataMovementDeleteRequest) Descriptor deprecated

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

Deprecated: Use DataMovementDeleteRequest.ProtoReflect.Descriptor instead.

func (*DataMovementDeleteRequest) GetUid

func (x *DataMovementDeleteRequest) GetUid() string

func (*DataMovementDeleteRequest) GetWorkflow

func (*DataMovementDeleteRequest) ProtoMessage

func (*DataMovementDeleteRequest) ProtoMessage()

func (*DataMovementDeleteRequest) ProtoReflect

func (*DataMovementDeleteRequest) Reset

func (x *DataMovementDeleteRequest) Reset()

func (*DataMovementDeleteRequest) String

func (x *DataMovementDeleteRequest) String() string

type DataMovementDeleteResponse

type DataMovementDeleteResponse struct {
	Status  DataMovementDeleteResponse_Status `protobuf:"varint,1,opt,name=status,proto3,enum=datamovement.DataMovementDeleteResponse_Status" json:"status,omitempty"`
	Message string                            `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

The data movement delete response returns the status of the delete operation.

func (*DataMovementDeleteResponse) Descriptor deprecated

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

Deprecated: Use DataMovementDeleteResponse.ProtoReflect.Descriptor instead.

func (*DataMovementDeleteResponse) GetMessage

func (x *DataMovementDeleteResponse) GetMessage() string

func (*DataMovementDeleteResponse) GetStatus

func (*DataMovementDeleteResponse) ProtoMessage

func (*DataMovementDeleteResponse) ProtoMessage()

func (*DataMovementDeleteResponse) ProtoReflect

func (*DataMovementDeleteResponse) Reset

func (x *DataMovementDeleteResponse) Reset()

func (*DataMovementDeleteResponse) String

func (x *DataMovementDeleteResponse) String() string

type DataMovementDeleteResponse_Status

type DataMovementDeleteResponse_Status int32
const (
	DataMovementDeleteResponse_INVALID   DataMovementDeleteResponse_Status = 0
	DataMovementDeleteResponse_NOT_FOUND DataMovementDeleteResponse_Status = 1
	DataMovementDeleteResponse_SUCCESS   DataMovementDeleteResponse_Status = 2
	DataMovementDeleteResponse_ACTIVE    DataMovementDeleteResponse_Status = 3
	DataMovementDeleteResponse_UNKNOWN   DataMovementDeleteResponse_Status = 4
)

func (DataMovementDeleteResponse_Status) Descriptor

func (DataMovementDeleteResponse_Status) Enum

func (DataMovementDeleteResponse_Status) EnumDescriptor deprecated

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

Deprecated: Use DataMovementDeleteResponse_Status.Descriptor instead.

func (DataMovementDeleteResponse_Status) Number

func (DataMovementDeleteResponse_Status) String

func (DataMovementDeleteResponse_Status) Type

type DataMovementListRequest

type DataMovementListRequest struct {
	Workflow *DataMovementWorkflow `protobuf:"bytes,1,opt,name=workflow,proto3" json:"workflow,omitempty"`
	// contains filtered or unexported fields
}

The data movement list request allows a user to get a list of the current data movement requests. The user must supply the workflow and namespace which will be used to filter the data movement requests for retrieval.

func (*DataMovementListRequest) Descriptor deprecated

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

Deprecated: Use DataMovementListRequest.ProtoReflect.Descriptor instead.

func (*DataMovementListRequest) GetWorkflow

func (*DataMovementListRequest) ProtoMessage

func (*DataMovementListRequest) ProtoMessage()

func (*DataMovementListRequest) ProtoReflect

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

func (*DataMovementListRequest) Reset

func (x *DataMovementListRequest) Reset()

func (*DataMovementListRequest) String

func (x *DataMovementListRequest) String() string

type DataMovementListResponse

type DataMovementListResponse struct {
	Uids []string `protobuf:"bytes,1,rep,name=uids,proto3" json:"uids,omitempty"`
	// contains filtered or unexported fields
}

The data movement list response returns a list of the matching data movement requests' uids

func (*DataMovementListResponse) Descriptor deprecated

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

Deprecated: Use DataMovementListResponse.ProtoReflect.Descriptor instead.

func (*DataMovementListResponse) GetUids

func (x *DataMovementListResponse) GetUids() []string

func (*DataMovementListResponse) ProtoMessage

func (*DataMovementListResponse) ProtoMessage()

func (*DataMovementListResponse) ProtoReflect

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

func (*DataMovementListResponse) Reset

func (x *DataMovementListResponse) Reset()

func (*DataMovementListResponse) String

func (x *DataMovementListResponse) String() string

type DataMovementStatusRequest

type DataMovementStatusRequest struct {
	Workflow    *DataMovementWorkflow `protobuf:"bytes,1,opt,name=workflow,proto3" json:"workflow,omitempty"`
	Uid         string                `protobuf:"bytes,2,opt,name=uid,proto3" json:"uid,omitempty"`
	MaxWaitTime int64                 `protobuf:"varint,3,opt,name=maxWaitTime,proto3" json:"maxWaitTime,omitempty"`
	// contains filtered or unexported fields
}

The data movement status request message permits users to query the status of a previously issued data movement request by specifying the request's unique identifier.

func (*DataMovementStatusRequest) Descriptor deprecated

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

Deprecated: Use DataMovementStatusRequest.ProtoReflect.Descriptor instead.

func (*DataMovementStatusRequest) GetMaxWaitTime

func (x *DataMovementStatusRequest) GetMaxWaitTime() int64

func (*DataMovementStatusRequest) GetUid

func (x *DataMovementStatusRequest) GetUid() string

func (*DataMovementStatusRequest) GetWorkflow

func (*DataMovementStatusRequest) ProtoMessage

func (*DataMovementStatusRequest) ProtoMessage()

func (*DataMovementStatusRequest) ProtoReflect

func (*DataMovementStatusRequest) Reset

func (x *DataMovementStatusRequest) Reset()

func (*DataMovementStatusRequest) String

func (x *DataMovementStatusRequest) String() string

type DataMovementStatusResponse

type DataMovementStatusResponse struct {
	State         DataMovementStatusResponse_State  `protobuf:"varint,1,opt,name=state,proto3,enum=datamovement.DataMovementStatusResponse_State" json:"state,omitempty"`
	Status        DataMovementStatusResponse_Status `protobuf:"varint,2,opt,name=status,proto3,enum=datamovement.DataMovementStatusResponse_Status" json:"status,omitempty"`
	Message       string                            `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	CommandStatus *DataMovementCommandStatus        `protobuf:"bytes,4,opt,name=commandStatus,proto3" json:"commandStatus,omitempty"`
	// contains filtered or unexported fields
}

The data movement status response message defines the current status of a data movement request. The state field describes the current state of the request. The message field contains ancillary information describing the data movement request.

func (*DataMovementStatusResponse) Descriptor deprecated

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

Deprecated: Use DataMovementStatusResponse.ProtoReflect.Descriptor instead.

func (*DataMovementStatusResponse) GetCommandStatus

func (*DataMovementStatusResponse) GetMessage

func (x *DataMovementStatusResponse) GetMessage() string

func (*DataMovementStatusResponse) GetState

func (*DataMovementStatusResponse) GetStatus

func (*DataMovementStatusResponse) ProtoMessage

func (*DataMovementStatusResponse) ProtoMessage()

func (*DataMovementStatusResponse) ProtoReflect

func (*DataMovementStatusResponse) Reset

func (x *DataMovementStatusResponse) Reset()

func (*DataMovementStatusResponse) String

func (x *DataMovementStatusResponse) String() string

type DataMovementStatusResponse_State

type DataMovementStatusResponse_State int32
const (
	DataMovementStatusResponse_PENDING       DataMovementStatusResponse_State = 0
	DataMovementStatusResponse_STARTING      DataMovementStatusResponse_State = 1
	DataMovementStatusResponse_RUNNING       DataMovementStatusResponse_State = 2
	DataMovementStatusResponse_COMPLETED     DataMovementStatusResponse_State = 3
	DataMovementStatusResponse_CANCELLING    DataMovementStatusResponse_State = 4
	DataMovementStatusResponse_UNKNOWN_STATE DataMovementStatusResponse_State = 5
)

func (DataMovementStatusResponse_State) Descriptor

func (DataMovementStatusResponse_State) Enum

func (DataMovementStatusResponse_State) EnumDescriptor deprecated

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

Deprecated: Use DataMovementStatusResponse_State.Descriptor instead.

func (DataMovementStatusResponse_State) Number

func (DataMovementStatusResponse_State) String

func (DataMovementStatusResponse_State) Type

type DataMovementStatusResponse_Status

type DataMovementStatusResponse_Status int32
const (
	DataMovementStatusResponse_INVALID        DataMovementStatusResponse_Status = 0
	DataMovementStatusResponse_NOT_FOUND      DataMovementStatusResponse_Status = 1
	DataMovementStatusResponse_SUCCESS        DataMovementStatusResponse_Status = 2
	DataMovementStatusResponse_FAILED         DataMovementStatusResponse_Status = 3
	DataMovementStatusResponse_CANCELLED      DataMovementStatusResponse_Status = 4
	DataMovementStatusResponse_UNKNOWN_STATUS DataMovementStatusResponse_Status = 5
)

func (DataMovementStatusResponse_Status) Descriptor

func (DataMovementStatusResponse_Status) Enum

func (DataMovementStatusResponse_Status) EnumDescriptor deprecated

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

Deprecated: Use DataMovementStatusResponse_Status.Descriptor instead.

func (DataMovementStatusResponse_Status) Number

func (DataMovementStatusResponse_Status) String

func (DataMovementStatusResponse_Status) Type

type DataMovementWorkflow

type DataMovementWorkflow struct {
	Name      string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// contains filtered or unexported fields
}

Data Movement workflow message contains identifying information for the workflow initiating the data movement operation. This message must be nested in all Request messages.

func (*DataMovementWorkflow) Descriptor deprecated

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

Deprecated: Use DataMovementWorkflow.ProtoReflect.Descriptor instead.

func (*DataMovementWorkflow) GetName

func (x *DataMovementWorkflow) GetName() string

func (*DataMovementWorkflow) GetNamespace

func (x *DataMovementWorkflow) GetNamespace() string

func (*DataMovementWorkflow) ProtoMessage

func (*DataMovementWorkflow) ProtoMessage()

func (*DataMovementWorkflow) ProtoReflect

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

func (*DataMovementWorkflow) Reset

func (x *DataMovementWorkflow) Reset()

func (*DataMovementWorkflow) String

func (x *DataMovementWorkflow) String() string

type DataMoverClient

type DataMoverClient interface {
	// Create sends a new data movement request identified by source and destination fields. It returns
	// a response containing a unique identifier which can be used to query the status of the request.
	Create(ctx context.Context, in *DataMovementCreateRequest, opts ...grpc.CallOption) (*DataMovementCreateResponse, error)
	// Status requests the status of a previously submitted data movement request. It accepts a unique
	// identifier that identifies the request and returns a status message.
	Status(ctx context.Context, in *DataMovementStatusRequest, opts ...grpc.CallOption) (*DataMovementStatusResponse, error)
	// Delete will attempt to delete a completed data movement request. It accepts a unique identifier
	// that identifies the request and returns the status of the delete operation.
	Delete(ctx context.Context, in *DataMovementDeleteRequest, opts ...grpc.CallOption) (*DataMovementDeleteResponse, error)
	// List returns all current data movement requests for a given namespace and workflow.
	List(ctx context.Context, in *DataMovementListRequest, opts ...grpc.CallOption) (*DataMovementListResponse, error)
	// Cancel will attempt to stop a data movement request. It accepts a unique identifier
	// that identifies the request and returns the status of the cancel operation.
	Cancel(ctx context.Context, in *DataMovementCancelRequest, opts ...grpc.CallOption) (*DataMovementCancelResponse, error)
}

DataMoverClient is the client API for DataMover 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 NewDataMoverClient

func NewDataMoverClient(cc grpc.ClientConnInterface) DataMoverClient

type DataMoverServer

type DataMoverServer interface {
	// Create sends a new data movement request identified by source and destination fields. It returns
	// a response containing a unique identifier which can be used to query the status of the request.
	Create(context.Context, *DataMovementCreateRequest) (*DataMovementCreateResponse, error)
	// Status requests the status of a previously submitted data movement request. It accepts a unique
	// identifier that identifies the request and returns a status message.
	Status(context.Context, *DataMovementStatusRequest) (*DataMovementStatusResponse, error)
	// Delete will attempt to delete a completed data movement request. It accepts a unique identifier
	// that identifies the request and returns the status of the delete operation.
	Delete(context.Context, *DataMovementDeleteRequest) (*DataMovementDeleteResponse, error)
	// List returns all current data movement requests for a given namespace and workflow.
	List(context.Context, *DataMovementListRequest) (*DataMovementListResponse, error)
	// Cancel will attempt to stop a data movement request. It accepts a unique identifier
	// that identifies the request and returns the status of the cancel operation.
	Cancel(context.Context, *DataMovementCancelRequest) (*DataMovementCancelResponse, error)
	// contains filtered or unexported methods
}

DataMoverServer is the server API for DataMover service. All implementations must embed UnimplementedDataMoverServer for forward compatibility

type UnimplementedDataMoverServer

type UnimplementedDataMoverServer struct {
}

UnimplementedDataMoverServer must be embedded to have forward compatible implementations.

type UnsafeDataMoverServer

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

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

Jump to

Keyboard shortcuts

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