Class: OCI::DataSafe::Models::ShuffleFormatEntry

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

Overview

The Shuffle masking format randomly shuffles values within a column. It can also be used to shuffle column data within discrete units, or groups, where there is a relationship among the members of each group. To learn more, check Shuffle in the Data Safe documentation. The Shuffle masking format randomly shuffles values within a column. It can also be used to shuffle column data within discrete units, or groups, where there is a relationship among the members of each group. To learn more, check Shuffle 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 = {}) ⇒ ShuffleFormatEntry

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

  • :grouping_columns (Array<String>) —

    The value to assign to the #grouping_columns property



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/data_safe/models/shuffle_format_entry.rb', line 57

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

  attributes['type'] = 'SHUFFLE'

  super(attributes)

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

  self.grouping_columns = attributes[:'groupingColumns'] if attributes[:'groupingColumns']

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

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

Instance Attribute Details

#grouping_columns ⇒ Array<String>

One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table.

Returns:

  • (Array<String>) 


25
26
27
 
# File 'lib/oci/data_safe/models/shuffle_format_entry.rb', line 25

def grouping_columns
  @grouping_columns
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
 
# File 'lib/oci/data_safe/models/shuffle_format_entry.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'description': :'description',
    'grouping_columns': :'groupingColumns'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/data_safe/models/shuffle_format_entry.rb', line 39

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'description': :'String',
    'grouping_columns': :'Array<String>'
    # 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



81
82
83
84
85
86
87
88
 
# File 'lib/oci/data_safe/models/shuffle_format_entry.rb', line 81

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

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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/data_safe/models/shuffle_format_entry.rb', line 113

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


93
94
95
 
# File 'lib/oci/data_safe/models/shuffle_format_entry.rb', line 93

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



102
103
104
 
# File 'lib/oci/data_safe/models/shuffle_format_entry.rb', line 102

def hash
  [type, description, grouping_columns].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/data_safe/models/shuffle_format_entry.rb', line 146

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



140
141
142
 
# File 'lib/oci/data_safe/models/shuffle_format_entry.rb', line 140

def to_s
  to_hash.to_s
end