Class ValidateStateMachineDefinitionRequest

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

  • Method Details

    • definition

      public final String definition()

      The Amazon States Language definition of the state machine. For more information, see Amazon States Language (ASL).

      Returns:
      The Amazon States Language definition of the state machine. For more information, see Amazon States Language (ASL).

    • type

      public final StateMachineType type()

      The target type of state machine for this definition. The default is STANDARD.

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

      Returns:
      The target type of state machine for this definition. The default is STANDARD.
      See Also:

    • typeAsString

      public final String typeAsString()

      The target type of state machine for this definition. The default is STANDARD.

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

      Returns:
      The target type of state machine for this definition. The default is STANDARD.
      See Also:

    • severity

      public final ValidateStateMachineDefinitionSeverity severity()

      Minimum level of diagnostics to return. ERROR returns only ERROR diagnostics, whereas WARNING returns both WARNING and ERROR diagnostics. The default is ERROR.

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

      Returns:
      Minimum level of diagnostics to return. ERROR returns only ERROR diagnostics, whereas WARNING returns both WARNING and ERROR diagnostics. The default is ERROR.
      See Also:

    • severityAsString

      public final String severityAsString()

      Minimum level of diagnostics to return. ERROR returns only ERROR diagnostics, whereas WARNING returns both WARNING and ERROR diagnostics. The default is ERROR.

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

      Returns:
      Minimum level of diagnostics to return. ERROR returns only ERROR diagnostics, whereas WARNING returns both WARNING and ERROR diagnostics. The default is ERROR.
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of diagnostics that are returned per call. The default and maximum value is 100. Setting the value to 0 will also use the default of 100.

      If the number of diagnostics returned in the response exceeds maxResults, the value of the truncated field in the response will be set to true.

      Returns:
      The maximum number of diagnostics that are returned per call. The default and maximum value is 100. Setting the value to 0 will also use the default of 100.

      If the number of diagnostics returned in the response exceeds maxResults, the value of the truncated field in the response will be set to true.

    • toBuilder

      public ValidateStateMachineDefinitionRequest.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<ValidateStateMachineDefinitionRequest.Builder,ValidateStateMachineDefinitionRequest>
      Specified by:
      toBuilder in class SfnRequest
      Returns:
      a builder for type T

    • builder

      public static ValidateStateMachineDefinitionRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.

    • sdkFieldNameToField

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