Package software.amazon.awssdk.services.elasticbeanstalk.model

Class TerminateEnvironmentResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkResponse
software.amazon.awssdk.services.elasticbeanstalk.model.TerminateEnvironmentResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<TerminateEnvironmentResponse.Builder,TerminateEnvironmentResponse>
@Generated("software.amazon.awssdk:codegen") public final class TerminateEnvironmentResponse extends ElasticBeanstalkResponse implements ToCopyableBuilder<TerminateEnvironmentResponse.Builder,TerminateEnvironmentResponse>

Describes the properties of an environment.

  • Method Details

    • environmentName

      public final String environmentName()

      The name of this environment.

      Returns:
      The name of this environment.

    • environmentId

      public final String environmentId()

      The ID of this environment.

      Returns:
      The ID of this environment.

    • applicationName

      public final String applicationName()

      The name of the application associated with this environment.

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

    • versionLabel

      public final String versionLabel()

      The application version deployed in this environment.

      Returns:
      The application version deployed in this environment.

    • solutionStackName

      public final String solutionStackName()

      The name of the SolutionStack deployed with this environment.

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

    • platformArn

      public final String platformArn()

      The ARN of the platform version.

      Returns:
      The ARN of the platform version.

    • templateName

      public final String templateName()

      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.

    • description

      public final String description()

      Describes this environment.

      Returns:
      Describes this environment.

    • endpointURL

      public final String endpointURL()

      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.

    • cname

      public final String cname()

      The URL to the CNAME for this environment.

      Returns:
      The URL to the CNAME for this environment.

    • dateCreated

      public final Instant dateCreated()

      The creation date for this environment.

      Returns:
      The creation date for this environment.

    • dateUpdated

      public final Instant dateUpdated()

      The last modified date for this environment.

      Returns:
      The last modified date for this environment.

    • status

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, status will return EnvironmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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:

    • statusAsString

      public final String statusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, status will return EnvironmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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:

    • abortableOperationInProgress

      public final 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.

      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.

    • health

      public final 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 RestartEnvironment request.

      Default: Grey

      If the service returns an enum value that is not available in the current SDK version, health will return EnvironmentHealth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthAsString().

      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 RestartEnvironment request.

      Default: Grey

      See Also:

    • healthAsString

      public final String healthAsString()

      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

      If the service returns an enum value that is not available in the current SDK version, health will return EnvironmentHealth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthAsString().

      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 RestartEnvironment request.

      Default: Grey

      See Also:

    • healthStatus

      public final EnvironmentHealthStatus healthStatus()

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

      If the service returns an enum value that is not available in the current SDK version, healthStatus will return EnvironmentHealthStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthStatusAsString().

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

    • healthStatusAsString

      public final String healthStatusAsString()

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

      If the service returns an enum value that is not available in the current SDK version, healthStatus will return EnvironmentHealthStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthStatusAsString().

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

    • resources

      public final EnvironmentResourcesDescription resources()

      The description of the AWS resources used by this environment.

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

    • tier

      public final EnvironmentTier tier()

      Describes the current tier of this environment.

      Returns:
      Describes the current tier of this environment.

    • hasEnvironmentLinks

      public final boolean hasEnvironmentLinks()
      For responses, this returns true if the service returned a value for the EnvironmentLinks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • environmentLinks

      public final List<EnvironmentLink> environmentLinks()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnvironmentLinks() method.

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

    • environmentArn

      public final String environmentArn()

      The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

      Returns:
      The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

    • operationsRole

      public final String 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.

      Returns:
      The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

    • toBuilder

      public TerminateEnvironmentResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TerminateEnvironmentResponse.Builder,TerminateEnvironmentResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static TerminateEnvironmentResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TerminateEnvironmentResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.