Documentation
¶
Index ¶
Constants ¶
const ( // DirEntryTypeRegular captures enum value "regular" DirEntryTypeRegular string = "regular" // DirEntryTypeDir captures enum value "dir" DirEntryTypeDir string = "dir" // DirEntryTypeSymlink captures enum value "symlink" DirEntryTypeSymlink string = "symlink" // DirEntryTypeUnknown captures enum value "unknown" DirEntryTypeUnknown string = "unknown" )
const ( // JobStatusStatusScheduled captures enum value "scheduled" JobStatusStatusScheduled string = "scheduled" // JobStatusStatusPending captures enum value "pending" JobStatusStatusPending string = "pending" // JobStatusStatusActive captures enum value "active" JobStatusStatusActive string = "active" // JobStatusStatusRetry captures enum value "retry" JobStatusStatusRetry string = "retry" // JobStatusStatusCompleted captures enum value "completed" JobStatusStatusCompleted string = "completed" // JobStatusStatusArchived captures enum value "archived" JobStatusStatusArchived string = "archived" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Collection ¶
type Collection struct {
// iRODS namespace for the collection
// Required: true
CollName *string `json:"collName"`
}
Collection JSON object of a RDR collection
swagger:model collection
func (*Collection) ContextValidate ¶
ContextValidate validates this collection based on context it is used
func (*Collection) MarshalBinary ¶
func (m *Collection) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Collection) UnmarshalBinary ¶
func (m *Collection) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DirEntry ¶
type DirEntry struct {
// name of the entry
// Required: true
Name *string `json:"name"`
// size of the entry in bytes
// Required: true
Size *int64 `json:"size"`
// type of the entry
// Required: true
// Enum: [regular dir symlink unknown]
Type *string `json:"type"`
}
DirEntry directory entry
swagger:model dirEntry
func (*DirEntry) ContextValidate ¶
ContextValidate validates this dir entry based on context it is used
func (*DirEntry) MarshalBinary ¶
MarshalBinary interface implementation
func (*DirEntry) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type DirPath ¶
type DirPath struct {
// path of the directory
// Required: true
Path *string `json:"path"`
}
DirPath directory path data
swagger:model dirPath
func (*DirPath) ContextValidate ¶
ContextValidate validates this dir path based on context it is used
func (*DirPath) MarshalBinary ¶
MarshalBinary interface implementation
func (*DirPath) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type JobData ¶
type JobData struct {
// password of the DR data-access account
DrPass string `json:"drPass,omitempty"`
// username of the DR data-access account
// Required: true
DrUser *string `json:"drUser"`
// path or DR namespace (prefixed with irods:) of the destination endpoint
// Required: true
DstURL *string `json:"dstURL"`
// path or DR namespace (prefixed with irods:) of the source endpoint
// Required: true
SrcURL *string `json:"srcURL"`
// username of the stager user
// Required: true
StagerUser *string `json:"stagerUser"`
// email of the stager user
// Format: email
StagerUserEmail strfmt.Email `json:"stagerUserEmail,omitempty"`
// allowed duration in seconds for entire transfer job (0 for no timeout)
Timeout int64 `json:"timeout,omitempty"`
// allowed duration in seconds for no further transfer progress (0 for no timeout)
TimeoutNoprogress int64 `json:"timeout_noprogress,omitempty"`
// short description about the job
// Required: true
Title *string `json:"title"`
}
JobData job data
swagger:model jobData
func (*JobData) ContextValidate ¶
ContextValidate validates this job data based on context it is used
func (*JobData) MarshalBinary ¶
MarshalBinary interface implementation
func (*JobData) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type JobID ¶
type JobID string
JobID identifier for scheduled background tasks.
swagger:model jobID
func (JobID) ContextValidate ¶
ContextValidate validates this job ID based on context it is used
type JobInfo ¶
type JobInfo struct {
// data
// Required: true
Data *JobData `json:"data"`
// id
// Required: true
ID *JobID `json:"id"`
// status
// Required: true
Status *JobStatus `json:"status"`
// timestamps
// Required: true
Timestamps *JobTimestamps `json:"timestamps"`
}
JobInfo JSON object containing scheduled job information.
swagger:model jobInfo
func (*JobInfo) ContextValidate ¶
ContextValidate validate this job info based on the context it is used
func (*JobInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*JobInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type JobProgress ¶
type JobProgress struct {
// number of failed files
// Required: true
Failed *int64 `json:"failed"`
// number of processed files
// Required: true
Processed *int64 `json:"processed"`
// number of total files to be processed
// Required: true
Total *int64 `json:"total"`
}
JobProgress job progress information
swagger:model jobProgress
func (*JobProgress) ContextValidate ¶
ContextValidate validates this job progress based on context it is used
func (*JobProgress) MarshalBinary ¶
func (m *JobProgress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*JobProgress) UnmarshalBinary ¶
func (m *JobProgress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type JobStatus ¶
type JobStatus struct {
// number of attempts
// Required: true
Attempts *int64 `json:"attempts"`
// job error message from the last execution.
// Required: true
Error *string `json:"error"`
// job progress info from the last execution.
// Required: true
Progress *JobProgress `json:"progress"`
// job status from the last execution.
// Required: true
// Enum: [scheduled pending active retry completed archived]
Status *string `json:"status"`
}
JobStatus status of the background task.
swagger:model jobStatus
func (*JobStatus) ContextValidate ¶
ContextValidate validate this job status based on the context it is used
func (*JobStatus) MarshalBinary ¶
MarshalBinary interface implementation
func (*JobStatus) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type JobTimestamps ¶
type JobTimestamps struct {
// timestamp at which the job is completed, -62135596800 (0001-01-01T00:00:00) if not applicable.
// Required: true
CompletedAt *int64 `json:"completedAt"`
// timestamp at which the job is created.
// Required: true
CreatedAt *int64 `json:"createdAt"`
// timestamp at which the job failed the last time, -62135596800 (0001-01-01T00:00:00) if not applicable.
// Required: true
LastFailedAt *int64 `json:"lastFailedAt"`
// timestamp at which the job will be processed, -62135596800 (0001-01-01T00:00:00) if not applicable.
// Required: true
NextProcessAt *int64 `json:"nextProcessAt"`
}
JobTimestamps job timestamps
swagger:model jobTimestamps
func (*JobTimestamps) ContextValidate ¶
ContextValidate validates this job timestamps based on context it is used
func (*JobTimestamps) MarshalBinary ¶
func (m *JobTimestamps) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*JobTimestamps) UnmarshalBinary ¶
func (m *JobTimestamps) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Principal ¶
type Principal string
Principal authenticated client identifier
swagger:model principal
func (Principal) ContextValidate ¶
ContextValidate validates this principal based on context it is used
type RequestBodyJobs ¶
type RequestBodyJobs struct {
// jobs
Jobs []*JobData `json:"jobs"`
}
RequestBodyJobs JSON object containing a list of job data.
swagger:model requestBodyJobs
func (*RequestBodyJobs) ContextValidate ¶
ContextValidate validate this request body jobs based on the context it is used
func (*RequestBodyJobs) MarshalBinary ¶
func (m *RequestBodyJobs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RequestBodyJobs) UnmarshalBinary ¶
func (m *RequestBodyJobs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResponseBody500 ¶
type ResponseBody500 struct {
// server-side error message.
ErrorMessage string `json:"errorMessage,omitempty"`
// server-side exit code.
ExitCode int64 `json:"exitCode,omitempty"`
}
ResponseBody500 JSON object containing server side error.
swagger:model responseBody500
func (*ResponseBody500) ContextValidate ¶
ContextValidate validates this response body500 based on context it is used
func (*ResponseBody500) MarshalBinary ¶
func (m *ResponseBody500) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResponseBody500) UnmarshalBinary ¶
func (m *ResponseBody500) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResponseBodyJobs ¶
type ResponseBodyJobs struct {
// jobs
Jobs []*JobInfo `json:"jobs"`
}
ResponseBodyJobs JSON object containing a list of job information.
swagger:model responseBodyJobs
func (*ResponseBodyJobs) ContextValidate ¶
ContextValidate validate this response body jobs based on the context it is used
func (*ResponseBodyJobs) MarshalBinary ¶
func (m *ResponseBodyJobs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResponseBodyJobs) UnmarshalBinary ¶
func (m *ResponseBodyJobs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResponseDirEntries ¶
type ResponseDirEntries struct {
// entries
Entries []*DirEntry `json:"entries"`
}
ResponseDirEntries JSON object containing dir entries.
swagger:model responseDirEntries
func (*ResponseDirEntries) ContextValidate ¶
ContextValidate validate this response dir entries based on the context it is used
func (*ResponseDirEntries) MarshalBinary ¶
func (m *ResponseDirEntries) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResponseDirEntries) UnmarshalBinary ¶
func (m *ResponseDirEntries) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files