Class: OCI::CloudGuard::Models::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_guard/models/configuration.rb

Overview

Specifies several key settings for a Cloud Guard tenancy, identified by tenancy root compartment OCID.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_ENABLED = 'ENABLED'.freeze,
  STATUS_DISABLED = 'DISABLED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Configuration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/cloud_guard/models/configuration.rb', line 69

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

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

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

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

  self.service_configurations = attributes[:'serviceConfigurations'] if attributes[:'serviceConfigurations']

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

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

  self.self_manage_resources = attributes[:'selfManageResources'] unless attributes[:'selfManageResources'].nil?

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

  self.self_manage_resources = attributes[:'self_manage_resources'] unless attributes[:'self_manage_resources'].nil?
end

Instance Attribute Details

#reporting_region ⇒ String

[Required] The reporting region

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/cloud_guard/models/configuration.rb', line 20

def reporting_region
  @reporting_region
end

#self_manage_resources ⇒ BOOLEAN

Were Oracle-managed resources created by customer?

Returns:

  • (BOOLEAN) 


33
34
35
 
# File 'lib/oci/cloud_guard/models/configuration.rb', line 33

def self_manage_resources
  @self_manage_resources
end

#service_configurations ⇒ Array<OCI::CloudGuard::Models::ServiceConfiguration>

List of service configurations for this tenant

Returns:



28
29
30
 
# File 'lib/oci/cloud_guard/models/configuration.rb', line 28

def service_configurations
  @service_configurations
end

#status ⇒ String

Status of the Cloud Guard tenant

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/cloud_guard/models/configuration.rb', line 24

def status
  @status
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
 
# File 'lib/oci/cloud_guard/models/configuration.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'reporting_region': :'reportingRegion',
    'status': :'status',
    'service_configurations': :'serviceConfigurations',
    'self_manage_resources': :'selfManageResources'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/cloud_guard/models/configuration.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'reporting_region': :'String',
    'status': :'String',
    'service_configurations': :'Array<OCI::CloudGuard::Models::ServiceConfiguration>',
    'self_manage_resources': :'BOOLEAN'
    # 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



116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/cloud_guard/models/configuration.rb', line 116

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

  self.class == other.class &&
    reporting_region == other.reporting_region &&
    status == other.status &&
    service_configurations == other.service_configurations &&
    self_manage_resources == other.self_manage_resources
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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/cloud_guard/models/configuration.rb', line 149

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


129
130
131
 
# File 'lib/oci/cloud_guard/models/configuration.rb', line 129

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



138
139
140
 
# File 'lib/oci/cloud_guard/models/configuration.rb', line 138

def hash
  [reporting_region, status, service_configurations, self_manage_resources].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/cloud_guard/models/configuration.rb', line 182

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



176
177
178
 
# File 'lib/oci/cloud_guard/models/configuration.rb', line 176

def to_s
  to_hash.to_s
end