Package com.google.cloud.documentai.v1
Class ProcessorType.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ProcessorType.Builder>
com.google.cloud.documentai.v1.ProcessorType.Builder
- All Implemented Interfaces:
ProcessorTypeOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- ProcessorType
public static final class ProcessorType.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ProcessorType.Builder>
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-
Method Summary
Modifier and TypeMethodDescriptionaddAllAvailableLocations(Iterable<? extends ProcessorType.LocationInfo> values) The locations in which this processor is available.addAllSampleDocumentUris(Iterable<String> values) A set of Cloud Storage URIs of sample documents for this processor.addAvailableLocations(int index, ProcessorType.LocationInfo value) The locations in which this processor is available.addAvailableLocations(int index, ProcessorType.LocationInfo.Builder builderForValue) The locations in which this processor is available.The locations in which this processor is available.addAvailableLocations(ProcessorType.LocationInfo.Builder builderForValue) The locations in which this processor is available.The locations in which this processor is available.addAvailableLocationsBuilder(int index) The locations in which this processor is available.addSampleDocumentUris(String value) A set of Cloud Storage URIs of sample documents for this processor.addSampleDocumentUrisBytes(com.google.protobuf.ByteString value) A set of Cloud Storage URIs of sample documents for this processor.build()clear()Whether the processor type allows creation.The locations in which this processor is available.The processor category, used by UI to group processor types.Launch stage of the processor typeThe resource name of the processor type.A set of Cloud Storage URIs of sample documents for this processor.The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.booleanWhether the processor type allows creation.getAvailableLocations(int index) The locations in which this processor is available.getAvailableLocationsBuilder(int index) The locations in which this processor is available.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.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorLaunch 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.com.google.protobuf.ProtocolStringListA 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`.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(ProcessorType other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) removeAvailableLocations(int index) The locations in which this processor is available.setAllowCreation(boolean value) Whether the processor type allows creation.setAvailableLocations(int index, ProcessorType.LocationInfo value) The locations in which this processor is available.setAvailableLocations(int index, ProcessorType.LocationInfo.Builder builderForValue) The locations in which this processor is available.setCategory(String value) The processor category, used by UI to group processor types.setCategoryBytes(com.google.protobuf.ByteString value) The processor category, used by UI to group processor types.setLaunchStage(LaunchStage value) Launch stage of the processor typesetLaunchStageValue(int value) Launch stage of the processor typeThe resource name of the processor type.setNameBytes(com.google.protobuf.ByteString value) The resource name of the processor type.setSampleDocumentUris(int index, String value) A set of Cloud Storage URIs of sample documents for this processor.The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.setTypeBytes(com.google.protobuf.ByteString value) The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<ProcessorType.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<ProcessorType.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<ProcessorType.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ProcessorType.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<ProcessorType.Builder>
-
mergeFrom
public ProcessorType.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ProcessorType.Builder>- Throws:
IOException
-
getName
The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}`string name = 1;- Specified by:
getNamein interfaceProcessorTypeOrBuilder- 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:
getNameBytesin interfaceProcessorTypeOrBuilder- Returns:
- The bytes for name.
-
setName
The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}`string name = 1;- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
clearName
The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}`string name = 1;- Returns:
- This builder for chaining.
-
setNameBytes
The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}`string name = 1;- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
getType
The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
string type = 2;- Specified by:
getTypein interfaceProcessorTypeOrBuilder- Returns:
- The type.
-
getTypeBytes
public com.google.protobuf.ByteString getTypeBytes()The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
string type = 2;- Specified by:
getTypeBytesin interfaceProcessorTypeOrBuilder- Returns:
- The bytes for type.
-
setType
The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
string type = 2;- Parameters:
value- The type to set.- Returns:
- This builder for chaining.
-
clearType
The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
string type = 2;- Returns:
- This builder for chaining.
-
setTypeBytes
The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
string type = 2;- Parameters:
value- The bytes for type to set.- Returns:
- This builder for chaining.
-
getCategory
The processor category, used by UI to group processor types.
string category = 3;- Specified by:
getCategoryin interfaceProcessorTypeOrBuilder- 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:
getCategoryBytesin interfaceProcessorTypeOrBuilder- Returns:
- The bytes for category.
-
setCategory
The processor category, used by UI to group processor types.
string category = 3;- Parameters:
value- The category to set.- Returns:
- This builder for chaining.
-
clearCategory
The processor category, used by UI to group processor types.
string category = 3;- Returns:
- This builder for chaining.
-
setCategoryBytes
The processor category, used by UI to group processor types.
string category = 3;- Parameters:
value- The bytes for category to set.- Returns:
- This builder for chaining.
-
getAvailableLocationsList
The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4;- Specified by:
getAvailableLocationsListin interfaceProcessorTypeOrBuilder
-
getAvailableLocationsCount
public int getAvailableLocationsCount()The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4;- Specified by:
getAvailableLocationsCountin interfaceProcessorTypeOrBuilder
-
getAvailableLocations
The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4;- Specified by:
getAvailableLocationsin interfaceProcessorTypeOrBuilder
-
setAvailableLocations
The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
setAvailableLocations
public ProcessorType.Builder setAvailableLocations(int index, ProcessorType.LocationInfo.Builder builderForValue) The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
addAvailableLocations
The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
addAvailableLocations
The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
addAvailableLocations
public ProcessorType.Builder addAvailableLocations(ProcessorType.LocationInfo.Builder builderForValue) The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
addAvailableLocations
public ProcessorType.Builder addAvailableLocations(int index, ProcessorType.LocationInfo.Builder builderForValue) The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
addAllAvailableLocations
public ProcessorType.Builder addAllAvailableLocations(Iterable<? extends ProcessorType.LocationInfo> values) The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
clearAvailableLocations
The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
removeAvailableLocations
The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
getAvailableLocationsBuilder
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;- Specified by:
getAvailableLocationsOrBuilderin interfaceProcessorTypeOrBuilder
-
getAvailableLocationsOrBuilderList
The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4;- Specified by:
getAvailableLocationsOrBuilderListin interfaceProcessorTypeOrBuilder
-
addAvailableLocationsBuilder
The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
addAvailableLocationsBuilder
The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
getAvailableLocationsBuilderList
The locations in which this processor is available.
repeated .google.cloud.documentai.v1.ProcessorType.LocationInfo available_locations = 4; -
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:
getAllowCreationin interfaceProcessorTypeOrBuilder- Returns:
- The allowCreation.
-
setAllowCreation
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;- Parameters:
value- The allowCreation to set.- Returns:
- This builder for chaining.
-
clearAllowCreation
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:
- This builder for chaining.
-
getLaunchStageValue
public int getLaunchStageValue()Launch stage of the processor type
.google.api.LaunchStage launch_stage = 8;- Specified by:
getLaunchStageValuein interfaceProcessorTypeOrBuilder- Returns:
- The enum numeric value on the wire for launchStage.
-
setLaunchStageValue
Launch stage of the processor type
.google.api.LaunchStage launch_stage = 8;- Parameters:
value- The enum numeric value on the wire for launchStage to set.- Returns:
- This builder for chaining.
-
getLaunchStage
Launch stage of the processor type
.google.api.LaunchStage launch_stage = 8;- Specified by:
getLaunchStagein interfaceProcessorTypeOrBuilder- Returns:
- The launchStage.
-
setLaunchStage
Launch stage of the processor type
.google.api.LaunchStage launch_stage = 8;- Parameters:
value- The launchStage to set.- Returns:
- This builder for chaining.
-
clearLaunchStage
Launch stage of the processor type
.google.api.LaunchStage launch_stage = 8;- Returns:
- This builder for chaining.
-
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:
getSampleDocumentUrisListin interfaceProcessorTypeOrBuilder- 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:
getSampleDocumentUrisCountin interfaceProcessorTypeOrBuilder- Returns:
- The count of sampleDocumentUris.
-
getSampleDocumentUris
A set of Cloud Storage URIs of sample documents for this processor.
repeated string sample_document_uris = 9;- Specified by:
getSampleDocumentUrisin interfaceProcessorTypeOrBuilder- 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:
getSampleDocumentUrisBytesin interfaceProcessorTypeOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the sampleDocumentUris at the given index.
-
setSampleDocumentUris
A set of Cloud Storage URIs of sample documents for this processor.
repeated string sample_document_uris = 9;- Parameters:
index- The index to set the value at.value- The sampleDocumentUris to set.- Returns:
- This builder for chaining.
-
addSampleDocumentUris
A set of Cloud Storage URIs of sample documents for this processor.
repeated string sample_document_uris = 9;- Parameters:
value- The sampleDocumentUris to add.- Returns:
- This builder for chaining.
-
addAllSampleDocumentUris
A set of Cloud Storage URIs of sample documents for this processor.
repeated string sample_document_uris = 9;- Parameters:
values- The sampleDocumentUris to add.- Returns:
- This builder for chaining.
-
clearSampleDocumentUris
A set of Cloud Storage URIs of sample documents for this processor.
repeated string sample_document_uris = 9;- Returns:
- This builder for chaining.
-
addSampleDocumentUrisBytes
A set of Cloud Storage URIs of sample documents for this processor.
repeated string sample_document_uris = 9;- Parameters:
value- The bytes of the sampleDocumentUris to add.- Returns:
- This builder for chaining.
-