Class: OCI::ObjectStorage::Models::ObjectVersionSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/object_storage/models/object_version_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](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

Constant Summary collapse

STORAGE_TIER_ENUM = 
[
  STORAGE_TIER_STANDARD = 'Standard'.freeze,
  STORAGE_TIER_INFREQUENT_ACCESS = 'InfrequentAccess'.freeze,
  STORAGE_TIER_ARCHIVE = 'Archive'.freeze,
  STORAGE_TIER_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ARCHIVAL_STATE_ENUM = 
[
  ARCHIVAL_STATE_ARCHIVED = 'Archived'.freeze,
  ARCHIVAL_STATE_RESTORING = 'Restoring'.freeze,
  ARCHIVAL_STATE_RESTORED = 'Restored'.freeze,
  ARCHIVAL_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ObjectVersionSummary

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

  • :time_modified (DateTime) —

    The value to assign to the #time_modified property

  • :etag (String) —

    The value to assign to the #etag property

  • :storage_tier (String) —

    The value to assign to the #storage_tier property

  • :archival_state (String) —

    The value to assign to the #archival_state property

  • :version_id (String) —

    The value to assign to the #version_id property

  • :is_delete_marker (BOOLEAN) —

    The value to assign to the #is_delete_marker property



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 122

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

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

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

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

  self.is_delete_marker = attributes[:'isDeleteMarker'] unless attributes[:'isDeleteMarker'].nil?

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

  self.is_delete_marker = attributes[:'is_delete_marker'] unless attributes[:'is_delete_marker'].nil?
end

Instance Attribute Details

#archival_state ⇒ String

Archival state of an object. This field is set only for objects in Archive tier.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 60

def archival_state
  @archival_state
end

#etag ⇒ String

The current entity tag (ETag) for the object.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 52

def etag
  @etag
end

#is_delete_marker ⇒ BOOLEAN

[Required] This flag will indicate if the version is deleted or not.

Returns:

  • (BOOLEAN) 


68
69
70
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 68

def is_delete_marker
  @is_delete_marker
end

#md5 ⇒ String

Base64-encoded MD5 hash of the object data.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 40

def md5
  @md5
end

#name ⇒ String

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

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 32

def name
  @name
end

#size ⇒ Integer

Size of the object in bytes.

Returns:

  • (Integer) 


36
37
38
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 36

def size
  @size
end

#storage_tier ⇒ String

The storage tier that the object is stored in.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 56

def storage_tier
  @storage_tier
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


44
45
46
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 44

def time_created
  @time_created
end

#time_modified ⇒ DateTime

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

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 48

def time_modified
  @time_modified
end

#version_id ⇒ String

[Required] VersionId of the object.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 64

def version_id
  @version_id
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 71

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'size': :'size',
    'md5': :'md5',
    'time_created': :'timeCreated',
    'time_modified': :'timeModified',
    'etag': :'etag',
    'storage_tier': :'storageTier',
    'archival_state': :'archivalState',
    'version_id': :'versionId',
    'is_delete_marker': :'isDeleteMarker'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 89

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 206

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 &&
    time_modified == other.time_modified &&
    etag == other.etag &&
    storage_tier == other.storage_tier &&
    archival_state == other.archival_state &&
    version_id == other.version_id &&
    is_delete_marker == other.is_delete_marker
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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 245

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


225
226
227
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 225

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 234

def hash
  [name, size, md5, time_created, time_modified, etag, storage_tier, archival_state, version_id, is_delete_marker].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 278

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



272
273
274
 
# File 'lib/oci/object_storage/models/object_version_summary.rb', line 272

def to_s
  to_hash.to_s
end