com.google.cloud.documentai.v1beta3

Class ProcessorType

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1beta3.ProcessorType

All Implemented Interfaces:

ProcessorTypeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ProcessorType
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessorType.Builder A processor type is responsible for performing a certain document understanding task on a certain type of document.
static class	ProcessorType.LocationInfo The location information about where the processor is available.
static interface	ProcessorType.LocationInfoOrBuilder

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOW_CREATION_FIELD_NUMBER
static int	AVAILABLE_LOCATIONS_FIELD_NUMBER
static int	CATEGORY_FIELD_NUMBER
static int	LAUNCH_STAGE_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	SAMPLE_DOCUMENT_URIS_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	getAllowCreation() Whether the processor type allows creation.
ProcessorType.LocationInfo	getAvailableLocations(int index) The locations in which this processor is available.
int	getAvailableLocationsCount() The locations in which this processor is available.
List<ProcessorType.LocationInfo>	getAvailableLocationsList() The locations in which this processor is available.
ProcessorType.LocationInfoOrBuilder	getAvailableLocationsOrBuilder(int index) The locations in which this processor is available.
List<? extends ProcessorType.LocationInfoOrBuilder>	getAvailableLocationsOrBuilderList() The locations in which this processor is available.
String	getCategory() The processor category, used by UI to group processor types.
com.google.protobuf.ByteString	getCategoryBytes() The processor category, used by UI to group processor types.
static ProcessorType	getDefaultInstance()
ProcessorType	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.api.LaunchStage	getLaunchStage() Launch stage of the processor type .google.api.LaunchStage launch_stage = 8;
int	getLaunchStageValue() Launch stage of the processor type .google.api.LaunchStage launch_stage = 8;
String	getName() The resource name of the processor type.
com.google.protobuf.ByteString	getNameBytes() The resource name of the processor type.
com.google.protobuf.Parser<ProcessorType>	getParserForType()
String	getSampleDocumentUris(int index) A set of Cloud Storage URIs of sample documents for this processor.
com.google.protobuf.ByteString	getSampleDocumentUrisBytes(int index) A set of Cloud Storage URIs of sample documents for this processor.
int	getSampleDocumentUrisCount() A set of Cloud Storage URIs of sample documents for this processor.
com.google.protobuf.ProtocolStringList	getSampleDocumentUrisList() A set of Cloud Storage URIs of sample documents for this processor.
int	getSerializedSize()
String	getType() The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
com.google.protobuf.ByteString	getTypeBytes() The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ProcessorType.Builder	newBuilder()
static ProcessorType.Builder	newBuilder(ProcessorType prototype)
ProcessorType.Builder	newBuilderForType()
protected ProcessorType.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ProcessorType	parseDelimitedFrom(InputStream input)
static ProcessorType	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProcessorType	parseFrom(byte[] data)
static ProcessorType	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProcessorType	parseFrom(ByteBuffer data)
static ProcessorType	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProcessorType	parseFrom(com.google.protobuf.ByteString data)
static ProcessorType	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProcessorType	parseFrom(com.google.protobuf.CodedInputStream input)
static ProcessorType	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProcessorType	parseFrom(InputStream input)
static ProcessorType	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ProcessorType>	parser()
ProcessorType.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER

See Also:

Constant Field Values

AVAILABLE_LOCATIONS_FIELD_NUMBER

public static final int AVAILABLE_LOCATIONS_FIELD_NUMBER

See Also:

Constant Field Values

ALLOW_CREATION_FIELD_NUMBER

public static final int ALLOW_CREATION_FIELD_NUMBER

See Also:

Constant Field Values

LAUNCH_STAGE_FIELD_NUMBER

public static final int LAUNCH_STAGE_FIELD_NUMBER

See Also:

Constant Field Values

SAMPLE_DOCUMENT_URIS_FIELD_NUMBER

public static final int SAMPLE_DOCUMENT_URIS_FIELD_NUMBER

See Also:

Constant Field Values

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()

 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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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 com.google.api.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.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 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.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

getDefaultInstanceForType

public ProcessorType getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder