Class: OCI::SecurityAttribute::Models::SecurityAttribute

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

Overview

A security attribute that belongs to a specific security attribute namespace. Security attributes must be created in a tenancy before a user can apply them to resources. For more information, see Managing Security Attributes.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecurityAttribute

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 132

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

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

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

  self.security_attribute_namespace_name = attributes[:'securityAttributeNamespaceName'] if attributes[:'securityAttributeNamespaceName']

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

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

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

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

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

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

  self.is_retired = attributes[:'isRetired'] unless attributes[:'isRetired'].nil?

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

  self.is_retired = attributes[:'is_retired'] unless attributes[:'is_retired'].nil?

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the security attribute definition.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#description ⇒ String

[Required] The description of the security attribute.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 51

def description
  @description
end

#id ⇒ String

[Required] The OCID of the security attribute definition.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 41

def id
  @id
end

#is_retired ⇒ BOOLEAN

[Required] Indicates whether the security attribute is retired. See Managing Security Attribute Namespaces.

Returns:

  • (BOOLEAN) 


61
62
63
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 61

def is_retired
  @is_retired
end

#lifecycle_state ⇒ String

The security attribute's current state. After creating a security attribute, make sure its lifecycleState is ACTIVE before using it. After retiring a security attribute, make sure its lifecycleState is INACTIVE before using it. If you delete a security attribute, you cannot delete another security attribute until the deleted tag's lifecycleState changes from DELETING to DELETED.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 65

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The name assigned to the security attribute during creation. This is the security attribute key. The name must be unique within the security attribute namespace and cannot be changed.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 47

def name
  @name
end

#security_attribute_namespace_id ⇒ String

[Required] The OCID of the security attribute namespace that contains the security attribute definition.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 32

def security_attribute_namespace_id
  @security_attribute_namespace_id
end

#security_attribute_namespace_name ⇒ String

[Required] The name of the security attribute namespace that contains the security attribute.

Returns:

  • (String) 


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

def security_attribute_namespace_name
  @security_attribute_namespace_name
end

#time_created ⇒ DateTime

[Required] Date and time the security attribute was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


72
73
74
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 72

def time_created
  @time_created
end

#type ⇒ String

The data type of the security attribute.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 55

def type
  @type
end

#validator ⇒ OCI::SecurityAttribute::Models::BaseSecurityAttributeValidator

Returns:



75
76
77
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 75

def validator
  @validator
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 78

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'security_attribute_namespace_id': :'securityAttributeNamespaceId',
    'security_attribute_namespace_name': :'securityAttributeNamespaceName',
    'id': :'id',
    'name': :'name',
    'description': :'description',
    'type': :'type',
    'is_retired': :'isRetired',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'validator': :'validator'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 97

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'security_attribute_namespace_id': :'String',
    'security_attribute_namespace_name': :'String',
    'id': :'String',
    'name': :'String',
    'description': :'String',
    'type': :'String',
    'is_retired': :'BOOLEAN',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'validator': :'OCI::SecurityAttribute::Models::BaseSecurityAttributeValidator'
    # 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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 205

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    security_attribute_namespace_id == other.security_attribute_namespace_id &&
    security_attribute_namespace_name == other.security_attribute_namespace_name &&
    id == other.id &&
    name == other.name &&
    description == other.description &&
    type == other.type &&
    is_retired == other.is_retired &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    validator == other.validator
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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 245

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


225
226
227
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 225

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 234

def hash
  [compartment_id, security_attribute_namespace_id, security_attribute_namespace_name, id, name, description, type, is_retired, lifecycle_state, time_created, validator].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 278

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



272
273
274
 
# File 'lib/oci/security_attribute/models/security_attribute.rb', line 272

def to_s
  to_hash.to_s
end