com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticbeanstalk Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.elasticbeanstalk.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Describes the properties of an environment.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class EnvironmentDescription implements Serializable, Cloneable {
/**
*
* The name of this environment.
*
*/
private String environmentName;
/**
*
* The ID of this environment.
*
*/
private String environmentId;
/**
*
* The name of the application associated with this environment.
*
*/
private String applicationName;
/**
*
* The application version deployed in this environment.
*
*/
private String versionLabel;
/**
*
* The name of the SolutionStack deployed with this environment.
*
*/
private String solutionStackName;
/**
*
* The ARN of the platform version.
*
*/
private String platformArn;
/**
*
* The name of the configuration template used to originally launch this environment.
*
*/
private String templateName;
/**
*
* Describes this environment.
*
*/
private String description;
/**
*
* For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the
* IP address of the instance.
*
*/
private String endpointURL;
/**
*
* The URL to the CNAME for this environment.
*
*/
private String cNAME;
/**
*
* The creation date for this environment.
*
*/
private java.util.Date dateCreated;
/**
*
* The last modified date for this environment.
*
*/
private java.util.Date dateUpdated;
/**
*
* 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.
*
*
*
*/
private String status;
/**
*
* 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.
*
*/
private Boolean abortableOperationInProgress;
/**
*
* 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
* RestartEnvironment request.
*
*
*
*
* Default: Grey
*
*/
private String health;
/**
*
* Returns the health status of the application running in your environment. For more information, see Health Colors and
* Statuses.
*
*/
private String healthStatus;
/**
*
* The description of the AWS resources used by this environment.
*
*/
private EnvironmentResourcesDescription resources;
/**
*
* Describes the current tier of this environment.
*
*/
private EnvironmentTier tier;
/**
*
* A list of links to other environments in the same group.
*
*/
private com.amazonaws.internal.SdkInternalList environmentLinks;
/**
*
* The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
*
*/
private String environmentArn;
/**
*
* The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the
* AWS Elastic Beanstalk Developer Guide.
*
*/
private String operationsRole;
/**
*
* The name of this environment.
*
*
* @param environmentName
* The name of this environment.
*/
public void setEnvironmentName(String environmentName) {
this.environmentName = environmentName;
}
/**
*
* The name of this environment.
*
*
* @return The name of this environment.
*/
public String getEnvironmentName() {
return this.environmentName;
}
/**
*
* The name of this environment.
*
*
* @param environmentName
* The name of this environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withEnvironmentName(String environmentName) {
setEnvironmentName(environmentName);
return this;
}
/**
*
* The ID of this environment.
*
*
* @param environmentId
* The ID of this environment.
*/
public void setEnvironmentId(String environmentId) {
this.environmentId = environmentId;
}
/**
*
* The ID of this environment.
*
*
* @return The ID of this environment.
*/
public String getEnvironmentId() {
return this.environmentId;
}
/**
*
* The ID of this environment.
*
*
* @param environmentId
* The ID of this environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withEnvironmentId(String environmentId) {
setEnvironmentId(environmentId);
return this;
}
/**
*
* The name of the application associated with this environment.
*
*
* @param applicationName
* The name of the application associated with this environment.
*/
public void setApplicationName(String applicationName) {
this.applicationName = applicationName;
}
/**
*
* The name of the application associated with this environment.
*
*
* @return The name of the application associated with this environment.
*/
public String getApplicationName() {
return this.applicationName;
}
/**
*
* The name of the application associated with this environment.
*
*
* @param applicationName
* The name of the application associated with this environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withApplicationName(String applicationName) {
setApplicationName(applicationName);
return this;
}
/**
*
* The application version deployed in this environment.
*
*
* @param versionLabel
* The application version deployed in this environment.
*/
public void setVersionLabel(String versionLabel) {
this.versionLabel = versionLabel;
}
/**
*
* The application version deployed in this environment.
*
*
* @return The application version deployed in this environment.
*/
public String getVersionLabel() {
return this.versionLabel;
}
/**
*
* The application version deployed in this environment.
*
*
* @param versionLabel
* The application version deployed in this environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withVersionLabel(String versionLabel) {
setVersionLabel(versionLabel);
return this;
}
/**
*
* The name of the SolutionStack deployed with this environment.
*
*
* @param solutionStackName
* The name of the SolutionStack deployed with this environment.
*/
public void setSolutionStackName(String solutionStackName) {
this.solutionStackName = solutionStackName;
}
/**
*
* The name of the SolutionStack deployed with this environment.
*
*
* @return The name of the SolutionStack deployed with this environment.
*/
public String getSolutionStackName() {
return this.solutionStackName;
}
/**
*
* The name of the SolutionStack deployed with this environment.
*
*
* @param solutionStackName
* The name of the SolutionStack deployed with this environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withSolutionStackName(String solutionStackName) {
setSolutionStackName(solutionStackName);
return this;
}
/**
*
* The ARN of the platform version.
*
*
* @param platformArn
* The ARN of the platform version.
*/
public void setPlatformArn(String platformArn) {
this.platformArn = platformArn;
}
/**
*
* The ARN of the platform version.
*
*
* @return The ARN of the platform version.
*/
public String getPlatformArn() {
return this.platformArn;
}
/**
*
* The ARN of the platform version.
*
*
* @param platformArn
* The ARN of the platform version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withPlatformArn(String platformArn) {
setPlatformArn(platformArn);
return this;
}
/**
*
* The name of the configuration template used to originally launch this environment.
*
*
* @param templateName
* The name of the configuration template used to originally launch this environment.
*/
public void setTemplateName(String templateName) {
this.templateName = templateName;
}
/**
*
* The name of the configuration template used to originally launch this environment.
*
*
* @return The name of the configuration template used to originally launch this environment.
*/
public String getTemplateName() {
return this.templateName;
}
/**
*
* The name of the configuration template used to originally launch this environment.
*
*
* @param templateName
* The name of the configuration template used to originally launch this environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withTemplateName(String templateName) {
setTemplateName(templateName);
return this;
}
/**
*
* Describes this environment.
*
*
* @param description
* Describes this environment.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* Describes this environment.
*
*
* @return Describes this environment.
*/
public String getDescription() {
return this.description;
}
/**
*
* Describes this environment.
*
*
* @param description
* Describes this environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the
* IP address of the instance.
*
*
* @param endpointURL
* For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance
* environments, the IP address of the instance.
*/
public void setEndpointURL(String endpointURL) {
this.endpointURL = endpointURL;
}
/**
*
* For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the
* IP address of the instance.
*
*
* @return For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance
* environments, the IP address of the instance.
*/
public String getEndpointURL() {
return this.endpointURL;
}
/**
*
* For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the
* IP address of the instance.
*
*
* @param endpointURL
* For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance
* environments, the IP address of the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withEndpointURL(String endpointURL) {
setEndpointURL(endpointURL);
return this;
}
/**
*
* The URL to the CNAME for this environment.
*
*
* @param cNAME
* The URL to the CNAME for this environment.
*/
public void setCNAME(String cNAME) {
this.cNAME = cNAME;
}
/**
*
* The URL to the CNAME for this environment.
*
*
* @return The URL to the CNAME for this environment.
*/
public String getCNAME() {
return this.cNAME;
}
/**
*
* The URL to the CNAME for this environment.
*
*
* @param cNAME
* The URL to the CNAME for this environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withCNAME(String cNAME) {
setCNAME(cNAME);
return this;
}
/**
*
* The creation date for this environment.
*
*
* @param dateCreated
* The creation date for this environment.
*/
public void setDateCreated(java.util.Date dateCreated) {
this.dateCreated = dateCreated;
}
/**
*
* The creation date for this environment.
*
*
* @return The creation date for this environment.
*/
public java.util.Date getDateCreated() {
return this.dateCreated;
}
/**
*
* The creation date for this environment.
*
*
* @param dateCreated
* The creation date for this environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withDateCreated(java.util.Date dateCreated) {
setDateCreated(dateCreated);
return this;
}
/**
*
* The last modified date for this environment.
*
*
* @param dateUpdated
* The last modified date for this environment.
*/
public void setDateUpdated(java.util.Date dateUpdated) {
this.dateUpdated = dateUpdated;
}
/**
*
* The last modified date for this environment.
*
*
* @return The last modified date for this environment.
*/
public java.util.Date getDateUpdated() {
return this.dateUpdated;
}
/**
*
* The last modified date for this environment.
*
*
* @param dateUpdated
* The last modified date for this environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withDateUpdated(java.util.Date dateUpdated) {
setDateUpdated(dateUpdated);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 EnvironmentStatus
*/
public void setStatus(String status) {
this.status = 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.
*
*
*
*
* @return 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 EnvironmentStatus
*/
public String getStatus() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnvironmentStatus
*/
public EnvironmentDescription withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 EnvironmentStatus
*/
public void setStatus(EnvironmentStatus status) {
withStatus(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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnvironmentStatus
*/
public EnvironmentDescription withStatus(EnvironmentStatus status) {
this.status = status.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setAbortableOperationInProgress(Boolean abortableOperationInProgress) {
this.abortableOperationInProgress = 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.
*
*
* @return 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.
*/
public Boolean getAbortableOperationInProgress() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withAbortableOperationInProgress(Boolean abortableOperationInProgress) {
setAbortableOperationInProgress(abortableOperationInProgress);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isAbortableOperationInProgress() {
return this.abortableOperationInProgress;
}
/**
*
* 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
* RestartEnvironment request.
*
*
*
*
* Default: Grey
*
*
* @param 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
* RestartEnvironment request.
*
*
*
*
* Default: Grey
* @see EnvironmentHealth
*/
public void setHealth(String health) {
this.health = 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
* RestartEnvironment request.
*
*
*
*
* Default: Grey
*
*
* @return 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
* RestartEnvironment request.
*
*
*
*
* Default: Grey
* @see EnvironmentHealth
*/
public String getHealth() {
return this.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
* RestartEnvironment request.
*
*
*
*
* Default: Grey
*
*
* @param 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
* RestartEnvironment request.
*
*
*
*
* Default: Grey
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnvironmentHealth
*/
public EnvironmentDescription withHealth(String health) {
setHealth(health);
return this;
}
/**
*
* 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
* RestartEnvironment request.
*
*
*
*
* Default: Grey
*
*
* @param 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
* RestartEnvironment request.
*
*
*
*
* Default: Grey
* @see EnvironmentHealth
*/
public void setHealth(EnvironmentHealth health) {
withHealth(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
* RestartEnvironment request.
*
*
*
*
* Default: Grey
*
*
* @param 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
* RestartEnvironment request.
*
*
*
*
* Default: Grey
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnvironmentHealth
*/
public EnvironmentDescription withHealth(EnvironmentHealth health) {
this.health = health.toString();
return this;
}
/**
*
* Returns the health status of the application running in your environment. For more information, see Health Colors and
* Statuses.
*
*
* @param healthStatus
* Returns the health status of the application running in your environment. For more information, see Health Colors
* and Statuses.
* @see EnvironmentHealthStatus
*/
public void setHealthStatus(String healthStatus) {
this.healthStatus = healthStatus;
}
/**
*
* Returns the health status of the application running in your environment. For more information, see Health Colors and
* Statuses.
*
*
* @return Returns the health status of the application running in your environment. For more information, see Health Colors
* and Statuses.
* @see EnvironmentHealthStatus
*/
public String getHealthStatus() {
return this.healthStatus;
}
/**
*
* Returns the health status of the application running in your environment. For more information, see Health Colors and
* Statuses.
*
*
* @param healthStatus
* Returns the health status of the application running in your environment. For more information, see Health Colors
* and Statuses.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnvironmentHealthStatus
*/
public EnvironmentDescription withHealthStatus(String healthStatus) {
setHealthStatus(healthStatus);
return this;
}
/**
*
* Returns the health status of the application running in your environment. For more information, see Health Colors and
* Statuses.
*
*
* @param healthStatus
* Returns the health status of the application running in your environment. For more information, see Health Colors
* and Statuses.
* @see EnvironmentHealthStatus
*/
public void setHealthStatus(EnvironmentHealthStatus healthStatus) {
withHealthStatus(healthStatus);
}
/**
*
* Returns the health status of the application running in your environment. For more information, see Health Colors and
* Statuses.
*
*
* @param healthStatus
* Returns the health status of the application running in your environment. For more information, see Health Colors
* and Statuses.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnvironmentHealthStatus
*/
public EnvironmentDescription withHealthStatus(EnvironmentHealthStatus healthStatus) {
this.healthStatus = healthStatus.toString();
return this;
}
/**
*
* The description of the AWS resources used by this environment.
*
*
* @param resources
* The description of the AWS resources used by this environment.
*/
public void setResources(EnvironmentResourcesDescription resources) {
this.resources = resources;
}
/**
*
* The description of the AWS resources used by this environment.
*
*
* @return The description of the AWS resources used by this environment.
*/
public EnvironmentResourcesDescription getResources() {
return this.resources;
}
/**
*
* The description of the AWS resources used by this environment.
*
*
* @param resources
* The description of the AWS resources used by this environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withResources(EnvironmentResourcesDescription resources) {
setResources(resources);
return this;
}
/**
*
* Describes the current tier of this environment.
*
*
* @param tier
* Describes the current tier of this environment.
*/
public void setTier(EnvironmentTier tier) {
this.tier = tier;
}
/**
*
* Describes the current tier of this environment.
*
*
* @return Describes the current tier of this environment.
*/
public EnvironmentTier getTier() {
return this.tier;
}
/**
*
* Describes the current tier of this environment.
*
*
* @param tier
* Describes the current tier of this environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withTier(EnvironmentTier tier) {
setTier(tier);
return this;
}
/**
*
* A list of links to other environments in the same group.
*
*
* @return A list of links to other environments in the same group.
*/
public java.util.List getEnvironmentLinks() {
if (environmentLinks == null) {
environmentLinks = new com.amazonaws.internal.SdkInternalList();
}
return environmentLinks;
}
/**
*
* A list of links to other environments in the same group.
*
*
* @param environmentLinks
* A list of links to other environments in the same group.
*/
public void setEnvironmentLinks(java.util.Collection environmentLinks) {
if (environmentLinks == null) {
this.environmentLinks = null;
return;
}
this.environmentLinks = new com.amazonaws.internal.SdkInternalList(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
* {@link #setEnvironmentLinks(java.util.Collection)} or {@link #withEnvironmentLinks(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param environmentLinks
* A list of links to other environments in the same group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withEnvironmentLinks(EnvironmentLink... environmentLinks) {
if (this.environmentLinks == null) {
setEnvironmentLinks(new com.amazonaws.internal.SdkInternalList(environmentLinks.length));
}
for (EnvironmentLink ele : environmentLinks) {
this.environmentLinks.add(ele);
}
return this;
}
/**
*
* A list of links to other environments in the same group.
*
*
* @param environmentLinks
* A list of links to other environments in the same group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withEnvironmentLinks(java.util.Collection environmentLinks) {
setEnvironmentLinks(environmentLinks);
return this;
}
/**
*
* The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
*
*
* @param environmentArn
* The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
*/
public void setEnvironmentArn(String environmentArn) {
this.environmentArn = environmentArn;
}
/**
*
* The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
*
*
* @return The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an
* ARN.
*/
public String getEnvironmentArn() {
return this.environmentArn;
}
/**
*
* The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
*
*
* @param environmentArn
* The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withEnvironmentArn(String environmentArn) {
setEnvironmentArn(environmentArn);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the
* AWS Elastic Beanstalk Developer Guide.
*
*
* @param operationsRole
* The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles
* in the AWS Elastic Beanstalk Developer Guide.
*/
public void setOperationsRole(String operationsRole) {
this.operationsRole = operationsRole;
}
/**
*
* The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the
* AWS Elastic Beanstalk Developer Guide.
*
*
* @return The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations
* roles in the AWS Elastic Beanstalk Developer Guide.
*/
public String getOperationsRole() {
return this.operationsRole;
}
/**
*
* The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the
* AWS Elastic Beanstalk Developer Guide.
*
*
* @param operationsRole
* The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles
* in the AWS Elastic Beanstalk Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentDescription withOperationsRole(String operationsRole) {
setOperationsRole(operationsRole);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getEnvironmentName() != null)
sb.append("EnvironmentName: ").append(getEnvironmentName()).append(",");
if (getEnvironmentId() != null)
sb.append("EnvironmentId: ").append(getEnvironmentId()).append(",");
if (getApplicationName() != null)
sb.append("ApplicationName: ").append(getApplicationName()).append(",");
if (getVersionLabel() != null)
sb.append("VersionLabel: ").append(getVersionLabel()).append(",");
if (getSolutionStackName() != null)
sb.append("SolutionStackName: ").append(getSolutionStackName()).append(",");
if (getPlatformArn() != null)
sb.append("PlatformArn: ").append(getPlatformArn()).append(",");
if (getTemplateName() != null)
sb.append("TemplateName: ").append(getTemplateName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getEndpointURL() != null)
sb.append("EndpointURL: ").append(getEndpointURL()).append(",");
if (getCNAME() != null)
sb.append("CNAME: ").append(getCNAME()).append(",");
if (getDateCreated() != null)
sb.append("DateCreated: ").append(getDateCreated()).append(",");
if (getDateUpdated() != null)
sb.append("DateUpdated: ").append(getDateUpdated()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getAbortableOperationInProgress() != null)
sb.append("AbortableOperationInProgress: ").append(getAbortableOperationInProgress()).append(",");
if (getHealth() != null)
sb.append("Health: ").append(getHealth()).append(",");
if (getHealthStatus() != null)
sb.append("HealthStatus: ").append(getHealthStatus()).append(",");
if (getResources() != null)
sb.append("Resources: ").append(getResources()).append(",");
if (getTier() != null)
sb.append("Tier: ").append(getTier()).append(",");
if (getEnvironmentLinks() != null)
sb.append("EnvironmentLinks: ").append(getEnvironmentLinks()).append(",");
if (getEnvironmentArn() != null)
sb.append("EnvironmentArn: ").append(getEnvironmentArn()).append(",");
if (getOperationsRole() != null)
sb.append("OperationsRole: ").append(getOperationsRole());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof EnvironmentDescription == false)
return false;
EnvironmentDescription other = (EnvironmentDescription) obj;
if (other.getEnvironmentName() == null ^ this.getEnvironmentName() == null)
return false;
if (other.getEnvironmentName() != null && other.getEnvironmentName().equals(this.getEnvironmentName()) == false)
return false;
if (other.getEnvironmentId() == null ^ this.getEnvironmentId() == null)
return false;
if (other.getEnvironmentId() != null && other.getEnvironmentId().equals(this.getEnvironmentId()) == false)
return false;
if (other.getApplicationName() == null ^ this.getApplicationName() == null)
return false;
if (other.getApplicationName() != null && other.getApplicationName().equals(this.getApplicationName()) == false)
return false;
if (other.getVersionLabel() == null ^ this.getVersionLabel() == null)
return false;
if (other.getVersionLabel() != null && other.getVersionLabel().equals(this.getVersionLabel()) == false)
return false;
if (other.getSolutionStackName() == null ^ this.getSolutionStackName() == null)
return false;
if (other.getSolutionStackName() != null && other.getSolutionStackName().equals(this.getSolutionStackName()) == false)
return false;
if (other.getPlatformArn() == null ^ this.getPlatformArn() == null)
return false;
if (other.getPlatformArn() != null && other.getPlatformArn().equals(this.getPlatformArn()) == false)
return false;
if (other.getTemplateName() == null ^ this.getTemplateName() == null)
return false;
if (other.getTemplateName() != null && other.getTemplateName().equals(this.getTemplateName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getEndpointURL() == null ^ this.getEndpointURL() == null)
return false;
if (other.getEndpointURL() != null && other.getEndpointURL().equals(this.getEndpointURL()) == false)
return false;
if (other.getCNAME() == null ^ this.getCNAME() == null)
return false;
if (other.getCNAME() != null && other.getCNAME().equals(this.getCNAME()) == false)
return false;
if (other.getDateCreated() == null ^ this.getDateCreated() == null)
return false;
if (other.getDateCreated() != null && other.getDateCreated().equals(this.getDateCreated()) == false)
return false;
if (other.getDateUpdated() == null ^ this.getDateUpdated() == null)
return false;
if (other.getDateUpdated() != null && other.getDateUpdated().equals(this.getDateUpdated()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getAbortableOperationInProgress() == null ^ this.getAbortableOperationInProgress() == null)
return false;
if (other.getAbortableOperationInProgress() != null && other.getAbortableOperationInProgress().equals(this.getAbortableOperationInProgress()) == false)
return false;
if (other.getHealth() == null ^ this.getHealth() == null)
return false;
if (other.getHealth() != null && other.getHealth().equals(this.getHealth()) == false)
return false;
if (other.getHealthStatus() == null ^ this.getHealthStatus() == null)
return false;
if (other.getHealthStatus() != null && other.getHealthStatus().equals(this.getHealthStatus()) == false)
return false;
if (other.getResources() == null ^ this.getResources() == null)
return false;
if (other.getResources() != null && other.getResources().equals(this.getResources()) == false)
return false;
if (other.getTier() == null ^ this.getTier() == null)
return false;
if (other.getTier() != null && other.getTier().equals(this.getTier()) == false)
return false;
if (other.getEnvironmentLinks() == null ^ this.getEnvironmentLinks() == null)
return false;
if (other.getEnvironmentLinks() != null && other.getEnvironmentLinks().equals(this.getEnvironmentLinks()) == false)
return false;
if (other.getEnvironmentArn() == null ^ this.getEnvironmentArn() == null)
return false;
if (other.getEnvironmentArn() != null && other.getEnvironmentArn().equals(this.getEnvironmentArn()) == false)
return false;
if (other.getOperationsRole() == null ^ this.getOperationsRole() == null)
return false;
if (other.getOperationsRole() != null && other.getOperationsRole().equals(this.getOperationsRole()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEnvironmentName() == null) ? 0 : getEnvironmentName().hashCode());
hashCode = prime * hashCode + ((getEnvironmentId() == null) ? 0 : getEnvironmentId().hashCode());
hashCode = prime * hashCode + ((getApplicationName() == null) ? 0 : getApplicationName().hashCode());
hashCode = prime * hashCode + ((getVersionLabel() == null) ? 0 : getVersionLabel().hashCode());
hashCode = prime * hashCode + ((getSolutionStackName() == null) ? 0 : getSolutionStackName().hashCode());
hashCode = prime * hashCode + ((getPlatformArn() == null) ? 0 : getPlatformArn().hashCode());
hashCode = prime * hashCode + ((getTemplateName() == null) ? 0 : getTemplateName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getEndpointURL() == null) ? 0 : getEndpointURL().hashCode());
hashCode = prime * hashCode + ((getCNAME() == null) ? 0 : getCNAME().hashCode());
hashCode = prime * hashCode + ((getDateCreated() == null) ? 0 : getDateCreated().hashCode());
hashCode = prime * hashCode + ((getDateUpdated() == null) ? 0 : getDateUpdated().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getAbortableOperationInProgress() == null) ? 0 : getAbortableOperationInProgress().hashCode());
hashCode = prime * hashCode + ((getHealth() == null) ? 0 : getHealth().hashCode());
hashCode = prime * hashCode + ((getHealthStatus() == null) ? 0 : getHealthStatus().hashCode());
hashCode = prime * hashCode + ((getResources() == null) ? 0 : getResources().hashCode());
hashCode = prime * hashCode + ((getTier() == null) ? 0 : getTier().hashCode());
hashCode = prime * hashCode + ((getEnvironmentLinks() == null) ? 0 : getEnvironmentLinks().hashCode());
hashCode = prime * hashCode + ((getEnvironmentArn() == null) ? 0 : getEnvironmentArn().hashCode());
hashCode = prime * hashCode + ((getOperationsRole() == null) ? 0 : getOperationsRole().hashCode());
return hashCode;
}
@Override
public EnvironmentDescription clone() {
try {
return (EnvironmentDescription) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}