com.cloudera.api.model
Class ApiCluster

java.lang.Object
  extended by com.cloudera.api.model.ApiCluster

public class ApiCluster
extends Object

A cluster represents a set of interdependent services running on a set of hosts. All services on a given cluster are of the same software version (e.g. CDH4 or CDH5).


Constructor Summary
ApiCluster()
           
 
Method Summary
 boolean equals(Object o)
           
 String getClusterUrl()
          Readonly.
 String getDisplayName()
          The display name of the cluster that is shown in the UI.
 ApiEntityStatus getEntityStatus()
          Readonly.
 String getFullVersion()
          The full CDH version of the cluster.
 String getHostsUrl()
          Readonly.
 Boolean getMaintenanceMode()
          Readonly.
 List<ApiEntityType> getMaintenanceOwners()
          Readonly.
 String getName()
          The name of the cluster.
 List<ApiParcel> getParcels()
          Optional.
 List<ApiService> getServices()
          Optional.
 String getUuid()
          Readonly.
 ApiClusterVersion getVersion()
          Deprecated. 
 int hashCode()
           
 void setClusterUrl(String clusterUrl)
           
 void setDisplayName(String displayName)
           
 void setEntityStatus(ApiEntityStatus entityStatus)
           
 void setFullVersion(String fullVersion)
           
 void setHostsUrl(String hostsUrl)
           
 void setMaintenanceMode(Boolean maintenanceMode)
           
 void setMaintenanceOwners(List<ApiEntityType> maintenanceOwners)
           
 void setName(String name)
           
 void setParcels(List<ApiParcel> parcels)
           
 void setServices(List<ApiService> services)
           
 void setUuid(String uuid)
           
 void setVersion(ApiClusterVersion version)
          Deprecated. 
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ApiCluster

public ApiCluster()
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

getName

public String getName()
The name of the cluster.

Immutable since API v6.

Prior to API v6, will contain the display name of the cluster.


setName

public void setName(String name)

getDisplayName

public String getDisplayName()
The display name of the cluster that is shown in the UI.

Available since API v6.


setDisplayName

public void setDisplayName(String displayName)

getUuid

public String getUuid()
Readonly. The UUID of the cluster.

Available since API v15.


setUuid

public void setUuid(String uuid)

getClusterUrl

public String getClusterUrl()
Readonly. Link into the Cloudera Manager web UI for this specific cluster.

Available since API v10.


setClusterUrl

public void setClusterUrl(String clusterUrl)

getHostsUrl

public String getHostsUrl()
Readonly. Link into the Cloudera Manager web UI for host table for this cluster.

Available since API v11.


setHostsUrl

public void setHostsUrl(String hostsUrl)

getVersion

@Deprecated
public ApiClusterVersion getVersion()
Deprecated. 

The CDH version of the cluster.


setVersion

@Deprecated
public void setVersion(ApiClusterVersion version)
Deprecated. 


getFullVersion

public String getFullVersion()
The full CDH version of the cluster. The expected format is three dot separated version numbers, e.g. "4.2.1" or "5.0.0". The full version takes precedence over the version field during cluster creation.

Available since API v6.


setFullVersion

public void setFullVersion(String fullVersion)

getMaintenanceMode

public Boolean getMaintenanceMode()
Readonly. Whether the cluster is in maintenance mode. Available since API v2.


setMaintenanceMode

public void setMaintenanceMode(Boolean maintenanceMode)

getMaintenanceOwners

public List<ApiEntityType> getMaintenanceOwners()
Readonly. The list of objects that trigger this cluster to be in maintenance mode. Available since API v2.


setMaintenanceOwners

public void setMaintenanceOwners(List<ApiEntityType> maintenanceOwners)

getServices

public List<ApiService> getServices()
Optional. Used during import/export of settings.


setServices

public void setServices(List<ApiService> services)

getParcels

public List<ApiParcel> getParcels()
Optional. Used during import/export of settings. Available since API v4.


setParcels

public void setParcels(List<ApiParcel> parcels)

getEntityStatus

public ApiEntityStatus getEntityStatus()
Readonly. The entity status for this cluster. Available since API v11.


setEntityStatus

public void setEntityStatus(ApiEntityStatus entityStatus)


Copyright © Cloudera, Inc. Released under Apache License, Version 2.0.