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.



5354
5355
5356
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5354

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) 


5296
5297
5298
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5296

def create_time
  @create_time
end

#default_processor_version ⇒ String

The default processor version. Corresponds to the JSON property defaultProcessorVersion

Returns:

  • (String) 


5301
5302
5303
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5301

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) 


5306
5307
5308
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5306

def display_name
  @display_name
end

#kms_key_name ⇒ String

The KMS key used for encryption and decryption in CMEK scenarios. Corresponds to the JSON property kmsKeyName

Returns:

  • (String) 


5312
5313
5314
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5312

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) 


5318
5319
5320
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5318

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) 


5324
5325
5326
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5324

def process_endpoint
  @process_endpoint
end

#processor_version_aliases ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersionAlias>

Output only. The processor version aliases. Corresponds to the JSON property processorVersionAliases

Returns:



5329
5330
5331
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5329

def processor_version_aliases
  @processor_version_aliases
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


5334
5335
5336
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5334

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


5340
5341
5342
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5340

def satisfies_pzs
  @satisfies_pzs
end

#state ⇒ String

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

Returns:

  • (String) 


5346
5347
5348
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5346

def state
  @state
end

#type ⇒ String

The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes. Corresponds to the JSON property type

Returns:

  • (String) 


5352
5353
5354
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5352

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5359

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)
  @processor_version_aliases = args[:processor_version_aliases] if args.key?(:processor_version_aliases)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @state = args[:state] if args.key?(:state)
  @type = args[:type] if args.key?(:type)
end