Package software.amazon.awssdk.services.sfn.model

Class ValidateStateMachineDefinitionResponse

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

  • Method Details

    • result

      public final ValidateStateMachineDefinitionResultCode result()

      The result value will be OK when no syntax errors are found, or FAIL if the workflow definition does not pass verification.

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

      Returns:
      The result value will be OK when no syntax errors are found, or FAIL if the workflow definition does not pass verification.
      See Also:

    • resultAsString

      public final String resultAsString()

      The result value will be OK when no syntax errors are found, or FAIL if the workflow definition does not pass verification.

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

      Returns:
      The result value will be OK when no syntax errors are found, or FAIL if the workflow definition does not pass verification.
      See Also:

    • hasDiagnostics

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

    • diagnostics

      public final List<ValidateStateMachineDefinitionDiagnostic> diagnostics()

      An array of diagnostic errors and warnings found during validation of the state machine definition. Since warnings do not prevent deploying your workflow definition, the result value could be OK even when warning diagnostics are present in the response.

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

      Returns:
      An array of diagnostic errors and warnings found during validation of the state machine definition. Since warnings do not prevent deploying your workflow definition, the result value could be OK even when warning diagnostics are present in the response.

    • truncated

      public final Boolean truncated()

      The result value will be true if the number of diagnostics found in the workflow definition exceeds maxResults. When all diagnostics results are returned, the value will be false.

      Returns:
      The result value will be true if the number of diagnostics found in the workflow definition exceeds maxResults. When all diagnostics results are returned, the value will be false.

    • toBuilder

      public ValidateStateMachineDefinitionResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ValidateStateMachineDefinitionResponse.Builder,ValidateStateMachineDefinitionResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static ValidateStateMachineDefinitionResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ValidateStateMachineDefinitionResponse.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo