Class UpdateEnvironmentResult

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

public class UpdateEnvironmentResult extends Object implements Serializable, Cloneable

Describes the properties of an environment.

See Also:
  • Constructor Details

    • UpdateEnvironmentResult

      public UpdateEnvironmentResult()
  • Method Details

    • setEnvironmentName

      public void setEnvironmentName(String environmentName)

      The name of this environment.

      Parameters:
      environmentName - The name of this environment.
    • getEnvironmentName

      public String getEnvironmentName()

      The name of this environment.

      Returns:
      The name of this environment.
    • withEnvironmentName

      public UpdateEnvironmentResult withEnvironmentName(String environmentName)

      The name of this environment.

      Parameters:
      environmentName - The name of this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setEnvironmentId

      public void setEnvironmentId(String environmentId)

      The ID of this environment.

      Parameters:
      environmentId - The ID of this environment.
    • getEnvironmentId

      public String getEnvironmentId()

      The ID of this environment.

      Returns:
      The ID of this environment.
    • withEnvironmentId

      public UpdateEnvironmentResult withEnvironmentId(String environmentId)

      The ID of this environment.

      Parameters:
      environmentId - The ID of this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setApplicationName

      public void setApplicationName(String applicationName)

      The name of the application associated with this environment.

      Parameters:
      applicationName - The name of the application associated with this environment.
    • getApplicationName

      public String getApplicationName()

      The name of the application associated with this environment.

      Returns:
      The name of the application associated with this environment.
    • withApplicationName

      public UpdateEnvironmentResult withApplicationName(String applicationName)

      The name of the application associated with this environment.

      Parameters:
      applicationName - The name of the application associated with this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setVersionLabel

      public void setVersionLabel(String versionLabel)

      The application version deployed in this environment.

      Parameters:
      versionLabel - The application version deployed in this environment.
    • getVersionLabel

      public String getVersionLabel()

      The application version deployed in this environment.

      Returns:
      The application version deployed in this environment.
    • withVersionLabel

      public UpdateEnvironmentResult withVersionLabel(String versionLabel)

      The application version deployed in this environment.

      Parameters:
      versionLabel - The application version deployed in this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSolutionStackName

      public void setSolutionStackName(String solutionStackName)

      The name of the SolutionStack deployed with this environment.

      Parameters:
      solutionStackName - The name of the SolutionStack deployed with this environment.
    • getSolutionStackName

      public String getSolutionStackName()

      The name of the SolutionStack deployed with this environment.

      Returns:
      The name of the SolutionStack deployed with this environment.
    • withSolutionStackName

      public UpdateEnvironmentResult withSolutionStackName(String solutionStackName)

      The name of the SolutionStack deployed with this environment.

      Parameters:
      solutionStackName - The name of the SolutionStack deployed with this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setTemplateName

      public void setTemplateName(String templateName)

      The name of the configuration template used to originally launch this environment.

      Parameters:
      templateName - The name of the configuration template used to originally launch this environment.
    • getTemplateName

      public String getTemplateName()

      The name of the configuration template used to originally launch this environment.

      Returns:
      The name of the configuration template used to originally launch this environment.
    • withTemplateName

      public UpdateEnvironmentResult withTemplateName(String templateName)

      The name of the configuration template used to originally launch this environment.

      Parameters:
      templateName - The name of the configuration template used to originally launch this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDescription

      public void setDescription(String description)

      Describes this environment.

      Parameters:
      description - Describes this environment.
    • getDescription

      public String getDescription()

      Describes this environment.

      Returns:
      Describes this environment.
    • withDescription

      public UpdateEnvironmentResult withDescription(String description)

      Describes this environment.

      Parameters:
      description - Describes this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setEndpointURL

      public void setEndpointURL(String endpointURL)

      For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

      Parameters:
      endpointURL - For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
    • getEndpointURL

      public String getEndpointURL()

      For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

      Returns:
      For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
    • withEndpointURL

      public UpdateEnvironmentResult withEndpointURL(String endpointURL)

      For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

      Parameters:
      endpointURL - For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setCNAME

      public void setCNAME(String cNAME)

      The URL to the CNAME for this environment.

      Parameters:
      cNAME - The URL to the CNAME for this environment.
    • getCNAME

      public String getCNAME()

      The URL to the CNAME for this environment.

      Returns:
      The URL to the CNAME for this environment.
    • withCNAME

      public UpdateEnvironmentResult withCNAME(String cNAME)

      The URL to the CNAME for this environment.

      Parameters:
      cNAME - The URL to the CNAME for this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDateCreated

      public void setDateCreated(Date dateCreated)

      The creation date for this environment.

      Parameters:
      dateCreated - The creation date for this environment.
    • getDateCreated

      public Date getDateCreated()

      The creation date for this environment.

      Returns:
      The creation date for this environment.
    • withDateCreated

      public UpdateEnvironmentResult withDateCreated(Date dateCreated)

      The creation date for this environment.

      Parameters:
      dateCreated - The creation date for this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDateUpdated

      public void setDateUpdated(Date dateUpdated)

      The last modified date for this environment.

      Parameters:
      dateUpdated - The last modified date for this environment.
    • getDateUpdated

      public Date getDateUpdated()

      The last modified date for this environment.

      Returns:
      The last modified date for this environment.
    • withDateUpdated

      public UpdateEnvironmentResult withDateUpdated(Date dateUpdated)

      The last modified date for this environment.

      Parameters:
      dateUpdated - The last modified date for this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStatus

      public void setStatus(String status)

      The current operational status of the environment:

      • Launching: Environment is in the process of initial deployment.
      • Updating: Environment is in the process of updating its configuration settings or application version.
      • Ready: Environment is available to have an action performed on it, such as update or terminate.
      • Terminating: Environment is in the shut-down process.
      • Terminated: Environment is not running.
      Parameters:
      status - The current operational status of the environment:

      • Launching: Environment is in the process of initial deployment.
      • Updating: Environment is in the process of updating its configuration settings or application version.
      • Ready: Environment is available to have an action performed on it, such as update or terminate.
      • Terminating: Environment is in the shut-down process.
      • Terminated: Environment is not running.
      See Also:
    • getStatus

      public String getStatus()

      The current operational status of the environment:

      • Launching: Environment is in the process of initial deployment.
      • Updating: Environment is in the process of updating its configuration settings or application version.
      • Ready: Environment is available to have an action performed on it, such as update or terminate.
      • Terminating: Environment is in the shut-down process.
      • Terminated: Environment is not running.
      Returns:
      The current operational status of the environment:

      • Launching: Environment is in the process of initial deployment.
      • Updating: Environment is in the process of updating its configuration settings or application version.
      • Ready: Environment is available to have an action performed on it, such as update or terminate.
      • Terminating: Environment is in the shut-down process.
      • Terminated: Environment is not running.
      See Also:
    • withStatus

      public UpdateEnvironmentResult withStatus(String status)

      The current operational status of the environment:

      • Launching: Environment is in the process of initial deployment.
      • Updating: Environment is in the process of updating its configuration settings or application version.
      • Ready: Environment is available to have an action performed on it, such as update or terminate.
      • Terminating: Environment is in the shut-down process.
      • Terminated: Environment is not running.
      Parameters:
      status - The current operational status of the environment:

      • Launching: Environment is in the process of initial deployment.
      • Updating: Environment is in the process of updating its configuration settings or application version.
      • Ready: Environment is available to have an action performed on it, such as update or terminate.
      • Terminating: Environment is in the shut-down process.
      • Terminated: Environment is not running.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setStatus

      public void setStatus(EnvironmentStatus status)

      The current operational status of the environment:

      • Launching: Environment is in the process of initial deployment.
      • Updating: Environment is in the process of updating its configuration settings or application version.
      • Ready: Environment is available to have an action performed on it, such as update or terminate.
      • Terminating: Environment is in the shut-down process.
      • Terminated: Environment is not running.
      Parameters:
      status - The current operational status of the environment:

      • Launching: Environment is in the process of initial deployment.
      • Updating: Environment is in the process of updating its configuration settings or application version.
      • Ready: Environment is available to have an action performed on it, such as update or terminate.
      • Terminating: Environment is in the shut-down process.
      • Terminated: Environment is not running.
      See Also:
    • withStatus

      public UpdateEnvironmentResult withStatus(EnvironmentStatus status)

      The current operational status of the environment:

      • Launching: Environment is in the process of initial deployment.
      • Updating: Environment is in the process of updating its configuration settings or application version.
      • Ready: Environment is available to have an action performed on it, such as update or terminate.
      • Terminating: Environment is in the shut-down process.
      • Terminated: Environment is not running.
      Parameters:
      status - The current operational status of the environment:

      • Launching: Environment is in the process of initial deployment.
      • Updating: Environment is in the process of updating its configuration settings or application version.
      • Ready: Environment is available to have an action performed on it, such as update or terminate.
      • Terminating: Environment is in the shut-down process.
      • Terminated: Environment is not running.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setAbortableOperationInProgress

      public void setAbortableOperationInProgress(Boolean abortableOperationInProgress)

      Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

      true: There is an update in progress.

      false: There are no updates currently in progress.

      Parameters:
      abortableOperationInProgress - Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

      true: There is an update in progress.

      false: There are no updates currently in progress.

    • getAbortableOperationInProgress

      public Boolean getAbortableOperationInProgress()

      Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

      true: There is an update in progress.

      false: There are no updates currently in progress.

      Returns:
      Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

      true: There is an update in progress.

      false: There are no updates currently in progress.

    • withAbortableOperationInProgress

      public UpdateEnvironmentResult withAbortableOperationInProgress(Boolean abortableOperationInProgress)

      Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

      true: There is an update in progress.

      false: There are no updates currently in progress.

      Parameters:
      abortableOperationInProgress - Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

      true: There is an update in progress.

      false: There are no updates currently in progress.

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

      public Boolean isAbortableOperationInProgress()

      Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

      true: There is an update in progress.

      false: There are no updates currently in progress.

      Returns:
      Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

      true: There is an update in progress.

      false: There are no updates currently in progress.

    • setHealth

      public void setHealth(String health)

      Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

      • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
      • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
      • Green: Indicates the environment is healthy and fully functional.
      • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

      Default: Grey

      Parameters:
      health - Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

      • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
      • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
      • Green: Indicates the environment is healthy and fully functional.
      • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

      Default: Grey

      See Also:
    • getHealth

      public String getHealth()

      Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

      • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
      • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
      • Green: Indicates the environment is healthy and fully functional.
      • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

      Default: Grey

      Returns:
      Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

      • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
      • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
      • Green: Indicates the environment is healthy and fully functional.
      • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

      Default: Grey

      See Also:
    • withHealth

      public UpdateEnvironmentResult withHealth(String health)

      Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

      • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
      • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
      • Green: Indicates the environment is healthy and fully functional.
      • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

      Default: Grey

      Parameters:
      health - Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

      • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
      • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
      • Green: Indicates the environment is healthy and fully functional.
      • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

      Default: Grey

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

      public void setHealth(EnvironmentHealth health)

      Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

      • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
      • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
      • Green: Indicates the environment is healthy and fully functional.
      • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

      Default: Grey

      Parameters:
      health - Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

      • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
      • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
      • Green: Indicates the environment is healthy and fully functional.
      • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

      Default: Grey

      See Also:
    • withHealth

      public UpdateEnvironmentResult withHealth(EnvironmentHealth health)

      Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

      • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
      • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
      • Green: Indicates the environment is healthy and fully functional.
      • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

      Default: Grey

      Parameters:
      health - Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

      • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
      • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
      • Green: Indicates the environment is healthy and fully functional.
      • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

      Default: Grey

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

      public void setHealthStatus(String healthStatus)

      Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

      Parameters:
      healthStatus - Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
      See Also:
    • getHealthStatus

      public String getHealthStatus()

      Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

      Returns:
      Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
      See Also:
    • withHealthStatus

      public UpdateEnvironmentResult withHealthStatus(String healthStatus)

      Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

      Parameters:
      healthStatus - Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setHealthStatus

      public void setHealthStatus(EnvironmentHealthStatus healthStatus)

      Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

      Parameters:
      healthStatus - Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
      See Also:
    • withHealthStatus

      public UpdateEnvironmentResult withHealthStatus(EnvironmentHealthStatus healthStatus)

      Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

      Parameters:
      healthStatus - Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setResources

      public void setResources(EnvironmentResourcesDescription resources)

      The description of the AWS resources used by this environment.

      Parameters:
      resources - The description of the AWS resources used by this environment.
    • getResources

      public EnvironmentResourcesDescription getResources()

      The description of the AWS resources used by this environment.

      Returns:
      The description of the AWS resources used by this environment.
    • withResources

      public UpdateEnvironmentResult withResources(EnvironmentResourcesDescription resources)

      The description of the AWS resources used by this environment.

      Parameters:
      resources - The description of the AWS resources used by this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setTier

      public void setTier(EnvironmentTier tier)

      Describes the current tier of this environment.

      Parameters:
      tier - Describes the current tier of this environment.
    • getTier

      public EnvironmentTier getTier()

      Describes the current tier of this environment.

      Returns:
      Describes the current tier of this environment.
    • withTier

      public UpdateEnvironmentResult withTier(EnvironmentTier tier)

      Describes the current tier of this environment.

      Parameters:
      tier - Describes the current tier of this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getEnvironmentLinks

      public List<EnvironmentLink> getEnvironmentLinks()

      A list of links to other environments in the same group.

      Returns:
      A list of links to other environments in the same group.
    • setEnvironmentLinks

      public void setEnvironmentLinks(Collection<EnvironmentLink> environmentLinks)

      A list of links to other environments in the same group.

      Parameters:
      environmentLinks - A list of links to other environments in the same group.
    • withEnvironmentLinks

      public UpdateEnvironmentResult withEnvironmentLinks(EnvironmentLink... environmentLinks)

      A list of links to other environments in the same group.

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

      Parameters:
      environmentLinks - A list of links to other environments in the same group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withEnvironmentLinks

      public UpdateEnvironmentResult withEnvironmentLinks(Collection<EnvironmentLink> environmentLinks)

      A list of links to other environments in the same group.

      Parameters:
      environmentLinks - A list of links to other environments in the same group.
      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

      public UpdateEnvironmentResult clone()
      Overrides:
      clone in class Object