Class: OracleBMC::Core::Models::ConsoleHistory

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

Constant Summary collapse

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

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oraclebmc/core/models/console_history.rb', line 53

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
  
  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end
  
  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'instanceId']
    self.instance_id = attributes[:'instanceId']
  end
  
  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end
  
  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end
  
end

Instance Attribute Details

#availability_domain ⇒ String

The Availability Domain of an instance.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


18
19
20
 
# File 'lib/oraclebmc/core/models/console_history.rb', line 18

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

The OCID of the compartment.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oraclebmc/core/models/console_history.rb', line 22

def compartment_id
  @compartment_id
end

#display_name ⇒ String

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

Example: ‘My console history metadata`

Returns:

  • (String) 


29
30
31
 
# File 'lib/oraclebmc/core/models/console_history.rb', line 29

def display_name
  @display_name
end

#id ⇒ String

The OCID of the console history metadata object.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oraclebmc/core/models/console_history.rb', line 33

def id
  @id
end

#instance_id ⇒ String

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

Returns:

  • (String) 


37
38
39
 
# File 'lib/oraclebmc/core/models/console_history.rb', line 37

def instance_id
  @instance_id
end

#lifecycle_state ⇒ String

The current state of the console history.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oraclebmc/core/models/console_history.rb', line 41

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

The date and time the history was created, in the format defined by RFC3339.

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

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oraclebmc/core/models/console_history.rb', line 48

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



101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oraclebmc/core/models/console_history.rb', line 101

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 &&
      display_name == other_object.display_name &&
      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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oraclebmc/core/models/console_history.rb', line 128

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.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(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


115
116
117
 
# File 'lib/oraclebmc/core/models/console_history.rb', line 115

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



121
122
123
 
# File 'lib/oraclebmc/core/models/console_history.rb', line 121

def hash
  [availability_domain, compartment_id, display_name, 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



153
154
155
156
157
158
159
160
161
 
# File 'lib/oraclebmc/core/models/console_history.rb', line 153

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



147
148
149
 
# File 'lib/oraclebmc/core/models/console_history.rb', line 147

def to_s
  to_hash.to_s
end