ParcelResource (Cloudera Manager API (5.12.0))

```
public interface ParcelResource
```
This interface describes a parcel resource and all the operations that can be performed on it. All the commands in this resource are modeled as follows: When you execute a command, for example startDownload, that command simply starts the download and returns right away. This is why they are labeled as a synchronous commands. In order to see the progress of the command a call to 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

Method Summary

Methods
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.

- Method Detail
  - readParcel
```
@Path(value="/")
ApiParcel readParcel()
```
    Retrieves detailed information about a parcel.
    
    Returns:
    the parcel
  - startDownloadCommand
```
@Path(value="/commands/startDownload")
ApiCommand startDownloadCommand()
```
    A synchronous command that starts the parcel download.
    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.
    
    Returns:
    synchronous command result
  - cancelDownloadCommand
```
@Path(value="/commands/cancelDownload")
ApiCommand cancelDownloadCommand()
```
    A synchronous command that cancels the parcel download.
    Since it is synchronous, the result is known immediately upon return.
    
    Returns:
    synchronous command result
  - removeDownloadCommand
```
@Path(value="/commands/removeDownload")
ApiCommand removeDownloadCommand()
```
    A synchronous command that removes the downloaded parcel.
    Since it is synchronous, the result is known immediately upon return.
    
    Returns:
    synchronous command result
  - startDistributionCommand
```
@Path(value="/commands/startDistribution")
ApiCommand startDistributionCommand()
```
    A synchronous command that starts the distribution of the parcel to the cluster.
    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.
    
    Returns:
    synchronous command result
  - cancelDistributionCommand
```
@Path(value="/commands/cancelDistribution")
ApiCommand cancelDistributionCommand()
```
    A synchronous command that cancels the parcel distribution.
    Since it is synchronous, the result is known immediately upon return.
    
    Returns:
    synchronous command result
  - startRemovalOfDistributionCommand
```
@Path(value="/commands/startRemovalOfDistribution")
ApiCommand startRemovalOfDistributionCommand()
```
    A synchronous command that removes the distribution from the hosts in the cluster.
    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.
    
    Returns:
    synchronous command result
  - activateCommand
```
@Path(value="/commands/activate")
ApiCommand activateCommand()
```
    A synchronous command that activates the parcel on the cluster.
    Since it is synchronous, the result is known immediately upon return.
    
    Returns:
    synchronous command result
  - deactivateCommand
```
@Path(value="/commands/deactivate")
ApiCommand deactivateCommand()
```
    A synchronous command that deactivates the parcel on the cluster.
    Since it is synchronous, the result is known immediately upon return.
    
    Returns:
    synchronous command result

Interface ParcelResource

Method Summary

Method Detail

readParcel

startDownloadCommand

cancelDownloadCommand

removeDownloadCommand

startDistributionCommand

cancelDistributionCommand

startRemovalOfDistributionCommand

activateCommand

deactivateCommand