com.google.cloud.documentai.v1

Interface ProcessorOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Processor, Processor.Builder

public interface ProcessorOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Timestamp	getCreateTime() The time the processor was created.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() The time the processor was created.
String	getDefaultProcessorVersion() The default processor version.
com.google.protobuf.ByteString	getDefaultProcessorVersionBytes() The default processor version.
String	getDisplayName() The display name of the processor.
com.google.protobuf.ByteString	getDisplayNameBytes() The display name of the processor.
String	getKmsKeyName() The KMS key used for encryption/decryption in CMEK scenarios.
com.google.protobuf.ByteString	getKmsKeyNameBytes() The KMS key used for encryption/decryption in CMEK scenarios.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
String	getProcessEndpoint() Output only.
com.google.protobuf.ByteString	getProcessEndpointBytes() Output only.
Processor.State	getState() Output only.
int	getStateValue() Output only.
String	getType() The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
com.google.protobuf.ByteString	getTypeBytes() The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
boolean	hasCreateTime() The time the processor was created.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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];

Returns:

The name.

getNameBytes

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];

Returns:

The bytes for name.

getType

String getType()

 The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
 To get a list of processors types, see
 [FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes].
 

string type = 2;

Returns:

The type.

getTypeBytes

com.google.protobuf.ByteString getTypeBytes()

 The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
 To get a list of processors types, see
 [FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes].
 

string type = 2;

Returns:

The bytes for type.

getDisplayName

String getDisplayName()

 The display name of the processor.
 

string display_name = 3;

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 The display name of the processor.
 

string display_name = 3;

Returns:

The bytes for displayName.

getStateValue

int getStateValue()

 Output only. The state of the processor.
 

.google.cloud.documentai.v1.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for state.

getState

Processor.State getState()

 Output only. The state of the processor.
 

.google.cloud.documentai.v1.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The state.

getDefaultProcessorVersion

String getDefaultProcessorVersion()

 The default processor version.
 

string default_processor_version = 9 [(.google.api.resource_reference) = { ... }

Returns:

The defaultProcessorVersion.

getDefaultProcessorVersionBytes

com.google.protobuf.ByteString getDefaultProcessorVersionBytes()

 The default processor version.
 

string default_processor_version = 9 [(.google.api.resource_reference) = { ... }

Returns:

The bytes for defaultProcessorVersion.

getProcessEndpoint

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:

The processEndpoint.

getProcessEndpointBytes

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];

Returns:

The bytes for processEndpoint.

hasCreateTime

boolean hasCreateTime()

 The time the processor was created.
 

.google.protobuf.Timestamp create_time = 7;

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 The time the processor was created.
 

.google.protobuf.Timestamp create_time = 7;

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 The time the processor was created.
 

.google.protobuf.Timestamp create_time = 7;

getKmsKeyName

String getKmsKeyName()

 The KMS key used for encryption/decryption in CMEK scenarios.
 See https://cloud.google.com/security-key-management.
 

string kms_key_name = 8;

Returns:

The kmsKeyName.

getKmsKeyNameBytes

com.google.protobuf.ByteString getKmsKeyNameBytes()

 The KMS key used for encryption/decryption in CMEK scenarios.
 See https://cloud.google.com/security-key-management.
 

string kms_key_name = 8;

Returns:

The bytes for kmsKeyName.