Class: OCI::CloudGuard::Models::UpdateSecurityRecipeDetails

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

Overview

Parameters to be used to update a Security Zones security recipe.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateSecurityRecipeDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :security_policies (Array<String>) —

    The value to assign to the #security_policies 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



74
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
 
# File 'lib/oci/cloud_guard/models/update_security_recipe_details.rb', line 74

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

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

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

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

  self.security_policies = attributes[:'securityPolicies'] if attributes[:'securityPolicies']

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

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

  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

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


35
36
37
 
# File 'lib/oci/cloud_guard/models/update_security_recipe_details.rb', line 35

def defined_tags
  @defined_tags
end

#description ⇒ String

The recipe's description

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/cloud_guard/models/update_security_recipe_details.rb', line 17

def description
  @description
end

#display_name ⇒ String

[Required] The recipe's display name

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/cloud_guard/models/update_security_recipe_details.rb', line 13

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Avoid entering confidential information.

Returns:

  • (Hash<String, String>) 


29
30
31
 
# File 'lib/oci/cloud_guard/models/update_security_recipe_details.rb', line 29

def freeform_tags
  @freeform_tags
end

#security_policies ⇒ Array<String>

The list of security policy IDs to include in the recipe

Returns:

  • (Array<String>) 


21
22
23
 
# File 'lib/oci/cloud_guard/models/update_security_recipe_details.rb', line 21

def security_policies
  @security_policies
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/cloud_guard/models/update_security_recipe_details.rb', line 38

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'security_policies': :'securityPolicies',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



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

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    security_policies == other.security_policies &&
    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



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

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


128
129
130
 
# File 'lib/oci/cloud_guard/models/update_security_recipe_details.rb', line 128

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



137
138
139
 
# File 'lib/oci/cloud_guard/models/update_security_recipe_details.rb', line 137

def hash
  [display_name, description, security_policies, 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



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

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



175
176
177
 
# File 'lib/oci/cloud_guard/models/update_security_recipe_details.rb', line 175

def to_s
  to_hash.to_s
end