api

package
v0.1.13 Latest Latest
Warning

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

 Go to latest Published: Dec 11, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DataMover_Version_FullMethodName = "/datamovement.DataMover/Version"
	DataMover_Create_FullMethodName  = "/datamovement.DataMover/Create"
	DataMover_Status_FullMethodName  = "/datamovement.DataMover/Status"
	DataMover_Delete_FullMethodName  = "/datamovement.DataMover/Delete"
	DataMover_List_FullMethodName    = "/datamovement.DataMover/List"
	DataMover_Cancel_FullMethodName  = "/datamovement.DataMover/Cancel"
)

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: "Version",
			Handler:    _DataMover_Version_Handler,
		},
		{
			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 {

	// The name and namespace of the initiating workflow
	Workflow *DataMovementWorkflow `protobuf:"bytes,1,opt,name=workflow,proto3" json:"workflow,omitempty"`
	// The unique identifier for the data movement resource
	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 initiate 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 (x *DataMovementCancelRequest) GetWorkflow() *DataMovementWorkflow

func (*DataMovementCancelRequest) ProtoMessage 

func (*DataMovementCancelRequest) ProtoMessage()

func (*DataMovementCancelRequest) ProtoReflect 

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

func (*DataMovementCancelRequest) Reset 

func (x *DataMovementCancelRequest) Reset()

func (*DataMovementCancelRequest) String 

func (x *DataMovementCancelRequest) String() string

type DataMovementCancelResponse 

type DataMovementCancelResponse struct {

	// Status of the Data Movement Cancellation Request
	Status DataMovementCancelResponse_Status `protobuf:"varint,1,opt,name=status,proto3,enum=datamovement.DataMovementCancelResponse_Status" json:"status,omitempty"`
	// Any extra information included with the status
	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 (x *DataMovementCancelResponse) GetStatus() DataMovementCancelResponse_Status

func (*DataMovementCancelResponse) ProtoMessage 

func (*DataMovementCancelResponse) ProtoMessage()

func (*DataMovementCancelResponse) ProtoReflect 

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

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 // The cancel request was found to be invalid
	DataMovementCancelResponse_NOT_FOUND DataMovementCancelResponse_Status = 1 // The request with the supplied UID was not found
	DataMovementCancelResponse_SUCCESS   DataMovementCancelResponse_Status = 2 // The data movement request was cancelled successfully
	DataMovementCancelResponse_FAILED    DataMovementCancelResponse_Status = 3 // The data movement request cannot be canceled
)

func (DataMovementCancelResponse_Status) Descriptor 

func (DataMovementCancelResponse_Status) Descriptor() protoreflect.EnumDescriptor

func (DataMovementCancelResponse_Status) Enum 

func (x DataMovementCancelResponse_Status) Enum() *DataMovementCancelResponse_Status

func (DataMovementCancelResponse_Status) EnumDescriptor deprecated 

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

Deprecated: Use DataMovementCancelResponse_Status.Descriptor instead.

func (DataMovementCancelResponse_Status) Number 

func (x DataMovementCancelResponse_Status) Number() protoreflect.EnumNumber

func (DataMovementCancelResponse_Status) String 

func (x DataMovementCancelResponse_Status) String() string

func (DataMovementCancelResponse_Status) Type 

func (DataMovementCancelResponse_Status) Type() protoreflect.EnumType

type DataMovementCommandStatus 

type DataMovementCommandStatus struct {

	// Command used to perform Data Movement
	Command string `protobuf:"bytes,1,opt,name=command,proto3" json:"command,omitempty"`
	// Progress percentage (0-100%) of the data movement based on the output of `dcp`. `dcp` must be present in the command.
	Progress int32 `protobuf:"varint,2,opt,name=progress,proto3" json:"progress,omitempty"`
	// Duration of how long the operation has been running (e.g. 1m30s)
	ElapsedTime string `protobuf:"bytes,3,opt,name=elapsedTime,proto3" json:"elapsedTime,omitempty"`
	// The most recent line of output from the data movement command
	LastMessage string `protobuf:"bytes,4,opt,name=lastMessage,proto3" json:"lastMessage,omitempty"`
	// The time (local) of lastMessage
	LastMessageTime string `protobuf:"bytes,5,opt,name=lastMessageTime,proto3" json:"lastMessageTime,omitempty"`
	// contains filtered or unexported fields
}

Data movement operations contain a CommandStatus in the Status object. This information relays the current state of the data movement progress.

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 (x *DataMovementCommandStatus) ProtoReflect() protoreflect.Message

func (*DataMovementCommandStatus) Reset 

func (x *DataMovementCommandStatus) Reset()

func (*DataMovementCommandStatus) String 

func (x *DataMovementCommandStatus) String() string

type DataMovementCreateRequest 

type DataMovementCreateRequest struct {

	// The name and namespace of the initiating workflow
	Workflow *DataMovementWorkflow `protobuf:"bytes,1,opt,name=workflow,proto3" json:"workflow,omitempty"`
	// Source file or directory
	Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	// Destination file or directory
	Destination string `protobuf:"bytes,3,opt,name=destination,proto3" json:"destination,omitempty"`
	// If True, the data movement command runs `/bin/true` rather than perform actual data movement
	Dryrun bool `protobuf:"varint,4,opt,name=dryrun,proto3" json:"dryrun,omitempty"`
	// Extra options to pass to `dcp` if present in the Data Movement command.
	DcpOptions string `protobuf:"bytes,5,opt,name=dcpOptions,proto3" json:"dcpOptions,omitempty"`
	// If true, enable server-side logging of stdout when the command is successful. Failure output is always logged.
	LogStdout bool `protobuf:"varint,6,opt,name=logStdout,proto3" json:"logStdout,omitempty"`
	// If true, store stdout in DataMovementStatusResponse.Message when the command is successful. Failure output is always contained in the message.
	StoreStdout bool `protobuf:"varint,7,opt,name=storeStdout,proto3" json:"storeStdout,omitempty"`
	// The number of slots specified in the MPI hostfile. A value of 0 disables the use of slots in
	// the hostfile. -1 will defer to the server side configuration.
	Slots int32 `protobuf:"varint,8,opt,name=slots,proto3" json:"slots,omitempty"`
	// The number of max_slots specified in the MPI hostfile. A value of 0 disables the use of
	// max_slots in the hostfile. -1 will defer to the server side configuration.
	MaxSlots int32 `protobuf:"varint,9,opt,name=maxSlots,proto3" json:"maxSlots,omitempty"`
	// The name of the data movement configuration profile to use. The above parameters (e.g. slots,
	// logStdout) will override the settings defined by the profile. This profile must exist on the
	// server otherwise the data movement operation will be invalid. Empty will default to the
	// default profile.
	Profile string `protobuf:"bytes,10,opt,name=profile,proto3" json:"profile,omitempty"`
	// Extra options to pass to `mpirun` if present in the Data Movement command.
	MpirunOptions string `protobuf:"bytes,11,opt,name=mpirunOptions,proto3" json:"mpirunOptions,omitempty"`
	// contains filtered or unexported fields
}

Create a Data Movement Request to perform data movement. NNF Data Movement will copy from source to the destination path.

func (*DataMovementCreateRequest) Descriptor deprecated 

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

Deprecated: Use DataMovementCreateRequest.ProtoReflect.Descriptor instead.

func (*DataMovementCreateRequest) GetDcpOptions added in v0.0.2 

func (x *DataMovementCreateRequest) GetDcpOptions() string

func (*DataMovementCreateRequest) GetDestination 

func (x *DataMovementCreateRequest) GetDestination() string

func (*DataMovementCreateRequest) GetDryrun 

func (x *DataMovementCreateRequest) GetDryrun() bool

func (*DataMovementCreateRequest) GetLogStdout added in v0.0.3 

func (x *DataMovementCreateRequest) GetLogStdout() bool

func (*DataMovementCreateRequest) GetMaxSlots added in v0.0.6 

func (x *DataMovementCreateRequest) GetMaxSlots() int32

func (*DataMovementCreateRequest) GetMpirunOptions added in v0.1.5 

func (x *DataMovementCreateRequest) GetMpirunOptions() string

func (*DataMovementCreateRequest) GetProfile added in v0.0.7 

func (x *DataMovementCreateRequest) GetProfile() string

func (*DataMovementCreateRequest) GetSlots added in v0.0.6 

func (x *DataMovementCreateRequest) GetSlots() int32

func (*DataMovementCreateRequest) GetSource 

func (x *DataMovementCreateRequest) GetSource() string

func (*DataMovementCreateRequest) GetStoreStdout added in v0.0.3 

func (x *DataMovementCreateRequest) GetStoreStdout() bool

func (*DataMovementCreateRequest) GetWorkflow 

func (x *DataMovementCreateRequest) GetWorkflow() *DataMovementWorkflow

func (*DataMovementCreateRequest) ProtoMessage 

func (*DataMovementCreateRequest) ProtoMessage()

func (*DataMovementCreateRequest) ProtoReflect 

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

func (*DataMovementCreateRequest) Reset 

func (x *DataMovementCreateRequest) Reset()

func (*DataMovementCreateRequest) String 

func (x *DataMovementCreateRequest) String() string

type DataMovementCreateResponse 

type DataMovementCreateResponse struct {

	// The unique identifier for the created data movement resource if `Status` is Success
	Uid string `protobuf:"bytes,1,opt,name=uid,proto3" json:"uid,omitempty"`
	// Status of the DataMovementCreateRequest
	Status DataMovementCreateResponse_Status `protobuf:"varint,2,opt,name=status,proto3,enum=datamovement.DataMovementCreateResponse_Status" json:"status,omitempty"`
	// Any extra information supplied with the status
	Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

The Data Movement Create Response to indicate the status of of the Data Movement Request.

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 (x *DataMovementCreateResponse) GetStatus() DataMovementCreateResponse_Status

func (*DataMovementCreateResponse) GetUid 

func (x *DataMovementCreateResponse) GetUid() string

func (*DataMovementCreateResponse) ProtoMessage 

func (*DataMovementCreateResponse) ProtoMessage()

func (*DataMovementCreateResponse) ProtoReflect 

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

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 // The data movement resource created successfully
	DataMovementCreateResponse_FAILED  DataMovementCreateResponse_Status = 1 // The data movement resource failed to create. See `message` field for more information
	DataMovementCreateResponse_INVALID DataMovementCreateResponse_Status = 2 // Invalid request
)

func (DataMovementCreateResponse_Status) Descriptor 

func (DataMovementCreateResponse_Status) Descriptor() protoreflect.EnumDescriptor

func (DataMovementCreateResponse_Status) Enum 

func (x DataMovementCreateResponse_Status) Enum() *DataMovementCreateResponse_Status

func (DataMovementCreateResponse_Status) EnumDescriptor deprecated 

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

Deprecated: Use DataMovementCreateResponse_Status.Descriptor instead.

func (DataMovementCreateResponse_Status) Number 

func (x DataMovementCreateResponse_Status) Number() protoreflect.EnumNumber

func (DataMovementCreateResponse_Status) String 

func (x DataMovementCreateResponse_Status) String() string

func (DataMovementCreateResponse_Status) Type 

func (DataMovementCreateResponse_Status) Type() protoreflect.EnumType

type DataMovementDeleteRequest 

type DataMovementDeleteRequest struct {

	// The name and namespace of the initiating workflow
	Workflow *DataMovementWorkflow `protobuf:"bytes,1,opt,name=workflow,proto3" json:"workflow,omitempty"`
	// The unique identifier for the data movement resource
	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).

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 (x *DataMovementDeleteRequest) GetWorkflow() *DataMovementWorkflow

func (*DataMovementDeleteRequest) ProtoMessage 

func (*DataMovementDeleteRequest) ProtoMessage()

func (*DataMovementDeleteRequest) ProtoReflect 

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

func (*DataMovementDeleteRequest) Reset 

func (x *DataMovementDeleteRequest) Reset()

func (*DataMovementDeleteRequest) String 

func (x *DataMovementDeleteRequest) String() string

type DataMovementDeleteResponse 

type DataMovementDeleteResponse struct {

	// Status of the Data Movement Delete Request
	Status DataMovementDeleteResponse_Status `protobuf:"varint,1,opt,name=status,proto3,enum=datamovement.DataMovementDeleteResponse_Status" json:"status,omitempty"`
	// Any extra information supplied with the status
	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 (x *DataMovementDeleteResponse) GetStatus() DataMovementDeleteResponse_Status

func (*DataMovementDeleteResponse) ProtoMessage 

func (*DataMovementDeleteResponse) ProtoMessage()

func (*DataMovementDeleteResponse) ProtoReflect 

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

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 // The delete request was found to be invalid
	DataMovementDeleteResponse_NOT_FOUND DataMovementDeleteResponse_Status = 1 // The request with the supplied UID was not found
	DataMovementDeleteResponse_SUCCESS   DataMovementDeleteResponse_Status = 2 // The data movement request was deleted successfully
	DataMovementDeleteResponse_ACTIVE    DataMovementDeleteResponse_Status = 3 // The data movement request is currently active and cannot be deleted
	DataMovementDeleteResponse_UNKNOWN   DataMovementDeleteResponse_Status = 4 // Unknown status
)

func (DataMovementDeleteResponse_Status) Descriptor 

func (DataMovementDeleteResponse_Status) Descriptor() protoreflect.EnumDescriptor

func (DataMovementDeleteResponse_Status) Enum 

func (x DataMovementDeleteResponse_Status) Enum() *DataMovementDeleteResponse_Status

func (DataMovementDeleteResponse_Status) EnumDescriptor deprecated 

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

Deprecated: Use DataMovementDeleteResponse_Status.Descriptor instead.

func (DataMovementDeleteResponse_Status) Number 

func (x DataMovementDeleteResponse_Status) Number() protoreflect.EnumNumber

func (DataMovementDeleteResponse_Status) String 

func (x DataMovementDeleteResponse_Status) String() string

func (DataMovementDeleteResponse_Status) Type 

func (DataMovementDeleteResponse_Status) Type() protoreflect.EnumType

type DataMovementListRequest 

type DataMovementListRequest struct {

	// The name and namespace of the initiating workflow
	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 for a given DWS Workflow.

func (*DataMovementListRequest) Descriptor deprecated 

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

Deprecated: Use DataMovementListRequest.ProtoReflect.Descriptor instead.

func (*DataMovementListRequest) GetWorkflow 

func (x *DataMovementListRequest) GetWorkflow() *DataMovementWorkflow

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 {

	// List of data movement requests associated with the given workflow and namespace
	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 {

	// The name and namespace of the initiating workflow
	Workflow *DataMovementWorkflow `protobuf:"bytes,1,opt,name=workflow,proto3" json:"workflow,omitempty"`
	// UID of the Data Movement Request
	Uid string `protobuf:"bytes,2,opt,name=uid,proto3" json:"uid,omitempty"`
	// The maximum time in seconds to wait for completion of the data movement resource. Negative values imply an indefinite wait
	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 Data Movement Request.

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 (x *DataMovementStatusRequest) GetWorkflow() *DataMovementWorkflow

func (*DataMovementStatusRequest) ProtoMessage 

func (*DataMovementStatusRequest) ProtoMessage()

func (*DataMovementStatusRequest) ProtoReflect 

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

func (*DataMovementStatusRequest) Reset 

func (x *DataMovementStatusRequest) Reset()

func (*DataMovementStatusRequest) String 

func (x *DataMovementStatusRequest) String() string

type DataMovementStatusResponse 

type DataMovementStatusResponse struct {

	// Current state of the Data Movement Request
	State DataMovementStatusResponse_State `protobuf:"varint,1,opt,name=state,proto3,enum=datamovement.DataMovementStatusResponse_State" json:"state,omitempty"`
	// Current status of the Data Movement Request
	Status DataMovementStatusResponse_Status `protobuf:"varint,2,opt,name=status,proto3,enum=datamovement.DataMovementStatusResponse_Status" json:"status,omitempty"`
	// Any extra information supplied with the state/status
	Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// Current state/progress of the Data Movement command
	CommandStatus *DataMovementCommandStatus `protobuf:"bytes,4,opt,name=commandStatus,proto3" json:"commandStatus,omitempty"`
	// The start time (local) of the data movement operation
	StartTime string `protobuf:"bytes,5,opt,name=startTime,proto3" json:"startTime,omitempty"`
	// The end time (local) of the data movement operation
	EndTime string `protobuf:"bytes,6,opt,name=endTime,proto3" json:"endTime,omitempty"`
	// contains filtered or unexported fields
}

The Data Movement Status Response message defines the current status of a data movement request.

func (*DataMovementStatusResponse) Descriptor deprecated 

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

Deprecated: Use DataMovementStatusResponse.ProtoReflect.Descriptor instead.

func (*DataMovementStatusResponse) GetCommandStatus 

func (x *DataMovementStatusResponse) GetCommandStatus() *DataMovementCommandStatus

func (*DataMovementStatusResponse) GetEndTime added in v0.0.2 

func (x *DataMovementStatusResponse) GetEndTime() string

func (*DataMovementStatusResponse) GetMessage 

func (x *DataMovementStatusResponse) GetMessage() string

func (*DataMovementStatusResponse) GetStartTime added in v0.0.2 

func (x *DataMovementStatusResponse) GetStartTime() string

func (*DataMovementStatusResponse) GetState 

func (x *DataMovementStatusResponse) GetState() DataMovementStatusResponse_State

func (*DataMovementStatusResponse) GetStatus 

func (x *DataMovementStatusResponse) GetStatus() DataMovementStatusResponse_Status

func (*DataMovementStatusResponse) ProtoMessage 

func (*DataMovementStatusResponse) ProtoMessage()

func (*DataMovementStatusResponse) ProtoReflect 

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

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 // The request is created but has a pending status
	DataMovementStatusResponse_STARTING      DataMovementStatusResponse_State = 1 // The request was created and is in the act of starting
	DataMovementStatusResponse_RUNNING       DataMovementStatusResponse_State = 2 // The data movement request is actively running
	DataMovementStatusResponse_COMPLETED     DataMovementStatusResponse_State = 3 // The data movement request has completed
	DataMovementStatusResponse_CANCELLING    DataMovementStatusResponse_State = 4 // The data movement request has started the cancellation process
	DataMovementStatusResponse_UNKNOWN_STATE DataMovementStatusResponse_State = 5 // Unknown state
)

func (DataMovementStatusResponse_State) Descriptor 

func (DataMovementStatusResponse_State) Descriptor() protoreflect.EnumDescriptor

func (DataMovementStatusResponse_State) Enum 

func (x DataMovementStatusResponse_State) Enum() *DataMovementStatusResponse_State

func (DataMovementStatusResponse_State) EnumDescriptor deprecated 

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

Deprecated: Use DataMovementStatusResponse_State.Descriptor instead.

func (DataMovementStatusResponse_State) Number 

func (x DataMovementStatusResponse_State) Number() protoreflect.EnumNumber

func (DataMovementStatusResponse_State) String 

func (x DataMovementStatusResponse_State) String() string

func (DataMovementStatusResponse_State) Type 

func (DataMovementStatusResponse_State) Type() protoreflect.EnumType

type DataMovementStatusResponse_Status 

type DataMovementStatusResponse_Status int32
const (
	DataMovementStatusResponse_INVALID        DataMovementStatusResponse_Status = 0 // The request was found to be invalid. See `message` for details
	DataMovementStatusResponse_NOT_FOUND      DataMovementStatusResponse_Status = 1 // The request with the supplied UID was not found
	DataMovementStatusResponse_SUCCESS        DataMovementStatusResponse_Status = 2 // The request completed with success
	DataMovementStatusResponse_FAILED         DataMovementStatusResponse_Status = 3 // The request failed. See `message` for details
	DataMovementStatusResponse_CANCELLED      DataMovementStatusResponse_Status = 4 // The request was cancelled
	DataMovementStatusResponse_UNKNOWN_STATUS DataMovementStatusResponse_Status = 5 // Unknown status
)

func (DataMovementStatusResponse_Status) Descriptor 

func (DataMovementStatusResponse_Status) Descriptor() protoreflect.EnumDescriptor

func (DataMovementStatusResponse_Status) Enum 

func (x DataMovementStatusResponse_Status) Enum() *DataMovementStatusResponse_Status

func (DataMovementStatusResponse_Status) EnumDescriptor deprecated 

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

Deprecated: Use DataMovementStatusResponse_Status.Descriptor instead.

func (DataMovementStatusResponse_Status) Number 

func (x DataMovementStatusResponse_Status) Number() protoreflect.EnumNumber

func (DataMovementStatusResponse_Status) String 

func (x DataMovementStatusResponse_Status) String() string

func (DataMovementStatusResponse_Status) Type 

func (DataMovementStatusResponse_Status) Type() protoreflect.EnumType

type DataMovementVersionResponse added in v0.0.2 

type DataMovementVersionResponse struct {

	// Current version of the API.
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// List of supported API versions.
	ApiVersions []string `protobuf:"bytes,2,rep,name=apiVersions,proto3" json:"apiVersions,omitempty"`
	// contains filtered or unexported fields
}

The data movement version response returns information on the running data movement daemon.

func (*DataMovementVersionResponse) Descriptor deprecated added in v0.0.2 

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

Deprecated: Use DataMovementVersionResponse.ProtoReflect.Descriptor instead.

func (*DataMovementVersionResponse) GetApiVersions added in v0.0.2 

func (x *DataMovementVersionResponse) GetApiVersions() []string

func (*DataMovementVersionResponse) GetVersion added in v0.0.2 

func (x *DataMovementVersionResponse) GetVersion() string

func (*DataMovementVersionResponse) ProtoMessage added in v0.0.2 

func (*DataMovementVersionResponse) ProtoMessage()

func (*DataMovementVersionResponse) ProtoReflect added in v0.0.2 

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

func (*DataMovementVersionResponse) Reset added in v0.0.2 

func (x *DataMovementVersionResponse) Reset()

func (*DataMovementVersionResponse) String added in v0.0.2 

func (x *DataMovementVersionResponse) String() string

type DataMovementWorkflow 

type DataMovementWorkflow struct {

	// Name of the DWS workflow that is associated with this data movement request
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Namespace of the DWS workflow that is associated with this data movement request
	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 {
	// Version sends a request to the data movement daemon and returns a response containing details on the current build version and supported API versions.
	Version(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*DataMovementVersionResponse, error)
	// 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 {
	// Version sends a request to the data movement daemon and returns a response containing details on the current build version and supported API versions.
	Version(context.Context, *emptypb.Empty) (*DataMovementVersionResponse, error)
	// 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.

func (UnimplementedDataMoverServer) Cancel 

func (UnimplementedDataMoverServer) Cancel(context.Context, *DataMovementCancelRequest) (*DataMovementCancelResponse, error)

func (UnimplementedDataMoverServer) Create 

func (UnimplementedDataMoverServer) Create(context.Context, *DataMovementCreateRequest) (*DataMovementCreateResponse, error)

func (UnimplementedDataMoverServer) Delete 

func (UnimplementedDataMoverServer) Delete(context.Context, *DataMovementDeleteRequest) (*DataMovementDeleteResponse, error)

func (UnimplementedDataMoverServer) List 

func (UnimplementedDataMoverServer) List(context.Context, *DataMovementListRequest) (*DataMovementListResponse, error)

func (UnimplementedDataMoverServer) Status 

func (UnimplementedDataMoverServer) Status(context.Context, *DataMovementStatusRequest) (*DataMovementStatusResponse, error)

func (UnimplementedDataMoverServer) Version added in v0.0.2 

func (UnimplementedDataMoverServer) Version(context.Context, *emptypb.Empty) (*DataMovementVersionResponse, error)

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.

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.