Chunk.php

<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/cloud/documentai/v1/document.proto

namespace Google\Cloud\DocumentAI\V1\Document\ChunkedDocument;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\GPBUtil;
use Google\Protobuf\RepeatedField;

/**
 * Represents a chunk.
 *
 * Generated from protobuf message <code>google.cloud.documentai.v1.Document.ChunkedDocument.Chunk</code>
 */
class Chunk extends \Google\Protobuf\Internal\Message
{
    /**
     * ID of the chunk.
     *
     * Generated from protobuf field <code>string chunk_id = 1;</code>
     */
    protected $chunk_id = '';
    /**
     * Unused.
     *
     * Generated from protobuf field <code>repeated string source_block_ids = 2;</code>
     */
    private $source_block_ids;
    /**
     * Text content of the chunk.
     *
     * Generated from protobuf field <code>string content = 3;</code>
     */
    protected $content = '';
    /**
     * Page span of the chunk.
     *
     * Generated from protobuf field <code>.google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 4;</code>
     */
    protected $page_span = null;
    /**
     * Page headers associated with the chunk.
     *
     * Generated from protobuf field <code>repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageHeader page_headers = 5;</code>
     */
    private $page_headers;
    /**
     * Page footers associated with the chunk.
     *
     * Generated from protobuf field <code>repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageFooter page_footers = 6;</code>
     */
    private $page_footers;
    /**
     * Chunk fields inside this chunk.
     *
     * Generated from protobuf field <code>repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkField chunk_fields = 7;</code>
     */
    private $chunk_fields;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $chunk_id
     *           ID of the chunk.
     *     @type string[] $source_block_ids
     *           Unused.
     *     @type string $content
     *           Text content of the chunk.
     *     @type \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan $page_span
     *           Page span of the chunk.
     *     @type \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageHeader[] $page_headers
     *           Page headers associated with the chunk.
     *     @type \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageFooter[] $page_footers
     *           Page footers associated with the chunk.
     *     @type \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkField[] $chunk_fields
     *           Chunk fields inside this chunk.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce();
        parent::__construct($data);
    }

    /**
     * ID of the chunk.
     *
     * Generated from protobuf field <code>string chunk_id = 1;</code>
     * @return string
     */
    public function getChunkId()
    {
        return $this->chunk_id;
    }

    /**
     * ID of the chunk.
     *
     * Generated from protobuf field <code>string chunk_id = 1;</code>
     * @param string $var
     * @return $this
     */
    public function setChunkId($var)
    {
        GPBUtil::checkString($var, True);
        $this->chunk_id = $var;

        return $this;
    }

    /**
     * Unused.
     *
     * Generated from protobuf field <code>repeated string source_block_ids = 2;</code>
     * @return RepeatedField<string>
     */
    public function getSourceBlockIds()
    {
        return $this->source_block_ids;
    }

    /**
     * Unused.
     *
     * Generated from protobuf field <code>repeated string source_block_ids = 2;</code>
     * @param string[] $var
     * @return $this
     */
    public function setSourceBlockIds($var)
    {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
        $this->source_block_ids = $arr;

        return $this;
    }

    /**
     * Text content of the chunk.
     *
     * Generated from protobuf field <code>string content = 3;</code>
     * @return string
     */
    public function getContent()
    {
        return $this->content;
    }

    /**
     * Text content of the chunk.
     *
     * Generated from protobuf field <code>string content = 3;</code>
     * @param string $var
     * @return $this
     */
    public function setContent($var)
    {
        GPBUtil::checkString($var, True);
        $this->content = $var;

        return $this;
    }

    /**
     * Page span of the chunk.
     *
     * Generated from protobuf field <code>.google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 4;</code>
     * @return \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan|null
     */
    public function getPageSpan()
    {
        return $this->page_span;
    }

    public function hasPageSpan()
    {
        return isset($this->page_span);
    }

    public function clearPageSpan()
    {
        unset($this->page_span);
    }

    /**
     * Page span of the chunk.
     *
     * Generated from protobuf field <code>.google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 4;</code>
     * @param \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan $var
     * @return $this
     */
    public function setPageSpan($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan::class);
        $this->page_span = $var;

        return $this;
    }

    /**
     * Page headers associated with the chunk.
     *
     * Generated from protobuf field <code>repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageHeader page_headers = 5;</code>
     * @return RepeatedField<\Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageHeader>
     */
    public function getPageHeaders()
    {
        return $this->page_headers;
    }

    /**
     * Page headers associated with the chunk.
     *
     * Generated from protobuf field <code>repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageHeader page_headers = 5;</code>
     * @param \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageHeader[] $var
     * @return $this
     */
    public function setPageHeaders($var)
    {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageHeader::class);
        $this->page_headers = $arr;

        return $this;
    }

    /**
     * Page footers associated with the chunk.
     *
     * Generated from protobuf field <code>repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageFooter page_footers = 6;</code>
     * @return RepeatedField<\Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageFooter>
     */
    public function getPageFooters()
    {
        return $this->page_footers;
    }

    /**
     * Page footers associated with the chunk.
     *
     * Generated from protobuf field <code>repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageFooter page_footers = 6;</code>
     * @param \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageFooter[] $var
     * @return $this
     */
    public function setPageFooters($var)
    {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageFooter::class);
        $this->page_footers = $arr;

        return $this;
    }

    /**
     * Chunk fields inside this chunk.
     *
     * Generated from protobuf field <code>repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkField chunk_fields = 7;</code>
     * @return RepeatedField<\Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkField>
     */
    public function getChunkFields()
    {
        return $this->chunk_fields;
    }

    /**
     * Chunk fields inside this chunk.
     *
     * Generated from protobuf field <code>repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkField chunk_fields = 7;</code>
     * @param \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkField[] $var
     * @return $this
     */
    public function setChunkFields($var)
    {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkField::class);
        $this->chunk_fields = $arr;

        return $this;
    }

}