Package com.google.cloud.documentai.v1

Class ProcessorVersion

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1.ProcessorVersion
All Implemented Interfaces:
ProcessorVersionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ProcessorVersion extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DOCUMENT_SCHEMA_FIELD_NUMBER

      public static final int DOCUMENT_SCHEMA_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • LATEST_EVALUATION_FIELD_NUMBER

      public static final int LATEST_EVALUATION_FIELD_NUMBER
      See Also:

    • KMS_KEY_NAME_FIELD_NUMBER

      public static final int KMS_KEY_NAME_FIELD_NUMBER
      See Also:

    • KMS_KEY_VERSION_NAME_FIELD_NUMBER

      public static final int KMS_KEY_VERSION_NAME_FIELD_NUMBER
      See Also:

    • GOOGLE_MANAGED_FIELD_NUMBER

      public static final int GOOGLE_MANAGED_FIELD_NUMBER
      See Also:

    • DEPRECATION_INFO_FIELD_NUMBER

      public static final int DEPRECATION_INFO_FIELD_NUMBER
      See Also:

    • MODEL_TYPE_FIELD_NUMBER

      public static final int MODEL_TYPE_FIELD_NUMBER
      See Also:

    • SATISFIES_PZS_FIELD_NUMBER

      public static final int SATISFIES_PZS_FIELD_NUMBER
      See Also:

    • SATISFIES_PZI_FIELD_NUMBER

      public static final int SATISFIES_PZI_FIELD_NUMBER
      See Also:

    • GEN_AI_MODEL_INFO_FIELD_NUMBER

      public static final int GEN_AI_MODEL_INFO_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      getName in interface ProcessorVersionOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface ProcessorVersionOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       The display name of the processor version.
      string display_name = 2;
      Specified by:
      getDisplayName in interface ProcessorVersionOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       The display name of the processor version.
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface ProcessorVersionOrBuilder
      Returns:
      The bytes for displayName.

    • hasDocumentSchema

      public boolean hasDocumentSchema()
       Output only. The schema of the processor version. Describes the output.
      .google.cloud.documentai.v1.DocumentSchema document_schema = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasDocumentSchema in interface ProcessorVersionOrBuilder
      Returns:
      Whether the documentSchema field is set.

    • getDocumentSchema

      public DocumentSchema getDocumentSchema()
       Output only. The schema of the processor version. Describes the output.
      .google.cloud.documentai.v1.DocumentSchema document_schema = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDocumentSchema in interface ProcessorVersionOrBuilder
      Returns:
      The documentSchema.

    • getDocumentSchemaOrBuilder

      public DocumentSchemaOrBuilder getDocumentSchemaOrBuilder()
       Output only. The schema of the processor version. Describes the output.
      .google.cloud.documentai.v1.DocumentSchema document_schema = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDocumentSchemaOrBuilder in interface ProcessorVersionOrBuilder

    • 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];
      Specified by:
      getStateValue in interface ProcessorVersionOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • 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];
      Specified by:
      getState in interface ProcessorVersionOrBuilder
      Returns:
      The state.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The time the processor version was created.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface ProcessorVersionOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The time the processor version was created.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface ProcessorVersionOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time the processor version was created.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface ProcessorVersionOrBuilder

    • hasLatestEvaluation

      public boolean hasLatestEvaluation()
       Output only. The most recently invoked evaluation for the processor
 version.
      .google.cloud.documentai.v1.EvaluationReference latest_evaluation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasLatestEvaluation in interface ProcessorVersionOrBuilder
      Returns:
      Whether the latestEvaluation field is set.

    • getLatestEvaluation

      public EvaluationReference getLatestEvaluation()
       Output only. The most recently invoked evaluation for the processor
 version.
      .google.cloud.documentai.v1.EvaluationReference latest_evaluation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLatestEvaluation in interface ProcessorVersionOrBuilder
      Returns:
      The latestEvaluation.

    • getLatestEvaluationOrBuilder

      public EvaluationReferenceOrBuilder getLatestEvaluationOrBuilder()
       Output only. The most recently invoked evaluation for the processor
 version.
      .google.cloud.documentai.v1.EvaluationReference latest_evaluation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLatestEvaluationOrBuilder in interface ProcessorVersionOrBuilder

    • getKmsKeyName

      public String getKmsKeyName()
       Output only. The KMS key name used for encryption.
      string kms_key_name = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getKmsKeyName in interface ProcessorVersionOrBuilder
      Returns:
      The kmsKeyName.

    • getKmsKeyNameBytes

      public com.google.protobuf.ByteString getKmsKeyNameBytes()
       Output only. The KMS key name used for encryption.
      string kms_key_name = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getKmsKeyNameBytes in interface ProcessorVersionOrBuilder
      Returns:
      The bytes for kmsKeyName.

    • getKmsKeyVersionName

      public String getKmsKeyVersionName()
       Output only. The KMS key version with which data is encrypted.
      string kms_key_version_name = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getKmsKeyVersionName in interface ProcessorVersionOrBuilder
      Returns:
      The kmsKeyVersionName.

    • getKmsKeyVersionNameBytes

      public com.google.protobuf.ByteString getKmsKeyVersionNameBytes()
       Output only. The KMS key version with which data is encrypted.
      string kms_key_version_name = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getKmsKeyVersionNameBytes in interface ProcessorVersionOrBuilder
      Returns:
      The bytes for kmsKeyVersionName.

    • getGoogleManaged

      public boolean getGoogleManaged()
       Output only. Denotes that this `ProcessorVersion` is managed by Google.
      bool google_managed = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGoogleManaged in interface ProcessorVersionOrBuilder
      Returns:
      The googleManaged.

    • hasDeprecationInfo

      public boolean hasDeprecationInfo()
       Output only. If set, information about the eventual deprecation of this
 version.
      .google.cloud.documentai.v1.ProcessorVersion.DeprecationInfo deprecation_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasDeprecationInfo in interface ProcessorVersionOrBuilder
      Returns:
      Whether the deprecationInfo field is set.

    • getDeprecationInfo

      public ProcessorVersion.DeprecationInfo getDeprecationInfo()
       Output only. If set, information about the eventual deprecation of this
 version.
      .google.cloud.documentai.v1.ProcessorVersion.DeprecationInfo deprecation_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDeprecationInfo in interface ProcessorVersionOrBuilder
      Returns:
      The deprecationInfo.

    • getDeprecationInfoOrBuilder

      public ProcessorVersion.DeprecationInfoOrBuilder getDeprecationInfoOrBuilder()
       Output only. If set, information about the eventual deprecation of this
 version.
      .google.cloud.documentai.v1.ProcessorVersion.DeprecationInfo deprecation_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDeprecationInfoOrBuilder in interface ProcessorVersionOrBuilder

    • 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];
      Specified by:
      getModelTypeValue in interface ProcessorVersionOrBuilder
      Returns:
      The enum numeric value on the wire for modelType.

    • 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];
      Specified by:
      getModelType in interface ProcessorVersionOrBuilder
      Returns:
      The modelType.

    • getSatisfiesPzs

      public boolean getSatisfiesPzs()
       Output only. Reserved for future use.
      bool satisfies_pzs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzs in interface ProcessorVersionOrBuilder
      Returns:
      The satisfiesPzs.

    • getSatisfiesPzi

      public boolean getSatisfiesPzi()
       Output only. Reserved for future use.
      bool satisfies_pzi = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzi in interface ProcessorVersionOrBuilder
      Returns:
      The satisfiesPzi.

    • 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];
      Specified by:
      hasGenAiModelInfo in interface ProcessorVersionOrBuilder
      Returns:
      Whether the genAiModelInfo field is set.

    • 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];
      Specified by:
      getGenAiModelInfo in interface ProcessorVersionOrBuilder
      Returns:
      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];
      Specified by:
      getGenAiModelInfoOrBuilder in interface ProcessorVersionOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ProcessorVersion parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProcessorVersion parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProcessorVersion parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProcessorVersion parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProcessorVersion parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProcessorVersion parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProcessorVersion parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ProcessorVersion parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ProcessorVersion parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ProcessorVersion parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ProcessorVersion parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ProcessorVersion parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ProcessorVersion.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ProcessorVersion.Builder newBuilder()

    • newBuilder

      public static ProcessorVersion.Builder newBuilder(ProcessorVersion prototype)

    • toBuilder

      public ProcessorVersion.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ProcessorVersion.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ProcessorVersion getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ProcessorVersion> parser()

    • getParserForType

      public com.google.protobuf.Parser<ProcessorVersion> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ProcessorVersion getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder