Class: Azure::CognitiveServices::FormRecognizer::V1_0_preview::Models::StringValue

Inherits:
FieldValue
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/string_value.rb

Overview

Recognized string field value.

Instance Attribute Summary collapse

Attributes inherited from FieldValue

#elements, #text

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeStringValue

Returns a new instance of StringValue.



16
17
18
# File 'lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/string_value.rb', line 16

def initialize
  @valueType = "stringValue"
end

Instance Attribute Details

#valueString

Returns String value of the recognized field.

Returns:

  • (String)

    String value of the recognized field.



23
24
25
# File 'lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/string_value.rb', line 23

def value
  @value
end

#valueTypeObject

Returns the value of attribute valueType.



20
21
22
# File 'lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/string_value.rb', line 20

def valueType
  @valueType
end

Class Method Details

.mapperObject

Mapper for StringValue class as Ruby Hash. This will be used for serialization/deserialization.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/string_value.rb', line 30

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'stringValue',
    type: {
      name: 'Composite',
      class_name: 'StringValue',
      model_properties: {
        text: {
          client_side_validation: true,
          required: false,
          serialized_name: 'text',
          type: {
            name: 'String'
          }
        },
        elements: {
          client_side_validation: true,
          required: false,
          serialized_name: 'elements',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ElementReferenceElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ElementReference'
                }
            }
          }
        },
        valueType: {
          client_side_validation: true,
          required: true,
          serialized_name: 'valueType',
          type: {
            name: 'String'
          }
        },
        value: {
          client_side_validation: true,
          required: false,
          serialized_name: 'value',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end