ApiService (Cloudera Manager API (5.12.0))

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

```
public class ApiService
extends Object
```
A service (such as HDFS, MapReduce, HBase) runs in a cluster. It has roles, which are the actual entities (NameNode, DataNodes, etc.) that perform the service's functions.
HDFS services and health checks
In CDH4, HDFS services may not present any health checks. This will happen if the service has more than one nameservice configured. In those cases, the health information will be available by fetching information about the nameservices instead.
The health summary is still available, and reflects a service-wide summary.

Constructor Summary

Constructors
Constructor and Description

ApiService()

Constructors
Constructor and Description
`ApiService()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`ApiConfigStalenessStatus`	`getClientConfigStalenessStatus()` Readonly.
`ApiClusterRef`	`getClusterRef()` Readonly.
`ApiServiceConfig`	`getConfig()` Configuration of the service being created.
`Boolean`	`getConfigStale()` Deprecated. Use configStalenessStatus instead which exposes more staleness state. Deprecated since V6.
`ApiConfigStalenessStatus`	`getConfigStalenessStatus()` Readonly.
`String`	`getDisplayName()` The display name for the service that is shown in the UI.
`ApiEntityStatus`	`getEntityStatus()` Readonly.
`List<ApiHealthCheck>`	`getHealthChecks()` Readonly.
`ApiHealthSummary`	`getHealthSummary()` Readonly.
`Boolean`	`getMaintenanceMode()` Readonly.
`List<ApiEntityType>`	`getMaintenanceOwners()` Readonly.
`String`	`getName()` The name of the service.
`List<ApiReplicationSchedule>`	`getReplicationSchedules()` The list of replication schedules for this service.
`List<ApiRoleConfigGroup>`	`getRoleConfigGroups()` The list of role configuration groups in this service.
`String`	`getRoleInstancesUrl()` Readonly.
`List<ApiRole>`	`getRoles()` The list of service roles.
`ApiServiceState`	`getServiceState()` Readonly.
`String`	`getServiceUrl()` Readonly.
`List<ApiSnapshotPolicy>`	`getSnapshotPolicies()` The list of snapshot policies for this service.
`String`	`getType()` The type of the service, e.g.
`int`	`hashCode()`
`void`	`setClientConfigStalenessStatus(ApiConfigStalenessStatus clientConfigStalenessStatus)`
`void`	`setClusterRef(ApiClusterRef clusterRef)`
`void`	`setConfig(ApiServiceConfig config)`
`void`	`setConfigStale(Boolean configStale)`
`void`	`setConfigStalenessStatus(ApiConfigStalenessStatus configStalenessStatus)`
`void`	`setDisplayName(String displayName)`
`void`	`setEntityStatus(ApiEntityStatus entityStatus)`
`void`	`setHealthChecks(List<ApiHealthCheck> healthChecks)`
`void`	`setHealthSummary(ApiHealthSummary healthSummary)`
`void`	`setMaintenanceMode(Boolean maintenanceMode)`
`void`	`setMaintenanceOwners(List<ApiEntityType> maintenanceOwners)`
`void`	`setName(String name)`
`void`	`setReplicationSchedules(List<ApiReplicationSchedule> replicationSchedules)`
`void`	`setRoleConfigGroups(List<ApiRoleConfigGroup> roleConfigGroups)`
`void`	`setRoleInstancesUrl(String roleInstancesUrl)`
`void`	`setRoles(List<ApiRole> roles)`
`void`	`setServiceState(ApiServiceState serviceState)`
`void`	`setServiceUrl(String serviceUrl)`
`void`	`setSnapshotPolicies(List<ApiSnapshotPolicy> snapshotPolicies)`
`void`	`setType(String type)`
`String`	`toString()`

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

- Constructor Detail
  - ApiService
```
public ApiService()
```
- 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 service.
  - setName
```
public void setName(String name)
```
  - getType
```
public String getType()
```
    The type of the service, e.g. HDFS, MAPREDUCE, HBASE.
  - setType
```
public void setType(String type)
```
  - getClusterRef
```
public ApiClusterRef getClusterRef()
```
    Readonly. A reference to the enclosing cluster.
  - setClusterRef
```
public void setClusterRef(ApiClusterRef clusterRef)
```
  - getServiceState
```
public ApiServiceState getServiceState()
```
    Readonly. The configured run state of this service. Whether it's running, etc.
  - setServiceState
```
public void setServiceState(ApiServiceState serviceState)
```
  - getHealthSummary
```
public ApiHealthSummary getHealthSummary()
```
    Readonly. The high-level health status of this service.
  - setHealthSummary
```
public void setHealthSummary(ApiHealthSummary healthSummary)
```
  - getConfigStale
```
@Deprecated
public Boolean getConfigStale()
```
    Deprecated. Use configStalenessStatus instead which exposes more staleness state. Deprecated since V6.
    
    Readonly. Expresses whether the service configuration is stale.
  - setConfigStale
```
public void setConfigStale(Boolean configStale)
```
  - getConfigStalenessStatus
```
public ApiConfigStalenessStatus getConfigStalenessStatus()
```
    Readonly. Expresses the service's configuration staleness status which is based on the staleness status of its roles. Available since API v6.
  - setConfigStalenessStatus
```
public void setConfigStalenessStatus(ApiConfigStalenessStatus configStalenessStatus)
```
  - getClientConfigStalenessStatus
```
public ApiConfigStalenessStatus getClientConfigStalenessStatus()
```
    Readonly. Expresses the service's client configuration staleness status which is marked as stale if any of the service's hosts have missing client configurations or if any of the deployed client configurations are stale. Available since API v6.
  - setClientConfigStalenessStatus
```
public void setClientConfigStalenessStatus(ApiConfigStalenessStatus clientConfigStalenessStatus)
```
  - getHealthChecks
```
public List<ApiHealthCheck> getHealthChecks()
```
    Readonly. The list of health checks of this service.
  - setHealthChecks
```
public void setHealthChecks(List<ApiHealthCheck> healthChecks)
```
  - getServiceUrl
```
public String getServiceUrl()
```
    Readonly. Link into the Cloudera Manager web UI for this specific service.
  - setServiceUrl
```
public void setServiceUrl(String serviceUrl)
```
  - getRoleInstancesUrl
```
public String getRoleInstancesUrl()
```
    Readonly. Link into the Cloudera Manager web UI for role instances table for this specific service. Available since API v11.
  - setRoleInstancesUrl
```
public void setRoleInstancesUrl(String roleInstancesUrl)
```
  - getMaintenanceMode
```
public Boolean getMaintenanceMode()
```
    Readonly. Whether the service 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 service to be in maintenance mode. Available since API v2.
  - setMaintenanceOwners
```
public void setMaintenanceOwners(List<ApiEntityType> maintenanceOwners)
```
  - getConfig
```
public ApiServiceConfig getConfig()
```
    Configuration of the service being created. Optional.
  - setConfig
```
public void setConfig(ApiServiceConfig config)
```
  - getRoles
```
public List<ApiRole> getRoles()
```
    The list of service roles. Optional.
  - setRoles
```
public void setRoles(List<ApiRole> roles)
```
  - getDisplayName
```
public String getDisplayName()
```
    The display name for the service that is shown in the UI. Available since API v2.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
  - getRoleConfigGroups
```
public List<ApiRoleConfigGroup> getRoleConfigGroups()
```
    The list of role configuration groups in this service. Optional. Available since API v3.
  - setRoleConfigGroups
```
public void setRoleConfigGroups(List<ApiRoleConfigGroup> roleConfigGroups)
```
  - getReplicationSchedules
```
public List<ApiReplicationSchedule> getReplicationSchedules()
```
    The list of replication schedules for this service. Optional. Available since API v6.
  - setReplicationSchedules
```
public void setReplicationSchedules(List<ApiReplicationSchedule> replicationSchedules)
```
  - getSnapshotPolicies
```
public List<ApiSnapshotPolicy> getSnapshotPolicies()
```
    The list of snapshot policies for this service. Optional. Available since API v6.
  - setSnapshotPolicies
```
public void setSnapshotPolicies(List<ApiSnapshotPolicy> snapshotPolicies)
```
  - getEntityStatus
```
public ApiEntityStatus getEntityStatus()
```
    Readonly. The entity status for this service. Available since API v11.
  - setEntityStatus
```
public void setEntityStatus(ApiEntityStatus entityStatus)
```

Class ApiService

HDFS services and health checks

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiService

Method Detail

toString

equals

hashCode

getName

setName

getType

setType

getClusterRef

setClusterRef

getServiceState

setServiceState

getHealthSummary

setHealthSummary

getConfigStale

setConfigStale

getConfigStalenessStatus

setConfigStalenessStatus

getClientConfigStalenessStatus

setClientConfigStalenessStatus

getHealthChecks

setHealthChecks

getServiceUrl

setServiceUrl

getRoleInstancesUrl

setRoleInstancesUrl

getMaintenanceMode

setMaintenanceMode

getMaintenanceOwners

setMaintenanceOwners

getConfig

setConfig

getRoles

setRoles

getDisplayName

setDisplayName

getRoleConfigGroups

setRoleConfigGroups

getReplicationSchedules

setReplicationSchedules

getSnapshotPolicies

setSnapshotPolicies

getEntityStatus

setEntityStatus