Interface GetDocumentRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    GetDocumentRequest, GetDocumentRequest.Builder

    public interface GetDocumentRequestOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • getDataset

        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) = { ... }
        Returns:
        The dataset.
      • getDatasetBytes

        com.google.protobuf.ByteString getDatasetBytes()
         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) = { ... }
        Returns:
        The bytes for dataset.
      • hasDocumentId

        boolean hasDocumentId()
         Required. Document identifier.
         
        .google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the documentId field is set.
      • getDocumentId

        DocumentId getDocumentId()
         Required. Document identifier.
         
        .google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The documentId.
      • getDocumentIdOrBuilder

        DocumentIdOrBuilder getDocumentIdOrBuilder()
         Required. Document identifier.
         
        .google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
      • hasReadMask

        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;
        Returns:
        Whether the readMask field is set.
      • getReadMask

        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;
        Returns:
        The readMask.
      • getReadMaskOrBuilder

        com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
         If set, only fields listed here will be returned. Otherwise, all fields
         will be returned by default.
         
        .google.protobuf.FieldMask read_mask = 3;
      • hasPageRange

        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;
        Returns:
        Whether the pageRange field is set.
      • getPageRange

        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;
        Returns:
        The pageRange.
      • getPageRangeOrBuilder

        DocumentPageRangeOrBuilder getPageRangeOrBuilder()
         List of pages for which the fields specified in the `read_mask` must
         be served.
         
        .google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4;