Package com.google.cloud.documentai.v1beta3

Class GetDocumentRequest

  • All Implemented Interfaces:
    GetDocumentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class GetDocumentRequest
extends com.google.protobuf.GeneratedMessageV3
implements GetDocumentRequestOrBuilder
    Protobuf type google.cloud.documentai.v1beta3.GetDocumentRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getDataset

        public 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) = { ... }
        Specified by:
        getDataset in interface GetDocumentRequestOrBuilder
        Returns:
        The dataset.

      • getDatasetBytes

        public 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) = { ... }
        Specified by:
        getDatasetBytes in interface GetDocumentRequestOrBuilder
        Returns:
        The bytes for dataset.

      • hasDocumentId

        public boolean hasDocumentId()
         Required. Document identifier.
        .google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasDocumentId in interface GetDocumentRequestOrBuilder
        Returns:
        Whether the documentId field is set.

      • getDocumentId

        public DocumentId getDocumentId()
         Required. Document identifier.
        .google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDocumentId in interface GetDocumentRequestOrBuilder
        Returns:
        The documentId.

      • hasReadMask

        public 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;
        Specified by:
        hasReadMask in interface GetDocumentRequestOrBuilder
        Returns:
        Whether the readMask field is set.

      • getReadMask

        public 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;
        Specified by:
        getReadMask in interface GetDocumentRequestOrBuilder
        Returns:
        The readMask.

      • getReadMaskOrBuilder

        public 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;
        Specified by:
        getReadMaskOrBuilder in interface GetDocumentRequestOrBuilder

      • hasPageRange

        public 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;
        Specified by:
        hasPageRange in interface GetDocumentRequestOrBuilder
        Returns:
        Whether the pageRange field is set.

      • getPageRange

        public 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;
        Specified by:
        getPageRange in interface GetDocumentRequestOrBuilder
        Returns:
        The pageRange.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static GetDocumentRequest parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GetDocumentRequest parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GetDocumentRequest parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GetDocumentRequest parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GetDocumentRequest parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GetDocumentRequest parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GetDocumentRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException

      • newBuilderForType

        public GetDocumentRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public GetDocumentRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected GetDocumentRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<GetDocumentRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public GetDocumentRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder