Class SignalPrecondition

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

One assessed precondition with the basis behind it.

See Also:

  • Method Details

    • value

      public final Boolean value()

      The producer's determination.

      A Boolean rather than an enum, against the Common Terms preference for enums on extensibility grounds. The question each precondition answers is closed — is the code reachable, is configuration required, must a user other than the attacker interact — and the only third state, "not determined", is already expressed by omitting this member, which the projection does whenever the stored value is not a bool. An enum would give two ways to say the same thing, while basis and missingInfo already qualify how firm the answer is.

      Returns:
      The producer's determination.

      A Boolean rather than an enum, against the Common Terms preference for enums on extensibility grounds. The question each precondition answers is closed — is the code reachable, is configuration required, must a user other than the attacker interact — and the only third state, "not determined", is already expressed by omitting this member, which the projection does whenever the stored value is not a bool. An enum would give two ways to say the same thing, while basis and missingInfo already qualify how firm the answer is.

    • basis

      public final SignalBasis basis()

      Where the producer's determination came from.

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

      Returns:
      Where the producer's determination came from.
      See Also:

    • basisAsString

      public final String basisAsString()

      Where the producer's determination came from.

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

      Returns:
      Where the producer's determination came from.
      See Also:

    • reason

      public final String reason()

      The producer's explanation.

      Returns:
      The producer's explanation.

    • missingInfo

      public final String missingInfo()

      What the producer could not determine, when anything was missing.

      Returns:
      What the producer could not determine, when anything was missing.

    • toBuilder

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

    • builder

      public static SignalPrecondition.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SignalPrecondition.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.