Package com.google.cloud.documentai.v1

Class ProcessorType

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1.ProcessorType
All Implemented Interfaces:
ProcessorTypeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ProcessorType extends com.google.protobuf.GeneratedMessage implements ProcessorTypeOrBuilder
 A processor type is responsible for performing a certain document
 understanding task on a certain type of document.
Protobuf type google.cloud.documentai.v1.ProcessorType
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:

    • CATEGORY_FIELD_NUMBER

      public static final int CATEGORY_FIELD_NUMBER
      See Also:

    • AVAILABLE_LOCATIONS_FIELD_NUMBER

      public static final int AVAILABLE_LOCATIONS_FIELD_NUMBER
      See Also:

    • ALLOW_CREATION_FIELD_NUMBER

      public static final int ALLOW_CREATION_FIELD_NUMBER
      See Also:

    • LAUNCH_STAGE_FIELD_NUMBER

      public static final int LAUNCH_STAGE_FIELD_NUMBER
      See Also:

    • SAMPLE_DOCUMENT_URIS_FIELD_NUMBER

      public static final int SAMPLE_DOCUMENT_URIS_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()
       The resource name of the processor type.
 Format: `projects/{project}/processorTypes/{processor_type}`
      string name = 1;
      Specified by:
      getName in interface ProcessorTypeOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The resource name of the processor type.
 Format: `projects/{project}/processorTypes/{processor_type}`
      string name = 1;
      Specified by:
      getNameBytes in interface ProcessorTypeOrBuilder
      Returns:
      The bytes for name.

    • getType

      public String getType()
       The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
      string type = 2;
      Specified by:
      getType in interface ProcessorTypeOrBuilder
      Returns:
      The type.

    • getTypeBytes

      public com.google.protobuf.ByteString getTypeBytes()
       The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
      string type = 2;
      Specified by:
      getTypeBytes in interface ProcessorTypeOrBuilder
      Returns:
      The bytes for type.

    • getCategory

      public String getCategory()
       The processor category, used by UI to group processor types.
      string category = 3;
      Specified by:
      getCategory in interface ProcessorTypeOrBuilder
      Returns:
      The category.

    • getCategoryBytes

      public com.google.protobuf.ByteString getCategoryBytes()
       The processor category, used by UI to group processor types.
      string category = 3;
      Specified by:
      getCategoryBytes in interface ProcessorTypeOrBuilder
      Returns:
      The bytes for category.

    • getAvailableLocationsList

      public List<ProcessorType.LocationInfo> getAvailableLocationsList()
       The locations in which this processor is available.
      repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4;
      Specified by:
      getAvailableLocationsList in interface ProcessorTypeOrBuilder

    • getAvailableLocationsOrBuilderList

      public List<? extends ProcessorType.LocationInfoOrBuilder> getAvailableLocationsOrBuilderList()
       The locations in which this processor is available.
      repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4;
      Specified by:
      getAvailableLocationsOrBuilderList in interface ProcessorTypeOrBuilder

    • getAvailableLocationsCount

      public int getAvailableLocationsCount()
       The locations in which this processor is available.
      repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4;
      Specified by:
      getAvailableLocationsCount in interface ProcessorTypeOrBuilder

    • getAvailableLocations

      public ProcessorType.LocationInfo getAvailableLocations(int index)
       The locations in which this processor is available.
      repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4;
      Specified by:
      getAvailableLocations in interface ProcessorTypeOrBuilder

    • getAvailableLocationsOrBuilder

      public ProcessorType.LocationInfoOrBuilder getAvailableLocationsOrBuilder(int index)
       The locations in which this processor is available.
      repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4;
      Specified by:
      getAvailableLocationsOrBuilder in interface ProcessorTypeOrBuilder

    • getAllowCreation

      public boolean getAllowCreation()
       Whether the processor type allows creation. If true, users can create a
 processor of this processor type. Otherwise, users need to request access.
      bool allow_creation = 6;
      Specified by:
      getAllowCreation in interface ProcessorTypeOrBuilder
      Returns:
      The allowCreation.

    • getLaunchStageValue

      public int getLaunchStageValue()
       Launch stage of the processor type
      .google.api.LaunchStage launch_stage = 8;
      Specified by:
      getLaunchStageValue in interface ProcessorTypeOrBuilder
      Returns:
      The enum numeric value on the wire for launchStage.

    • getLaunchStage

      public LaunchStage getLaunchStage()
       Launch stage of the processor type
      .google.api.LaunchStage launch_stage = 8;
      Specified by:
      getLaunchStage in interface ProcessorTypeOrBuilder
      Returns:
      The launchStage.

    • getSampleDocumentUrisList

      public com.google.protobuf.ProtocolStringList getSampleDocumentUrisList()
       A set of Cloud Storage URIs of sample documents for this processor.
      repeated string sample_document_uris = 9;
      Specified by:
      getSampleDocumentUrisList in interface ProcessorTypeOrBuilder
      Returns:
      A list containing the sampleDocumentUris.

    • getSampleDocumentUrisCount

      public int getSampleDocumentUrisCount()
       A set of Cloud Storage URIs of sample documents for this processor.
      repeated string sample_document_uris = 9;
      Specified by:
      getSampleDocumentUrisCount in interface ProcessorTypeOrBuilder
      Returns:
      The count of sampleDocumentUris.

    • getSampleDocumentUris

      public String getSampleDocumentUris(int index)
       A set of Cloud Storage URIs of sample documents for this processor.
      repeated string sample_document_uris = 9;
      Specified by:
      getSampleDocumentUris in interface ProcessorTypeOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The sampleDocumentUris at the given index.

    • getSampleDocumentUrisBytes

      public com.google.protobuf.ByteString getSampleDocumentUrisBytes(int index)
       A set of Cloud Storage URIs of sample documents for this processor.
      repeated string sample_document_uris = 9;
      Specified by:
      getSampleDocumentUrisBytes in interface ProcessorTypeOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the sampleDocumentUris at the given index.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ProcessorType.Builder newBuilder()

    • newBuilder

      public static ProcessorType.Builder newBuilder(ProcessorType prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ProcessorType getDefaultInstance()

    • parser

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

    • getParserForType

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