public interface ParcelResource
readParcel()
needs to be made. This will
show the current stage and any progress information if the parcel is in a
transition stage. Eg. DOWNLOADING, DISTRIBUTING etc.
If the command for some reason could not execute properly, an error
is returned to the user as part of the synchronous command.
A Parcel goes through many stages during its lifecycle. The various stages
and their order is described on in ApiParcel
Modifier and Type | Method and Description |
---|---|
ApiCommand |
activateCommand()
A synchronous command that activates the parcel on the cluster.
|
ApiCommand |
cancelDistributionCommand()
A synchronous command that cancels the parcel distribution.
|
ApiCommand |
cancelDownloadCommand()
A synchronous command that cancels the parcel download.
|
ApiCommand |
deactivateCommand()
A synchronous command that deactivates the parcel on the cluster.
|
ApiParcel |
readParcel()
Retrieves detailed information about a parcel.
|
ApiCommand |
removeDownloadCommand()
A synchronous command that removes the downloaded parcel.
|
ApiCommand |
startDistributionCommand()
A synchronous command that starts the distribution of the parcel
to the cluster.
|
ApiCommand |
startDownloadCommand()
A synchronous command that starts the parcel download.
|
ApiCommand |
startRemovalOfDistributionCommand()
A synchronous command that removes the distribution from the hosts in
the cluster.
|
ApiParcel readParcel()
ApiCommand startDownloadCommand()
Since it is synchronous, the result is known immediately upon return.
In order to see the progress of the download, a call
to readParcel()
needs to be made.
ApiCommand cancelDownloadCommand()
Since it is synchronous, the result is known immediately upon return.
IllegalArgumentException
- if parcel is not in the DOWNLOADING stateApiCommand removeDownloadCommand()
Since it is synchronous, the result is known immediately upon return.
ApiCommand startDistributionCommand()
Since it is synchronous, the result is known immediately upon return.
In order to see the progress of the distribution, a call
to readParcel()
needs to be made.
ApiCommand cancelDistributionCommand()
Since it is synchronous, the result is known immediately upon return.
IllegalArgumentException
- if parcel is not in the DISTRIBUTING stateApiCommand startRemovalOfDistributionCommand()
Since it is synchronous, the result is known immediately upon return.
In order to see the progress of the removal, a call
to readParcel()
needs to be made.
ApiCommand activateCommand()
Since it is synchronous, the result is known immediately upon return.
ApiCommand deactivateCommand()
Since it is synchronous, the result is known immediately upon return.
Copyright © Cloudera, Inc. Released under Apache License, Version 2.0.