Class ProcessorType (2.7.3)

Stay organized with collections Save and categorize content based on your preferences.
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.v1beta3.ProcessorType

Static Fields

ALLOW_CREATION_FIELD_NUMBER

public static final int ALLOW_CREATION_FIELD_NUMBER
Field Value
TypeDescription
int

AVAILABLE_LOCATIONS_FIELD_NUMBER

public static final int AVAILABLE_LOCATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER
Field Value
TypeDescription
int

LAUNCH_STAGE_FIELD_NUMBER

public static final int LAUNCH_STAGE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ProcessorType getDefaultInstance()
Returns
TypeDescription
ProcessorType

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ProcessorType.Builder newBuilder()
Returns
TypeDescription
ProcessorType.Builder

newBuilder(ProcessorType prototype)

public static ProcessorType.Builder newBuilder(ProcessorType prototype)
Parameter
NameDescription
prototypeProcessorType
Returns
TypeDescription
ProcessorType.Builder

parseDelimitedFrom(InputStream input)

public static ProcessorType parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ProcessorType
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessorType parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessorType
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ProcessorType parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ProcessorType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProcessorType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessorType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProcessorType parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ProcessorType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProcessorType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessorType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProcessorType parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ProcessorType
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessorType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessorType
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ProcessorType parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ProcessorType
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessorType parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessorType
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ProcessorType parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ProcessorType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProcessorType parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessorType
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ProcessorType> parser()
Returns
TypeDescription
Parser<ProcessorType>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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
TypeDescription
boolean

The allowCreation.

getAvailableLocations(int index)

public ProcessorType.LocationInfo getAvailableLocations(int index)

The locations in which this processor is available.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
ProcessorType.LocationInfo

getAvailableLocationsCount()

public int getAvailableLocationsCount()

The locations in which this processor is available.

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

Returns
TypeDescription
int

getAvailableLocationsList()

public List<ProcessorType.LocationInfo> getAvailableLocationsList()

The locations in which this processor is available.

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

Returns
TypeDescription
List<LocationInfo>

getAvailableLocationsOrBuilder(int index)

public ProcessorType.LocationInfoOrBuilder getAvailableLocationsOrBuilder(int index)

The locations in which this processor is available.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
ProcessorType.LocationInfoOrBuilder

getAvailableLocationsOrBuilderList()

public List<? extends ProcessorType.LocationInfoOrBuilder> getAvailableLocationsOrBuilderList()

The locations in which this processor is available.

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

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1beta3.ProcessorType.LocationInfoOrBuilder>

getCategory()

public String getCategory()

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

string category = 3;

Returns
TypeDescription
String

The category.

getCategoryBytes()

public ByteString getCategoryBytes()

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

string category = 3;

Returns
TypeDescription
ByteString

The bytes for category.

getDefaultInstanceForType()

public ProcessorType getDefaultInstanceForType()
Returns
TypeDescription
ProcessorType

getLaunchStage()

public LaunchStage getLaunchStage()

Launch stage of the processor type

.google.api.LaunchStage launch_stage = 8;

Returns
TypeDescription
com.google.api.LaunchStage

The launchStage.

getLaunchStageValue()

public int getLaunchStageValue()

Launch stage of the processor type

.google.api.LaunchStage launch_stage = 8;

Returns
TypeDescription
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
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<ProcessorType> getParserForType()
Returns
TypeDescription
Parser<ProcessorType>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getType()

public String getType()

The type of the processor, e.g., "invoice_parsing".

string type = 2;

Returns
TypeDescription
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

The type of the processor, e.g., "invoice_parsing".

string type = 2;

Returns
TypeDescription
ByteString

The bytes for type.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ProcessorType.Builder newBuilderForType()
Returns
TypeDescription
ProcessorType.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProcessorType.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ProcessorType.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ProcessorType.Builder toBuilder()
Returns
TypeDescription
ProcessorType.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException