Class ApplicationStatusCheckResponseObject

java.lang.Object
software.amazon.awssdk.services.ec2.model.ApplicationStatusCheckResponseObject
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ApplicationStatusCheckResponseObject.Builder,ApplicationStatusCheckResponseObject>
@Generated("software.amazon.awssdk:codegen") public final class ApplicationStatusCheckResponseObject extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ApplicationStatusCheckResponseObject.Builder,ApplicationStatusCheckResponseObject>

Describes an application status check.

See Also:

  • Method Details

    • applicationStatusCheckId

      public final String applicationStatusCheckId()

      The ID of the application status check.

      Returns:
      The ID of the application status check.

    • aggregation

      public final AggregationStatusEnum aggregation()

      The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status. When set to excluded, the check runs independently and does not affect the instance-level status.

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

      Returns:
      The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status. When set to excluded, the check runs independently and does not affect the instance-level status.
      See Also:

    • aggregationAsString

      public final String aggregationAsString()

      The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status. When set to excluded, the check runs independently and does not affect the instance-level status.

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

      Returns:
      The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status. When set to excluded, the check runs independently and does not affect the instance-level status.
      See Also:

    • hasHealthCheckPaths

      public final boolean hasHealthCheckPaths()
      For responses, this returns true if the service returned a value for the HealthCheckPaths 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.

    • healthCheckPaths

      public final List<HealthCheckPathResponseObject> healthCheckPaths()

      The health check paths for the application status check.

      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 hasHealthCheckPaths() method.

      Returns:
      The health check paths for the application status check.

    • protocol

      public final NetworkProtocolEnum protocol()

      The protocol used for the health check.

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

      Returns:
      The protocol used for the health check.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      The protocol used for the health check.

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

      Returns:
      The protocol used for the health check.
      See Also:

    • port

      public final Integer port()

      The port used for the health check.

      Returns:
      The port used for the health check.

    • path

      public final String path()

      The URL path used for the health check HTTP request.

      Returns:
      The URL path used for the health check HTTP request.

    • deviceIndex

      public final Integer deviceIndex()

      The index of the network device used for the health check. The value is greater than or equal to 0.

      Returns:
      The index of the network device used for the health check. The value is greater than or equal to 0.

    • ipVersion

      public final IpVersionEnum ipVersion()

      The IP version used for the health check.

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

      Returns:
      The IP version used for the health check.
      See Also:

    • ipVersionAsString

      public final String ipVersionAsString()

      The IP version used for the health check.

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

      Returns:
      The IP version used for the health check.
      See Also:

    • ipScope

      public final IpScopeEnum ipScope()

      The IP scope used for the health check.

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

      Returns:
      The IP scope used for the health check.
      See Also:

    • ipScopeAsString

      public final String ipScopeAsString()

      The IP scope used for the health check.

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

      Returns:
      The IP scope used for the health check.
      See Also:

    • interval

      public final Integer interval()

      The interval, in seconds, between health checks. Valid value: 60.

      Returns:
      The interval, in seconds, between health checks. Valid value: 60.

    • timeout

      public final Integer timeout()

      The amount of time, in seconds, to wait for a health check response. Valid values: 1 to 30.

      Returns:
      The amount of time, in seconds, to wait for a health check response. Valid values: 1 to 30.

    • failureThreshold

      public final Integer failureThreshold()

      The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.

      Returns:
      The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.

    • successThreshold

      public final Integer successThreshold()

      The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.

      Returns:
      The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.

    • statusCodeMatcher

      public final String statusCodeMatcher()

      The comma-separated list of individual HTTP status codes or ranges that indicate a successful health check response.

      Returns:
      The comma-separated list of individual HTTP status codes or ranges that indicate a successful health check response.

    • initializationGracePeriodSeconds

      public final Integer initializationGracePeriodSeconds()

      The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.

      Returns:
      The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The date and time when the application status check was last updated.

      Returns:
      The date and time when the application status check was last updated.

    • hasTargetTagAssociations

      public final boolean hasTargetTagAssociations()
      For responses, this returns true if the service returned a value for the TargetTagAssociations 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.

    • targetTagAssociations

      public final List<CustomTagKeyValueResponsePair> targetTagAssociations()

      The tags associated with the application status check. Instances with these tags are automatically monitored by this check.

      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 hasTargetTagAssociations() method.

      Returns:
      The tags associated with the application status check. Instances with these tags are automatically monitored by this check.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      The tags assigned to the application status check.

      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 hasTags() method.

      Returns:
      The tags assigned to the application status check.

    • creationTime

      public final Instant creationTime()

      The date and time when the application status check was created.

      Returns:
      The date and time when the application status check was created.

    • modifyTime

      public final Instant modifyTime()

      The date and time when the application status check was last modified.

      Returns:
      The date and time when the application status check was last modified.

    • deletionTime

      public final Instant deletionTime()

      The date and time when the application status check was deleted.

      Returns:
      The date and time when the application status check was deleted.

    • toBuilder

      public ApplicationStatusCheckResponseObject.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<ApplicationStatusCheckResponseObject.Builder,ApplicationStatusCheckResponseObject>
      Returns:
      a builder for type T

    • builder

      public static ApplicationStatusCheckResponseObject.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.