class OCI::ObjectStorage::Models::RetentionRuleSummary

The summary of a retention rule.

Attributes

display_name[RW]

[Required] User specified name for the retention rule. @return [String]

duration[RW]

@return [OCI::ObjectStorage::Models::Duration]

etag[RW]

[Required] The entity tag (ETag) for the retention rule. @return [String]

id[RW]

[Required] Unique identifier for the retention rule. @return [String]

time_created[RW]

[Required] The date and time that the retention rule was created as per [RFC3339](tools.ietf.org/html/rfc3339). @return [DateTime]

time_modified[RW]

[Required] The date and time that the retention rule was modified as per [RFC3339](tools.ietf.org/html/rfc3339). @return [DateTime]

time_rule_locked[RW]

The date and time as per [RFC 3339](tools.ietf.org/html/rfc3339) after which this rule becomes locked. and can only be deleted by deleting the bucket.

@return [DateTime]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/object_storage/models/retention_rule_summary.rb, line 40
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'duration': :'duration',
    'etag': :'etag',
    'time_rule_locked': :'timeRuleLocked',
    'time_created': :'timeCreated',
    'time_modified': :'timeModified'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [OCI::ObjectStorage::Models::Duration] :duration The value to assign to the {#duration} property @option attributes [String] :etag The value to assign to the {#etag} property @option attributes [DateTime] :time_rule_locked The value to assign to the {#time_rule_locked} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_modified The value to assign to the {#time_modified} property

# File lib/oci/object_storage/models/retention_rule_summary.rb, line 82
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  self.id = attributes[:'id'] if attributes[:'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.duration = attributes[:'duration'] if attributes[:'duration']

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

  self.time_rule_locked = attributes[:'timeRuleLocked'] if attributes[:'timeRuleLocked']

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

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

  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_modified = attributes[:'timeModified'] if attributes[:'timeModified']

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

  self.time_modified = attributes[:'time_modified'] if attributes[:'time_modified']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/object_storage/models/retention_rule_summary.rb, line 55
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'duration': :'OCI::ObjectStorage::Models::Duration',
    'etag': :'String',
    'time_rule_locked': :'DateTime',
    'time_created': :'DateTime',
    'time_modified': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/object_storage/models/retention_rule_summary.rb, line 123
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    duration == other.duration &&
    etag == other.etag &&
    time_rule_locked == other.time_rule_locked &&
    time_created == other.time_created &&
    time_modified == other.time_modified
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/object_storage/models/retention_rule_summary.rb, line 159
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/object_storage/models/retention_rule_summary.rb, line 139
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/object_storage/models/retention_rule_summary.rb, line 148
def hash
  [id, display_name, duration, etag, time_rule_locked, time_created, time_modified].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/object_storage/models/retention_rule_summary.rb, line 192
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/object_storage/models/retention_rule_summary.rb, line 186
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/object_storage/models/retention_rule_summary.rb, line 209
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end