Send feedback
Class Processor (2.26.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.26.0 keyboard_arrow_down
public final class Processor extends 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value Type Description int
DEFAULT_PROCESSOR_VERSION_FIELD_NUMBER
public static final int DEFAULT_PROCESSOR_VERSION_FIELD_NUMBER
Field Value Type Description int
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value Type Description int
KMS_KEY_NAME_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value Type Description int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value Type Description int
PROCESS_ENDPOINT_FIELD_NUMBER
public static final int PROCESS_ENDPOINT_FIELD_NUMBER
Field Value Type Description int
STATE_FIELD_NUMBER
public static final int STATE_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 Processor getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Processor . Builder newBuilder ()
newBuilder(Processor prototype)
public static Processor . Builder newBuilder ( Processor prototype )
public static Processor parseDelimitedFrom ( InputStream input )
public static Processor parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Processor parseFrom ( byte [] data )
Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Processor parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Processor parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Processor parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Processor parseFrom ( CodedInputStream input )
public static Processor parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Processor parseFrom ( InputStream input )
public static Processor parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Processor parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Processor parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Processor> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description objObject
Overrides
getCreateTime()
public Timestamp getCreateTime ()
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;
Returns Type Description Timestamp The createTime.
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder ()
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;
getDefaultInstanceForType()
public Processor getDefaultInstanceForType ()
getDefaultProcessorVersion()
public String getDefaultProcessorVersion ()
The default processor version.
string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
Returns Type Description String The defaultProcessorVersion.
getDefaultProcessorVersionBytes()
public ByteString getDefaultProcessorVersionBytes ()
The default processor version.
string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
Returns Type Description ByteString The bytes for defaultProcessorVersion.
getDisplayName()
public String getDisplayName ()
The display name of the processor.
string display_name = 3;
Returns Type Description String The displayName.
getDisplayNameBytes()
public ByteString getDisplayNameBytes ()
The display name of the processor.
string display_name = 3;
Returns Type Description ByteString The bytes for displayName.
getKmsKeyName()
public String getKmsKeyName ()
The KMS key used for
encryption and decryption in CMEK scenarios.
string kms_key_name = 8;
Returns Type Description String The kmsKeyName.
getKmsKeyNameBytes()
public ByteString getKmsKeyNameBytes ()
The KMS key used for
encryption and decryption in CMEK scenarios.
string kms_key_name = 8;
Returns Type Description ByteString The bytes for kmsKeyName.
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];
Returns Type Description String The name.
getNameBytes()
public 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];
Returns Type Description ByteString The bytes for name.
getParserForType()
public Parser<Processor> getParserForType ()
Overrides
getProcessEndpoint()
public 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];
Returns Type Description String The processEndpoint.
getProcessEndpointBytes()
public 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];
Returns Type Description ByteString The bytes for processEndpoint.
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
getState()
public Processor . State getState ()
Output only. The state of the processor.
.google.cloud.documentai.v1beta3.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue ()
Output only. The state of the processor.
.google.cloud.documentai.v1beta3.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns Type Description int The enum numeric value on the wire for state.
getType()
The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR.
To get a list of processor types, see
FetchProcessorTypes .
string type = 2;
Returns Type Description String The type.
getTypeBytes()
public ByteString getTypeBytes ()
The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR.
To get a list of processor types, see
FetchProcessorTypes .
string type = 2;
Returns Type Description ByteString The bytes for type.
hasCreateTime()
public boolean hasCreateTime ()
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;
Returns Type Description boolean Whether the createTime field is set.
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Processor . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Processor . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public Processor . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]
