Interface Relationship.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Relationship.Builder,Relationship>, SdkBuilder<Relationship.Builder,Relationship>, SdkPojo
Enclosing class:
Relationship
@Mutable @NotThreadSafe public static interface Relationship.Builder extends SdkPojo, CopyableBuilder<Relationship.Builder,Relationship>

  • Method Details

    • type

      Relationship.Builder type(String 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.

      Parameters:
      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.

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

    • type

      Relationship.Builder type(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.

      Parameters:
      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.

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

    • ids

      Relationship.Builder ids(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.

    • ids

      Relationship.Builder ids(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.