Export | R Documentation |
R6 Class representing a resource for managing volume export jobs.
sevenbridges2::Item
-> Export
URL
List of URL endpoints for this resource.
id
Export job string identifier.
state
The state of the export job. Possible values are:
PENDING
: the export is queued;
RUNNING
: the export is running;
COMPLETED
: the export has completed successfully;
FAILED
: the export has failed.
source
List containing the source file ID that is being exported to the volume.
destination
List containing the destination volume ID and location (file name) on the volume where the file is being exported.
overwrite
Indicates whether the exported file name was overwritten if another file with the same name already existed on the volume.
started_on
Time when the export job started.
finished_on
Time when the export job ended.
properties
List of volume properties set.
error
In case of error in the export job, standard API error is returned here.
result
File object that was exported.
new()
Create a new Export object.
Export$new(res = NA, ...)
res
Response containing Export job information.
...
Other response arguments.
print()
Print method for Export class.
Export$print()
\dontrun{ # x is API response when export is requested export_object <- Export$new( res = x, href = x$href, auth = auth, response = attr(x, "response") ) # Print export object export_object$print() }
reload()
Refresh the Export object with updated information.
Export$reload(...)
...
Other arguments that can be passed to core api()
function
like 'fields', etc.
Export
object.
\dontrun{ # x is API response when export is requested export_object <- Export$new( res = x, href = x$href, auth = auth, response = attr(x, "response") ) # Reload export object export_object$reload() }
clone()
The objects of this class are cloneable with this method.
Export$clone(deep = FALSE)
deep
Whether to make a deep clone.
## ------------------------------------------------
## Method `Export$print`
## ------------------------------------------------
## Not run:
# x is API response when export is requested
export_object <- Export$new(
res = x,
href = x$href,
auth = auth,
response = attr(x, "response")
)
# Print export object
export_object$print()
## End(Not run)
## ------------------------------------------------
## Method `Export$reload`
## ------------------------------------------------
## Not run:
# x is API response when export is requested
export_object <- Export$new(
res = x,
href = x$href,
auth = auth,
response = attr(x, "response")
)
# Reload export object
export_object$reload()
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.