class OCI::ObjectStorage::Models::ObjectSummary

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

Constants

ARCHIVAL_STATE_ENUM
STORAGE_TIER_ENUM

Attributes

archival_state[R]

Archival state of an object. This field is set only for objects in Archive tier. @return [String]

etag[RW]

The current entity tag (ETag) for the object. @return [String]

md5[RW]

Base64-encoded MD5 hash of the object data. @return [String]

name[RW]

[Required] The name of the object. Avoid entering confidential information. Example: test/object1.log

@return [String]

size[RW]

Size of the object in bytes. @return [Integer]

storage_tier[R]

The storage tier that the object is stored in. @return [String]

time_created[RW]

The date and time the object was created, as described in [RFC 2616](tools.ietf.org/html/rfc2616#section-14.29). @return [DateTime]

time_modified[RW]

The date and time the object was modified, as described in [RFC 2616](tools.ietf.org/rfc/rfc2616), section 14.29. @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/object_summary.rb, line 63
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'size': :'size',
    'md5': :'md5',
    'time_created': :'timeCreated',
    'etag': :'etag',
    'storage_tier': :'storageTier',
    'archival_state': :'archivalState',
    '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] :name The value to assign to the {#name} property @option attributes [Integer] :size The value to assign to the {#size} property @option attributes [String] :md5 The value to assign to the {#md5} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :etag The value to assign to the {#etag} property @option attributes [String] :storage_tier The value to assign to the {#storage_tier} property @option attributes [String] :archival_state The value to assign to the {#archival_state} property @option attributes [DateTime] :time_modified The value to assign to the {#time_modified} property

# File lib/oci/object_storage/models/object_summary.rb, line 108
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.name = attributes[:'name'] if attributes[:'name']

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

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

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

  self.storage_tier = attributes[:'storageTier'] if attributes[:'storageTier']

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

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

  self.archival_state = attributes[:'archivalState'] if attributes[:'archivalState']

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

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

  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/object_summary.rb, line 79
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'size': :'Integer',
    'md5': :'String',
    'time_created': :'DateTime',
    'etag': :'String',
    'storage_tier': :'String',
    'archival_state': :'String',
    '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/object_summary.rb, line 180
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    size == other.size &&
    md5 == other.md5 &&
    time_created == other.time_created &&
    etag == other.etag &&
    storage_tier == other.storage_tier &&
    archival_state == other.archival_state &&
    time_modified == other.time_modified
end
archival_state=(archival_state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] archival_state Object to be assigned

# File lib/oci/object_storage/models/object_summary.rb, line 164
def archival_state=(archival_state)
  # rubocop:disable Style/ConditionalAssignment
  if archival_state && !ARCHIVAL_STATE_ENUM.include?(archival_state)
    OCI.logger.debug("Unknown value for 'archival_state' [" + archival_state + "]. Mapping to 'ARCHIVAL_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @archival_state = ARCHIVAL_STATE_UNKNOWN_ENUM_VALUE
  else
    @archival_state = archival_state
  end
  # rubocop:enable Style/ConditionalAssignment
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/object_summary.rb, line 217
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/object_summary.rb, line 197
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/object_summary.rb, line 206
def hash
  [name, size, md5, time_created, etag, storage_tier, archival_state, time_modified].hash
end
storage_tier=(storage_tier) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] storage_tier Object to be assigned

# File lib/oci/object_storage/models/object_summary.rb, line 151
def storage_tier=(storage_tier)
  # rubocop:disable Style/ConditionalAssignment
  if storage_tier && !STORAGE_TIER_ENUM.include?(storage_tier)
    OCI.logger.debug("Unknown value for 'storage_tier' [" + storage_tier + "]. Mapping to 'STORAGE_TIER_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @storage_tier = STORAGE_TIER_UNKNOWN_ENUM_VALUE
  else
    @storage_tier = storage_tier
  end
  # rubocop:enable Style/ConditionalAssignment
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/object_summary.rb, line 250
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/object_summary.rb, line 244
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/object_summary.rb, line 267
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