Class: OCI::Identity::Models::TagDefault

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

Overview

Tag defaults let you specify a default tag (tagnamespace.tag="value") to apply to all resource types in a specified compartment. The tag default is applied at the time the resource is created. Resources that exist in the compartment before you create the tag default are not tagged. The ‘TagDefault` object specifies the tag and compartment details.

Tag defaults are inherited by child compartments. This means that if you set a tag default on the root compartment for a tenancy, all resources that are created in the tenancy are tagged. For more information about using tag defaults, see [Managing Tag Defaults](docs.cloud.oracle.com/Content/Identity/Tasks/managingtagdefaults.htm).

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator.

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 = {}) ⇒ TagDefault

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



114
115
116
117
118
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
 
# File 'lib/oci/identity/models/tag_default.rb', line 114

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment. The tag default applies to all new resources that get created in the compartment. Resources that existed before the tag default was created are not tagged.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#id ⇒ String

[Required] The OCID of the tag default.

Returns:

  • (String) 


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

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


66
67
68
 
# File 'lib/oci/identity/models/tag_default.rb', line 66

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) 


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

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) 


49
50
51
 
# File 'lib/oci/identity/models/tag_default.rb', line 49

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) 


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

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) 


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

def time_created
  @time_created
end

#value ⇒ String

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

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/identity/models/tag_default.rb', line 54

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/identity/models/tag_default.rb', line 69

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/identity/models/tag_default.rb', line 85

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



181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/identity/models/tag_default.rb', line 181

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/identity/models/tag_default.rb', line 218

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


198
199
200
 
# File 'lib/oci/identity/models/tag_default.rb', line 198

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



207
208
209
 
# File 'lib/oci/identity/models/tag_default.rb', line 207

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
260
 
# File 'lib/oci/identity/models/tag_default.rb', line 251

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



245
246
247
 
# File 'lib/oci/identity/models/tag_default.rb', line 245

def to_s
  to_hash.to_s
end