Package com.google.cloud.documentai.v1beta3

Class Processor

  • All Implemented Interfaces:
    ProcessorOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Processor
extends com.google.protobuf.GeneratedMessageV3
implements ProcessorOrBuilder
     The first-class citizen for Document AI. Each processor defines how to
 extract structural information from a document.
    Protobuf type google.cloud.documentai.v1beta3.Processor
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Processor.Builder
      The first-class citizen for Document AI.
      static class  Processor.State
      The possible states of the processor.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • 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()
         Output only. Immutable. The resource name of the processor.
 Format: `projects/{project}/locations/{location}/processors/{processor}`
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface ProcessorOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Immutable. The resource name of the processor.
 Format: `projects/{project}/locations/{location}/processors/{processor}`
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface ProcessorOrBuilder
        Returns:
        The bytes for name.

      • getType

        public String getType()
         The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
 To get a list of processor types, see
 [FetchProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypes].
        string type = 2;
        Specified by:
        getType in interface ProcessorOrBuilder
        Returns:
        The type.

      • getTypeBytes

        public com.google.protobuf.ByteString getTypeBytes()
         The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
 To get a list of processor types, see
 [FetchProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypes].
        string type = 2;
        Specified by:
        getTypeBytes in interface ProcessorOrBuilder
        Returns:
        The bytes for type.

      • getDisplayName

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

      • getDisplayNameBytes

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

      • getStateValue

        public int getStateValue()
         Output only. The state of the processor.
        .google.cloud.documentai.v1beta3.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface ProcessorOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Processor.State getState()
         Output only. The state of the processor.
        .google.cloud.documentai.v1beta3.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface ProcessorOrBuilder
        Returns:
        The state.

      • getDefaultProcessorVersion

        public String getDefaultProcessorVersion()
         The default processor version.
        string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
        Specified by:
        getDefaultProcessorVersion in interface ProcessorOrBuilder
        Returns:
        The defaultProcessorVersion.

      • getDefaultProcessorVersionBytes

        public com.google.protobuf.ByteString getDefaultProcessorVersionBytes()
         The default processor version.
        string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
        Specified by:
        getDefaultProcessorVersionBytes in interface ProcessorOrBuilder
        Returns:
        The bytes for defaultProcessorVersion.

      • getProcessEndpoint

        public String getProcessEndpoint()
         Output only. Immutable. The http endpoint that can be called to invoke
 processing.
        string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getProcessEndpoint in interface ProcessorOrBuilder
        Returns:
        The processEndpoint.

      • getProcessEndpointBytes

        public com.google.protobuf.ByteString getProcessEndpointBytes()
         Output only. Immutable. The http endpoint that can be called to invoke
 processing.
        string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getProcessEndpointBytes in interface ProcessorOrBuilder
        Returns:
        The bytes for processEndpoint.

      • hasCreateTime

        public boolean hasCreateTime()
         The time the processor was created.
        .google.protobuf.Timestamp create_time = 7;
        Specified by:
        hasCreateTime in interface ProcessorOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

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

      • getCreateTimeOrBuilder

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

      • getKmsKeyName

        public String getKmsKeyName()
         The [KMS key](https://cloud.google.com/security-key-management) used for
 encryption and decryption in CMEK scenarios.
        string kms_key_name = 8;
        Specified by:
        getKmsKeyName in interface ProcessorOrBuilder
        Returns:
        The kmsKeyName.

      • getKmsKeyNameBytes

        public com.google.protobuf.ByteString getKmsKeyNameBytes()
         The [KMS key](https://cloud.google.com/security-key-management) used for
 encryption and decryption in CMEK scenarios.
        string kms_key_name = 8;
        Specified by:
        getKmsKeyNameBytes in interface ProcessorOrBuilder
        Returns:
        The bytes for kmsKeyName.

      • 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 Processor parseFrom​(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Processor.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Processor getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Processor> 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 Processor getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder