Class: OCI::DataSafe::Models::FormatSummary

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

Overview

Summary of a masking format.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormatSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :name (String) —

    The value to assign to the #name property

  • :description (String) —

    The value to assign to the #description property



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/data_safe/models/format_summary.rb', line 54

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 }

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

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

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

Instance Attribute Details

#description ⇒ String

The description of the masking format.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_safe/models/format_summary.rb', line 21

def description
  @description
end

#id ⇒ String

The OCID of the masking format.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/data_safe/models/format_summary.rb', line 13

def id
  @id
end

#name ⇒ String

[Required] The name of the masking format.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/data_safe/models/format_summary.rb', line 17

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
31
32
 
# File 'lib/oci/data_safe/models/format_summary.rb', line 24

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'description': :'description'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



74
75
76
77
78
79
80
81
 
# File 'lib/oci/data_safe/models/format_summary.rb', line 74

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    description == other.description
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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/data_safe/models/format_summary.rb', line 106

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


86
87
88
 
# File 'lib/oci/data_safe/models/format_summary.rb', line 86

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



95
96
97
 
# File 'lib/oci/data_safe/models/format_summary.rb', line 95

def hash
  [id, name, description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/data_safe/models/format_summary.rb', line 139

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



133
134
135
 
# File 'lib/oci/data_safe/models/format_summary.rb', line 133

def to_s
  to_hash.to_s
end