Class ProcessorVersion.Builder (2.37.0)

public static final class ProcessorVersion.Builder extends GeneratedMessageV3.Builder<ProcessorVersion.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ProcessorVersion.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ProcessorVersion.Builder
Overrides

build()

public ProcessorVersion build()
Returns
TypeDescription
ProcessorVersion

buildPartial()

public ProcessorVersion buildPartial()
Returns
TypeDescription
ProcessorVersion

clear()

public ProcessorVersion.Builder clear()
Returns
TypeDescription
ProcessorVersion.Builder
Overrides

clearCreateTime()

public ProcessorVersion.Builder clearCreateTime()

The time the processor version was created.

.google.protobuf.Timestamp create_time = 7;

Returns
TypeDescription
ProcessorVersion.Builder

clearDeprecationInfo()

public ProcessorVersion.Builder clearDeprecationInfo()

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

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

Returns
TypeDescription
ProcessorVersion.Builder

clearDisplayName()

public ProcessorVersion.Builder clearDisplayName()

The display name of the processor version.

string display_name = 2;

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

clearDocumentSchema()

public ProcessorVersion.Builder clearDocumentSchema()

The schema of the processor version. Describes the output.

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

Returns
TypeDescription
ProcessorVersion.Builder

clearField(Descriptors.FieldDescriptor field)

public ProcessorVersion.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ProcessorVersion.Builder
Overrides

clearGoogleManaged()

public ProcessorVersion.Builder clearGoogleManaged()

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

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

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

clearKmsKeyName()

public ProcessorVersion.Builder clearKmsKeyName()

The KMS key name used for encryption.

string kms_key_name = 9;

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

clearKmsKeyVersionName()

public ProcessorVersion.Builder clearKmsKeyVersionName()

The KMS key version with which data is encrypted.

string kms_key_version_name = 10;

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

clearLatestEvaluation()

public ProcessorVersion.Builder clearLatestEvaluation()

The most recently invoked evaluation for the processor version.

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

Returns
TypeDescription
ProcessorVersion.Builder

clearName()

public ProcessorVersion.Builder clearName()

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

string name = 1;

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ProcessorVersion.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ProcessorVersion.Builder
Overrides

clearState()

public ProcessorVersion.Builder clearState()

The state of the processor version.

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

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

clone()

public ProcessorVersion.Builder clone()
Returns
TypeDescription
ProcessorVersion.Builder
Overrides

getCreateTime()

public Timestamp getCreateTime()

The time the processor version was created.

.google.protobuf.Timestamp create_time = 7;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

The time the processor version was created.

.google.protobuf.Timestamp create_time = 7;

Returns
TypeDescription
Builder

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.

getDeprecationInfoBuilder()

public ProcessorVersion.DeprecationInfo.Builder getDeprecationInfoBuilder()

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

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

Returns
TypeDescription
ProcessorVersion.DeprecationInfo.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getDocumentSchemaBuilder()

public DocumentSchema.Builder getDocumentSchemaBuilder()

The schema of the processor version. Describes the output.

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

Returns
TypeDescription
DocumentSchema.Builder

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.

getLatestEvaluationBuilder()

public EvaluationReference.Builder getLatestEvaluationBuilder()

The most recently invoked evaluation for the processor version.

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

Returns
TypeDescription
EvaluationReference.Builder

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public ProcessorVersion.Builder mergeCreateTime(Timestamp value)

The time the processor version was created.

.google.protobuf.Timestamp create_time = 7;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
ProcessorVersion.Builder

mergeDeprecationInfo(ProcessorVersion.DeprecationInfo value)

public ProcessorVersion.Builder mergeDeprecationInfo(ProcessorVersion.DeprecationInfo value)

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

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

Parameter
NameDescription
valueProcessorVersion.DeprecationInfo
Returns
TypeDescription
ProcessorVersion.Builder

mergeDocumentSchema(DocumentSchema value)

public ProcessorVersion.Builder mergeDocumentSchema(DocumentSchema value)

The schema of the processor version. Describes the output.

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

Parameter
NameDescription
valueDocumentSchema
Returns
TypeDescription
ProcessorVersion.Builder

mergeFrom(ProcessorVersion other)

public ProcessorVersion.Builder mergeFrom(ProcessorVersion other)
Parameter
NameDescription
otherProcessorVersion
Returns
TypeDescription
ProcessorVersion.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ProcessorVersion.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessorVersion.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ProcessorVersion.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ProcessorVersion.Builder
Overrides

mergeLatestEvaluation(EvaluationReference value)

public ProcessorVersion.Builder mergeLatestEvaluation(EvaluationReference value)

The most recently invoked evaluation for the processor version.

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

Parameter
NameDescription
valueEvaluationReference
Returns
TypeDescription
ProcessorVersion.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ProcessorVersion.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ProcessorVersion.Builder
Overrides

setCreateTime(Timestamp value)

public ProcessorVersion.Builder setCreateTime(Timestamp value)

The time the processor version was created.

.google.protobuf.Timestamp create_time = 7;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
ProcessorVersion.Builder

setCreateTime(Timestamp.Builder builderForValue)

public ProcessorVersion.Builder setCreateTime(Timestamp.Builder builderForValue)

The time the processor version was created.

.google.protobuf.Timestamp create_time = 7;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ProcessorVersion.Builder

setDeprecationInfo(ProcessorVersion.DeprecationInfo value)

public ProcessorVersion.Builder setDeprecationInfo(ProcessorVersion.DeprecationInfo value)

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

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

Parameter
NameDescription
valueProcessorVersion.DeprecationInfo
Returns
TypeDescription
ProcessorVersion.Builder

setDeprecationInfo(ProcessorVersion.DeprecationInfo.Builder builderForValue)

public ProcessorVersion.Builder setDeprecationInfo(ProcessorVersion.DeprecationInfo.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueProcessorVersion.DeprecationInfo.Builder
Returns
TypeDescription
ProcessorVersion.Builder

setDisplayName(String value)

public ProcessorVersion.Builder setDisplayName(String value)

The display name of the processor version.

string display_name = 2;

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ProcessorVersion.Builder setDisplayNameBytes(ByteString value)

The display name of the processor version.

string display_name = 2;

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

setDocumentSchema(DocumentSchema value)

public ProcessorVersion.Builder setDocumentSchema(DocumentSchema value)

The schema of the processor version. Describes the output.

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

Parameter
NameDescription
valueDocumentSchema
Returns
TypeDescription
ProcessorVersion.Builder

setDocumentSchema(DocumentSchema.Builder builderForValue)

public ProcessorVersion.Builder setDocumentSchema(DocumentSchema.Builder builderForValue)

The schema of the processor version. Describes the output.

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

Parameter
NameDescription
builderForValueDocumentSchema.Builder
Returns
TypeDescription
ProcessorVersion.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ProcessorVersion.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ProcessorVersion.Builder
Overrides

setGoogleManaged(boolean value)

public ProcessorVersion.Builder setGoogleManaged(boolean value)

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

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

Parameter
NameDescription
valueboolean

The googleManaged to set.

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

setKmsKeyName(String value)

public ProcessorVersion.Builder setKmsKeyName(String value)

The KMS key name used for encryption.

string kms_key_name = 9;

Parameter
NameDescription
valueString

The kmsKeyName to set.

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public ProcessorVersion.Builder setKmsKeyNameBytes(ByteString value)

The KMS key name used for encryption.

string kms_key_name = 9;

Parameter
NameDescription
valueByteString

The bytes for kmsKeyName to set.

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

setKmsKeyVersionName(String value)

public ProcessorVersion.Builder setKmsKeyVersionName(String value)

The KMS key version with which data is encrypted.

string kms_key_version_name = 10;

Parameter
NameDescription
valueString

The kmsKeyVersionName to set.

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

setKmsKeyVersionNameBytes(ByteString value)

public ProcessorVersion.Builder setKmsKeyVersionNameBytes(ByteString value)

The KMS key version with which data is encrypted.

string kms_key_version_name = 10;

Parameter
NameDescription
valueByteString

The bytes for kmsKeyVersionName to set.

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

setLatestEvaluation(EvaluationReference value)

public ProcessorVersion.Builder setLatestEvaluation(EvaluationReference value)

The most recently invoked evaluation for the processor version.

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

Parameter
NameDescription
valueEvaluationReference
Returns
TypeDescription
ProcessorVersion.Builder

setLatestEvaluation(EvaluationReference.Builder builderForValue)

public ProcessorVersion.Builder setLatestEvaluation(EvaluationReference.Builder builderForValue)

The most recently invoked evaluation for the processor version.

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

Parameter
NameDescription
builderForValueEvaluationReference.Builder
Returns
TypeDescription
ProcessorVersion.Builder

setName(String value)

public ProcessorVersion.Builder setName(String value)

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

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ProcessorVersion.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ProcessorVersion.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ProcessorVersion.Builder
Overrides

setState(ProcessorVersion.State value)

public ProcessorVersion.Builder setState(ProcessorVersion.State value)

The state of the processor version.

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

Parameter
NameDescription
valueProcessorVersion.State

The state to set.

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

setStateValue(int value)

public ProcessorVersion.Builder setStateValue(int value)

The state of the processor version.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
ProcessorVersion.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ProcessorVersion.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ProcessorVersion.Builder
Overrides