Class DescribeEnvironmentHealthRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentHealthRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class DescribeEnvironmentHealthRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

See the example below to learn how to create a request body.

See Also:
  • Constructor Details

    • DescribeEnvironmentHealthRequest

      public DescribeEnvironmentHealthRequest()
  • Method Details

    • setEnvironmentName

      public void setEnvironmentName(String environmentName)

      Specifies the AWS Elastic Beanstalk environment name.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

      Parameters:
      environmentName - Specifies the AWS Elastic Beanstalk environment name.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • getEnvironmentName

      public String getEnvironmentName()

      Specifies the AWS Elastic Beanstalk environment name.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

      Returns:
      Specifies the AWS Elastic Beanstalk environment name.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • withEnvironmentName

      public DescribeEnvironmentHealthRequest withEnvironmentName(String environmentName)

      Specifies the AWS Elastic Beanstalk environment name.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

      Parameters:
      environmentName - Specifies the AWS Elastic Beanstalk environment name.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setEnvironmentId

      public void setEnvironmentId(String environmentId)

      Specifies the AWS Elastic Beanstalk environment ID.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

      Parameters:
      environmentId - Specifies the AWS Elastic Beanstalk environment ID.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • getEnvironmentId

      public String getEnvironmentId()

      Specifies the AWS Elastic Beanstalk environment ID.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

      Returns:
      Specifies the AWS Elastic Beanstalk environment ID.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • withEnvironmentId

      public DescribeEnvironmentHealthRequest withEnvironmentId(String environmentId)

      Specifies the AWS Elastic Beanstalk environment ID.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

      Parameters:
      environmentId - Specifies the AWS Elastic Beanstalk environment ID.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getAttributeNames

      public List<String> getAttributeNames()

      Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns the name of the environment.

      Returns:
      Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns the name of the environment.
      See Also:
    • setAttributeNames

      public void setAttributeNames(Collection<String> attributeNames)

      Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns the name of the environment.

      Parameters:
      attributeNames - Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns the name of the environment.
      See Also:
    • withAttributeNames

      public DescribeEnvironmentHealthRequest withAttributeNames(String... attributeNames)

      Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns the name of the environment.

      NOTE: This method appends the values to the existing list (if any). Use setAttributeNames(java.util.Collection) or withAttributeNames(java.util.Collection) if you want to override the existing values.

      Parameters:
      attributeNames - Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns the name of the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • withAttributeNames

      public DescribeEnvironmentHealthRequest withAttributeNames(Collection<String> attributeNames)

      Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns the name of the environment.

      Parameters:
      attributeNames - Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns the name of the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • withAttributeNames

      public DescribeEnvironmentHealthRequest withAttributeNames(EnvironmentHealthAttribute... attributeNames)

      Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns the name of the environment.

      Parameters:
      attributeNames - Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns the name of the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: