Class: WordsRubySdk::ReplaceTextRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/words_ruby_sdk/models/replace_text_request.rb

Overview

Class for document replace text request building.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReplaceTextRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 74

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.key?(:'OldValue')
    self.old_value = attributes[:'OldValue']
  end

  if attributes.key?(:'NewValue')
    self.new_value = attributes[:'NewValue']
  end

  if attributes.key?(:'IsMatchCase')
    self.is_match_case = attributes[:'IsMatchCase']
  end

  if attributes.key?(:'IsMatchWholeWord')
    self.is_match_whole_word = attributes[:'IsMatchWholeWord']
  end

  if attributes.key?(:'IsOldValueRegex')
    self.is_old_value_regex = attributes[:'IsOldValueRegex']
  end

end

Instance Attribute Details

#is_match_case ⇒ Object

Flag, true means the search is case-sensitive; false means the search is not case-sensitive.



41
42
43
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 41

def is_match_case
  @is_match_case
end

#is_match_whole_word ⇒ Object

Flag, means that only whole word matched are replaced.



44
45
46
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 44

def is_match_whole_word
  @is_match_whole_word
end

#is_old_value_regex ⇒ Object

Flag, means that contains regex expression.



47
48
49
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 47

def is_old_value_regex
  @is_old_value_regex
end

#new_value ⇒ Object

New text value to replace by.



38
39
40
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 38

def new_value
  @new_value
end

#old_value ⇒ Object

Old text value (or regex pattern ) to replace.



35
36
37
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 35

def old_value
  @old_value
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



51
52
53
54
55
56
57
58
59
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 51

def self.attribute_map
  {
    :'old_value' => :'OldValue',
    :'new_value' => :'NewValue',
    :'is_match_case' => :'IsMatchCase',
    :'is_match_whole_word' => :'IsMatchWholeWord',
    :'is_old_value_regex' => :'IsOldValueRegex'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 62

def self.swagger_types
  {
    :'old_value' => :'String',
    :'new_value' => :'String',
    :'is_match_case' => :'BOOLEAN',
    :'is_match_whole_word' => :'BOOLEAN',
    :'is_old_value_regex' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



132
133
134
135
136
137
138
139
140
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 132

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      old_value == other.old_value &&
      new_value == other.new_value &&
      is_match_case == other.is_match_case &&
      is_match_whole_word == other.is_match_whole_word &&
      is_old_value_regex == other.is_old_value_regex
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 179

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Time.at(/\d/.match(value)[0].to_f).to_datetime
  when :Date
    Time.at(/\d/.match(value)[0].to_f).to_date
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else
  # model
    temp_model = WordsRubySdk.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 246

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 157

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


144
145
146
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 144

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



150
151
152
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 150

def hash
  [old_value, new_value, is_match_case, is_match_whole_word, is_old_value_regex].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 104

def list_invalid_properties
  invalid_properties = []
  if @is_match_case.nil?
    invalid_properties.push("invalid value for 'is_match_case', is_match_case cannot be nil.")
  end

  if @is_match_whole_word.nil?
    invalid_properties.push("invalid value for 'is_match_whole_word', is_match_whole_word cannot be nil.")
  end

  if @is_old_value_regex.nil?
    invalid_properties.push("invalid value for 'is_old_value_regex', is_old_value_regex cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



226
227
228
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 226

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



232
233
234
235
236
237
238
239
240
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 232

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



220
221
222
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 220

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



123
124
125
126
127
128
 
# File 'lib/words_ruby_sdk/models/replace_text_request.rb', line 123

def valid?
  return false if @is_match_case.nil?
  return false if @is_match_whole_word.nil?
  return false if @is_old_value_regex.nil?
  return true
end