Package com.google.cloud.documentai.v1

Class TrainProcessorVersionRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<TrainProcessorVersionRequest.Builder>
com.google.cloud.documentai.v1.TrainProcessorVersionRequest.Builder
All Implemented Interfaces:
TrainProcessorVersionRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
TrainProcessorVersionRequest
public static final class TrainProcessorVersionRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<TrainProcessorVersionRequest.Builder> implements TrainProcessorVersionRequestOrBuilder
 Request message for the
 [TrainProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.TrainProcessorVersion]
 method.
Protobuf type google.cloud.documentai.v1.TrainProcessorVersionRequest

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

    • clear

      public TrainProcessorVersionRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<TrainProcessorVersionRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<TrainProcessorVersionRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public TrainProcessorVersionRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TrainProcessorVersionRequest.Builder>

    • mergeFrom

      public TrainProcessorVersionRequest.Builder mergeFrom(TrainProcessorVersionRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<TrainProcessorVersionRequest.Builder>

    • mergeFrom

      public TrainProcessorVersionRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TrainProcessorVersionRequest.Builder>
      Throws:
      IOException

    • getProcessorFlagsCase

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

    • clearProcessorFlags

      public TrainProcessorVersionRequest.Builder clearProcessorFlags()

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

    • setCustomDocumentExtractionOptions

      public TrainProcessorVersionRequest.Builder setCustomDocumentExtractionOptions(TrainProcessorVersionRequest.CustomDocumentExtractionOptions value)
       Options to control Custom Document Extraction (CDE) Processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions custom_document_extraction_options = 5;

    • setCustomDocumentExtractionOptions

      public TrainProcessorVersionRequest.Builder setCustomDocumentExtractionOptions(TrainProcessorVersionRequest.CustomDocumentExtractionOptions.Builder builderForValue)
       Options to control Custom Document Extraction (CDE) Processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions custom_document_extraction_options = 5;

    • mergeCustomDocumentExtractionOptions

      public TrainProcessorVersionRequest.Builder mergeCustomDocumentExtractionOptions(TrainProcessorVersionRequest.CustomDocumentExtractionOptions value)
       Options to control Custom Document Extraction (CDE) Processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions custom_document_extraction_options = 5;

    • clearCustomDocumentExtractionOptions

      public TrainProcessorVersionRequest.Builder clearCustomDocumentExtractionOptions()
       Options to control Custom Document Extraction (CDE) Processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions custom_document_extraction_options = 5;

    • getCustomDocumentExtractionOptionsBuilder

      public TrainProcessorVersionRequest.CustomDocumentExtractionOptions.Builder getCustomDocumentExtractionOptionsBuilder()
       Options to control Custom Document Extraction (CDE) Processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions custom_document_extraction_options = 5;

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

    • setFoundationModelTuningOptions

      public TrainProcessorVersionRequest.Builder setFoundationModelTuningOptions(TrainProcessorVersionRequest.FoundationModelTuningOptions value)
       Options to control foundation model tuning of a processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptions foundation_model_tuning_options = 12;

    • setFoundationModelTuningOptions

      public TrainProcessorVersionRequest.Builder setFoundationModelTuningOptions(TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder builderForValue)
       Options to control foundation model tuning of a processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptions foundation_model_tuning_options = 12;

    • mergeFoundationModelTuningOptions

      public TrainProcessorVersionRequest.Builder mergeFoundationModelTuningOptions(TrainProcessorVersionRequest.FoundationModelTuningOptions value)
       Options to control foundation model tuning of a processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptions foundation_model_tuning_options = 12;

    • clearFoundationModelTuningOptions

      public TrainProcessorVersionRequest.Builder clearFoundationModelTuningOptions()
       Options to control foundation model tuning of a processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptions foundation_model_tuning_options = 12;

    • getFoundationModelTuningOptionsBuilder

      public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder getFoundationModelTuningOptionsBuilder()
       Options to control foundation model tuning of a processor.
      .google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptions foundation_model_tuning_options = 12;

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

    • setParent

      public TrainProcessorVersionRequest.Builder setParent(String value)
       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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public TrainProcessorVersionRequest.Builder clearParent()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setParentBytes

      public TrainProcessorVersionRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

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

    • setProcessorVersion

      public TrainProcessorVersionRequest.Builder setProcessorVersion(ProcessorVersion value)
       Required. The processor version to be created.
      .google.cloud.documentai.v1.ProcessorVersion processor_version = 2 [(.google.api.field_behavior) = REQUIRED];

    • setProcessorVersion

      public TrainProcessorVersionRequest.Builder setProcessorVersion(ProcessorVersion.Builder builderForValue)
       Required. The processor version to be created.
      .google.cloud.documentai.v1.ProcessorVersion processor_version = 2 [(.google.api.field_behavior) = REQUIRED];

    • mergeProcessorVersion

      public TrainProcessorVersionRequest.Builder mergeProcessorVersion(ProcessorVersion value)
       Required. The processor version to be created.
      .google.cloud.documentai.v1.ProcessorVersion processor_version = 2 [(.google.api.field_behavior) = REQUIRED];

    • clearProcessorVersion

      public TrainProcessorVersionRequest.Builder clearProcessorVersion()
       Required. The processor version to be created.
      .google.cloud.documentai.v1.ProcessorVersion processor_version = 2 [(.google.api.field_behavior) = REQUIRED];

    • getProcessorVersionBuilder

      public ProcessorVersion.Builder getProcessorVersionBuilder()
       Required. The processor version to be created.
      .google.cloud.documentai.v1.ProcessorVersion processor_version = 2 [(.google.api.field_behavior) = REQUIRED];

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

    • setDocumentSchema

      public TrainProcessorVersionRequest.Builder setDocumentSchema(DocumentSchema value)
       Optional. The schema the processor version will be trained with.
      .google.cloud.documentai.v1.DocumentSchema document_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

    • setDocumentSchema

      public TrainProcessorVersionRequest.Builder setDocumentSchema(DocumentSchema.Builder builderForValue)
       Optional. The schema the processor version will be trained with.
      .google.cloud.documentai.v1.DocumentSchema document_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

    • mergeDocumentSchema

      public TrainProcessorVersionRequest.Builder mergeDocumentSchema(DocumentSchema value)
       Optional. The schema the processor version will be trained with.
      .google.cloud.documentai.v1.DocumentSchema document_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

    • clearDocumentSchema

      public TrainProcessorVersionRequest.Builder clearDocumentSchema()
       Optional. The schema the processor version will be trained with.
      .google.cloud.documentai.v1.DocumentSchema document_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

    • getDocumentSchemaBuilder

      public DocumentSchema.Builder getDocumentSchemaBuilder()
       Optional. The schema the processor version will be trained with.
      .google.cloud.documentai.v1.DocumentSchema document_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

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

    • setInputData

      public TrainProcessorVersionRequest.Builder setInputData(TrainProcessorVersionRequest.InputData value)
       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];

    • setInputData

      public TrainProcessorVersionRequest.Builder setInputData(TrainProcessorVersionRequest.InputData.Builder builderForValue)
       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];

    • mergeInputData

      public TrainProcessorVersionRequest.Builder mergeInputData(TrainProcessorVersionRequest.InputData value)
       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];

    • clearInputData

      public TrainProcessorVersionRequest.Builder clearInputData()
       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];

    • getInputDataBuilder

      public TrainProcessorVersionRequest.InputData.Builder getInputDataBuilder()
       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];

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

    • setBaseProcessorVersion

      public TrainProcessorVersionRequest.Builder setBaseProcessorVersion(String value)
       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];
      Parameters:
      value - The baseProcessorVersion to set.
      Returns:
      This builder for chaining.

    • clearBaseProcessorVersion

      public TrainProcessorVersionRequest.Builder clearBaseProcessorVersion()
       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];
      Returns:
      This builder for chaining.

    • setBaseProcessorVersionBytes

      public TrainProcessorVersionRequest.Builder setBaseProcessorVersionBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for baseProcessorVersion to set.
      Returns:
      This builder for chaining.