Package com.google.cloud.documentai.v1beta2

Class InputConfig

  • All Implemented Interfaces:
    InputConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class InputConfig
extends com.google.protobuf.GeneratedMessageV3
implements InputConfigOrBuilder
     The desired input location and metadata.
    Protobuf type google.cloud.documentai.v1beta2.InputConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  InputConfig.Builder
      The desired input location and metadata.
      static class  InputConfig.SourceCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int CONTENTS_FIELD_NUMBER  
      static int GCS_SOURCE_FIELD_NUMBER  
      static int MIME_TYPE_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • 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

      • hasGcsSource

        public boolean hasGcsSource()
         The Google Cloud Storage location to read the input from. This must be a
 single file.
        .google.cloud.documentai.v1beta2.GcsSource gcs_source = 1;
        Specified by:
        hasGcsSource in interface InputConfigOrBuilder
        Returns:
        Whether the gcsSource field is set.

      • getGcsSource

        public GcsSource getGcsSource()
         The Google Cloud Storage location to read the input from. This must be a
 single file.
        .google.cloud.documentai.v1beta2.GcsSource gcs_source = 1;
        Specified by:
        getGcsSource in interface InputConfigOrBuilder
        Returns:
        The gcsSource.

      • hasContents

        public boolean hasContents()
         Content in bytes, represented as a stream of bytes.
 Note: As with all `bytes` fields, proto buffer messages use a pure binary
 representation, whereas JSON representations use base64.

 This field only works for synchronous ProcessDocument method.
        bytes contents = 3;
        Specified by:
        hasContents in interface InputConfigOrBuilder
        Returns:
        Whether the contents field is set.

      • getContents

        public com.google.protobuf.ByteString getContents()
         Content in bytes, represented as a stream of bytes.
 Note: As with all `bytes` fields, proto buffer messages use a pure binary
 representation, whereas JSON representations use base64.

 This field only works for synchronous ProcessDocument method.
        bytes contents = 3;
        Specified by:
        getContents in interface InputConfigOrBuilder
        Returns:
        The contents.

      • getMimeType

        public String getMimeType()
         Required. Mimetype of the input. Current supported mimetypes are
 application/pdf, image/tiff, and image/gif. In addition, application/json
 type is supported for requests with
 [ProcessDocumentRequest.automl_params][google.cloud.documentai.v1beta2.ProcessDocumentRequest.automl_params]
 field set. The JSON file needs to be in
 [Document][google.cloud.documentai.v1beta2.Document] format.
        string mime_type = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMimeType in interface InputConfigOrBuilder
        Returns:
        The mimeType.

      • getMimeTypeBytes

        public com.google.protobuf.ByteString getMimeTypeBytes()
         Required. Mimetype of the input. Current supported mimetypes are
 application/pdf, image/tiff, and image/gif. In addition, application/json
 type is supported for requests with
 [ProcessDocumentRequest.automl_params][google.cloud.documentai.v1beta2.ProcessDocumentRequest.automl_params]
 field set. The JSON file needs to be in
 [Document][google.cloud.documentai.v1beta2.Document] format.
        string mime_type = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMimeTypeBytes in interface InputConfigOrBuilder
        Returns:
        The bytes for mimeType.

      • 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 InputConfig parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static InputConfig getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<InputConfig> parser()

      • getParserForType

        public com.google.protobuf.Parser<InputConfig> 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 InputConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder