Class: OCI::DataSafe::Models::Summary

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

Overview

Summary of the audit report.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Summary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :is_hidden (BOOLEAN) —

    The value to assign to the #is_hidden property

  • :display_order (Integer) —

    The value to assign to the #display_order property

  • :group_by_field_name (String) —

    The value to assign to the #group_by_field_name property

  • :count_of (String) —

    The value to assign to the #count_of property

  • :scim_filter (String) —

    The value to assign to the #scim_filter property



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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/data_safe/models/summary.rb', line 75

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.name = attributes[:'name'] if attributes[:'name']

  self.is_hidden = attributes[:'isHidden'] unless attributes[:'isHidden'].nil?
  self.is_hidden = true if is_hidden.nil? && !attributes.key?(:'isHidden') # rubocop:disable Style/StringLiterals

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

  self.is_hidden = attributes[:'is_hidden'] unless attributes[:'is_hidden'].nil?
  self.is_hidden = true if is_hidden.nil? && !attributes.key?(:'isHidden') && !attributes.key?(:'is_hidden') # rubocop:disable Style/StringLiterals

  self.display_order = attributes[:'displayOrder'] if attributes[:'displayOrder']

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

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

  self.group_by_field_name = attributes[:'groupByFieldName'] if attributes[:'groupByFieldName']

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

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

  self.count_of = attributes[:'countOf'] if attributes[:'countOf']

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

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

  self.scim_filter = attributes[:'scimFilter'] if attributes[:'scimFilter']

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

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

Instance Attribute Details

#count_of ⇒ String

Name of the key or count of object.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/data_safe/models/summary.rb', line 29

def count_of
  @count_of
end

#display_order ⇒ Integer

[Required] Specifies the order in which the summary must be displayed.

Returns:

  • (Integer) 


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

def display_order
  @display_order
end

#group_by_field_name ⇒ String

A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.

Returns:

  • (String) 


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

def group_by_field_name
  @group_by_field_name
end

#is_hidden ⇒ BOOLEAN

Indicates if the summary is hidden. Values can either be 'true' or 'false'.

Returns:

  • (BOOLEAN) 


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

def is_hidden
  @is_hidden
end

#name ⇒ String

[Required] Name of the report summary.

Returns:

  • (String) 


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

def name
  @name
end

#scim_filter ⇒ String

Additional scim filters used to get the specific summary.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/data_safe/models/summary.rb', line 33

def scim_filter
  @scim_filter
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'is_hidden': :'isHidden',
    'display_order': :'displayOrder',
    'group_by_field_name': :'groupByFieldName',
    'count_of': :'countOf',
    'scim_filter': :'scimFilter'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/data_safe/models/summary.rb', line 50

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'is_hidden': :'BOOLEAN',
    'display_order': :'Integer',
    'group_by_field_name': :'String',
    'count_of': :'String',
    'scim_filter': :'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



123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/data_safe/models/summary.rb', line 123

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

  self.class == other.class &&
    name == other.name &&
    is_hidden == other.is_hidden &&
    display_order == other.display_order &&
    group_by_field_name == other.group_by_field_name &&
    count_of == other.count_of &&
    scim_filter == other.scim_filter
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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/data_safe/models/summary.rb', line 158

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


138
139
140
 
# File 'lib/oci/data_safe/models/summary.rb', line 138

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/oci/data_safe/models/summary.rb', line 147

def hash
  [name, is_hidden, display_order, group_by_field_name, count_of, scim_filter].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/data_safe/models/summary.rb', line 191

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



185
186
187
 
# File 'lib/oci/data_safe/models/summary.rb', line 185

def to_s
  to_hash.to_s
end