Class ProcessorType (2.45.0)

Version latest

• 2.45.0 (latest)
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public final class ProcessorType extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ProcessorType

Implements

ProcessorTypeOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALLOW_CREATION_FIELD_NUMBER

public static final int ALLOW_CREATION_FIELD_NUMBER

Field Value
Type	Description
int

AVAILABLE_LOCATIONS_FIELD_NUMBER

public static final int AVAILABLE_LOCATIONS_FIELD_NUMBER

Field Value
Type	Description
int

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER

Field Value
Type	Description
int

LAUNCH_STAGE_FIELD_NUMBER

public static final int LAUNCH_STAGE_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

SAMPLE_DOCUMENT_URIS_FIELD_NUMBER

public static final int SAMPLE_DOCUMENT_URIS_FIELD_NUMBER

Field Value
Type	Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static ProcessorType getDefaultInstance()

Returns
Type	Description
ProcessorType

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static ProcessorType.Builder newBuilder()

Returns
Type	Description
ProcessorType.Builder

newBuilder(ProcessorType prototype)

public static ProcessorType.Builder newBuilder(ProcessorType prototype)

Parameter
Name	Description
prototype	ProcessorType

Returns
Type	Description
ProcessorType.Builder

parseDelimitedFrom(InputStream input)

public static ProcessorType parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ProcessorType

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessorType parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ProcessorType

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static ProcessorType parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
ProcessorType

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProcessorType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ProcessorType

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProcessorType parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
ProcessorType

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProcessorType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ProcessorType

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProcessorType parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
ProcessorType

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessorType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ProcessorType

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static ProcessorType parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ProcessorType

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessorType parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ProcessorType

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static ProcessorType parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
ProcessorType

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProcessorType parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ProcessorType

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ProcessorType> parser()

Returns
Type	Description
Parser<ProcessorType>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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;

Returns
Type	Description
boolean	The allowCreation.

getAvailableLocations(int index)

public ProcessorType.LocationInfo getAvailableLocations(int index)

The locations in which this processor is available.

repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
ProcessorType.LocationInfo

getAvailableLocationsCount()

public int getAvailableLocationsCount()

The locations in which this processor is available.

repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4;

Returns
Type	Description
int

getAvailableLocationsList()

public List<ProcessorType.LocationInfo> getAvailableLocationsList()

The locations in which this processor is available.

repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4;

Returns
Type	Description
List<LocationInfo>

getAvailableLocationsOrBuilder(int index)

public ProcessorType.LocationInfoOrBuilder getAvailableLocationsOrBuilder(int index)

The locations in which this processor is available.

repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
ProcessorType.LocationInfoOrBuilder

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;

Returns
Type	Description
List<? extends com.google.cloud.documentai.v1.ProcessorType.LocationInfoOrBuilder>

getCategory()

public String getCategory()

The processor category, used by UI to group processor types.

string category = 3;

Returns
Type	Description
String	The category.

getCategoryBytes()

public ByteString getCategoryBytes()

The processor category, used by UI to group processor types.

string category = 3;

Returns
Type	Description
ByteString	The bytes for category.

getDefaultInstanceForType()

public ProcessorType getDefaultInstanceForType()

Returns
Type	Description
ProcessorType

getLaunchStage()

public LaunchStage getLaunchStage()

Launch stage of the processor type

.google.api.LaunchStage launch_stage = 8;

Returns
Type	Description
com.google.api.LaunchStage	The launchStage.

getLaunchStageValue()

public int getLaunchStageValue()

Launch stage of the processor type

.google.api.LaunchStage launch_stage = 8;

Returns
Type	Description
int	The enum numeric value on the wire for launchStage.

getName()

public String getName()

The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type}

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type}

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<ProcessorType> getParserForType()

Returns
Type	Description
Parser<ProcessorType>

Overrides

GeneratedMessageV3.getParserForType()

getSampleDocumentUris(int index)

public String getSampleDocumentUris(int index)

A set of Cloud Storage URIs of sample documents for this processor.

repeated string sample_document_uris = 9;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The sampleDocumentUris at the given index.

getSampleDocumentUrisBytes(int index)

public ByteString getSampleDocumentUrisBytes(int index)

A set of Cloud Storage URIs of sample documents for this processor.

repeated string sample_document_uris = 9;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the sampleDocumentUris at the given index.

getSampleDocumentUrisCount()

public int getSampleDocumentUrisCount()

A set of Cloud Storage URIs of sample documents for this processor.

repeated string sample_document_uris = 9;

Returns
Type	Description
int	The count of sampleDocumentUris.

getSampleDocumentUrisList()

public ProtocolStringList getSampleDocumentUrisList()

A set of Cloud Storage URIs of sample documents for this processor.

repeated string sample_document_uris = 9;

Returns
Type	Description
ProtocolStringList	A list containing the sampleDocumentUris.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getType()

public String getType()

The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR.

string type = 2;

Returns
Type	Description
String	The type.

getTypeBytes()

public ByteString getTypeBytes()

The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR.

string type = 2;

Returns
Type	Description
ByteString	The bytes for type.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public ProcessorType.Builder newBuilderForType()

Returns
Type	Description
ProcessorType.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProcessorType.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
ProcessorType.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public ProcessorType.Builder toBuilder()

Returns
Type	Description
ProcessorType.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException