Class: OCI::Core::Models::ConsoleHistory

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/console_history.rb

Overview

An instance’s serial console data. It includes configuration messages that occur when the instance boots, such as kernel and BIOS messages, and is useful for checking the status of the instance or diagnosing problems. The console data is minimally formatted ASCII text.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_REQUESTED = 'REQUESTED',
LIFECYCLE_STATE_GETTING_HISTORY = 'GETTING-HISTORY',
LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED',
LIFECYCLE_STATE_FAILED = 'FAILED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConsoleHistory

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

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

    The value to assign to the #defined_tags property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :id (String) —

    The value to assign to the #id property

  • :instance_id (String) —

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/core/models/console_history.rb', line 84

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}

  if attributes[:'availabilityDomain']
    self.availability_domain = attributes[:'availabilityDomain']
  end

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

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

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

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

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

  if attributes[:'definedTags']
    self.defined_tags = attributes[:'definedTags']
  end

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

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

  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end

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

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

  if attributes[:'freeformTags']
    self.freeform_tags = attributes[:'freeformTags']
  end

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

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

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

  if attributes[:'instanceId']
    self.instance_id = attributes[:'instanceId']
  end

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

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

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

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

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

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

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

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

end

Instance Attribute Details

#availability_domain ⇒ String

[Required] The Availability Domain of an instance.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/core/models/console_history.rb', line 23

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/core/models/console_history.rb', line 27

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](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`

Returns:

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


35
36
37
 
# File 'lib/oci/core/models/console_history.rb', line 35

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Example: ‘My console history metadata`

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/core/models/console_history.rb', line 43

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](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


52
53
54
 
# File 'lib/oci/core/models/console_history.rb', line 52

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the console history metadata object.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/core/models/console_history.rb', line 56

def id
  @id
end

#instance_id ⇒ String

[Required] The OCID of the instance this console history was fetched from.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/core/models/console_history.rb', line 60

def instance_id
  @instance_id
end

#lifecycle_state ⇒ String

[Required] The current state of the console history.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/core/models/console_history.rb', line 64

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

[Required] The date and time the history was created, in the format defined by RFC3339. Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


70
71
72
 
# File 'lib/oci/core/models/console_history.rb', line 70

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/core/models/console_history.rb', line 188

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      availability_domain == other_object.availability_domain &&
      compartment_id == other_object.compartment_id &&
      defined_tags == other_object.defined_tags &&
      display_name == other_object.display_name &&
      freeform_tags == other_object.freeform_tags &&
      id == other_object.id &&
      instance_id == other_object.instance_id &&
      lifecycle_state == other_object.lifecycle_state &&
      time_created == other_object.time_created
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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/core/models/console_history.rb', line 217

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


204
205
206
 
# File 'lib/oci/core/models/console_history.rb', line 204

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



210
211
212
 
# File 'lib/oci/core/models/console_history.rb', line 210

def hash
  [availability_domain, compartment_id, defined_tags, display_name, freeform_tags, id, instance_id, lifecycle_state, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/core/models/console_history.rb', line 242

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



236
237
238
 
# File 'lib/oci/core/models/console_history.rb', line 236

def to_s
  to_hash.to_s
end