You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::S3::MultipartUploadPart

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_name, object_key, multipart_upload_id, part_number, options = {}) ⇒ MultipartUploadPart #initialize(options = {}) ⇒ MultipartUploadPart

Returns a new instance of MultipartUploadPart

Overloads:

  • #initialize(bucket_name, object_key, multipart_upload_id, part_number, options = {}) ⇒ MultipartUploadPart

    Parameters:

    • bucket_name (String)
    • object_key (String)
    • multipart_upload_id (String)
    • part_number (Integer)

    Options Hash (options):

  • #initialize(options = {}) ⇒ MultipartUploadPart

    Options Hash (options):

    • :bucket_name (required, String)
    • :object_key (required, String)
    • :multipart_upload_id (required, String)
    • :part_number (required, Integer)
    • :client (Client)


25
26
27
28
29
30
31
32
33
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 25

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @bucket_name = extract_bucket_name(args, options)
  @object_key = extract_object_key(args, options)
  @multipart_upload_id = extract_multipart_upload_id(args, options)
  @part_number = extract_part_number(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#bucket_nameString

Returns:

  • (String)


38
39
40
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 38

def bucket_name
  @bucket_name
end

#clientClient

Returns:



78
79
80
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 78

def client
  @client
end

#copy_from(options = {}) ⇒ Types::UploadPartCopyOutput

Examples:

Request syntax with placeholder values


multipart_upload_part.copy_from({
  copy_source: "CopySource", # required
  copy_source_if_match: "CopySourceIfMatch",
  copy_source_if_modified_since: Time.now,
  copy_source_if_none_match: "CopySourceIfNoneMatch",
  copy_source_if_unmodified_since: Time.now,
  copy_source_range: "CopySourceRange",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  copy_source_sse_customer_algorithm: "CopySourceSSECustomerAlgorithm",
  copy_source_sse_customer_key: "CopySourceSSECustomerKey",
  copy_source_sse_customer_key_md5: "CopySourceSSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
})

Parameters:

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

    ({})

Options Hash (options):

  • :copy_source (required, String)

    The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

  • :copy_source_if_match (String)

    Copies the object if its entity tag (ETag) matches the specified tag.

  • :copy_source_if_modified_since (Time, DateTime, Date, Integer, String)

    Copies the object if it has been modified since the specified time.

  • :copy_source_if_none_match (String)

    Copies the object if its entity tag (ETag) is different than the specified ETag.

  • :copy_source_if_unmodified_since (Time, DateTime, Date, Integer, String)

    Copies the object if it hasn't been modified since the specified time.

  • :copy_source_range (String)

    The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 GB.

  • :sse_customer_algorithm (String)

    Specifies the algorithm to use to when encrypting the object (e.g., AES256).

  • :sse_customer_key (String)

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

  • :sse_customer_key_md5 (String)

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

  • :copy_source_sse_customer_algorithm (String)

    Specifies the algorithm to use when decrypting the source object (e.g., AES256).

  • :copy_source_sse_customer_key (String)

    Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

  • :copy_source_sse_customer_key_md5 (String)

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

  • :request_payer (String)

    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:



177
178
179
180
181
182
183
184
185
186
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 177

def copy_from(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @object_key,
    upload_id: @multipart_upload_id,
    part_number: @part_number
  )
  resp = @client.upload_part_copy(options)
  resp.data
end

#dataTypes::Part

Returns the data for this Aws::S3::MultipartUploadPart.

Returns:

Raises:



93
94
95
96
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 93

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



101
102
103
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 101

def data_loaded?
  !!@data
end

#etagString

Entity tag returned when the part was uploaded.

Returns:

  • (String)


65
66
67
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 65

def etag
  data.etag
end

#last_modifiedTime

Date and time at which the part was uploaded.

Returns:

  • (Time)


59
60
61
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 59

def last_modified
  data.last_modified
end

#multipart_uploadMultipartUpload

Returns:



243
244
245
246
247
248
249
250
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 243

def multipart_upload
  MultipartUpload.new(
    bucket_name: @bucket_name,
    object_key: @object_key,
    id: @multipart_upload_id,
    client: @client
  )
end

#multipart_upload_idString

Returns:

  • (String)


48
49
50
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 48

def multipart_upload_id
  @multipart_upload_id
end

#object_keyString

Returns:

  • (String)


43
44
45
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 43

def object_key
  @object_key
end

#part_numberInteger

Returns:

  • (Integer)


53
54
55
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 53

def part_number
  @part_number
end

#sizeInteger

Size of the uploaded part data.

Returns:

  • (Integer)


71
72
73
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 71

def size
  data.size
end

#upload(options = {}) ⇒ Types::UploadPartOutput

Examples:

Request syntax with placeholder values


multipart_upload_part.upload({
  body: source_file,
  content_length: 1,
  content_md5: "ContentMD5",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
})

Parameters:

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

    ({})

Options Hash (options):

  • :body (String, IO)

    Object data.

  • :content_length (Integer)

    Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

  • :content_md5 (String)

    The base64-encoded 128-bit MD5 digest of the part data.

  • :sse_customer_algorithm (String)

    Specifies the algorithm to use to when encrypting the object (e.g., AES256).

  • :sse_customer_key (String)

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

  • :sse_customer_key_md5 (String)

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

  • :request_payer (String)

    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:



229
230
231
232
233
234
235
236
237
238
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb', line 229

def upload(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @object_key,
    upload_id: @multipart_upload_id,
    part_number: @part_number
  )
  resp = @client.upload_part(options)
  resp.data
end