Import {sevenbridges2} | R Documentation |
R6 Class representing a resource for managing volume import jobs.
sevenbridges2::Item
-> Import
URL
List of URL endpoints for this resource.
id
Import job string identifier.
state
The state of the import job. Possible values are:
PENDING
: the import is queued;
RUNNING
: the import is running;
COMPLETED
: the import has completed successfully;
FAILED
: the import has failed.
overwrite
Whether the imported file/folder name was overwritten or not, if another one with the same name had already existed.
autorename
Whether the imported file/folder name was automatically renamed (by prefixing its name with an underscore and number) if another one with the same name had already existed.
preserve_folder_structure
Whether the imported folder structure was preserved or not.
source
List containing source volume id and source location of the file/folder is being imported to the platform.
destination
List containing destination project id or parent directory id where the file/folder is being imported, together with its name.
started_on
Time when the import job started.
finished_on
Time when the import job ended.
error
In case of error in the import job, standard API error is returned here.
result
File object that was imported.
new()
Create a new Import object.
Import$new(res = NA, ...)
res
Response containing Import object information.
...
Other response arguments.
print()
Print method for Import class.
Import$print()
\dontrun{ # x is API response when import is requested import_object <- Import$new( res = x, href = x$href, auth = auth, response = attr(x, "response") ) # Print import object import_object$print() }
reload()
Reload Import object information.
Import$reload(...)
...
Other arguments that can be passed to core api()
function
like 'fields', etc.
Import
object.
\dontrun{ # x is API response when import is requested import_object <- Import$new( res = x, href = x$href, auth = auth, response = attr(x, "response") ) # Reload import object import_object$reload() }
clone()
The objects of this class are cloneable with this method.
Import$clone(deep = FALSE)
deep
Whether to make a deep clone.
## ------------------------------------------------
## Method `Import$print`
## ------------------------------------------------
## Not run:
# x is API response when import is requested
import_object <- Import$new(
res = x,
href = x$href,
auth = auth,
response = attr(x, "response")
)
# Print import object
import_object$print()
## End(Not run)
## ------------------------------------------------
## Method `Import$reload`
## ------------------------------------------------
## Not run:
# x is API response when import is requested
import_object <- Import$new(
res = x,
href = x$href,
auth = auth,
response = attr(x, "response")
)
# Reload import object
import_object$reload()
## End(Not run)