Class: OCI::DataSafe::Models::GenerateHealthReportDetails

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

Overview

Details to use when performing health check on a masking policy.

Constant Summary collapse

CHECK_TYPE_ENUM = 
[
  CHECK_TYPE_ALL = 'ALL'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerateHealthReportDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :check_type (String) —

    The value to assign to the #check_type property

  • :target_id (String) —

    The value to assign to the #target_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :tablespace (String) —

    The value to assign to the #tablespace property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/data_safe/models/generate_health_report_details.rb', line 91

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.check_type = attributes[:'checkType'] if attributes[:'checkType']
  self.check_type = "ALL" if check_type.nil? && !attributes.key?(:'checkType') # rubocop:disable Style/StringLiterals

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

  self.check_type = attributes[:'check_type'] if attributes[:'check_type']
  self.check_type = "ALL" if check_type.nil? && !attributes.key?(:'checkType') && !attributes.key?(:'check_type') # rubocop:disable Style/StringLiterals

  self.target_id = attributes[:'targetId'] if attributes[:'targetId']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#check_type ⇒ String

The type of health check. The default behaviour is to perform all health checks.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/data_safe/models/generate_health_report_details.rb', line 18

def check_type
  @check_type
end

#compartment_id ⇒ String

The OCID of the compartment where the health report resource should be created.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


49
50
51
 
# File 'lib/oci/data_safe/models/generate_health_report_details.rb', line 49

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


42
43
44
 
# File 'lib/oci/data_safe/models/generate_health_report_details.rb', line 42

def freeform_tags
  @freeform_tags
end

#tablespace ⇒ String

The tablespace that should be used to estimate space. If no tablespace is provided, the DEFAULT tablespace is used.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/data_safe/models/generate_health_report_details.rb', line 35

def tablespace
  @tablespace
end

#target_id ⇒ String

The OCID of the target database to use for the masking policy health check. The targetId associated with the masking policy is used if this is not passed.

Returns:

  • (String) 


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

def target_id
  @target_id
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/data_safe/models/generate_health_report_details.rb', line 52

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'check_type': :'checkType',
    'target_id': :'targetId',
    'compartment_id': :'compartmentId',
    'tablespace': :'tablespace',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/data_safe/models/generate_health_report_details.rb', line 66

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'check_type': :'String',
    'target_id': :'String',
    'compartment_id': :'String',
    'tablespace': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



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

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

  self.class == other.class &&
    check_type == other.check_type &&
    target_id == other.target_id &&
    compartment_id == other.compartment_id &&
    tablespace == other.tablespace &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/oci/data_safe/models/generate_health_report_details.rb', line 182

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


162
163
164
 
# File 'lib/oci/data_safe/models/generate_health_report_details.rb', line 162

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



171
172
173
 
# File 'lib/oci/data_safe/models/generate_health_report_details.rb', line 171

def hash
  [check_type, target_id, compartment_id, tablespace, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/data_safe/models/generate_health_report_details.rb', line 215

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



209
210
211
 
# File 'lib/oci/data_safe/models/generate_health_report_details.rb', line 209

def to_s
  to_hash.to_s
end