com.google.cloud.documentai.v1beta3.GetDocumentRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-document-ai-v1beta3 Show documentation
PROTO library for proto-google-cloud-document-ai-v1beta3
There is a newer version: 0.71.0
Show newest version
/*
 * Copyright 2024 Google LLC
 *
 * 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/documentai/v1beta3/document_service.proto

// Protobuf Java Version: 3.25.2
package com.google.cloud.documentai.v1beta3;

public interface GetDocumentRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.documentai.v1beta3.GetDocumentRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The resource name of the dataset that the document belongs to .
   * Format:
   * projects/{project}/locations/{location}/processors/{processor}/dataset
   * 
   *
   * 
   * string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The dataset.
   */
  java.lang.String getDataset();
  /**
   *
   *
   *    * Required. The resource name of the dataset that the document belongs to .
   * Format:
   * projects/{project}/locations/{location}/processors/{processor}/dataset
   * 
   *
   * 
   * string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for dataset.
   */
  com.google.protobuf.ByteString getDatasetBytes();

  /**
   *
   *
   *    * Required. Document identifier.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return Whether the documentId field is set.
   */
  boolean hasDocumentId();
  /**
   *
   *
   *    * Required. Document identifier.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The documentId.
   */
  com.google.cloud.documentai.v1beta3.DocumentId getDocumentId();
  /**
   *
   *
   *    * Required. Document identifier.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.documentai.v1beta3.DocumentIdOrBuilder getDocumentIdOrBuilder();

  /**
   *
   *
   *    * If set, only fields listed here will be returned. Otherwise, all fields
   * will be returned by default.
   * 
   *
   * .google.protobuf.FieldMask read_mask = 3;
   *
   * @return Whether the readMask field is set.
   */
  boolean hasReadMask();
  /**
   *
   *
   *    * If set, only fields listed here will be returned. Otherwise, all fields
   * will be returned by default.
   * 
   *
   * .google.protobuf.FieldMask read_mask = 3;
   *
   * @return The readMask.
   */
  com.google.protobuf.FieldMask getReadMask();
  /**
   *
   *
   *    * If set, only fields listed here will be returned. Otherwise, all fields
   * will be returned by default.
   * 
   *
   * .google.protobuf.FieldMask read_mask = 3;
   */
  com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder();

  /**
   *
   *
   *    * List of pages for which the fields specified in the `read_mask` must
   * be served.
   * 
   *
   * .google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4;
   *
   * @return Whether the pageRange field is set.
   */
  boolean hasPageRange();
  /**
   *
   *
   *    * List of pages for which the fields specified in the `read_mask` must
   * be served.
   * 
   *
   * .google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4;
   *
   * @return The pageRange.
   */
  com.google.cloud.documentai.v1beta3.DocumentPageRange getPageRange();
  /**
   *
   *
   *    * List of pages for which the fields specified in the `read_mask` must
   * be served.
   * 
   *
   * .google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4;
   */
  com.google.cloud.documentai.v1beta3.DocumentPageRangeOrBuilder getPageRangeOrBuilder();
}