Class: OCI::Identity::Models::TagDefaultSummary

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

Overview

Summary information for the specified tag default.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.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 = {}) ⇒ TagDefaultSummary

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

  • :tag_namespace_id (String) —

    The value to assign to the #tag_namespace_id property

  • :tag_definition_id (String) —

    The value to assign to the #tag_definition_id property

  • :tag_definition_name (String) —

    The value to assign to the #tag_definition_name property

  • :value (String) —

    The value to assign to the #value property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :is_required (BOOLEAN) —

    The value to assign to the #is_required property



119
120
121
122
123
124
125
126
127
128
129
130
131
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
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 119

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

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

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

  self.tag_definition_id = attributes[:'tagDefinitionId'] if attributes[:'tagDefinitionId']

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

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

  self.tag_definition_name = attributes[:'tagDefinitionName'] if attributes[:'tagDefinitionName']

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

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

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

  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.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.is_required = attributes[:'isRequired'] unless attributes[:'isRequired'].nil?

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment. The tag default will apply to all new resources that are created in the compartment.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 24

def compartment_id
  @compartment_id
end

#id ⇒ String

[Required] The OCID of the tag default.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 19

def id
  @id
end

#is_required ⇒ BOOLEAN

[Required] If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the ‘isRequired` flag is set to "true", the value is set during resource creation.

  • If the ‘isRequired` flag is set to "false", the value you enter is set during resource creation.

Example: ‘false`

Returns:

  • (BOOLEAN) 


68
69
70
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 68

def is_required
  @is_required
end

#lifecycle_state ⇒ String

The tag default’s current state. After creating a ‘TagDefault`, make sure its `lifecycleState` is ACTIVE before using it.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 56

def lifecycle_state
  @lifecycle_state
end

#tag_definition_id ⇒ String

[Required] The OCID of the tag definition. The tag default will always assign a default value for this tag definition.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 34

def tag_definition_id
  @tag_definition_id
end

#tag_definition_name ⇒ String

[Required] The name used in the tag definition. This field is informational in the context of the tag default.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 39

def tag_definition_name
  @tag_definition_name
end

#tag_namespace_id ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 29

def tag_namespace_id
  @tag_namespace_id
end

#time_created ⇒ DateTime

[Required] Date and time the ‘TagDefault` object was created, in the format defined by RFC3339.

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#value ⇒ String

[Required] The default value for the tag definition. This will be applied to all new resources created in the compartment.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 44

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 71

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'tag_namespace_id': :'tagNamespaceId',
    'tag_definition_id': :'tagDefinitionId',
    'tag_definition_name': :'tagDefinitionName',
    'value': :'value',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'is_required': :'isRequired'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 88

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'tag_namespace_id': :'String',
    'tag_definition_id': :'String',
    'tag_definition_name': :'String',
    'value': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'is_required': :'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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 192

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    tag_namespace_id == other.tag_namespace_id &&
    tag_definition_id == other.tag_definition_id &&
    tag_definition_name == other.tag_definition_name &&
    value == other.value &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    is_required == other.is_required
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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 230

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


210
211
212
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 210

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



219
220
221
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 219

def hash
  [id, compartment_id, tag_namespace_id, tag_definition_id, tag_definition_name, value, time_created, lifecycle_state, is_required].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 263

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



257
258
259
 
# File 'lib/oci/identity/models/tag_default_summary.rb', line 257

def to_s
  to_hash.to_s
end