Class: OCI::ObjectStorage::Models::Duration

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/object_storage/models/duration.rb

Overview

The amount of time that objects in the bucket should be preserved for and which is calculated in relation to each object's Last-Modified timestamp. If duration is not present, then there is no time limit and the objects in the bucket will be preserved indefinitely.

Constant Summary collapse

TIME_UNIT_ENUM = 
[
  TIME_UNIT_YEARS = 'YEARS'.freeze,
  TIME_UNIT_DAYS = 'DAYS'.freeze,
  TIME_UNIT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Duration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :time_amount (Integer) —

    The value to assign to the #time_amount property

  • :time_unit (String) —

    The value to assign to the #time_unit property



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/object_storage/models/duration.rb', line 59

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

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

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

  self.time_unit = attributes[:'timeUnit'] if attributes[:'timeUnit']

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

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

Instance Attribute Details

#time_amount ⇒ Integer

[Required] The timeAmount is interpreted in units defined by the timeUnit parameter, and is calculated in relation to each object's Last-Modified timestamp.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/oci/object_storage/models/duration.rb', line 25

def time_amount
  @time_amount
end

#time_unit ⇒ String

[Required] The unit that should be used to interpret timeAmount.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/object_storage/models/duration.rb', line 29

def time_unit
  @time_unit
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/oci/object_storage/models/duration.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_amount': :'timeAmount',
    'time_unit': :'timeUnit'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
 
# File 'lib/oci/object_storage/models/duration.rb', line 42

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'time_amount': :'Integer',
    'time_unit': :'String'
    # 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



98
99
100
101
102
103
104
 
# File 'lib/oci/object_storage/models/duration.rb', line 98

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

  self.class == other.class &&
    time_amount == other.time_amount &&
    time_unit == other.time_unit
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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/object_storage/models/duration.rb', line 129

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


109
110
111
 
# File 'lib/oci/object_storage/models/duration.rb', line 109

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



118
119
120
 
# File 'lib/oci/object_storage/models/duration.rb', line 118

def hash
  [time_amount, time_unit].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/object_storage/models/duration.rb', line 162

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



156
157
158
 
# File 'lib/oci/object_storage/models/duration.rb', line 156

def to_s
  to_hash.to_s
end