Class: OCI::Wlms::Models::WlsDomain

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

Overview

WLSDomain is representative of a WebLogic Domain running on one or more managed instances.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

PATCH_READINESS_STATUS_ENUM = 
[
  PATCH_READINESS_STATUS_OK = 'OK'.freeze,
  PATCH_READINESS_STATUS_WARNING = 'WARNING'.freeze,
  PATCH_READINESS_STATUS_ERROR = 'ERROR'.freeze,
  PATCH_READINESS_STATUS_UNKNOWN = 'UNKNOWN'.freeze,
  PATCH_READINESS_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.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 = {}) ⇒ WlsDomain

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 181

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

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

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

  self.weblogic_version = attributes[:'weblogicVersion'] if attributes[:'weblogicVersion']

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

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

  self.patch_readiness_status = attributes[:'patchReadinessStatus'] if attributes[:'patchReadinessStatus']

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

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

  self.is_accepted_terms_and_conditions = attributes[:'isAcceptedTermsAndConditions'] unless attributes[:'isAcceptedTermsAndConditions'].nil?

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

  self.is_accepted_terms_and_conditions = attributes[:'is_accepted_terms_and_conditions'] unless attributes[:'is_accepted_terms_and_conditions'].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.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

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

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

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 46

def compartment_id
  @compartment_id
end

#configuration ⇒ OCI::Wlms::Models::WlsDomainConfiguration

Returns:



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

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


105
106
107
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 105

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name that does not have to be unique and is changeable.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 42

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


97
98
99
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 97

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the WebLogic domain.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 38

def id
  @id
end

#is_accepted_terms_and_conditions ⇒ BOOLEAN

Whether or not the terms of use agreement has been accepted for the WebLogic domain.

Returns:

  • (BOOLEAN) 


62
63
64
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 62

def is_accepted_terms_and_conditions
  @is_accepted_terms_and_conditions
end

#lifecycle_details ⇒ String

A message that describes the current state of the WebLogic domain in more detail. For example, it can be used to provide actionable information for a resource in the Failed state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the WebLogic service domain.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 66

def lifecycle_state
  @lifecycle_state
end

#middleware_type ⇒ String

The middleware type on the administration server of the WebLogic domain.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 50

def middleware_type
  @middleware_type
end

#patch_readiness_status ⇒ String

The patch readiness status of the WebLogic domain.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 58

def patch_readiness_status
  @patch_readiness_status
end

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

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


112
113
114
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 112

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The date and time the WebLogic domain was created (in RFC 3339 format).

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

Returns:

  • (DateTime) 


82
83
84
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 82

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the WebLogic domain was updated (in RFC 3339 format).

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

Returns:

  • (DateTime) 


89
90
91
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 89

def time_updated
  @time_updated
end

#weblogic_version ⇒ String

The version of the WebLogic domain.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 54

def weblogic_version
  @weblogic_version
end

Class Method Details

.attribute_map ⇒ Object

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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 115

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'middleware_type': :'middlewareType',
    'weblogic_version': :'weblogicVersion',
    'patch_readiness_status': :'patchReadinessStatus',
    'is_accepted_terms_and_conditions': :'isAcceptedTermsAndConditions',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'configuration': :'configuration',
    '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.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 138

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'middleware_type': :'String',
    'weblogic_version': :'String',
    'patch_readiness_status': :'String',
    'is_accepted_terms_and_conditions': :'BOOLEAN',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'configuration': :'OCI::Wlms::Models::WlsDomainConfiguration',
    '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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 303

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    middleware_type == other.middleware_type &&
    weblogic_version == other.weblogic_version &&
    patch_readiness_status == other.patch_readiness_status &&
    is_accepted_terms_and_conditions == other.is_accepted_terms_and_conditions &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    configuration == other.configuration &&
    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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 347

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


327
328
329
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 327

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



336
337
338
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 336

def hash
  [id, display_name, compartment_id, middleware_type, weblogic_version, patch_readiness_status, is_accepted_terms_and_conditions, lifecycle_state, lifecycle_details, configuration, 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



380
381
382
383
384
385
386
387
388
389
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 380

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



374
375
376
 
# File 'lib/oci/wlms/models/wls_domain.rb', line 374

def to_s
  to_hash.to_s
end