Class Relationship

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

Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships. For more information, see Block.

The Type element provides the type of the relationship for all blocks in the IDs array.

See Also:

  • Method Details

    • type

      public final RelationshipType type()

      The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned.

      • VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.

      • CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.

      • MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.

      • ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.

      • TABLE - A list of IDs that identify associated TABLE block types.

      • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

      • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

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

      Returns:
      The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned.

      • VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.

      • CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.

      • MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.

      • ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.

      • TABLE - A list of IDs that identify associated TABLE block types.

      • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

      • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned.

      • VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.

      • CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.

      • MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.

      • ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.

      • TABLE - A list of IDs that identify associated TABLE block types.

      • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

      • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

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

      Returns:
      The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned.

      • VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.

      • CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.

      • MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.

      • ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.

      • TABLE - A list of IDs that identify associated TABLE block types.

      • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

      • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

      See Also:

    • hasIds

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

    • ids

      public final List<String> ids()

      An array of IDs for related blocks. You can get the type of the relationship from the Type element.

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

      Returns:
      An array of IDs for related blocks. You can get the type of the relationship from the Type element.

    • toBuilder

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

    • builder

      public static Relationship.Builder builder()

    • serializableBuilderClass

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