Class ProcessorVersion.Builder

  • All Implemented Interfaces:
    ProcessorVersionOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ProcessorVersion

    public static final class ProcessorVersion.Builder
    extends com.google.protobuf.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
    • Method Detail

      • 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.Builder<ProcessorVersion.Builder>
      • clear

        public ProcessorVersion.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessorVersion.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessorVersion.Builder>
      • getDefaultInstanceForType

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

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

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

        public ProcessorVersion.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessorVersion.Builder>
      • setField

        public ProcessorVersion.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessorVersion.Builder>
      • clearField

        public ProcessorVersion.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessorVersion.Builder>
      • clearOneof

        public ProcessorVersion.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessorVersion.Builder>
      • setRepeatedField

        public ProcessorVersion.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         int index,
                                                         Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessorVersion.Builder>
      • addRepeatedField

        public ProcessorVersion.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessorVersion.Builder>
      • mergeFrom

        public ProcessorVersion.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProcessorVersion.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessorVersion.Builder>
      • mergeFrom

        public ProcessorVersion.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProcessorVersion.Builder>
        Throws:
        IOException
      • 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.
      • setName

        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;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.
      • 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:
        This builder for chaining.
      • setNameBytes

        public ProcessorVersion.Builder setNameBytes​(com.google.protobuf.ByteString value)
         The resource name of the processor version.
         Format:
         `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
         
        string name = 1;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.
      • 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.
      • setDisplayName

        public ProcessorVersion.Builder setDisplayName​(String value)
         The display name of the processor version.
         
        string display_name = 2;
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.
      • clearDisplayName

        public ProcessorVersion.Builder clearDisplayName()
         The display name of the processor version.
         
        string display_name = 2;
        Returns:
        This builder for chaining.
      • setDisplayNameBytes

        public ProcessorVersion.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         The display name of the processor version.
         
        string display_name = 2;
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.
      • 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.
      • setDocumentSchema

        public ProcessorVersion.Builder setDocumentSchema​(DocumentSchema value)
         The schema of the processor version. Describes the output.
         
        .google.cloud.documentai.v1.DocumentSchema document_schema = 12;
      • setDocumentSchema

        public ProcessorVersion.Builder setDocumentSchema​(DocumentSchema.Builder builderForValue)
         The schema of the processor version. Describes the output.
         
        .google.cloud.documentai.v1.DocumentSchema document_schema = 12;
      • mergeDocumentSchema

        public ProcessorVersion.Builder mergeDocumentSchema​(DocumentSchema value)
         The schema of the processor version. Describes the output.
         
        .google.cloud.documentai.v1.DocumentSchema document_schema = 12;
      • clearDocumentSchema

        public ProcessorVersion.Builder clearDocumentSchema()
         The schema of the processor version. Describes the output.
         
        .google.cloud.documentai.v1.DocumentSchema document_schema = 12;
      • getDocumentSchemaBuilder

        public DocumentSchema.Builder getDocumentSchemaBuilder()
         The schema of the processor version. Describes the output.
         
        .google.cloud.documentai.v1.DocumentSchema document_schema = 12;
      • 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.
      • setStateValue

        public ProcessorVersion.Builder setStateValue​(int value)
         The state of the processor version.
         
        .google.cloud.documentai.v1.ProcessorVersion.State state = 6;
        Parameters:
        value - The enum numeric value on the wire for state to set.
        Returns:
        This builder for chaining.
      • setState

        public ProcessorVersion.Builder setState​(ProcessorVersion.State value)
         The state of the processor version.
         
        .google.cloud.documentai.v1.ProcessorVersion.State state = 6;
        Parameters:
        value - The state to set.
        Returns:
        This builder for chaining.
      • clearState

        public ProcessorVersion.Builder clearState()
         The state of the processor version.
         
        .google.cloud.documentai.v1.ProcessorVersion.State state = 6;
        Returns:
        This builder for chaining.
      • 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.
      • setCreateTime

        public ProcessorVersion.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         The time the processor version was created.
         
        .google.protobuf.Timestamp create_time = 7;
      • setCreateTime

        public ProcessorVersion.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         The time the processor version was created.
         
        .google.protobuf.Timestamp create_time = 7;
      • mergeCreateTime

        public ProcessorVersion.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         The time the processor version was created.
         
        .google.protobuf.Timestamp create_time = 7;
      • clearCreateTime

        public ProcessorVersion.Builder clearCreateTime()
         The time the processor version was created.
         
        .google.protobuf.Timestamp create_time = 7;
      • getCreateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
         The time the processor version was created.
         
        .google.protobuf.Timestamp create_time = 7;
      • 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.
      • setLatestEvaluation

        public ProcessorVersion.Builder setLatestEvaluation​(EvaluationReference value)
         The most recently invoked evaluation for the processor version.
         
        .google.cloud.documentai.v1.EvaluationReference latest_evaluation = 8;
      • setLatestEvaluation

        public ProcessorVersion.Builder setLatestEvaluation​(EvaluationReference.Builder builderForValue)
         The most recently invoked evaluation for the processor version.
         
        .google.cloud.documentai.v1.EvaluationReference latest_evaluation = 8;
      • mergeLatestEvaluation

        public ProcessorVersion.Builder mergeLatestEvaluation​(EvaluationReference value)
         The most recently invoked evaluation for the processor version.
         
        .google.cloud.documentai.v1.EvaluationReference latest_evaluation = 8;
      • clearLatestEvaluation

        public ProcessorVersion.Builder clearLatestEvaluation()
         The most recently invoked evaluation for the processor version.
         
        .google.cloud.documentai.v1.EvaluationReference latest_evaluation = 8;
      • getLatestEvaluationBuilder

        public EvaluationReference.Builder getLatestEvaluationBuilder()
         The most recently invoked evaluation for the processor version.
         
        .google.cloud.documentai.v1.EvaluationReference latest_evaluation = 8;
      • 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.
      • setKmsKeyName

        public ProcessorVersion.Builder setKmsKeyName​(String value)
         The KMS key name used for encryption.
         
        string kms_key_name = 9;
        Parameters:
        value - The kmsKeyName to set.
        Returns:
        This builder for chaining.
      • clearKmsKeyName

        public ProcessorVersion.Builder clearKmsKeyName()
         The KMS key name used for encryption.
         
        string kms_key_name = 9;
        Returns:
        This builder for chaining.
      • setKmsKeyNameBytes

        public ProcessorVersion.Builder setKmsKeyNameBytes​(com.google.protobuf.ByteString value)
         The KMS key name used for encryption.
         
        string kms_key_name = 9;
        Parameters:
        value - The bytes for kmsKeyName to set.
        Returns:
        This builder for chaining.
      • 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.
      • setKmsKeyVersionName

        public ProcessorVersion.Builder setKmsKeyVersionName​(String value)
         The KMS key version with which data is encrypted.
         
        string kms_key_version_name = 10;
        Parameters:
        value - The kmsKeyVersionName to set.
        Returns:
        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:
        This builder for chaining.
      • setKmsKeyVersionNameBytes

        public ProcessorVersion.Builder setKmsKeyVersionNameBytes​(com.google.protobuf.ByteString value)
         The KMS key version with which data is encrypted.
         
        string kms_key_version_name = 10;
        Parameters:
        value - The bytes for kmsKeyVersionName to set.
        Returns:
        This builder for chaining.
      • 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.
      • setGoogleManaged

        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];
        Parameters:
        value - The googleManaged to set.
        Returns:
        This builder for chaining.
      • 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:
        This builder for chaining.
      • 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.
      • clearDeprecationInfo

        public ProcessorVersion.Builder clearDeprecationInfo()
         If set, information about the eventual deprecation of this version.
         
        .google.cloud.documentai.v1.ProcessorVersion.DeprecationInfo deprecation_info = 13;
      • 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;
      • setUnknownFields

        public final ProcessorVersion.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessorVersion.Builder>
      • mergeUnknownFields

        public final ProcessorVersion.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessorVersion.Builder>