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.



5361
5362
5363
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5361

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) 


5303
5304
5305
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5303

def create_time
  @create_time
end

#default_processor_version ⇒ String

The default processor version. Corresponds to the JSON property defaultProcessorVersion

Returns:

  • (String) 


5308
5309
5310
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5308

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) 


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

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) 


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

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) 


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

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) 


5331
5332
5333
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5331

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:



5336
5337
5338
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5336

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) 


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

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) 


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

def satisfies_pzs
  @satisfies_pzs
end

#state ⇒ String

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

Returns:

  • (String) 


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

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) 


5359
5360
5361
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5359

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5366

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