Package com.google.cloud.documentai.v1

Class TrainProcessorVersionRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1.TrainProcessorVersionRequest
All Implemented Interfaces:
TrainProcessorVersionRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class TrainProcessorVersionRequest extends com.google.protobuf.GeneratedMessage implements TrainProcessorVersionRequestOrBuilder
 Request message for the
 [TrainProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.TrainProcessorVersion]
 method.
Protobuf type google.cloud.documentai.v1.TrainProcessorVersionRequest
See Also:

  • Field Details

    • CUSTOM_DOCUMENT_EXTRACTION_OPTIONS_FIELD_NUMBER

      public static final int CUSTOM_DOCUMENT_EXTRACTION_OPTIONS_FIELD_NUMBER
      See Also:

    • FOUNDATION_MODEL_TUNING_OPTIONS_FIELD_NUMBER

      public static final int FOUNDATION_MODEL_TUNING_OPTIONS_FIELD_NUMBER
      See Also:

    • PARENT_FIELD_NUMBER

      public static final int PARENT_FIELD_NUMBER
      See Also:

    • PROCESSOR_VERSION_FIELD_NUMBER

      public static final int PROCESSOR_VERSION_FIELD_NUMBER
      See Also:

    • DOCUMENT_SCHEMA_FIELD_NUMBER

      public static final int DOCUMENT_SCHEMA_FIELD_NUMBER
      See Also:

    • INPUT_DATA_FIELD_NUMBER

      public static final int INPUT_DATA_FIELD_NUMBER
      See Also:

    • BASE_PROCESSOR_VERSION_FIELD_NUMBER

      public static final int BASE_PROCESSOR_VERSION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getProcessorFlagsCase

      public TrainProcessorVersionRequest.ProcessorFlagsCase getProcessorFlagsCase()
      Specified by:
      getProcessorFlagsCase in interface TrainProcessorVersionRequestOrBuilder

    • 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.

    • getCustomDocumentExtractionOptions

      public TrainProcessorVersionRequest.CustomDocumentExtractionOptions getCustomDocumentExtractionOptions()
       Options to control Custom Document Extraction (CDE) Processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions custom_document_extraction_options = 5;
      Specified by:
      getCustomDocumentExtractionOptions in interface TrainProcessorVersionRequestOrBuilder
      Returns:
      The customDocumentExtractionOptions.

    • getCustomDocumentExtractionOptionsOrBuilder

      public TrainProcessorVersionRequest.CustomDocumentExtractionOptionsOrBuilder getCustomDocumentExtractionOptionsOrBuilder()
       Options to control Custom Document Extraction (CDE) Processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions custom_document_extraction_options = 5;
      Specified by:
      getCustomDocumentExtractionOptionsOrBuilder in interface TrainProcessorVersionRequestOrBuilder

    • hasFoundationModelTuningOptions

      public boolean hasFoundationModelTuningOptions()
       Options to control foundation model tuning of a processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptions foundation_model_tuning_options = 12;
      Specified by:
      hasFoundationModelTuningOptions in interface TrainProcessorVersionRequestOrBuilder
      Returns:
      Whether the foundationModelTuningOptions field is set.

    • getFoundationModelTuningOptions

      public TrainProcessorVersionRequest.FoundationModelTuningOptions getFoundationModelTuningOptions()
       Options to control foundation model tuning of a processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptions foundation_model_tuning_options = 12;
      Specified by:
      getFoundationModelTuningOptions in interface TrainProcessorVersionRequestOrBuilder
      Returns:
      The foundationModelTuningOptions.

    • getFoundationModelTuningOptionsOrBuilder

      public TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder getFoundationModelTuningOptionsOrBuilder()
       Options to control foundation model tuning of a processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptions foundation_model_tuning_options = 12;
      Specified by:
      getFoundationModelTuningOptionsOrBuilder in interface TrainProcessorVersionRequestOrBuilder

    • 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.

    • getProcessorVersion

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

    • getProcessorVersionOrBuilder

      public ProcessorVersionOrBuilder getProcessorVersionOrBuilder()
       Required. The processor version to be created.
      .google.cloud.documentai.v1.ProcessorVersion processor_version = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProcessorVersionOrBuilder in interface TrainProcessorVersionRequestOrBuilder

    • 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.

    • getDocumentSchemaOrBuilder

      public DocumentSchemaOrBuilder getDocumentSchemaOrBuilder()
       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:
      getDocumentSchemaOrBuilder in interface TrainProcessorVersionRequestOrBuilder

    • 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.

    • getInputData

      public TrainProcessorVersionRequest.InputData getInputData()
       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:
      getInputData in interface TrainProcessorVersionRequestOrBuilder
      Returns:
      The inputData.

    • getInputDataOrBuilder

      public TrainProcessorVersionRequest.InputDataOrBuilder getInputDataOrBuilder()
       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:
      getInputDataOrBuilder in interface TrainProcessorVersionRequestOrBuilder

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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

    • parseFrom

      public static TrainProcessorVersionRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TrainProcessorVersionRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TrainProcessorVersionRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TrainProcessorVersionRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TrainProcessorVersionRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TrainProcessorVersionRequest.Builder newBuilder()

    • newBuilder

      public static TrainProcessorVersionRequest.Builder newBuilder(TrainProcessorVersionRequest prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TrainProcessorVersionRequest getDefaultInstance()

    • parser

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

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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