Class: OCI::ComputeInstanceAgent::Models::InstanceAgentCommandSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb

Overview

Summary information for a command.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstanceAgentCommandSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :instance_agent_command_id (String) —

    The value to assign to the #instance_agent_command_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

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

  • :is_canceled (BOOLEAN) —

    The value to assign to the #is_canceled property

[View source]

79
80
81
82
83
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
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 79

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

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

  self.instance_agent_command_id = attributes[:'instance_agent_command_id'] if attributes[:'instance_agent_command_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.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.is_canceled = attributes[:'isCanceled'] unless attributes[:'isCanceled'].nil?

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

  self.is_canceled = attributes[:'is_canceled'] unless attributes[:'is_canceled'].nil?
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the command.

Returns:

  • (String) 

21
22
23
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 21

def compartment_id
  @compartment_id
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique.

Returns:

  • (String) 

17
18
19
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 17

def display_name
  @display_name
end

#instance_agent_command_id ⇒ String

[Required] The OCID of the command.

Returns:

  • (String) 

13
14
15
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 13

def instance_agent_command_id
  @instance_agent_command_id
end

#is_canceled ⇒ BOOLEAN

Whether a request was made to cancel the command. Canceling a command is a best-effort attempt.

Returns:

  • (BOOLEAN) 

37
38
39
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 37

def is_canceled
  @is_canceled
end

#time_created ⇒ DateTime

[Required] The date and time the command was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 

27
28
29
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 27

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the command was last updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 

33
34
35
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 33

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 40

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'instance_agent_command_id': :'instanceAgentCommandId',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'is_canceled': :'isCanceled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 54

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'instance_agent_command_id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'is_canceled': :'BOOLEAN'
    # 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

[View source]

129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 129

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

  self.class == other.class &&
    instance_agent_command_id == other.instance_agent_command_id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    is_canceled == other.is_canceled
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

[View source]

164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 164

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
[View source]

144
145
146
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 144

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

153
154
155
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 153

def hash
  [instance_agent_command_id, display_name, compartment_id, time_created, time_updated, is_canceled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 197

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

[View source]

191
192
193
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_summary.rb', line 191

def to_s
  to_hash.to_s
end