Class X12ElementRequirementValidationRule

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

Defines a validation rule that modifies the requirement status of a specific X12 element within a segment. This rule allows you to make optional elements mandatory or mandatory elements optional, providing flexibility to accommodate different trading partner requirements and business rules. The rule targets a specific element position within a segment and sets its requirement status to either OPTIONAL or MANDATORY.

See Also:

  • Method Details

    • elementPosition

      public final String elementPosition()

      Specifies the position of the element within an X12 segment for which the requirement status will be modified. The format follows the pattern of segment identifier followed by element position (e.g., "ST-01" for the first element of the ST segment).

      Returns:
      Specifies the position of the element within an X12 segment for which the requirement status will be modified. The format follows the pattern of segment identifier followed by element position (e.g., "ST-01" for the first element of the ST segment).

    • requirement

      public final ElementRequirement requirement()

      Specifies the requirement status for the element at the specified position. Valid values are OPTIONAL (the element may be omitted) or MANDATORY (the element must be present).

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

      Returns:
      Specifies the requirement status for the element at the specified position. Valid values are OPTIONAL (the element may be omitted) or MANDATORY (the element must be present).
      See Also:

    • requirementAsString

      public final String requirementAsString()

      Specifies the requirement status for the element at the specified position. Valid values are OPTIONAL (the element may be omitted) or MANDATORY (the element must be present).

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

      Returns:
      Specifies the requirement status for the element at the specified position. Valid values are OPTIONAL (the element may be omitted) or MANDATORY (the element must be present).
      See Also:

    • toBuilder

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

    • builder

      public static X12ElementRequirementValidationRule.Builder builder()

    • serializableBuilderClass

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