ApiHost (Cloudera Manager API (5.12.0))

java.lang.Object
- com.cloudera.api.model.ApiHost

```
public class ApiHost
extends Object
```
This is the model for a host in the system.

Constructor Summary

Constructors
Constructor and Description

ApiHost()

ApiHost(ApiHost host)
Copy constructor

Constructors
Constructor and Description
`ApiHost()`
`ApiHost(ApiHost host)` Copy constructor

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`ApiClusterRef`	`getClusterRef()` Readonly.
`ApiCommissionState`	`getCommissionState()` Readonly.
`ApiConfigList`	`getConfig()`
`ApiEntityStatus`	`getEntityStatus()` Readonly.
`List<ApiHealthCheck>`	`getHealthChecks()` Readonly.
`ApiHealthSummary`	`getHealthSummary()` Readonly.
`String`	`getHostId()` A unique host identifier.
`String`	`getHostname()` The hostname.
`String`	`getHostUrl()` Readonly.
`String`	`getIpAddress()` The host IP address.
`Date`	`getLastHeartbeat()` Readonly.
`Boolean`	`getMaintenanceMode()` Readonly.
`List<ApiEntityType>`	`getMaintenanceOwners()` Readonly.
`Long`	`getNumCores()` Readonly.
`Long`	`getNumPhysicalCores()` Readonly.
`String`	`getRackId()` The rack ID for this host.
`List<ApiRoleRef>`	`getRoleRefs()` Readonly.
`Long`	`getTotalPhysMemBytes()` Readonly.
`int`	`hashCode()`
`void`	`setClusterRef(ApiClusterRef clusterRef)`
`void`	`setCommissionState(ApiCommissionState commissionState)`
`void`	`setConfig(ApiConfigList config)`
`void`	`setEntityStatus(ApiEntityStatus entityStatus)`
`void`	`setHealthChecks(List<ApiHealthCheck> healthChecks)`
`void`	`setHealthSummary(ApiHealthSummary healthSummary)`
`void`	`setHostId(String hostId)`
`void`	`setHostname(String hostname)`
`void`	`setHostUrl(String hostUrl)`
`void`	`setIpAddress(String ipAddress)`
`void`	`setLastHeartbeat(Date lastHeartbeat)`
`void`	`setMaintenanceMode(Boolean maintenanceMode)`
`void`	`setMaintenanceOwners(List<ApiEntityType> maintenanceOwners)`
`void`	`setNumCores(Long numCores)`
`void`	`setNumPhysicalCores(Long numCores)`
`void`	`setRackId(String rackId)`
`void`	`setRoleRefs(List<ApiRoleRef> roleRefs)`
`void`	`setTotalPhysMemBytes(Long totalPhysMemBytes)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ApiHost
```
public ApiHost()
```
  - ApiHost
```
public ApiHost(ApiHost host)
```
    Copy constructor
    
    Parameters:
    host - The host to copy
- 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
  - getHostId
```
public String getHostId()
```
    A unique host identifier. This is not the same as the hostname (FQDN). It is a distinct value that remains the same even if the hostname changes.
  - setHostId
```
public void setHostId(String hostId)
```
  - getIpAddress
```
public String getIpAddress()
```
    The host IP address. This field is not mutable after the initial creation.
  - setIpAddress
```
public void setIpAddress(String ipAddress)
```
  - getHostname
```
public String getHostname()
```
    The hostname. This field is not mutable after the initial creation.
  - setHostname
```
public void setHostname(String hostname)
```
  - getRackId
```
public String getRackId()
```
    The rack ID for this host.
  - setRackId
```
public void setRackId(String rackId)
```
  - getLastHeartbeat
```
public Date getLastHeartbeat()
```
    Readonly. Requires "full" view. When the host agent sent the last heartbeat.
  - setLastHeartbeat
```
public void setLastHeartbeat(Date lastHeartbeat)
```
  - getRoleRefs
```
public List<ApiRoleRef> getRoleRefs()
```
    Readonly. Requires "full" view. The list of roles assigned to this host.
  - setRoleRefs
```
public void setRoleRefs(List<ApiRoleRef> roleRefs)
```
  - getHealthSummary
```
public ApiHealthSummary getHealthSummary()
```
    Readonly. Requires "full" view. The high-level health status of this host.
  - setHealthSummary
```
public void setHealthSummary(ApiHealthSummary healthSummary)
```
  - getHealthChecks
```
public List<ApiHealthCheck> getHealthChecks()
```
    Readonly. Requires "full" view. The list of health checks performed on the host, with their results.
  - setHealthChecks
```
public void setHealthChecks(List<ApiHealthCheck> healthChecks)
```
  - getHostUrl
```
public String getHostUrl()
```
    Readonly. A URL into the Cloudera Manager web UI for this specific host.
  - setHostUrl
```
public void setHostUrl(String hostUrl)
```
  - getMaintenanceMode
```
public Boolean getMaintenanceMode()
```
    Readonly. Whether the host is in maintenance mode. Available since API v2.
  - setMaintenanceMode
```
public void setMaintenanceMode(Boolean maintenanceMode)
```
  - getCommissionState
```
public ApiCommissionState getCommissionState()
```
    Readonly. The commission state of this role. Available since API v2.
  - setCommissionState
```
public void setCommissionState(ApiCommissionState commissionState)
```
  - getMaintenanceOwners
```
public List<ApiEntityType> getMaintenanceOwners()
```
    Readonly. The list of objects that trigger this host to be in maintenance mode. Available since API v2.
  - setMaintenanceOwners
```
public void setMaintenanceOwners(List<ApiEntityType> maintenanceOwners)
```
  - getConfig
```
public ApiConfigList getConfig()
```
  - setConfig
```
public void setConfig(ApiConfigList config)
```
  - getNumCores
```
public Long getNumCores()
```
    Readonly. The number of logical CPU cores on this host. Only populated after the host has heartbeated to the server. Available since API v4.
  - setNumCores
```
public void setNumCores(Long numCores)
```
  - getNumPhysicalCores
```
public Long getNumPhysicalCores()
```
    Readonly. The number of physical CPU cores on this host. Only populated after the host has heartbeated to the server. Available since API v9.
  - setNumPhysicalCores
```
public void setNumPhysicalCores(Long numCores)
```
  - getTotalPhysMemBytes
```
public Long getTotalPhysMemBytes()
```
    Readonly. The amount of physical RAM on this host, in bytes. Only populated after the host has heartbeated to the server. Available since API v4.
  - setTotalPhysMemBytes
```
public void setTotalPhysMemBytes(Long totalPhysMemBytes)
```
  - getEntityStatus
```
public ApiEntityStatus getEntityStatus()
```
    Readonly. The entity status for this host. Available since API v11.
  - setEntityStatus
```
public void setEntityStatus(ApiEntityStatus entityStatus)
```
  - getClusterRef
```
public ApiClusterRef getClusterRef()
```
    Readonly. A reference to the enclosing cluster. This might be null if the host is not yet assigned to a cluster. Available since API v11.
  - setClusterRef
```
public void setClusterRef(ApiClusterRef clusterRef)
```

Class ApiHost

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiHost

ApiHost

Method Detail

toString

equals

hashCode

getHostId

setHostId

getIpAddress

setIpAddress

getHostname

setHostname

getRackId

setRackId

getLastHeartbeat

setLastHeartbeat

getRoleRefs

setRoleRefs

getHealthSummary

setHealthSummary

getHealthChecks

setHealthChecks

getHostUrl

setHostUrl

getMaintenanceMode

setMaintenanceMode

getCommissionState

setCommissionState

getMaintenanceOwners

setMaintenanceOwners

getConfig

setConfig

getNumCores

setNumCores

getNumPhysicalCores

setNumPhysicalCores

getTotalPhysMemBytes

setTotalPhysMemBytes

getEntityStatus

setEntityStatus

getClusterRef

setClusterRef