Class: OCI::ObjectStorage::Models::MultipartUpload

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

Overview

Multipart uploads provide efficient and resilient uploads, especially for large objects. Multipart uploads also accommodate objects that are too large for a single upload operation. With multipart uploads, individual parts of an object can be uploaded in parallel to reduce the amount of time you spend uploading. Multipart uploads can also minimize the impact of network failures by letting you retry a failed part upload instead of requiring you to retry an entire object upload. See Using Multipart Uploads.

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 = {}) ⇒ MultipartUpload

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :namespace (String)

    The value to assign to the #namespace property

  • :bucket (String)

    The value to assign to the #bucket property

  • :object (String)

    The value to assign to the #object property

  • :upload_id (String)

    The value to assign to the #upload_id property

  • :time_created (DateTime)

    The value to assign to the #time_created property



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 76

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

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

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

  self.upload_id = attributes[:'uploadId'] if attributes[:'uploadId']

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

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

  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

#bucketString

[Required] The bucket in which the in-progress multipart upload is stored.

Returns:

  • (String)


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

def bucket
  @bucket
end

#namespaceString

[Required] The Object Storage namespace in which the in-progress multipart upload is stored.

Returns:

  • (String)


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

def namespace
  @namespace
end

#objectString

[Required] The object name of the in-progress multipart upload.

Returns:

  • (String)


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

def object
  @object
end

#time_createdDateTime

[Required] The date and time the upload was created, as described in RFC 2616.

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#upload_idString

[Required] The unique identifier for the in-progress multipart upload.

Returns:

  • (String)


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

def upload_id
  @upload_id
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'namespace': :'namespace',
    'bucket': :'bucket',
    'object': :'object',
    'upload_id': :'uploadId',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'namespace': :'String',
    'bucket': :'String',
    'object': :'String',
    'upload_id': :'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



108
109
110
111
112
113
114
115
116
117
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 108

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    namespace == other.namespace &&
    bucket == other.bucket &&
    object == other.object &&
    upload_id == other.upload_id &&
    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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 142

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


122
123
124
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 122

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



131
132
133
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 131

def hash
  [namespace, bucket, object, upload_id, time_created].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



175
176
177
178
179
180
181
182
183
184
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 175

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



169
170
171
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 169

def to_s
  to_hash.to_s
end