Package com.google.cloud.documentai.v1

Class TrainProcessorVersionRequest

  • All Implemented Interfaces:
    TrainProcessorVersionRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TrainProcessorVersionRequest
extends com.google.protobuf.GeneratedMessageV3
implements TrainProcessorVersionRequestOrBuilder
     Request message for the
 [TrainProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.TrainProcessorVersion]
 method.
    Protobuf type google.cloud.documentai.v1.TrainProcessorVersionRequest
    See Also:
    Serialized Form

    • Field Detail

      • CUSTOM_DOCUMENT_EXTRACTION_OPTIONS_FIELD_NUMBER

        public static final int CUSTOM_DOCUMENT_EXTRACTION_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROCESSOR_VERSION_FIELD_NUMBER

        public static final int PROCESSOR_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_SCHEMA_FIELD_NUMBER

        public static final int DOCUMENT_SCHEMA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INPUT_DATA_FIELD_NUMBER

        public static final int INPUT_DATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BASE_PROCESSOR_VERSION_FIELD_NUMBER

        public static final int BASE_PROCESSOR_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • hasCustomDocumentExtractionOptions

        public boolean hasCustomDocumentExtractionOptions()
         Options to control Custom Document Extraction (CDE) Processor.
        .google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions custom_document_extraction_options = 5;
        Specified by:
        hasCustomDocumentExtractionOptions in interface TrainProcessorVersionRequestOrBuilder
        Returns:
        Whether the customDocumentExtractionOptions field is set.

      • getParent

        public String getParent()
         Required. The parent (project, location and processor) to create the new
 version for. Format:
 `projects/{project}/locations/{location}/processors/{processor}`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface TrainProcessorVersionRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The parent (project, location and processor) to create the new
 version for. Format:
 `projects/{project}/locations/{location}/processors/{processor}`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface TrainProcessorVersionRequestOrBuilder
        Returns:
        The bytes for parent.

      • hasProcessorVersion

        public boolean hasProcessorVersion()
         Required. The processor version to be created.
        .google.cloud.documentai.v1.ProcessorVersion processor_version = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasProcessorVersion in interface TrainProcessorVersionRequestOrBuilder
        Returns:
        Whether the processorVersion field is set.

      • hasDocumentSchema

        public boolean hasDocumentSchema()
         Optional. The schema the processor version will be trained with.
        .google.cloud.documentai.v1.DocumentSchema document_schema = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasDocumentSchema in interface TrainProcessorVersionRequestOrBuilder
        Returns:
        Whether the documentSchema field is set.

      • getDocumentSchema

        public DocumentSchema getDocumentSchema()
         Optional. The schema the processor version will be trained with.
        .google.cloud.documentai.v1.DocumentSchema document_schema = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDocumentSchema in interface TrainProcessorVersionRequestOrBuilder
        Returns:
        The documentSchema.

      • hasInputData

        public boolean hasInputData()
         Optional. The input data used to train the
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion].
        .google.cloud.documentai.v1.TrainProcessorVersionRequest.InputData input_data = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasInputData in interface TrainProcessorVersionRequestOrBuilder
        Returns:
        Whether the inputData field is set.

      • getBaseProcessorVersion

        public String getBaseProcessorVersion()
         Optional. The processor version to use as a base for training. This
 processor version must be a child of `parent`. Format:
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
        string base_processor_version = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getBaseProcessorVersion in interface TrainProcessorVersionRequestOrBuilder
        Returns:
        The baseProcessorVersion.

      • getBaseProcessorVersionBytes

        public com.google.protobuf.ByteString getBaseProcessorVersionBytes()
         Optional. The processor version to use as a base for training. This
 processor version must be a child of `parent`. Format:
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
        string base_processor_version = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getBaseProcessorVersionBytes in interface TrainProcessorVersionRequestOrBuilder
        Returns:
        The bytes for baseProcessorVersion.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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