Class: OCI::CloudGuard::Models::CreateSecurityZoneDetails

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

Overview

Parameters to be used to create a new security zone.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSecurityZoneDetails

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_zone_recipe_id (String) —

    The value to assign to the #security_zone_recipe_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :is_inheritance_after_delete_enabled (BOOLEAN) —

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



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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/cloud_guard/models/create_security_zone_details.rb', line 88

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_zone_recipe_id = attributes[:'securityZoneRecipeId'] if attributes[:'securityZoneRecipeId']

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

  self.security_zone_recipe_id = attributes[:'security_zone_recipe_id'] if attributes[:'security_zone_recipe_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.is_inheritance_after_delete_enabled = attributes[:'isInheritanceAfterDeleteEnabled'] unless attributes[:'isInheritanceAfterDeleteEnabled'].nil?
  self.is_inheritance_after_delete_enabled = true if is_inheritance_after_delete_enabled.nil? && !attributes.key?(:'isInheritanceAfterDeleteEnabled') # rubocop:disable Style/StringLiterals

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

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

  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

#compartment_id ⇒ String

[Required] The OCID of the compartment for the security zone

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/cloud_guard/models/create_security_zone_details.rb', line 25

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


43
44
45
 
# File 'lib/oci/cloud_guard/models/create_security_zone_details.rb', line 43

def defined_tags
  @defined_tags
end

#description ⇒ String

The security zone's description

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

[Required] The security zone's display name

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/cloud_guard/models/create_security_zone_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>) 


37
38
39
 
# File 'lib/oci/cloud_guard/models/create_security_zone_details.rb', line 37

def freeform_tags
  @freeform_tags
end

#is_inheritance_after_delete_enabled ⇒ BOOLEAN

Indicates if upon deletion of the security zone the comparment should inherit parent security zone

Returns:

  • (BOOLEAN) 


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

def is_inheritance_after_delete_enabled
  @is_inheritance_after_delete_enabled
end

#security_zone_recipe_id ⇒ String

[Required] The OCID of the security zone recipe (SecurityRecipe resource) for the security zone

Returns:

  • (String) 


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

def security_zone_recipe_id
  @security_zone_recipe_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'security_zone_recipe_id': :'securityZoneRecipeId',
    'compartment_id': :'compartmentId',
    'is_inheritance_after_delete_enabled': :'isInheritanceAfterDeleteEnabled',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/cloud_guard/models/create_security_zone_details.rb', line 61

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



142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/cloud_guard/models/create_security_zone_details.rb', line 142

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

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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/cloud_guard/models/create_security_zone_details.rb', line 178

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


158
159
160
 
# File 'lib/oci/cloud_guard/models/create_security_zone_details.rb', line 158

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



167
168
169
 
# File 'lib/oci/cloud_guard/models/create_security_zone_details.rb', line 167

def hash
  [display_name, description, security_zone_recipe_id, compartment_id, is_inheritance_after_delete_enabled, 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



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/cloud_guard/models/create_security_zone_details.rb', line 211

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



205
206
207
 
# File 'lib/oci/cloud_guard/models/create_security_zone_details.rb', line 205

def to_s
  to_hash.to_s
end