416 lines
12 KiB
PHP
416 lines
12 KiB
PHP
<?php
|
|
|
|
namespace AsyncAws\S3\Input;
|
|
|
|
use AsyncAws\Core\Exception\InvalidArgument;
|
|
use AsyncAws\Core\Input;
|
|
use AsyncAws\Core\Request;
|
|
use AsyncAws\Core\Stream\StreamFactory;
|
|
use AsyncAws\S3\Enum\RequestPayer;
|
|
use AsyncAws\S3\ValueObject\CompletedMultipartUpload;
|
|
|
|
final class CompleteMultipartUploadRequest extends Input
|
|
{
|
|
/**
|
|
* Name of the bucket to which the multipart upload was initiated.
|
|
*
|
|
* @required
|
|
*
|
|
* @var string|null
|
|
*/
|
|
private $bucket;
|
|
|
|
/**
|
|
* Object key for which the multipart upload was initiated.
|
|
*
|
|
* @required
|
|
*
|
|
* @var string|null
|
|
*/
|
|
private $key;
|
|
|
|
/**
|
|
* The container for the multipart upload request information.
|
|
*
|
|
* @var CompletedMultipartUpload|null
|
|
*/
|
|
private $multipartUpload;
|
|
|
|
/**
|
|
* ID for the initiated multipart upload.
|
|
*
|
|
* @required
|
|
*
|
|
* @var string|null
|
|
*/
|
|
private $uploadId;
|
|
|
|
/**
|
|
* This header can be used as a data integrity check to verify that the data received is the same data that was
|
|
* originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information,
|
|
* see Checking object integrity in the *Amazon S3 User Guide*.
|
|
*
|
|
* @see https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
|
|
*
|
|
* @var string|null
|
|
*/
|
|
private $checksumCrc32;
|
|
|
|
/**
|
|
* This header can be used as a data integrity check to verify that the data received is the same data that was
|
|
* originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more
|
|
* information, see Checking object integrity in the *Amazon S3 User Guide*.
|
|
*
|
|
* @see https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
|
|
*
|
|
* @var string|null
|
|
*/
|
|
private $checksumCrc32C;
|
|
|
|
/**
|
|
* This header can be used as a data integrity check to verify that the data received is the same data that was
|
|
* originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information,
|
|
* see Checking object integrity in the *Amazon S3 User Guide*.
|
|
*
|
|
* @see https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
|
|
*
|
|
* @var string|null
|
|
*/
|
|
private $checksumSha1;
|
|
|
|
/**
|
|
* This header can be used as a data integrity check to verify that the data received is the same data that was
|
|
* originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more
|
|
* information, see Checking object integrity in the *Amazon S3 User Guide*.
|
|
*
|
|
* @see https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
|
|
*
|
|
* @var string|null
|
|
*/
|
|
private $checksumSha256;
|
|
|
|
/**
|
|
* @var RequestPayer::*|null
|
|
*/
|
|
private $requestPayer;
|
|
|
|
/**
|
|
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with
|
|
* the HTTP status code `403 Forbidden` (access denied).
|
|
*
|
|
* @var string|null
|
|
*/
|
|
private $expectedBucketOwner;
|
|
|
|
/**
|
|
* The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object
|
|
* was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the *Amazon S3
|
|
* User Guide*.
|
|
*
|
|
* @see https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
|
|
*
|
|
* @var string|null
|
|
*/
|
|
private $sseCustomerAlgorithm;
|
|
|
|
/**
|
|
* The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created
|
|
* using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the *Amazon S3 User Guide*.
|
|
*
|
|
* @see https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
|
|
*
|
|
* @var string|null
|
|
*/
|
|
private $sseCustomerKey;
|
|
|
|
/**
|
|
* The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created
|
|
* using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the *Amazon S3 User Guide*.
|
|
*
|
|
* @see https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
|
|
*
|
|
* @var string|null
|
|
*/
|
|
private $sseCustomerKeyMd5;
|
|
|
|
/**
|
|
* @param array{
|
|
* Bucket?: string,
|
|
* Key?: string,
|
|
* MultipartUpload?: CompletedMultipartUpload|array,
|
|
* UploadId?: string,
|
|
* ChecksumCRC32?: string,
|
|
* ChecksumCRC32C?: string,
|
|
* ChecksumSHA1?: string,
|
|
* ChecksumSHA256?: string,
|
|
* RequestPayer?: RequestPayer::*,
|
|
* ExpectedBucketOwner?: string,
|
|
* SSECustomerAlgorithm?: string,
|
|
* SSECustomerKey?: string,
|
|
* SSECustomerKeyMD5?: string,
|
|
* @region?: string,
|
|
* } $input
|
|
*/
|
|
public function __construct(array $input = [])
|
|
{
|
|
$this->bucket = $input['Bucket'] ?? null;
|
|
$this->key = $input['Key'] ?? null;
|
|
$this->multipartUpload = isset($input['MultipartUpload']) ? CompletedMultipartUpload::create($input['MultipartUpload']) : null;
|
|
$this->uploadId = $input['UploadId'] ?? null;
|
|
$this->checksumCrc32 = $input['ChecksumCRC32'] ?? null;
|
|
$this->checksumCrc32C = $input['ChecksumCRC32C'] ?? null;
|
|
$this->checksumSha1 = $input['ChecksumSHA1'] ?? null;
|
|
$this->checksumSha256 = $input['ChecksumSHA256'] ?? null;
|
|
$this->requestPayer = $input['RequestPayer'] ?? null;
|
|
$this->expectedBucketOwner = $input['ExpectedBucketOwner'] ?? null;
|
|
$this->sseCustomerAlgorithm = $input['SSECustomerAlgorithm'] ?? null;
|
|
$this->sseCustomerKey = $input['SSECustomerKey'] ?? null;
|
|
$this->sseCustomerKeyMd5 = $input['SSECustomerKeyMD5'] ?? null;
|
|
parent::__construct($input);
|
|
}
|
|
|
|
public static function create($input): self
|
|
{
|
|
return $input instanceof self ? $input : new self($input);
|
|
}
|
|
|
|
public function getBucket(): ?string
|
|
{
|
|
return $this->bucket;
|
|
}
|
|
|
|
public function getChecksumCrc32(): ?string
|
|
{
|
|
return $this->checksumCrc32;
|
|
}
|
|
|
|
public function getChecksumCrc32C(): ?string
|
|
{
|
|
return $this->checksumCrc32C;
|
|
}
|
|
|
|
public function getChecksumSha1(): ?string
|
|
{
|
|
return $this->checksumSha1;
|
|
}
|
|
|
|
public function getChecksumSha256(): ?string
|
|
{
|
|
return $this->checksumSha256;
|
|
}
|
|
|
|
public function getExpectedBucketOwner(): ?string
|
|
{
|
|
return $this->expectedBucketOwner;
|
|
}
|
|
|
|
public function getKey(): ?string
|
|
{
|
|
return $this->key;
|
|
}
|
|
|
|
public function getMultipartUpload(): ?CompletedMultipartUpload
|
|
{
|
|
return $this->multipartUpload;
|
|
}
|
|
|
|
/**
|
|
* @return RequestPayer::*|null
|
|
*/
|
|
public function getRequestPayer(): ?string
|
|
{
|
|
return $this->requestPayer;
|
|
}
|
|
|
|
public function getSseCustomerAlgorithm(): ?string
|
|
{
|
|
return $this->sseCustomerAlgorithm;
|
|
}
|
|
|
|
public function getSseCustomerKey(): ?string
|
|
{
|
|
return $this->sseCustomerKey;
|
|
}
|
|
|
|
public function getSseCustomerKeyMd5(): ?string
|
|
{
|
|
return $this->sseCustomerKeyMd5;
|
|
}
|
|
|
|
public function getUploadId(): ?string
|
|
{
|
|
return $this->uploadId;
|
|
}
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
public function request(): Request
|
|
{
|
|
// Prepare headers
|
|
$headers = ['content-type' => 'application/xml'];
|
|
if (null !== $this->checksumCrc32) {
|
|
$headers['x-amz-checksum-crc32'] = $this->checksumCrc32;
|
|
}
|
|
if (null !== $this->checksumCrc32C) {
|
|
$headers['x-amz-checksum-crc32c'] = $this->checksumCrc32C;
|
|
}
|
|
if (null !== $this->checksumSha1) {
|
|
$headers['x-amz-checksum-sha1'] = $this->checksumSha1;
|
|
}
|
|
if (null !== $this->checksumSha256) {
|
|
$headers['x-amz-checksum-sha256'] = $this->checksumSha256;
|
|
}
|
|
if (null !== $this->requestPayer) {
|
|
if (!RequestPayer::exists($this->requestPayer)) {
|
|
throw new InvalidArgument(sprintf('Invalid parameter "RequestPayer" for "%s". The value "%s" is not a valid "RequestPayer".', __CLASS__, $this->requestPayer));
|
|
}
|
|
$headers['x-amz-request-payer'] = $this->requestPayer;
|
|
}
|
|
if (null !== $this->expectedBucketOwner) {
|
|
$headers['x-amz-expected-bucket-owner'] = $this->expectedBucketOwner;
|
|
}
|
|
if (null !== $this->sseCustomerAlgorithm) {
|
|
$headers['x-amz-server-side-encryption-customer-algorithm'] = $this->sseCustomerAlgorithm;
|
|
}
|
|
if (null !== $this->sseCustomerKey) {
|
|
$headers['x-amz-server-side-encryption-customer-key'] = $this->sseCustomerKey;
|
|
}
|
|
if (null !== $this->sseCustomerKeyMd5) {
|
|
$headers['x-amz-server-side-encryption-customer-key-MD5'] = $this->sseCustomerKeyMd5;
|
|
}
|
|
|
|
// Prepare query
|
|
$query = [];
|
|
if (null === $v = $this->uploadId) {
|
|
throw new InvalidArgument(sprintf('Missing parameter "UploadId" for "%s". The value cannot be null.', __CLASS__));
|
|
}
|
|
$query['uploadId'] = $v;
|
|
|
|
// Prepare URI
|
|
$uri = [];
|
|
if (null === $v = $this->bucket) {
|
|
throw new InvalidArgument(sprintf('Missing parameter "Bucket" for "%s". The value cannot be null.', __CLASS__));
|
|
}
|
|
$uri['Bucket'] = $v;
|
|
if (null === $v = $this->key) {
|
|
throw new InvalidArgument(sprintf('Missing parameter "Key" for "%s". The value cannot be null.', __CLASS__));
|
|
}
|
|
$uri['Key'] = $v;
|
|
$uriString = '/' . rawurlencode($uri['Bucket']) . '/' . str_replace('%2F', '/', rawurlencode($uri['Key']));
|
|
|
|
// Prepare Body
|
|
|
|
$document = new \DOMDocument('1.0', 'UTF-8');
|
|
$document->formatOutput = false;
|
|
$this->requestBody($document, $document);
|
|
$body = $document->hasChildNodes() ? $document->saveXML() : '';
|
|
|
|
// Return the Request
|
|
return new Request('POST', $uriString, $query, $headers, StreamFactory::create($body));
|
|
}
|
|
|
|
public function setBucket(?string $value): self
|
|
{
|
|
$this->bucket = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setChecksumCrc32(?string $value): self
|
|
{
|
|
$this->checksumCrc32 = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setChecksumCrc32C(?string $value): self
|
|
{
|
|
$this->checksumCrc32C = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setChecksumSha1(?string $value): self
|
|
{
|
|
$this->checksumSha1 = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setChecksumSha256(?string $value): self
|
|
{
|
|
$this->checksumSha256 = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setExpectedBucketOwner(?string $value): self
|
|
{
|
|
$this->expectedBucketOwner = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setKey(?string $value): self
|
|
{
|
|
$this->key = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setMultipartUpload(?CompletedMultipartUpload $value): self
|
|
{
|
|
$this->multipartUpload = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param RequestPayer::*|null $value
|
|
*/
|
|
public function setRequestPayer(?string $value): self
|
|
{
|
|
$this->requestPayer = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setSseCustomerAlgorithm(?string $value): self
|
|
{
|
|
$this->sseCustomerAlgorithm = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setSseCustomerKey(?string $value): self
|
|
{
|
|
$this->sseCustomerKey = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setSseCustomerKeyMd5(?string $value): self
|
|
{
|
|
$this->sseCustomerKeyMd5 = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setUploadId(?string $value): self
|
|
{
|
|
$this->uploadId = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
private function requestBody(\DOMNode $node, \DOMDocument $document): void
|
|
{
|
|
if (null !== $v = $this->multipartUpload) {
|
|
$node->appendChild($child = $document->createElement('CompleteMultipartUpload'));
|
|
$child->setAttribute('xmlns', 'http://s3.amazonaws.com/doc/2006-03-01/');
|
|
$v->requestBody($child, $document);
|
|
}
|
|
}
|
|
}
|