Class: OCI::TenantManagerControlPlane::Models::DomainGovernance

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

Overview

The model for a domain governance entity.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.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 = {}) ⇒ DomainGovernance

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

  • :owner_id (String) —

    The value to assign to the #owner_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :domain_id (String) —

    The value to assign to the #domain_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :is_governance_enabled (BOOLEAN) —

    The value to assign to the #is_governance_enabled property

  • :subscription_email (String) —

    The value to assign to the #subscription_email property

  • :ons_topic_id (String) —

    The value to assign to the #ons_topic_id property

  • :ons_subscription_id (String) —

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

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



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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 144

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

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

  self.owner_id = attributes[:'owner_id'] if attributes[:'owner_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.domain_id = attributes[:'domainId'] if attributes[:'domainId']

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

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

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

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

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

  self.subscription_email = attributes[:'subscriptionEmail'] if attributes[:'subscriptionEmail']

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

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

  self.ons_topic_id = attributes[:'onsTopicId'] if attributes[:'onsTopicId']

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

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

  self.ons_subscription_id = attributes[:'onsSubscriptionId'] if attributes[:'onsSubscriptionId']

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

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

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

#compartment_id ⇒ String

[Required] The OCID of the tenancy that owns this domain governance entity.

Returns:

  • (String) 


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

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


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

def defined_tags
  @defined_tags
end

#domain_id ⇒ String

[Required] The OCID of the domain associated with this domain governance entity.

Returns:

  • (String) 


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

def domain_id
  @domain_id
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\"}

Returns:

  • (Hash<String, String>) 


66
67
68
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 66

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the domain governance entity.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 20

def id
  @id
end

#is_governance_enabled ⇒ BOOLEAN

Indicates whether governance is enabled for this domain.

Returns:

  • (BOOLEAN) 


40
41
42
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 40

def is_governance_enabled
  @is_governance_enabled
end

#lifecycle_state ⇒ String

[Required] Lifecycle state of the domain governance entity.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 36

def lifecycle_state
  @lifecycle_state
end

#ons_subscription_id ⇒ String

[Required] The ONS subscription associated with this domain governance entity.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 52

def ons_subscription_id
  @ons_subscription_id
end

#ons_topic_id ⇒ String

[Required] The ONS topic associated with this domain governance entity.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 48

def ons_topic_id
  @ons_topic_id
end

#owner_id ⇒ String

[Required] The OCID of the tenancy that owns this domain governance entity.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 24

def owner_id
  @owner_id
end

#subscription_email ⇒ String

Email address to be used to notify the user, and that the ONS subscription will be created with.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 44

def subscription_email
  @subscription_email
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


78
79
80
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 78

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

Date-time when this domain governance was created. An RFC 3339-formatted date and time string.

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 56

def time_created
  @time_created
end

#time_updated ⇒ DateTime

Date-time when this domain governance was last updated. An RFC 3339-formatted date and time string.

Returns:

  • (DateTime) 


60
61
62
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 60

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 81

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'owner_id': :'ownerId',
    'compartment_id': :'compartmentId',
    'domain_id': :'domainId',
    'lifecycle_state': :'lifecycleState',
    'is_governance_enabled': :'isGovernanceEnabled',
    'subscription_email': :'subscriptionEmail',
    'ons_topic_id': :'onsTopicId',
    'ons_subscription_id': :'onsSubscriptionId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 103

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'owner_id': :'String',
    'compartment_id': :'String',
    'domain_id': :'String',
    'lifecycle_state': :'String',
    'is_governance_enabled': :'BOOLEAN',
    'subscription_email': :'String',
    'ons_topic_id': :'String',
    'ons_subscription_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 251

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

  self.class == other.class &&
    id == other.id &&
    owner_id == other.owner_id &&
    compartment_id == other.compartment_id &&
    domain_id == other.domain_id &&
    lifecycle_state == other.lifecycle_state &&
    is_governance_enabled == other.is_governance_enabled &&
    subscription_email == other.subscription_email &&
    ons_topic_id == other.ons_topic_id &&
    ons_subscription_id == other.ons_subscription_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 294

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


274
275
276
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 274

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



283
284
285
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 283

def hash
  [id, owner_id, compartment_id, domain_id, lifecycle_state, is_governance_enabled, subscription_email, ons_topic_id, ons_subscription_id, time_created, time_updated, 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



327
328
329
330
331
332
333
334
335
336
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 327

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



321
322
323
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_governance.rb', line 321

def to_s
  to_hash.to_s
end