Class MockInput

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

A JSON object that contains a mocked result or errorOutput.

See Also:

  • Method Details

    • result

      public final String result()

      A JSON string containing the mocked result of the state invocation.

      Returns:
      A JSON string containing the mocked result of the state invocation.

    • errorOutput

      public final MockErrorOutput errorOutput()

      The mocked error output when calling TestState. When specified, the mocked response is returned as a JSON object that contains an error and cause field.

      Returns:
      The mocked error output when calling TestState. When specified, the mocked response is returned as a JSON object that contains an error and cause field.

    • fieldValidationMode

      public final MockResponseValidationMode fieldValidationMode()

      Determines the level of strictness when validating mocked results against their respective API models. Values include:

      • STRICT: All required fields must be present, and all present fields must conform to the API's schema.

      • PRESENT: All present fields must conform to the API's schema.

      • NONE: No validation is performed.

      If no value is specified, the default value is STRICT.

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

      Returns:
      Determines the level of strictness when validating mocked results against their respective API models. Values include:

      • STRICT: All required fields must be present, and all present fields must conform to the API's schema.

      • PRESENT: All present fields must conform to the API's schema.

      • NONE: No validation is performed.

      If no value is specified, the default value is STRICT.

      See Also:

    • fieldValidationModeAsString

      public final String fieldValidationModeAsString()

      Determines the level of strictness when validating mocked results against their respective API models. Values include:

      • STRICT: All required fields must be present, and all present fields must conform to the API's schema.

      • PRESENT: All present fields must conform to the API's schema.

      • NONE: No validation is performed.

      If no value is specified, the default value is STRICT.

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

      Returns:
      Determines the level of strictness when validating mocked results against their respective API models. Values include:

      • STRICT: All required fields must be present, and all present fields must conform to the API's schema.

      • PRESENT: All present fields must conform to the API's schema.

      • NONE: No validation is performed.

      If no value is specified, the default value is STRICT.

      See Also:

    • toBuilder

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

    • builder

      public static MockInput.Builder builder()

    • serializableBuilderClass

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