com.amazonaws.services.textract.model

Class Relationship

java.lang.Object

com.amazonaws.services.textract.model.Relationship

All Implemented Interfaces:

Serializable

public class Relationship
extends Object
implements Serializable

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

Constructor Summary

Constructors

Constructor and Description
Relationship()

Method Summary

Modifier and Type	Method and Description
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	setIds(Collection<String> ids) An array of IDs for related blocks.
void	setType(RelationshipType type) The type of relationship that the blocks in the IDs array have with the current block.
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; useful for testing and debugging.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Relationship

public Relationship()

Method Detail

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.

Constraints:
Allowed Values: VALUE, CHILD

Returns:

The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD.

See Also:

RelationshipType

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.

Constraints:
Allowed Values: VALUE, CHILD

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.

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: VALUE, CHILD

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

RelationshipType

setType

public void setType(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.

Constraints:
Allowed Values: VALUE, CHILD

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.

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: VALUE, CHILD

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.

Returns:

A reference to this updated 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

ids -

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

Returns:

A reference to this updated 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

ids -

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object