Package com.google.cloud.documentai.v1

Class ProcessorVersion

  • All Implemented Interfaces:
    ProcessorVersionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ProcessorVersion
extends com.google.protobuf.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
    See Also:
    Serialized Form

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_SCHEMA_FIELD_NUMBER

        public static final int DOCUMENT_SCHEMA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LATEST_EVALUATION_FIELD_NUMBER

        public static final int LATEST_EVALUATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KMS_KEY_NAME_FIELD_NUMBER

        public static final int KMS_KEY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KMS_KEY_VERSION_NAME_FIELD_NUMBER

        public static final int KMS_KEY_VERSION_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GOOGLE_MANAGED_FIELD_NUMBER

        public static final int GOOGLE_MANAGED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEPRECATION_INFO_FIELD_NUMBER

        public static final int DEPRECATION_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         The resource name of the processor version.
 Format:
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
        string name = 1;
        Specified by:
        getName in interface ProcessorVersionOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The resource name of the processor version.
 Format:
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
        string name = 1;
        Specified by:
        getNameBytes in interface ProcessorVersionOrBuilder
        Returns:
        The bytes for name.

      • 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()
         The schema of the processor version. Describes the output.
        .google.cloud.documentai.v1.DocumentSchema document_schema = 12;
        Specified by:
        hasDocumentSchema in interface ProcessorVersionOrBuilder
        Returns:
        Whether the documentSchema field is set.

      • getDocumentSchema

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

      • getStateValue

        public int getStateValue()
         The state of the processor version.
        .google.cloud.documentai.v1.ProcessorVersion.State state = 6;
        Specified by:
        getStateValue in interface ProcessorVersionOrBuilder
        Returns:
        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;
        Specified by:
        hasCreateTime in interface ProcessorVersionOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

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

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         The time the processor version was created.
        .google.protobuf.Timestamp create_time = 7;
        Specified by:
        getCreateTimeOrBuilder in interface ProcessorVersionOrBuilder

      • hasLatestEvaluation

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

      • getKmsKeyNameBytes

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

      • getKmsKeyVersionNameBytes

        public com.google.protobuf.ByteString getKmsKeyVersionNameBytes()
         The KMS key version with which data is encrypted.
        string kms_key_version_name = 10;
        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()
         If set, information about the eventual deprecation of this version.
        .google.cloud.documentai.v1.ProcessorVersion.DeprecationInfo deprecation_info = 13;
        Specified by:
        hasDeprecationInfo in interface ProcessorVersionOrBuilder
        Returns:
        Whether the deprecationInfo field is set.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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​(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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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