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

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

  • :etag (String) —

    The value to assign to the #etag property

  • :time_modified (DateTime) —

    The value to assign to the #time_modified property



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 79

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

Instance Attribute Details

#etag ⇒ String

The current entity tag (ETag) for the object.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 33

def etag
  @etag
end

#md5 ⇒ String

Base64-encoded MD5 hash of the object data.

Returns:

  • (String) 


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

def md5
  @md5
end

#name ⇒ String

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

Returns:

  • (String) 


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

def name
  @name
end

#size ⇒ Integer

Size of the object in bytes.

Returns:

  • (Integer) 


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

def size
  @size
end

#time_created ⇒ DateTime

The date and time the object was created, as described in RFC 2616.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_modified ⇒ DateTime

The date and time the object was modified, as described in RFC 2616, section 14.29.

Returns:

  • (DateTime) 


37
38
39
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 37

def time_modified
  @time_modified
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 54

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



113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 113

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 &&
    time_modified == other.time_modified
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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 148

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


128
129
130
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 128

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



137
138
139
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 137

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 181

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



175
176
177
 
# File 'lib/oci/object_storage/models/object_summary.rb', line 175

def to_s
  to_hash.to_s
end