Package com.google.cloud.documentai.v1
Interface ProcessorTypeOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
ProcessorType,ProcessorType.Builder
@Generated
public interface ProcessorTypeOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleanWhether the processor type allows creation.getAvailableLocations(int index) The locations in which this processor is available.intThe locations in which this processor is available.The locations in which this processor is available.getAvailableLocationsOrBuilder(int index) The locations in which this processor is available.List<? extends ProcessorType.LocationInfoOrBuilder>The locations in which this processor is available.The processor category, used by UI to group processor types.com.google.protobuf.ByteStringThe processor category, used by UI to group processor types.Launch stage of the processor typeintLaunch stage of the processor typegetName()The resource name of the processor type.com.google.protobuf.ByteStringThe resource name of the processor type.getSampleDocumentUris(int index) A set of Cloud Storage URIs of sample documents for this processor.com.google.protobuf.ByteStringgetSampleDocumentUrisBytes(int index) A set of Cloud Storage URIs of sample documents for this processor.intA set of Cloud Storage URIs of sample documents for this processor.A set of Cloud Storage URIs of sample documents for this processor.getType()The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.com.google.protobuf.ByteStringThe processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}`string name = 1;- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}`string name = 1;- Returns:
- The bytes for name.
-
getType
String getType()The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
string type = 2;- Returns:
- The type.
-
getTypeBytes
com.google.protobuf.ByteString getTypeBytes()The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
string type = 2;- Returns:
- The bytes for type.
-
getCategory
String getCategory()The processor category, used by UI to group processor types.
string category = 3;- Returns:
- The category.
-
getCategoryBytes
com.google.protobuf.ByteString getCategoryBytes()The processor category, used by UI to group processor types.
string category = 3;- Returns:
- The bytes for category.
-
getAvailableLocationsList
List<ProcessorType.LocationInfo> getAvailableLocationsList()The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
getAvailableLocations
The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
getAvailableLocationsCount
int getAvailableLocationsCount()The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
getAvailableLocationsOrBuilderList
List<? extends ProcessorType.LocationInfoOrBuilder> getAvailableLocationsOrBuilderList()The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
getAvailableLocationsOrBuilder
The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
getAllowCreation
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:
- The allowCreation.
-
getLaunchStageValue
int getLaunchStageValue()Launch stage of the processor type
.google.api.LaunchStage launch_stage = 8;- Returns:
- The enum numeric value on the wire for launchStage.
-
getLaunchStage
LaunchStage getLaunchStage()Launch stage of the processor type
.google.api.LaunchStage launch_stage = 8;- Returns:
- The launchStage.
-
getSampleDocumentUrisList
A set of Cloud Storage URIs of sample documents for this processor.
repeated string sample_document_uris = 9;- Returns:
- A list containing the sampleDocumentUris.
-
getSampleDocumentUrisCount
int getSampleDocumentUrisCount()A set of Cloud Storage URIs of sample documents for this processor.
repeated string sample_document_uris = 9;- Returns:
- The count of sampleDocumentUris.
-
getSampleDocumentUris
A set of Cloud Storage URIs of sample documents for this processor.
repeated string sample_document_uris = 9;- Parameters:
index- The index of the element to return.- Returns:
- The sampleDocumentUris at the given index.
-
getSampleDocumentUrisBytes
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;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the sampleDocumentUris at the given index.
-