Class TrainProcessorVersionRequest (2.46.0)

public final class TrainProcessorVersionRequest extends GeneratedMessageV3 implements TrainProcessorVersionRequestOrBuilder

Request message for the TrainProcessorVersion method.

Protobuf type google.cloud.documentai.v1.TrainProcessorVersionRequest

Static Fields

BASE_PROCESSOR_VERSION_FIELD_NUMBER

public static final int BASE_PROCESSOR_VERSION_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_DOCUMENT_EXTRACTION_OPTIONS_FIELD_NUMBER

public static final int CUSTOM_DOCUMENT_EXTRACTION_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENT_SCHEMA_FIELD_NUMBER

public static final int DOCUMENT_SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

FOUNDATION_MODEL_TUNING_OPTIONS_FIELD_NUMBER

public static final int FOUNDATION_MODEL_TUNING_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

INPUT_DATA_FIELD_NUMBER

public static final int INPUT_DATA_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

PROCESSOR_VERSION_FIELD_NUMBER

public static final int PROCESSOR_VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TrainProcessorVersionRequest getDefaultInstance()
Returns
Type Description
TrainProcessorVersionRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TrainProcessorVersionRequest.Builder newBuilder()
Returns
Type Description
TrainProcessorVersionRequest.Builder

newBuilder(TrainProcessorVersionRequest prototype)

public static TrainProcessorVersionRequest.Builder newBuilder(TrainProcessorVersionRequest prototype)
Parameter
Name Description
prototype TrainProcessorVersionRequest
Returns
Type Description
TrainProcessorVersionRequest.Builder

parseDelimitedFrom(InputStream input)

public static TrainProcessorVersionRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TrainProcessorVersionRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainProcessorVersionRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TrainProcessorVersionRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TrainProcessorVersionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainProcessorVersionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TrainProcessorVersionRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TrainProcessorVersionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainProcessorVersionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TrainProcessorVersionRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TrainProcessorVersionRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainProcessorVersionRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TrainProcessorVersionRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TrainProcessorVersionRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainProcessorVersionRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TrainProcessorVersionRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TrainProcessorVersionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainProcessorVersionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TrainProcessorVersionRequest> parser()
Returns
Type Description
Parser<TrainProcessorVersionRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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];

Returns
Type Description
String

The baseProcessorVersion.

getBaseProcessorVersionBytes()

public 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];

Returns
Type Description
ByteString

The bytes for baseProcessorVersion.

getCustomDocumentExtractionOptions()

public TrainProcessorVersionRequest.CustomDocumentExtractionOptions getCustomDocumentExtractionOptions()

Options to control Custom Document Extraction (CDE) Processor.

.google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions custom_document_extraction_options = 5;

Returns
Type Description
TrainProcessorVersionRequest.CustomDocumentExtractionOptions

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;

Returns
Type Description
TrainProcessorVersionRequest.CustomDocumentExtractionOptionsOrBuilder

getDefaultInstanceForType()

public TrainProcessorVersionRequest getDefaultInstanceForType()
Returns
Type Description
TrainProcessorVersionRequest

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];

Returns
Type Description
DocumentSchema

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];

Returns
Type Description
DocumentSchemaOrBuilder

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;

Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

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;

Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder

getInputData()

public TrainProcessorVersionRequest.InputData getInputData()

Optional. The input data used to train the ProcessorVersion.

.google.cloud.documentai.v1.TrainProcessorVersionRequest.InputData input_data = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TrainProcessorVersionRequest.InputData

The inputData.

getInputDataOrBuilder()

public TrainProcessorVersionRequest.InputDataOrBuilder getInputDataOrBuilder()

Optional. The input data used to train the ProcessorVersion.

.google.cloud.documentai.v1.TrainProcessorVersionRequest.InputData input_data = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TrainProcessorVersionRequest.InputDataOrBuilder

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) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<TrainProcessorVersionRequest> getParserForType()
Returns
Type Description
Parser<TrainProcessorVersionRequest>
Overrides

getProcessorFlagsCase()

public TrainProcessorVersionRequest.ProcessorFlagsCase getProcessorFlagsCase()
Returns
Type Description
TrainProcessorVersionRequest.ProcessorFlagsCase

getProcessorVersion()

public ProcessorVersion getProcessorVersion()

Required. The processor version to be created.

.google.cloud.documentai.v1.ProcessorVersion processor_version = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProcessorVersion

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];

Returns
Type Description
ProcessorVersionOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCustomDocumentExtractionOptions()

public boolean hasCustomDocumentExtractionOptions()

Options to control Custom Document Extraction (CDE) Processor.

.google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions custom_document_extraction_options = 5;

Returns
Type Description
boolean

Whether the customDocumentExtractionOptions 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];

Returns
Type Description
boolean

Whether the documentSchema field is set.

hasFoundationModelTuningOptions()

public boolean hasFoundationModelTuningOptions()

Options to control foundation model tuning of a processor.

.google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptions foundation_model_tuning_options = 12;

Returns
Type Description
boolean

Whether the foundationModelTuningOptions field is set.

hasInputData()

public boolean hasInputData()

Optional. The input data used to train the ProcessorVersion.

.google.cloud.documentai.v1.TrainProcessorVersionRequest.InputData input_data = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the inputData field is set.

hasProcessorVersion()

public boolean hasProcessorVersion()

Required. The processor version to be created.

.google.cloud.documentai.v1.ProcessorVersion processor_version = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the processorVersion field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TrainProcessorVersionRequest.Builder newBuilderForType()
Returns
Type Description
TrainProcessorVersionRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TrainProcessorVersionRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TrainProcessorVersionRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TrainProcessorVersionRequest.Builder toBuilder()
Returns
Type Description
TrainProcessorVersionRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException