Package com.google.cloud.documentai.v1

Class Processor

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

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • DEFAULT_PROCESSOR_VERSION_FIELD_NUMBER

      public static final int DEFAULT_PROCESSOR_VERSION_FIELD_NUMBER
      See Also:

    • PROCESSOR_VERSION_ALIASES_FIELD_NUMBER

      public static final int PROCESSOR_VERSION_ALIASES_FIELD_NUMBER
      See Also:

    • PROCESS_ENDPOINT_FIELD_NUMBER

      public static final int PROCESS_ENDPOINT_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • KMS_KEY_NAME_FIELD_NUMBER

      public static final int KMS_KEY_NAME_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:

  • 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()
       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.v1.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.v1.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.v1.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.v1.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.

    • getProcessorVersionAliasesList

      public List<ProcessorVersionAlias> getProcessorVersionAliasesList()
       Output only. The processor version aliases.
      repeated .google.cloud.documentai.v1.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getProcessorVersionAliasesList in interface ProcessorOrBuilder

    • getProcessorVersionAliasesOrBuilderList

      public List<? extends ProcessorVersionAliasOrBuilder> getProcessorVersionAliasesOrBuilderList()
       Output only. The processor version aliases.
      repeated .google.cloud.documentai.v1.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getProcessorVersionAliasesOrBuilderList in interface ProcessorOrBuilder

    • getProcessorVersionAliasesCount

      public int getProcessorVersionAliasesCount()
       Output only. The processor version aliases.
      repeated .google.cloud.documentai.v1.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getProcessorVersionAliasesCount in interface ProcessorOrBuilder

    • getProcessorVersionAliases

      public ProcessorVersionAlias getProcessorVersionAliases(int index)
       Output only. The processor version aliases.
      repeated .google.cloud.documentai.v1.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getProcessorVersionAliases in interface ProcessorOrBuilder

    • getProcessorVersionAliasesOrBuilder

      public ProcessorVersionAliasOrBuilder getProcessorVersionAliasesOrBuilder(int index)
       Output only. The processor version aliases.
      repeated .google.cloud.documentai.v1.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getProcessorVersionAliasesOrBuilder in interface ProcessorOrBuilder

    • 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()
       Output only. The time the processor was created.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface ProcessorOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

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

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time the processor was created.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      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.

    • getSatisfiesPzs

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

    • getSatisfiesPzi

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

    • 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 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • 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

    • newBuilder

      public static Processor.Builder newBuilder()

    • newBuilder

      public static Processor.Builder newBuilder(Processor prototype)

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

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

    • getDefaultInstanceForType

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