com.google.api.services.documentai.v1.model.GoogleCloudDocumentaiV1beta1DocumentShardInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-documentai Show documentation
There is a newer version: v1-rev20250117-2.0.0
Show newest version
/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.documentai.v1.model;

/**
 * For a large document, sharding may be performed to produce several document shards. Each document
 * shard contains this field to detail which shard it is.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Cloud Document AI API. For a detailed explanation
 * see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudDocumentaiV1beta1DocumentShardInfo extends com.google.api.client.json.GenericJson {

  /**
   * Total number of shards.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long shardCount;

  /**
   * The 0-based index of this shard.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long shardIndex;

  /**
   * The index of the first character in Document.text in the overall document global text.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long textOffset;

  /**
   * Total number of shards.
   * @return value or {@code null} for none
   */
  public java.lang.Long getShardCount() {
    return shardCount;
  }

  /**
   * Total number of shards.
   * @param shardCount shardCount or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta1DocumentShardInfo setShardCount(java.lang.Long shardCount) {
    this.shardCount = shardCount;
    return this;
  }

  /**
   * The 0-based index of this shard.
   * @return value or {@code null} for none
   */
  public java.lang.Long getShardIndex() {
    return shardIndex;
  }

  /**
   * The 0-based index of this shard.
   * @param shardIndex shardIndex or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta1DocumentShardInfo setShardIndex(java.lang.Long shardIndex) {
    this.shardIndex = shardIndex;
    return this;
  }

  /**
   * The index of the first character in Document.text in the overall document global text.
   * @return value or {@code null} for none
   */
  public java.lang.Long getTextOffset() {
    return textOffset;
  }

  /**
   * The index of the first character in Document.text in the overall document global text.
   * @param textOffset textOffset or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta1DocumentShardInfo setTextOffset(java.lang.Long textOffset) {
    this.textOffset = textOffset;
    return this;
  }

  @Override
  public GoogleCloudDocumentaiV1beta1DocumentShardInfo set(String fieldName, Object value) {
    return (GoogleCloudDocumentaiV1beta1DocumentShardInfo) super.set(fieldName, value);
  }

  @Override
  public GoogleCloudDocumentaiV1beta1DocumentShardInfo clone() {
    return (GoogleCloudDocumentaiV1beta1DocumentShardInfo) super.clone();
  }

}