DescribeEnvironmentHealthResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentHealthResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeEnvironmentHealthResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Health details for an AWS Elastic Beanstalk environment.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeEnvironmentHealthResult()

Constructors
Constructor and Description
`DescribeEnvironmentHealthResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeEnvironmentHealthResult`	`clone()`
`boolean`	`equals(Object obj)`
`ApplicationMetrics`	`getApplicationMetrics()` Application request metrics for the environment.
`List<String>`	`getCauses()` Descriptions of the data that contributed to the environment's current health status.
`String`	`getColor()` The health color of the environment.
`String`	`getEnvironmentName()` The environment's name.
`String`	`getHealthStatus()` The health status of the environment.
`InstanceHealthSummary`	`getInstancesHealth()` Summary health information for the instances in the environment.
`Date`	`getRefreshedAt()` The date and time that the health information was retrieved.
`String`	`getStatus()` The environment's operational status.
`int`	`hashCode()`
`void`	`setApplicationMetrics(ApplicationMetrics applicationMetrics)` Application request metrics for the environment.
`void`	`setCauses(Collection<String> causes)` Descriptions of the data that contributed to the environment's current health status.
`void`	`setColor(String color)` The health color of the environment.
`void`	`setEnvironmentName(String environmentName)` The environment's name.
`void`	`setHealthStatus(String healthStatus)` The health status of the environment.
`void`	`setInstancesHealth(InstanceHealthSummary instancesHealth)` Summary health information for the instances in the environment.
`void`	`setRefreshedAt(Date refreshedAt)` The date and time that the health information was retrieved.
`void`	`setStatus(EnvironmentHealth status)` The environment's operational status.
`void`	`setStatus(String status)` The environment's operational status.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeEnvironmentHealthResult`	`withApplicationMetrics(ApplicationMetrics applicationMetrics)` Application request metrics for the environment.
`DescribeEnvironmentHealthResult`	`withCauses(Collection<String> causes)` Descriptions of the data that contributed to the environment's current health status.
`DescribeEnvironmentHealthResult`	`withCauses(String... causes)` Descriptions of the data that contributed to the environment's current health status.
`DescribeEnvironmentHealthResult`	`withColor(String color)` The health color of the environment.
`DescribeEnvironmentHealthResult`	`withEnvironmentName(String environmentName)` The environment's name.
`DescribeEnvironmentHealthResult`	`withHealthStatus(String healthStatus)` The health status of the environment.
`DescribeEnvironmentHealthResult`	`withInstancesHealth(InstanceHealthSummary instancesHealth)` Summary health information for the instances in the environment.
`DescribeEnvironmentHealthResult`	`withRefreshedAt(Date refreshedAt)` The date and time that the health information was retrieved.
`DescribeEnvironmentHealthResult`	`withStatus(EnvironmentHealth status)` The environment's operational status.
`DescribeEnvironmentHealthResult`	`withStatus(String status)` The environment's operational status.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - DescribeEnvironmentHealthResult
```
public DescribeEnvironmentHealthResult()
```
- Method Detail
  - setEnvironmentName
```
public void setEnvironmentName(String environmentName)
```
    The environment's name.
    
    Parameters:
    
    environmentName - The environment's name.
  - getEnvironmentName
```
public String getEnvironmentName()
```
    The environment's name.
    
    Returns:
    
    The environment's name.
  - withEnvironmentName
```
public DescribeEnvironmentHealthResult withEnvironmentName(String environmentName)
```
    The environment's name.
    
    Parameters:
    
    environmentName - The environment's name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHealthStatus
```
public void setHealthStatus(String healthStatus)
```
    The health status of the environment. For example, Ok.
    
    Parameters:
    
    healthStatus - The health status of the environment. For example, Ok.
  - getHealthStatus
```
public String getHealthStatus()
```
    The health status of the environment. For example, Ok.
    
    Returns:
    
    The health status of the environment. For example, Ok.
  - withHealthStatus
```
public DescribeEnvironmentHealthResult withHealthStatus(String healthStatus)
```
    The health status of the environment. For example, Ok.
    
    Parameters:
    
    healthStatus - The health status of the environment. For example, Ok.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
    
    Parameters:
    
    status - The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
    
    See Also:
    
    EnvironmentHealth
  - getStatus
```
public String getStatus()
```
    The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
    
    Returns:
    
    The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
    
    See Also:
    
    EnvironmentHealth
  - withStatus
```
public DescribeEnvironmentHealthResult withStatus(String status)
```
    The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
    
    Parameters:
    
    status - The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EnvironmentHealth
  - setStatus
```
public void setStatus(EnvironmentHealth status)
```
    The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
    
    Parameters:
    
    status - The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
    
    See Also:
    
    EnvironmentHealth
  - withStatus
```
public DescribeEnvironmentHealthResult withStatus(EnvironmentHealth status)
```
    The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
    
    Parameters:
    
    status - The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EnvironmentHealth
  - setColor
```
public void setColor(String color)
```
    The health color of the environment.
    
    Parameters:
    
    color - The health color of the environment.
  - getColor
```
public String getColor()
```
    The health color of the environment.
    
    Returns:
    
    The health color of the environment.
  - withColor
```
public DescribeEnvironmentHealthResult withColor(String color)
```
    The health color of the environment.
    
    Parameters:
    
    color - The health color of the environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCauses
```
public List<String> getCauses()
```
    Descriptions of the data that contributed to the environment's current health status.
    
    Returns:
    
    Descriptions of the data that contributed to the environment's current health status.
  - setCauses
```
public void setCauses(Collection<String> causes)
```
    Descriptions of the data that contributed to the environment's current health status.
    
    Parameters:
    
    causes - Descriptions of the data that contributed to the environment's current health status.
  - withCauses
```
public DescribeEnvironmentHealthResult withCauses(String... causes)
```
    Descriptions of the data that contributed to the environment's current health status.
    
    NOTE: This method appends the values to the existing list (if any). Use setCauses(java.util.Collection) or withCauses(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    causes - Descriptions of the data that contributed to the environment's current health status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCauses
```
public DescribeEnvironmentHealthResult withCauses(Collection<String> causes)
```
    Descriptions of the data that contributed to the environment's current health status.
    
    Parameters:
    
    causes - Descriptions of the data that contributed to the environment's current health status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApplicationMetrics
```
public void setApplicationMetrics(ApplicationMetrics applicationMetrics)
```
    Application request metrics for the environment.
    
    Parameters:
    
    applicationMetrics - Application request metrics for the environment.
  - getApplicationMetrics
```
public ApplicationMetrics getApplicationMetrics()
```
    Application request metrics for the environment.
    
    Returns:
    
    Application request metrics for the environment.
  - withApplicationMetrics
```
public DescribeEnvironmentHealthResult withApplicationMetrics(ApplicationMetrics applicationMetrics)
```
    Application request metrics for the environment.
    
    Parameters:
    
    applicationMetrics - Application request metrics for the environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstancesHealth
```
public void setInstancesHealth(InstanceHealthSummary instancesHealth)
```
    Summary health information for the instances in the environment.
    
    Parameters:
    
    instancesHealth - Summary health information for the instances in the environment.
  - getInstancesHealth
```
public InstanceHealthSummary getInstancesHealth()
```
    Summary health information for the instances in the environment.
    
    Returns:
    
    Summary health information for the instances in the environment.
  - withInstancesHealth
```
public DescribeEnvironmentHealthResult withInstancesHealth(InstanceHealthSummary instancesHealth)
```
    Summary health information for the instances in the environment.
    
    Parameters:
    
    instancesHealth - Summary health information for the instances in the environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRefreshedAt
```
public void setRefreshedAt(Date refreshedAt)
```
    The date and time that the health information was retrieved.
    
    Parameters:
    
    refreshedAt - The date and time that the health information was retrieved.
  - getRefreshedAt
```
public Date getRefreshedAt()
```
    The date and time that the health information was retrieved.
    
    Returns:
    
    The date and time that the health information was retrieved.
  - withRefreshedAt
```
public DescribeEnvironmentHealthResult withRefreshedAt(Date refreshedAt)
```
    The date and time that the health information was retrieved.
    
    Parameters:
    
    refreshedAt - The date and time that the health information was retrieved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeEnvironmentHealthResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeEnvironmentHealthResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeEnvironmentHealthResult

Method Detail

setEnvironmentName

getEnvironmentName

withEnvironmentName

setHealthStatus

getHealthStatus

withHealthStatus

setStatus

getStatus

withStatus

setStatus

withStatus

setColor

getColor

withColor

getCauses

setCauses

withCauses

withCauses

setApplicationMetrics

getApplicationMetrics

withApplicationMetrics

setInstancesHealth

getInstancesHealth

withInstancesHealth

setRefreshedAt

getRefreshedAt

withRefreshedAt

toString

equals

hashCode

clone