Class: OCI::DataSafe::Models::RandomStringFormatEntry

Inherits:
FormatEntry
  • Object
show all
Defined in:
lib/oci/data_safe/models/random_string_format_entry.rb

Overview

The Random String masking format generates random and unique strings of length within a range. The length range is defined by the startLength and endLength attributes. The start length must be less than or equal to the end length. When masking columns with uniqueness constraint, ensure that the length range is sufficient enough to generate unique values. To learn more, check Random String in the Data Safe documentation.

Constant Summary

Constants inherited from FormatEntry

FormatEntry::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from FormatEntry

#description, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from FormatEntry

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ RandomStringFormatEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :description (String) —

    The value to assign to the #description proprety

  • :start_length (Integer) —

    The value to assign to the #start_length property

  • :end_length (Integer) —

    The value to assign to the #end_length property



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/data_safe/models/random_string_format_entry.rb', line 65

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

  attributes['type'] = 'RANDOM_STRING'

  super(attributes)

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

  self.start_length = attributes[:'startLength'] if attributes[:'startLength']

  raise 'You cannot provide both :startLength and :start_length' if attributes.key?(:'startLength') && attributes.key?(:'start_length')

  self.start_length = attributes[:'start_length'] if attributes[:'start_length']

  self.end_length = attributes[:'endLength'] if attributes[:'endLength']

  raise 'You cannot provide both :endLength and :end_length' if attributes.key?(:'endLength') && attributes.key?(:'end_length')

  self.end_length = attributes[:'end_length'] if attributes[:'end_length']
end

Instance Attribute Details

#end_length ⇒ Integer

[Required] The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length.

Returns:

  • (Integer) 


30
31
32
 
# File 'lib/oci/data_safe/models/random_string_format_entry.rb', line 30

def end_length
  @end_length
end

#start_length ⇒ Integer

[Required] The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length.

Returns:

  • (Integer) 


23
24
25
 
# File 'lib/oci/data_safe/models/random_string_format_entry.rb', line 23

def start_length
  @start_length
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/data_safe/models/random_string_format_entry.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'description': :'description',
    'start_length': :'startLength',
    'end_length': :'endLength'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/data_safe/models/random_string_format_entry.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'description': :'String',
    'start_length': :'Integer',
    'end_length': :'Integer'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/data_safe/models/random_string_format_entry.rb', line 95

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    type == other.type &&
    description == other.description &&
    start_length == other.start_length &&
    end_length == other.end_length
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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/data_safe/models/random_string_format_entry.rb', line 128

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/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)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(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:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


108
109
110
 
# File 'lib/oci/data_safe/models/random_string_format_entry.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/oci/data_safe/models/random_string_format_entry.rb', line 117

def hash
  [type, description, start_length, end_length].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/data_safe/models/random_string_format_entry.rb', line 161

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



155
156
157
 
# File 'lib/oci/data_safe/models/random_string_format_entry.rb', line 155

def to_s
  to_hash.to_s
end