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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ProcessorType.Builder newBuilder()
newBuilder(ProcessorType prototype)
public static ProcessorType.Builder newBuilder(ProcessorType prototype)
public static ProcessorType parseDelimitedFrom(InputStream input)
public static ProcessorType parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ProcessorType parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ProcessorType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ProcessorType parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ProcessorType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ProcessorType parseFrom(CodedInputStream input)
public static ProcessorType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ProcessorType parseFrom(InputStream input)
public static ProcessorType parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ProcessorType parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ProcessorType parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ProcessorType> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
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 |
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.v1beta3.ProcessorType.LocationInfo available_locations = 4;
Parameter |
Name |
Description |
index |
int
|
getAvailableLocationsCount()
public int getAvailableLocationsCount()
The locations in which this processor is available.
repeated .google.cloud.documentai.v1beta3.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.v1beta3.ProcessorType.LocationInfo available_locations = 4;
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 |
Name |
Description |
index |
int
|
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 |
Type |
Description |
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 |
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()
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()
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()
Overrides
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;
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
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()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ProcessorType.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ProcessorType.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public ProcessorType.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides