Class: OCI::ObjectStorage::Models::ObjectSummary

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

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ObjectSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :size (Integer) —

    The value to assign to the #size property

  • :md5 (String) —

    The value to assign to the #md5 property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 64

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']
end

Instance Attribute Details

#md5 ⇒ String

Base64-encoded MD5 hash of the object data.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 24

def md5
  @md5
end

#name ⇒ String

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

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 16

def name
  @name
end

#size ⇒ Integer

Size of the object in bytes.

Returns:

  • (Integer) 


20
21
22
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 20

def size
  @size
end

#time_created ⇒ DateTime

The date and time the object was created, as described in [RFC 2616](tools.ietf.org/rfc/rfc2616), section 14.29.

Returns:

  • (DateTime) 


28
29
30
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 28

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'size': :'size',
    'md5': :'md5',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'size': :'Integer',
    'md5': :'String',
    'time_created': :'DateTime'
    # 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



90
91
92
93
94
95
96
97
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 90

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
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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 122

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


102
103
104
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 102

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



111
112
113
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 111

def hash
  [name, size, md5, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 154

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



148
149
150
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 148

def to_s
  to_hash.to_s
end