Relationship (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.textract.model.Relationship

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Relationship
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Relationship()

Constructors
Constructor and Description
`Relationship()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Relationship`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getIds()` An array of IDs for related blocks.
`String`	`getType()` The type of relationship that the blocks in the IDs array have with the current block.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setIds(Collection<String> ids)` An array of IDs for related blocks.
`void`	`setType(String type)` The type of relationship that the blocks in the IDs array have with the current block.
`String`	`toString()` Returns a string representation of this object.
`Relationship`	`withIds(Collection<String> ids)` An array of IDs for related blocks.
`Relationship`	`withIds(String... ids)` An array of IDs for related blocks.
`Relationship`	`withType(RelationshipType type)` The type of relationship that the blocks in the IDs array have with the current block.
`Relationship`	`withType(String type)` The type of relationship that the blocks in the IDs array have with the current block.

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

- Constructor Detail
  - Relationship
```
public Relationship()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD. A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
    
    Parameters:
    
    type - The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD. A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
    
    See Also:
    
    RelationshipType
  - getType
```
public String getType()
```
    The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD. A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
    
    Returns:
    
    The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD. A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
    
    See Also:
    
    RelationshipType
  - withType
```
public Relationship withType(String type)
```
    The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD. A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
    
    Parameters:
    
    type - The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD. A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RelationshipType
  - withType
```
public Relationship withType(RelationshipType type)
```
    The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD. A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
    
    Parameters:
    
    type - The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD. A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RelationshipType
  - getIds
```
public List<String> getIds()
```
    An array of IDs for related blocks. You can get the type of the relationship from the Type element.
    
    Returns:
    
    An array of IDs for related blocks. You can get the type of the relationship from the Type element.
  - setIds
```
public void setIds(Collection<String> ids)
```
    An array of IDs for related blocks. You can get the type of the relationship from the Type element.
    
    Parameters:
    
    ids - An array of IDs for related blocks. You can get the type of the relationship from the Type element.
  - withIds
```
public Relationship withIds(String... ids)
```
    An array of IDs for related blocks. You can get the type of the relationship from the Type element.
    
    NOTE: This method appends the values to the existing list (if any). Use setIds(java.util.Collection) or withIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    ids - An array of IDs for related blocks. You can get the type of the relationship from the Type element.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIds
```
public Relationship withIds(Collection<String> ids)
```
    An array of IDs for related blocks. You can get the type of the relationship from the Type element.
    
    Parameters:
    
    ids - An array of IDs for related blocks. You can get the type of the relationship from the Type element.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Relationship clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Relationship

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Relationship

Method Detail

setType

getType

withType

withType

getIds

setIds

withIds

withIds

toString

equals

hashCode

clone

marshall