Class TrainProcessorVersionRequest (2.58.0)

Version 2.58.0

• 2.59.0 (latest)
• 2.58.0
• 2.57.0
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public final class TrainProcessorVersionRequest extends GeneratedMessageV3 implements TrainProcessorVersionRequestOrBuilder

Request message for the TrainProcessorVersion method.

Protobuf type google.cloud.documentai.v1.TrainProcessorVersionRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TrainProcessorVersionRequest

Implements

TrainProcessorVersionRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public TrainProcessorVersionRequest.Builder toBuilder()

Returns
Type	Description
TrainProcessorVersionRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException