Class ProcessorVersion (2.53.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
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

GEN_AI_MODEL_INFO_FIELD_NUMBER

public static final int GEN_AI_MODEL_INFO_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

MODEL_TYPE_FIELD_NUMBER

public static final int MODEL_TYPE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_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

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

getGenAiModelInfo()

public ProcessorVersion.GenAiModelInfo getGenAiModelInfo()

Output only. Information about Generative AI model-based processor versions.

.google.cloud.documentai.v1.ProcessorVersion.GenAiModelInfo gen_ai_model_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProcessorVersion.GenAiModelInfo

The genAiModelInfo.

getGenAiModelInfoOrBuilder()

public ProcessorVersion.GenAiModelInfoOrBuilder getGenAiModelInfoOrBuilder()

Output only. Information about Generative AI model-based processor versions.

.google.cloud.documentai.v1.ProcessorVersion.GenAiModelInfo gen_ai_model_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProcessorVersion.GenAiModelInfoOrBuilder

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

getModelType()

public ProcessorVersion.ModelType getModelType()

Output only. The model type of this processor version.

.google.cloud.documentai.v1.ProcessorVersion.ModelType model_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProcessorVersion.ModelType

The modelType.

getModelTypeValue()

public int getModelTypeValue()

Output only. The model type of this processor version.

.google.cloud.documentai.v1.ProcessorVersion.ModelType model_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for modelType.

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public ProcessorVersion.State getState()

Output only. The state of the processor version.

.google.cloud.documentai.v1.ProcessorVersion.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProcessorVersion.State

The state.

getStateValue()

public int getStateValue()

Output only. The state of the processor version.

.google.cloud.documentai.v1.ProcessorVersion.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
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
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.

hasGenAiModelInfo()

public boolean hasGenAiModelInfo()

Output only. Information about Generative AI model-based processor versions.

.google.cloud.documentai.v1.ProcessorVersion.GenAiModelInfo gen_ai_model_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the genAiModelInfo 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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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