Send feedback
Class Processor (2.12.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.12.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
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DEFAULT_PROCESSOR_VERSION_FIELD_NUMBER
public static final int DEFAULT_PROCESSOR_VERSION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
KMS_KEY_NAME_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PROCESS_ENDPOINT_FIELD_NUMBER
public static final int PROCESS_ENDPOINT_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Processor getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static Processor . Builder newBuilder ()
Returns
newBuilder(Processor prototype)
public static Processor . Builder newBuilder ( Processor prototype )
Parameter
Returns
public static Processor parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Processor parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Processor parseFrom ( byte [] data )
Parameter
Name Description data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Processor parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Processor parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Processor parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Processor parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static Processor parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Processor parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Processor parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Processor parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Processor parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<Processor> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getCreateTime()
public Timestamp getCreateTime ()
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;
Returns
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder ()
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;
Returns
getDefaultInstanceForType()
public Processor getDefaultInstanceForType ()
Returns
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 ()
Returns
Type Description String The kmsKeyName.
getKmsKeyNameBytes()
public ByteString getKmsKeyNameBytes ()
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
getParserForType()
public Parser<Processor> getParserForType ()
Returns
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
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];
Returns
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, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc.
To get a list of processors types, see
FetchProcessorTypes .
string type = 2;
Returns
Type Description String The type.
getTypeBytes()
public ByteString getTypeBytes ()
The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc.
To get a list of processors types, see
FetchProcessorTypes .
string type = 2;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public Processor . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Processor . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public Processor . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
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-27 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-27 UTC."],[],[]]
