Document AI V1 API - Class Google::Cloud::DocumentAI::V1::Processor (v1.0.0)

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

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#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 and decryption in CMEK scenarios.

#kms_key_name=

def kms_key_name=(value) -> ::String
Parameter
  • value (::String) — The KMS key used for encryption and decryption in CMEK scenarios.
Returns
  • (::String) — The KMS key used for encryption and decryption in CMEK scenarios.

#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.

#processor_version_aliases

def processor_version_aliases() -> ::Array<::Google::Cloud::DocumentAI::V1::ProcessorVersionAlias>
Returns

#satisfies_pzi

def satisfies_pzi() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#state

def state() -> ::Google::Cloud::DocumentAI::V1::Processor::State
Returns

#type

def type() -> ::String
Returns
  • (::String) — The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.

#type=

def type=(value) -> ::String
Parameter
  • value (::String) — The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.
Returns
  • (::String) — The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.