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

Overview

A processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1ProcessorVersion

Returns a new instance of GoogleCloudDocumentaiV1ProcessorVersion.



3293
3294
3295
# File 'lib/google/apis/documentai_v1/classes.rb', line 3293

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

Instance Attribute Details

#create_timeString

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

Returns:

  • (String)


3253
3254
3255
# File 'lib/google/apis/documentai_v1/classes.rb', line 3253

def create_time
  @create_time
end

#deprecation_infoGoogle::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo

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



3258
3259
3260
# File 'lib/google/apis/documentai_v1/classes.rb', line 3258

def deprecation_info
  @deprecation_info
end

#display_nameString

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

Returns:

  • (String)


3263
3264
3265
# File 'lib/google/apis/documentai_v1/classes.rb', line 3263

def display_name
  @display_name
end

#google_managedBoolean Also known as: google_managed?

Denotes that this ProcessorVersion is managed by google. Corresponds to the JSON property googleManaged

Returns:

  • (Boolean)


3268
3269
3270
# File 'lib/google/apis/documentai_v1/classes.rb', line 3268

def google_managed
  @google_managed
end

#kms_key_nameString

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

Returns:

  • (String)


3274
3275
3276
# File 'lib/google/apis/documentai_v1/classes.rb', line 3274

def kms_key_name
  @kms_key_name
end

#kms_key_version_nameString

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

Returns:

  • (String)


3279
3280
3281
# File 'lib/google/apis/documentai_v1/classes.rb', line 3279

def kms_key_version_name
  @kms_key_version_name
end

#nameString

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

Returns:

  • (String)


3286
3287
3288
# File 'lib/google/apis/documentai_v1/classes.rb', line 3286

def name
  @name
end

#stateString

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

Returns:

  • (String)


3291
3292
3293
# File 'lib/google/apis/documentai_v1/classes.rb', line 3291

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/google/apis/documentai_v1/classes.rb', line 3298

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