Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::Processor.
The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — The time the processor was created.
#create_time=
def create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — The time the processor was created.
Returns
- (::Google::Protobuf::Timestamp) — The time the processor was created.
#default_processor_version
def default_processor_version() -> ::String
Returns
- (::String) — The default processor version.
#default_processor_version=
def default_processor_version=(value) -> ::String
Parameter
- value (::String) — The default processor version.
Returns
- (::String) — The default processor version.
#display_name
def display_name() -> ::String
Returns
- (::String) — The display name of the processor.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — The display name of the processor.
Returns
- (::String) — The display name of the processor.
#kms_key_name
def kms_key_name() -> ::String
Returns
- (::String) — The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
#kms_key_name=
def kms_key_name=(value) -> ::String
Parameter
- value (::String) — The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
Returns
- (::String) — The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
#name
def name() -> ::String
Returns
-
(::String) — Output only. Immutable. The resource name of the processor.
Format:
projects/{project}/locations/{location}/processors/{processor}
#process_endpoint
def process_endpoint() -> ::String
Returns
- (::String) — Output only. Immutable. The http endpoint that can be called to invoke processing.
#state
def state() -> ::Google::Cloud::DocumentAI::V1::Processor::State
Returns
- (::Google::Cloud::DocumentAI::V1::Processor::State) — Output only. The state of the processor.
#type
def type() -> ::String
Returns
-
(::String) — The processor type, e.g.,
OCR_PROCESSOR,INVOICE_PROCESSOR, etc. To get a list of processors types, see FetchProcessorTypes.
#type=
def type=(value) -> ::String
Parameter
-
value (::String) — The processor type, e.g.,
OCR_PROCESSOR,INVOICE_PROCESSOR, etc. To get a list of processors types, see FetchProcessorTypes.
Returns
-
(::String) — The processor type, e.g.,
OCR_PROCESSOR,INVOICE_PROCESSOR, etc. To get a list of processors types, see FetchProcessorTypes.