Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersion

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

Overview

A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1ProcessorVersion

Returns a new instance of GoogleCloudDocumentaiV1ProcessorVersion.

[View source]

5016
5017
5018
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5016

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 

4966
4967
4968
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4966

def create_time
  @create_time
end

#deprecation_info ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo

Information about the upcoming deprecation of this processor version. Corresponds to the JSON property deprecationInfo

Returns:


4971
4972
4973
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4971

def deprecation_info
  @deprecation_info
end

#display_name ⇒ String

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

Returns:

  • (String) 

4976
4977
4978
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4976

def display_name
  @display_name
end

#document_schema ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema

The schema defines the output of the processed document by a processor. Corresponds to the JSON property documentSchema

Returns:


4981
4982
4983
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4981

def document_schema
  @document_schema
end

#google_managed ⇒ Boolean Also known as: google_managed?

Output only. Denotes that this ProcessorVersion is managed by Google. Corresponds to the JSON property googleManaged

Returns:

  • (Boolean) 

4986
4987
4988
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4986

def google_managed
  @google_managed
end

#kms_key_name ⇒ String

The KMS key name used for encryption. Corresponds to the JSON property kmsKeyName

Returns:

  • (String) 

4992
4993
4994
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4992

def kms_key_name
  @kms_key_name
end

#kms_key_version_name ⇒ String

The KMS key version with which data is encrypted. Corresponds to the JSON property kmsKeyVersionName

Returns:

  • (String) 

4997
4998
4999
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4997

def kms_key_version_name
  @kms_key_version_name
end

#latest_evaluation ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationReference

Gives a short summary of an evaluation, and links to the evaluation itself. Corresponds to the JSON property latestEvaluation

Returns:


5002
5003
5004
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5002

def latest_evaluation
  @latest_evaluation
end

#name ⇒ String

The resource name of the processor version. Format: projects/project/ locations/location/processors/processor/processorVersions/ processor_version` Corresponds to the JSON propertyname`

Returns:

  • (String) 

5009
5010
5011
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5009

def name
  @name
end

#state ⇒ String

The state of the processor version. Corresponds to the JSON property state

Returns:

  • (String) 

5014
5015
5016
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5014

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5021

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deprecation_info = args[:deprecation_info] if args.key?(:deprecation_info)
  @display_name = args[:display_name] if args.key?(:display_name)
  @document_schema = args[:document_schema] if args.key?(:document_schema)
  @google_managed = args[:google_managed] if args.key?(:google_managed)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
  @latest_evaluation = args[:latest_evaluation] if args.key?(:latest_evaluation)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
end