Class DescribeEnvironmentsRequest

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

public class DescribeEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Request to describe one or more environments.

See Also:
  • Constructor Details

    • DescribeEnvironmentsRequest

      public DescribeEnvironmentsRequest()
  • Method Details

    • setApplicationName

      public void setApplicationName(String applicationName)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

      Parameters:
      applicationName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
    • getApplicationName

      public String getApplicationName()

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

      Returns:
      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
    • withApplicationName

      public DescribeEnvironmentsRequest withApplicationName(String applicationName)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

      Parameters:
      applicationName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setVersionLabel

      public void setVersionLabel(String versionLabel)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

      Parameters:
      versionLabel - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
    • getVersionLabel

      public String getVersionLabel()

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

      Returns:
      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
    • withVersionLabel

      public DescribeEnvironmentsRequest withVersionLabel(String versionLabel)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

      Parameters:
      versionLabel - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getEnvironmentIds

      public List<String> getEnvironmentIds()

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

      Returns:
      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
    • setEnvironmentIds

      public void setEnvironmentIds(Collection<String> environmentIds)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

      Parameters:
      environmentIds - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
    • withEnvironmentIds

      public DescribeEnvironmentsRequest withEnvironmentIds(String... environmentIds)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

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

      Parameters:
      environmentIds - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withEnvironmentIds

      public DescribeEnvironmentsRequest withEnvironmentIds(Collection<String> environmentIds)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

      Parameters:
      environmentIds - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getEnvironmentNames

      public List<String> getEnvironmentNames()

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

      Returns:
      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
    • setEnvironmentNames

      public void setEnvironmentNames(Collection<String> environmentNames)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

      Parameters:
      environmentNames - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
    • withEnvironmentNames

      public DescribeEnvironmentsRequest withEnvironmentNames(String... environmentNames)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

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

      Parameters:
      environmentNames - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withEnvironmentNames

      public DescribeEnvironmentsRequest withEnvironmentNames(Collection<String> environmentNames)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

      Parameters:
      environmentNames - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setIncludeDeleted

      public void setIncludeDeleted(Boolean includeDeleted)

      Indicates whether to include deleted environments:

      true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

      false: Do not include deleted environments.

      Parameters:
      includeDeleted - Indicates whether to include deleted environments:

      true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

      false: Do not include deleted environments.

    • getIncludeDeleted

      public Boolean getIncludeDeleted()

      Indicates whether to include deleted environments:

      true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

      false: Do not include deleted environments.

      Returns:
      Indicates whether to include deleted environments:

      true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

      false: Do not include deleted environments.

    • withIncludeDeleted

      public DescribeEnvironmentsRequest withIncludeDeleted(Boolean includeDeleted)

      Indicates whether to include deleted environments:

      true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

      false: Do not include deleted environments.

      Parameters:
      includeDeleted - Indicates whether to include deleted environments:

      true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

      false: Do not include deleted environments.

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

      public Boolean isIncludeDeleted()

      Indicates whether to include deleted environments:

      true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

      false: Do not include deleted environments.

      Returns:
      Indicates whether to include deleted environments:

      true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

      false: Do not include deleted environments.

    • setIncludedDeletedBackTo

      public void setIncludedDeletedBackTo(Date includedDeletedBackTo)

      If specified when IncludeDeleted is set to true , then environments deleted after this date are displayed.

      Parameters:
      includedDeletedBackTo - If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.
    • getIncludedDeletedBackTo

      public Date getIncludedDeletedBackTo()

      If specified when IncludeDeleted is set to true , then environments deleted after this date are displayed.

      Returns:
      If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.
    • withIncludedDeletedBackTo

      public DescribeEnvironmentsRequest withIncludedDeletedBackTo(Date includedDeletedBackTo)

      If specified when IncludeDeleted is set to true , then environments deleted after this date are displayed.

      Parameters:
      includedDeletedBackTo - If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.
      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:
    • 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: