com.cloudera.api.model

Class ApiParcel

java.lang.Object

com.cloudera.api.model.ApiParcel

public class ApiParcel
extends Object

A Parcel encapsulate a specific product and version. For example, (CDH 4.1). A parcel is downloaded, distributed to all the machines of a cluster and then allowed to be activated.

> The available parcels are determined by which cluster they will be running on. For example, a SLES parcel won't show up for a RHEL cluster.

Constructor Summary

Constructors

Constructor and Description
ApiParcel()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
ApiClusterRef	getClusterRef() Readonly.
String	getProduct() The name of the product, e.g.
String	getStage() Returns the current stage of the parcel.
ApiParcelState	getState() The state of the parcel.
String	getVersion() The version of the product, e.g.
int	hashCode()
void	setClusterRef(ApiClusterRef clusterRef)
void	setProduct(String product)
void	setStage(String stage)
void	setState(ApiParcelState state)
void	setVersion(String version)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApiParcel

public ApiParcel()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getProduct

public String getProduct()

The name of the product, e.g. CDH, Impala

setProduct

public void setProduct(String product)

getVersion

public String getVersion()

The version of the product, e.g. 1.1.0, 2.3.0.

setVersion

public void setVersion(String version)

getStage

public String getStage()

Returns the current stage of the parcel.

There are a number of stages a parcel can be in. There are two types of stages - stable and transient. A parcel is in a transient stage when it is transitioning between two stable stages. The stages are listed below with some additional information.

• AVAILABLE_REMOTELY: Stable stage - the parcel can be downloaded to the server.
• DOWNLOADING: Transient stage - the parcel is in the process of being downloaded to the server.
• DOWNLOADED: Stable stage - the parcel is downloaded and ready to be distributed or removed from the server.
• DISTRIBUTING: Transient stage - the parcel is being sent to all the hosts in the cluster.
• DISTRIBUTED: Stable stage - the parcel is on all the hosts in the cluster. The parcel can now be activated, or removed from all the hosts.
• UNDISTRIBUTING: Transient stage - the parcel is being removed from all the hosts in the cluster>
• ACTIVATING: Transient stage - the parcel is being activated on the hosts in the cluster. New in API v7
• ACTIVATED: Steady stage - the parcel is set to active on every host in the cluster. If desired, a parcel can be deactivated from this stage.

setStage

public void setStage(String stage)

getState

public ApiParcelState getState()

The state of the parcel. This shows the progress of state transitions and if there were any errors.

setState

public void setState(ApiParcelState state)

getClusterRef

public ApiClusterRef getClusterRef()

Readonly. A reference to the enclosing cluster.

setClusterRef

public void setClusterRef(ApiClusterRef clusterRef)