Relationship (AWS Java SDK :: Services :: Textract 2.20.103 API)

java.lang.Object
- software.amazon.awssdk.services.textract.model.Relationship

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Relationship.Builder,Relationship>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Relationship.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Relationship.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Relationship.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasIds()` For responses, this returns true if the service returned a value for the Ids property.
`List<String>`	`ids()` An array of IDs for related blocks.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Relationship.Builder>`	`serializableBuilderClass()`
`Relationship.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`RelationshipType`	`type()` The type of relationship between the blocks in the IDs array and the current block.
`String`	`typeAsString()` The type of relationship between the blocks in the IDs array and the current block.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    RelationshipType
  - 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:
    
    RelationshipType
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Relationship.Builder,Relationship>
  - 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)
```
    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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Relationship

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

type

typeAsString

hasIds

ids

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields