Class: MicrosoftGraph::Models::Security::OcrSettings

Inherits:
Object
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/security/ocr_settings.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeObject

Instantiates a new ocrSettings and sets the default values.



45
46
47
# File 'lib/models/security/ocr_settings.rb', line 45

def initialize()
    @additional_data = Hash.new
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node

    The parse node to use to read the discriminator value and create the object

Returns:

  • a ocr_settings

Raises:

  • (StandardError)


53
54
55
56
# File 'lib/models/security/ocr_settings.rb', line 53

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return OcrSettings.new
end

Instance Method Details

#additional_dataObject

Gets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Returns:

  • a i_dictionary



30
31
32
# File 'lib/models/security/ocr_settings.rb', line 30

def additional_data
    return @additional_data
end

#additional_data=(value) ⇒ Object

Sets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Parameters:

  • value

    Value to set for the AdditionalData property.

Returns:

  • a void



38
39
40
# File 'lib/models/security/ocr_settings.rb', line 38

def additional_data=(value)
    @additional_data = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



61
62
63
64
65
66
67
68
# File 'lib/models/security/ocr_settings.rb', line 61

def get_field_deserializers()
    return {
        "isEnabled" => lambda {|n| @is_enabled = n.get_boolean_value() },
        "maxImageSize" => lambda {|n| @max_image_size = n.get_number_value() },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "timeout" => lambda {|n| @timeout = n.get_duration_value() },
    }
end

#is_enabledObject

Gets the isEnabled property value. Indicates whether or not OCR is enabled for the case.

Returns:

  • a boolean



73
74
75
# File 'lib/models/security/ocr_settings.rb', line 73

def is_enabled
    return @is_enabled
end

#is_enabled=(value) ⇒ Object

Sets the isEnabled property value. Indicates whether or not OCR is enabled for the case.

Parameters:

  • value

    Value to set for the is_enabled property.

Returns:

  • a void



81
82
83
# File 'lib/models/security/ocr_settings.rb', line 81

def is_enabled=(value)
    @is_enabled = value
end

#max_image_sizeObject

Gets the maxImageSize property value. Maximum image size that will be processed in KB).

Returns:

  • a integer



88
89
90
# File 'lib/models/security/ocr_settings.rb', line 88

def max_image_size
    return @max_image_size
end

#max_image_size=(value) ⇒ Object

Sets the maxImageSize property value. Maximum image size that will be processed in KB).

Parameters:

  • value

    Value to set for the max_image_size property.

Returns:

  • a void



96
97
98
# File 'lib/models/security/ocr_settings.rb', line 96

def max_image_size=(value)
    @max_image_size = value
end

#odata_typeObject

Gets the @odata.type property value. The OdataType property

Returns:

  • a string



103
104
105
# File 'lib/models/security/ocr_settings.rb', line 103

def odata_type
    return @odata_type
end

#odata_type=(value) ⇒ Object

Sets the @odata.type property value. The OdataType property

Parameters:

  • value

    Value to set for the odata_type property.

Returns:

  • a void



111
112
113
# File 'lib/models/security/ocr_settings.rb', line 111

def odata_type=(value)
    @odata_type = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError)


119
120
121
122
123
124
125
126
# File 'lib/models/security/ocr_settings.rb', line 119

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_boolean_value("isEnabled", @is_enabled)
    writer.write_number_value("maxImageSize", @max_image_size)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_duration_value("timeout", @timeout)
    writer.write_additional_data(@additional_data)
end

#timeoutObject

Gets the timeout property value. The timeout duration for the OCR engine. A longer timeout might increase success of OCR, but might add to the total processing time.

Returns:

  • a microsoft_kiota_abstractions::_i_s_o_duration



131
132
133
# File 'lib/models/security/ocr_settings.rb', line 131

def timeout
    return @timeout
end

#timeout=(value) ⇒ Object

Sets the timeout property value. The timeout duration for the OCR engine. A longer timeout might increase success of OCR, but might add to the total processing time.

Parameters:

  • value

    Value to set for the timeout property.

Returns:

  • a void



139
140
141
# File 'lib/models/security/ocr_settings.rb', line 139

def timeout=(value)
    @timeout = value
end