Class: OCI::Opensearch::Models::BackupEventDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opensearch/models/backup_event_details.rb

Overview

Details about a cluster backup event.

Constant Summary collapse

BACKUP_STATE_ENUM = 
[
  BACKUP_STATE_DELETED = 'DELETED'.freeze,
  BACKUP_STATE_SUCCESS = 'SUCCESS'.freeze,
  BACKUP_STATE_FAILED = 'FAILED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BackupEventDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :cluster_id (String) —

    The value to assign to the #cluster_id property

  • :backup_state (String) —

    The value to assign to the #backup_state property

  • :snapshot_name (String) —

    The value to assign to the #snapshot_name property

  • :time_started (DateTime) —

    The value to assign to the #time_started property

  • :time_ended (DateTime) —

    The value to assign to the #time_ended property

  • :backup_size (Float) —

    The value to assign to the #backup_size property



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
121
122
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 81

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

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

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

  self.backup_state = attributes[:'backupState'] if attributes[:'backupState']

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

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

  self.snapshot_name = attributes[:'snapshotName'] if attributes[:'snapshotName']

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

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

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

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

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

  self.time_ended = attributes[:'timeEnded'] if attributes[:'timeEnded']

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

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

  self.backup_size = attributes[:'backupSize'] if attributes[:'backupSize']

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

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

Instance Attribute Details

#backup_size ⇒ Float

The cluster backup size in GB.

Returns:

  • (Float) 


39
40
41
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 39

def backup_size
  @backup_size
end

#backup_state ⇒ String

[Required] The result of the cluster backup operation.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 23

def backup_state
  @backup_state
end

#cluster_id ⇒ String

[Required] The OCID of the OpenSearch cluster for the cluster backup.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 19

def cluster_id
  @cluster_id
end

#snapshot_name ⇒ String

The name of the cluster backup.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 27

def snapshot_name
  @snapshot_name
end

#time_ended ⇒ DateTime

[Required] The date and time the cluster backup event started. Format defined by RFC3339.

Returns:

  • (DateTime) 


35
36
37
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 35

def time_ended
  @time_ended
end

#time_started ⇒ DateTime

[Required] The date and time the cluster backup event started. Format defined by RFC3339.

Returns:

  • (DateTime) 


31
32
33
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 31

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'cluster_id': :'clusterId',
    'backup_state': :'backupState',
    'snapshot_name': :'snapshotName',
    'time_started': :'timeStarted',
    'time_ended': :'timeEnded',
    'backup_size': :'backupSize'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 56

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'cluster_id': :'String',
    'backup_state': :'String',
    'snapshot_name': :'String',
    'time_started': :'DateTime',
    'time_ended': :'DateTime',
    'backup_size': :'Float'
    # 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



139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 139

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

  self.class == other.class &&
    cluster_id == other.cluster_id &&
    backup_state == other.backup_state &&
    snapshot_name == other.snapshot_name &&
    time_started == other.time_started &&
    time_ended == other.time_ended &&
    backup_size == other.backup_size
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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 174

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


154
155
156
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 154

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 163

def hash
  [cluster_id, backup_state, snapshot_name, time_started, time_ended, backup_size].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 207

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



201
202
203
 
# File 'lib/oci/opensearch/models/backup_event_details.rb', line 201

def to_s
  to_hash.to_s
end