Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Processor

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1/classes.rb,
lib/google/apis/documentai_v1/representations.rb,
lib/google/apis/documentai_v1/representations.rb

Overview

The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1Processor

Returns a new instance of GoogleCloudDocumentaiV1Processor.



3009
3010
3011
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3009

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

The time the processor was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


2969
2970
2971
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2969

def create_time
  @create_time
end

#default_processor_version ⇒ String

The default processor version. Corresponds to the JSON property defaultProcessorVersion

Returns:

  • (String) 


2974
2975
2976
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2974

def default_processor_version
  @default_processor_version
end

#display_name ⇒ String

The display name of the processor. Corresponds to the JSON property displayName

Returns:

  • (String) 


2979
2980
2981
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2979

def display_name
  @display_name
end

#kms_key_name ⇒ String

The KMS key used for encryption/decryption in CMEK scenarios. See https:// cloud.google.com/security-key-management. Corresponds to the JSON property kmsKeyName

Returns:

  • (String) 


2985
2986
2987
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2985

def kms_key_name
  @kms_key_name
end

#name ⇒ String

Output only. Immutable. The resource name of the processor. Format: projects/ project/locations/location/processors/processor` Corresponds to the JSON propertyname`

Returns:

  • (String) 


2991
2992
2993
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2991

def name
  @name
end

#process_endpoint ⇒ String

Output only. Immutable. The http endpoint that can be called to invoke processing. Corresponds to the JSON property processEndpoint

Returns:

  • (String) 


2997
2998
2999
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2997

def process_endpoint
  @process_endpoint
end

#state ⇒ String

Output only. The state of the processor. Corresponds to the JSON property state

Returns:

  • (String) 


3002
3003
3004
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3002

def state
  @state
end

#type ⇒ String

The processor type, e.g., INVOICE_PARSING, W2_PARSING, etc. Corresponds to the JSON property type

Returns:

  • (String) 


3007
3008
3009
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3007

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3014

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @default_processor_version = args[:default_processor_version] if args.key?(:default_processor_version)
  @display_name = args[:display_name] if args.key?(:display_name)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @name = args[:name] if args.key?(:name)
  @process_endpoint = args[:process_endpoint] if args.key?(:process_endpoint)
  @state = args[:state] if args.key?(:state)
  @type = args[:type] if args.key?(:type)
end