public final class Processor extends com.google.protobuf.GeneratedMessageV3 implements ProcessorOrBuilder
The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.Protobuf type
google.cloud.documentai.v1beta3.Processor| Modifier and Type | Class and Description |
|---|---|
static class |
Processor.Builder
The first-class citizen for Document AI.
|
static class |
Processor.State
The possible states of the processor.
|
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| Modifier and Type | Field and Description |
|---|---|
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
DEFAULT_PROCESSOR_VERSION_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
KMS_KEY_NAME_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PROCESS_ENDPOINT_FIELD_NUMBER |
static int |
PROCESSOR_VERSION_ALIASES_FIELD_NUMBER |
static int |
SATISFIES_PZI_FIELD_NUMBER |
static int |
SATISFIES_PZS_FIELD_NUMBER |
static int |
STATE_FIELD_NUMBER |
static int |
TYPE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
com.google.protobuf.Timestamp |
getCreateTime()
The time the processor was created.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
The time the processor was created.
|
static Processor |
getDefaultInstance() |
Processor |
getDefaultInstanceForType() |
String |
getDefaultProcessorVersion()
The default processor version.
|
com.google.protobuf.ByteString |
getDefaultProcessorVersionBytes()
The default processor version.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
The display name of the processor.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
The display name of the processor.
|
String |
getKmsKeyName()
The [KMS key](https://cloud.google.com/security-key-management) used for
encryption and decryption in CMEK scenarios.
|
com.google.protobuf.ByteString |
getKmsKeyNameBytes()
The [KMS key](https://cloud.google.com/security-key-management) used for
encryption and decryption in CMEK scenarios.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
com.google.protobuf.Parser<Processor> |
getParserForType() |
String |
getProcessEndpoint()
Output only.
|
com.google.protobuf.ByteString |
getProcessEndpointBytes()
Output only.
|
ProcessorVersionAlias |
getProcessorVersionAliases(int index)
Output only.
|
int |
getProcessorVersionAliasesCount()
Output only.
|
List<ProcessorVersionAlias> |
getProcessorVersionAliasesList()
Output only.
|
ProcessorVersionAliasOrBuilder |
getProcessorVersionAliasesOrBuilder(int index)
Output only.
|
List<? extends ProcessorVersionAliasOrBuilder> |
getProcessorVersionAliasesOrBuilderList()
Output only.
|
boolean |
getSatisfiesPzi()
Output only.
|
boolean |
getSatisfiesPzs()
Output only.
|
int |
getSerializedSize() |
Processor.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
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`.
|
boolean |
hasCreateTime()
The time the processor was created.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Processor.Builder |
newBuilder() |
static Processor.Builder |
newBuilder(Processor prototype) |
Processor.Builder |
newBuilderForType() |
protected Processor.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Processor |
parseDelimitedFrom(InputStream input) |
static Processor |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Processor |
parseFrom(byte[] data) |
static Processor |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Processor |
parseFrom(ByteBuffer data) |
static Processor |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Processor |
parseFrom(com.google.protobuf.ByteString data) |
static Processor |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Processor |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Processor |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Processor |
parseFrom(InputStream input) |
static Processor |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Processor> |
parser() |
Processor.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int DEFAULT_PROCESSOR_VERSION_FIELD_NUMBER
public static final int PROCESSOR_VERSION_ALIASES_FIELD_NUMBER
public static final int PROCESS_ENDPOINT_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER
public static final int SATISFIES_PZI_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Output only. Immutable. The resource name of the processor.
Format: `projects/{project}/locations/{location}/processors/{processor}`
string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
getName in interface ProcessorOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Output only. Immutable. The resource name of the processor.
Format: `projects/{project}/locations/{location}/processors/{processor}`
string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
getNameBytes in interface ProcessorOrBuilderpublic String getType()
The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see [FetchProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypes].
string type = 2;getType in interface ProcessorOrBuilderpublic com.google.protobuf.ByteString getTypeBytes()
The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see [FetchProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypes].
string type = 2;getTypeBytes in interface ProcessorOrBuilderpublic String getDisplayName()
The display name of the processor.
string display_name = 3;getDisplayName in interface ProcessorOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
The display name of the processor.
string display_name = 3;getDisplayNameBytes in interface ProcessorOrBuilderpublic int getStateValue()
Output only. The state of the processor.
.google.cloud.documentai.v1beta3.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface ProcessorOrBuilderpublic Processor.State getState()
Output only. The state of the processor.
.google.cloud.documentai.v1beta3.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface ProcessorOrBuilderpublic String getDefaultProcessorVersion()
The default processor version.
string default_processor_version = 9 [(.google.api.resource_reference) = { ... }getDefaultProcessorVersion in interface ProcessorOrBuilderpublic com.google.protobuf.ByteString getDefaultProcessorVersionBytes()
The default processor version.
string default_processor_version = 9 [(.google.api.resource_reference) = { ... }getDefaultProcessorVersionBytes in interface ProcessorOrBuilderpublic List<ProcessorVersionAlias> getProcessorVersionAliasesList()
Output only. The processor version aliases.
repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getProcessorVersionAliasesList in interface ProcessorOrBuilderpublic List<? extends ProcessorVersionAliasOrBuilder> getProcessorVersionAliasesOrBuilderList()
Output only. The processor version aliases.
repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getProcessorVersionAliasesOrBuilderList in interface ProcessorOrBuilderpublic int getProcessorVersionAliasesCount()
Output only. The processor version aliases.
repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getProcessorVersionAliasesCount in interface ProcessorOrBuilderpublic ProcessorVersionAlias getProcessorVersionAliases(int index)
Output only. The processor version aliases.
repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getProcessorVersionAliases in interface ProcessorOrBuilderpublic ProcessorVersionAliasOrBuilder getProcessorVersionAliasesOrBuilder(int index)
Output only. The processor version aliases.
repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getProcessorVersionAliasesOrBuilder in interface ProcessorOrBuilderpublic String getProcessEndpoint()
Output only. Immutable. The http endpoint that can be called to invoke processing.
string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
getProcessEndpoint in interface ProcessorOrBuilderpublic com.google.protobuf.ByteString getProcessEndpointBytes()
Output only. Immutable. The http endpoint that can be called to invoke processing.
string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
getProcessEndpointBytes in interface ProcessorOrBuilderpublic boolean hasCreateTime()
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;hasCreateTime in interface ProcessorOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;getCreateTime in interface ProcessorOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;getCreateTimeOrBuilder in interface ProcessorOrBuilderpublic String getKmsKeyName()
The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.
string kms_key_name = 8;getKmsKeyName in interface ProcessorOrBuilderpublic com.google.protobuf.ByteString getKmsKeyNameBytes()
The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.
string kms_key_name = 8;getKmsKeyNameBytes in interface ProcessorOrBuilderpublic boolean getSatisfiesPzs()
Output only. Reserved for future use.
bool satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];getSatisfiesPzs in interface ProcessorOrBuilderpublic boolean getSatisfiesPzi()
Output only. Reserved for future use.
bool satisfies_pzi = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];getSatisfiesPzi in interface ProcessorOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Processor parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Processor parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Processor parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Processor parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Processor parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Processor parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Processor parseFrom(InputStream input) throws IOException
IOExceptionpublic static Processor parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Processor parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Processor parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Processor parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Processor parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Processor.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Processor.Builder newBuilder()
public static Processor.Builder newBuilder(Processor prototype)
public Processor.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Processor.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Processor getDefaultInstance()
public static com.google.protobuf.Parser<Processor> parser()
public com.google.protobuf.Parser<Processor> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Processor getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.