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 [Managing Multipart Uploads](docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/managingmultipartuploads.htm).

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

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 45

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}

  if attributes[:'namespace']
    self.namespace = attributes[:'namespace']
  end

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

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

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

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

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

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

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

  if attributes[:'time_created']
    self.time_created = attributes[:'time_created']
  end

end

Instance Attribute Details

#bucket ⇒ String

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

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 23

def bucket
  @bucket
end

#namespace ⇒ String

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

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 19

def namespace
  @namespace
end

#object ⇒ String

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

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 27

def object
  @object
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


35
36
37
 
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 35

def time_created
  @time_created
end

#upload_id ⇒ String

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

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 31

def upload_id
  @upload_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 87

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      namespace == other_object.namespace &&
      bucket == other_object.bucket &&
      object == other_object.object &&
      upload_id == other_object.upload_id &&
      time_created == other_object.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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 112

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


99
100
101
 
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 99

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



105
106
107
 
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 105

def hash
  [namespace, bucket, object, upload_id, 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



137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/object_storage/models/multipart_upload.rb', line 137

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



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

def to_s
  to_hash.to_s
end