Class ProcessorVersion (2.34.0)

public final class ProcessorVersion extends GeneratedMessageV3 implements ProcessorVersionOrBuilder

A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.

Protobuf type google.cloud.documentai.v1.ProcessorVersion

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DEPRECATION_INFO_FIELD_NUMBER

public static final int DEPRECATION_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_SCHEMA_FIELD_NUMBER

public static final int DOCUMENT_SCHEMA_FIELD_NUMBER
Field Value
TypeDescription
int

GOOGLE_MANAGED_FIELD_NUMBER

public static final int GOOGLE_MANAGED_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_KEY_VERSION_NAME_FIELD_NUMBER

public static final int KMS_KEY_VERSION_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

LATEST_EVALUATION_FIELD_NUMBER

public static final int LATEST_EVALUATION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ProcessorVersion getDefaultInstance()
Returns
TypeDescription
ProcessorVersion

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ProcessorVersion.Builder newBuilder()
Returns
TypeDescription
ProcessorVersion.Builder

newBuilder(ProcessorVersion prototype)

public static ProcessorVersion.Builder newBuilder(ProcessorVersion prototype)
Parameter
NameDescription
prototypeProcessorVersion
Returns
TypeDescription
ProcessorVersion.Builder

parseDelimitedFrom(InputStream input)

public static ProcessorVersion parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ProcessorVersion
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessorVersion parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessorVersion
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ProcessorVersion parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ProcessorVersion
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProcessorVersion parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessorVersion
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProcessorVersion parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ProcessorVersion
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProcessorVersion parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessorVersion
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProcessorVersion parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ProcessorVersion
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessorVersion parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessorVersion
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ProcessorVersion parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ProcessorVersion
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessorVersion parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessorVersion
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ProcessorVersion parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ProcessorVersion
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProcessorVersion parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessorVersion
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ProcessorVersion> parser()
Returns
TypeDescription
Parser<ProcessorVersion>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

The time the processor version was created.

.google.protobuf.Timestamp create_time = 7;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time the processor version was created.

.google.protobuf.Timestamp create_time = 7;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public ProcessorVersion getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProcessorVersion.DeprecationInfoOrBuilder

getDisplayName()

public String getDisplayName()

The display name of the processor version.

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the processor version.

string display_name = 2;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
DocumentSchemaOrBuilder

getGoogleManaged()

public boolean getGoogleManaged()

Output only. Denotes that this ProcessorVersion is managed by Google.

bool google_managed = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

The googleManaged.

getKmsKeyName()

public String getKmsKeyName()

The KMS key name used for encryption.

string kms_key_name = 9;

Returns
TypeDescription
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

The KMS key name used for encryption.

string kms_key_name = 9;

Returns
TypeDescription
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
TypeDescription
String

The kmsKeyVersionName.

getKmsKeyVersionNameBytes()

public ByteString getKmsKeyVersionNameBytes()

The KMS key version with which data is encrypted.

string kms_key_version_name = 10;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<ProcessorVersion> getParserForType()
Returns
TypeDescription
Parser<ProcessorVersion>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public ProcessorVersion.State getState()

The state of the processor version.

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

Returns
TypeDescription
ProcessorVersion.State

The state.

getStateValue()

public int getStateValue()

The state of the processor version.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

hasCreateTime()

public boolean hasCreateTime()

The time the processor version was created.

.google.protobuf.Timestamp create_time = 7;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the latestEvaluation field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ProcessorVersion.Builder newBuilderForType()
Returns
TypeDescription
ProcessorVersion.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProcessorVersion.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ProcessorVersion.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ProcessorVersion.Builder toBuilder()
Returns
TypeDescription
ProcessorVersion.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException