Class: OCI::DataSafe::Models::AttributeSetSummary

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

Overview

Summary details of an attribute set.

Constant Summary collapse

IN_USE_ENUM = 
[
  IN_USE_YES = 'YES'.freeze,
  IN_USE_NO = 'NO'.freeze,
  IN_USE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AttributeSetSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :attribute_set_type (String) —

    The value to assign to the #attribute_set_type property

  • :is_user_defined (BOOLEAN) —

    The value to assign to the #is_user_defined property

  • :in_use (String) —

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

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

    The value to assign to the #system_tags property



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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 138

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.id = attributes[:'id'] if attributes[:'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.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.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.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.attribute_set_type = attributes[:'attributeSetType'] if attributes[:'attributeSetType']

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

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

  self.is_user_defined = attributes[:'isUserDefined'] unless attributes[:'isUserDefined'].nil?

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

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

  self.in_use = attributes[:'inUse'] if attributes[:'inUse']

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

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

  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']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#attribute_set_type ⇒ String

[Required] The type of attribute set.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 48

def attribute_set_type
  @attribute_set_type
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 24

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>>) 


69
70
71
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 69

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of an attribute set.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

[Required] The display name of an attribute set. The name does not have to be unique, and is changeable.

Returns:

  • (String) 


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

def display_name
  @display_name
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>) 


63
64
65
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 63

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of an attribute set.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 20

def id
  @id
end

#in_use ⇒ String

Indicates whether the attribute set is in use by other resource.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 56

def in_use
  @in_use
end

#is_user_defined ⇒ BOOLEAN

Indicates whether the attribute set is user defined or pre defined in Data Safe. Values can either be 'true' or 'false'.

Returns:

  • (BOOLEAN) 


52
53
54
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 52

def is_user_defined
  @is_user_defined
end

#lifecycle_state ⇒ String

[Required] The current state of an attribute set.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 36

def lifecycle_state
  @lifecycle_state
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


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

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time an attribute set was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 40

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time an attribute set was updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


44
45
46
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 44

def time_updated
  @time_updated
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
95
96
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 78

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'attribute_set_type': :'attributeSetType',
    'is_user_defined': :'isUserDefined',
    'in_use': :'inUse',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 99

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'attribute_set_type': :'String',
    'is_user_defined': :'BOOLEAN',
    'in_use': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 235

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    attribute_set_type == other.attribute_set_type &&
    is_user_defined == other.is_user_defined &&
    in_use == other.in_use &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 277

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


257
258
259
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 257

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



266
267
268
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 266

def hash
  [id, compartment_id, display_name, description, lifecycle_state, time_created, time_updated, attribute_set_type, is_user_defined, in_use, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



310
311
312
313
314
315
316
317
318
319
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 310

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



304
305
306
 
# File 'lib/oci/data_safe/models/attribute_set_summary.rb', line 304

def to_s
  to_hash.to_s
end