Class ProcessorVersion (2.16.0)

Version 2.16.0

• 2.57.0 (latest)
• 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 ProcessorVersion extends GeneratedMessageV3 implements ProcessorVersionOrBuilder

A processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version

Protobuf type google.cloud.documentai.v1.ProcessorVersion

Inheritance

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

Implements

ProcessorVersionOrBuilder

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)

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)

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)

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

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value

Type	Description
int

DEPRECATION_INFO_FIELD_NUMBER

public static final int DEPRECATION_INFO_FIELD_NUMBER

Field Value

Type	Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value

Type	Description
int

DOCUMENT_SCHEMA_FIELD_NUMBER

public static final int DOCUMENT_SCHEMA_FIELD_NUMBER

Field Value

Type	Description
int

GOOGLE_MANAGED_FIELD_NUMBER

public static final int GOOGLE_MANAGED_FIELD_NUMBER

Field Value

Type	Description
int

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER

Field Value

Type	Description
int

KMS_KEY_VERSION_NAME_FIELD_NUMBER

public static final int KMS_KEY_VERSION_NAME_FIELD_NUMBER

Field Value

Type	Description
int

LATEST_EVALUATION_FIELD_NUMBER

public static final int LATEST_EVALUATION_FIELD_NUMBER

Field Value

Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static ProcessorVersion getDefaultInstance()

Returns

Type	Description
ProcessorVersion

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static ProcessorVersion.Builder newBuilder()

Returns

Type	Description
ProcessorVersion.Builder

newBuilder(ProcessorVersion prototype)

public static ProcessorVersion.Builder newBuilder(ProcessorVersion prototype)

Parameter

Name	Description
prototype	ProcessorVersion

Returns

Type	Description
ProcessorVersion.Builder

parseDelimitedFrom(InputStream input)

public static ProcessorVersion parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
ProcessorVersion

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessorVersion parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ProcessorVersion

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static ProcessorVersion parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
ProcessorVersion

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProcessorVersion parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ProcessorVersion

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProcessorVersion parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
ProcessorVersion

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProcessorVersion parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ProcessorVersion

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProcessorVersion parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
ProcessorVersion

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessorVersion parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ProcessorVersion

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static ProcessorVersion parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
ProcessorVersion

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessorVersion parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ProcessorVersion

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static ProcessorVersion parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
ProcessorVersion

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProcessorVersion parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ProcessorVersion

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ProcessorVersion> parser()

Returns

Type	Description
Parser<ProcessorVersion>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getCreateTime()

public Timestamp getCreateTime()

The time the processor version was created.

.google.protobuf.Timestamp create_time = 7;

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time the processor version was created.

.google.protobuf.Timestamp create_time = 7;

Returns

Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public ProcessorVersion getDefaultInstanceForType()

Returns

Type	Description
ProcessorVersion

getDeprecationInfo()

public ProcessorVersion.DeprecationInfo getDeprecationInfo()

If set, information about the eventual deprecation of this version.

.google.cloud.documentai.v1.ProcessorVersion.DeprecationInfo deprecation_info = 13;

Returns

Type	Description
ProcessorVersion.DeprecationInfo	The deprecationInfo.

getDeprecationInfoOrBuilder()

public ProcessorVersion.DeprecationInfoOrBuilder getDeprecationInfoOrBuilder()

If set, information about the eventual deprecation of this version.

.google.cloud.documentai.v1.ProcessorVersion.DeprecationInfo deprecation_info = 13;

Returns

Type	Description
ProcessorVersion.DeprecationInfoOrBuilder

getDisplayName()

public String getDisplayName()

The display name of the processor version.

string display_name = 2;

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the processor version.

string display_name = 2;

Returns

Type	Description
ByteString	The bytes for displayName.

getDocumentSchema()

public DocumentSchema getDocumentSchema()

The schema of the processor version. Describes the output.

.google.cloud.documentai.v1.DocumentSchema document_schema = 12;

Returns

Type	Description
DocumentSchema	The documentSchema.

getDocumentSchemaOrBuilder()

public DocumentSchemaOrBuilder getDocumentSchemaOrBuilder()

The schema of the processor version. Describes the output.

.google.cloud.documentai.v1.DocumentSchema document_schema = 12;

Returns

Type	Description
DocumentSchemaOrBuilder

getGoogleManaged()

public boolean getGoogleManaged()

Denotes that this ProcessorVersion is managed by google.

bool google_managed = 11;

Returns

Type	Description
boolean	The googleManaged.

getKmsKeyName()

public String getKmsKeyName()

The KMS key name used for encryption.

string kms_key_name = 9;

Returns

Type	Description
String	The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

The KMS key name used for encryption.

string kms_key_name = 9;

Returns

Type	Description
ByteString	The bytes for kmsKeyName.

getKmsKeyVersionName()

public String getKmsKeyVersionName()

The KMS key version with which data is encrypted.

string kms_key_version_name = 10;

Returns

Type	Description
String	The kmsKeyVersionName.

getKmsKeyVersionNameBytes()

public ByteString getKmsKeyVersionNameBytes()

The KMS key version with which data is encrypted.

string kms_key_version_name = 10;

Returns

Type	Description
ByteString	The bytes for kmsKeyVersionName.

getLatestEvaluation()

public EvaluationReference getLatestEvaluation()

The most recently invoked evaluation for the processor version.

.google.cloud.documentai.v1.EvaluationReference latest_evaluation = 8;

Returns

Type	Description
EvaluationReference	The latestEvaluation.

getLatestEvaluationOrBuilder()

public EvaluationReferenceOrBuilder getLatestEvaluationOrBuilder()

The most recently invoked evaluation for the processor version.

.google.cloud.documentai.v1.EvaluationReference latest_evaluation = 8;

Returns

Type	Description
EvaluationReferenceOrBuilder

getName()

public String getName()

The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<ProcessorVersion> getParserForType()

Returns

Type	Description
Parser<ProcessorVersion>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getState()

public ProcessorVersion.State getState()

The state of the processor version.

.google.cloud.documentai.v1.ProcessorVersion.State state = 6;

Returns

Type	Description
ProcessorVersion.State	The state.

getStateValue()

public int getStateValue()

The state of the processor version.

.google.cloud.documentai.v1.ProcessorVersion.State state = 6;

Returns

Type	Description
int	The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hasCreateTime()

public boolean hasCreateTime()

The time the processor version was created.

.google.protobuf.Timestamp create_time = 7;

Returns

Type	Description
boolean	Whether the createTime field is set.

hasDeprecationInfo()

public boolean hasDeprecationInfo()

If set, information about the eventual deprecation of this version.

.google.cloud.documentai.v1.ProcessorVersion.DeprecationInfo deprecation_info = 13;

Returns

Type	Description
boolean	Whether the deprecationInfo field is set.

hasDocumentSchema()

public boolean hasDocumentSchema()

The schema of the processor version. Describes the output.

.google.cloud.documentai.v1.DocumentSchema document_schema = 12;

Returns

Type	Description
boolean	Whether the documentSchema field is set.

hasLatestEvaluation()

public boolean hasLatestEvaluation()

The most recently invoked evaluation for the processor version.

.google.cloud.documentai.v1.EvaluationReference latest_evaluation = 8;

Returns

Type	Description
boolean	Whether the latestEvaluation 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 ProcessorVersion.Builder newBuilderForType()

Returns

Type	Description
ProcessorVersion.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProcessorVersion.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
ProcessorVersion.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 ProcessorVersion.Builder toBuilder()

Returns

Type	Description
ProcessorVersion.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException