317 lines
8.6 KiB
PHP
317 lines
8.6 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;
|
|
|
|
final class ListPartsRequest extends Input
|
|
{
|
|
/**
|
|
* The name of the bucket to which the parts are being uploaded.
|
|
*
|
|
* @required
|
|
*
|
|
* @var string|null
|
|
*/
|
|
private $bucket;
|
|
|
|
/**
|
|
* Object key for which the multipart upload was initiated.
|
|
*
|
|
* @required
|
|
*
|
|
* @var string|null
|
|
*/
|
|
private $key;
|
|
|
|
/**
|
|
* Sets the maximum number of parts to return.
|
|
*
|
|
* @var int|null
|
|
*/
|
|
private $maxParts;
|
|
|
|
/**
|
|
* Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
|
|
*
|
|
* @var int|null
|
|
*/
|
|
private $partNumberMarker;
|
|
|
|
/**
|
|
* Upload ID identifying the multipart upload whose parts are being listed.
|
|
*
|
|
* @required
|
|
*
|
|
* @var string|null
|
|
*/
|
|
private $uploadId;
|
|
|
|
/**
|
|
* @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,
|
|
* MaxParts?: int,
|
|
* PartNumberMarker?: int,
|
|
* UploadId?: 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->maxParts = $input['MaxParts'] ?? null;
|
|
$this->partNumberMarker = $input['PartNumberMarker'] ?? null;
|
|
$this->uploadId = $input['UploadId'] ?? 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 getExpectedBucketOwner(): ?string
|
|
{
|
|
return $this->expectedBucketOwner;
|
|
}
|
|
|
|
public function getKey(): ?string
|
|
{
|
|
return $this->key;
|
|
}
|
|
|
|
public function getMaxParts(): ?int
|
|
{
|
|
return $this->maxParts;
|
|
}
|
|
|
|
public function getPartNumberMarker(): ?int
|
|
{
|
|
return $this->partNumberMarker;
|
|
}
|
|
|
|
/**
|
|
* @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->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 !== $this->maxParts) {
|
|
$query['max-parts'] = (string) $this->maxParts;
|
|
}
|
|
if (null !== $this->partNumberMarker) {
|
|
$query['part-number-marker'] = (string) $this->partNumberMarker;
|
|
}
|
|
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
|
|
$body = '';
|
|
|
|
// Return the Request
|
|
return new Request('GET', $uriString, $query, $headers, StreamFactory::create($body));
|
|
}
|
|
|
|
public function setBucket(?string $value): self
|
|
{
|
|
$this->bucket = $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 setMaxParts(?int $value): self
|
|
{
|
|
$this->maxParts = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setPartNumberMarker(?int $value): self
|
|
{
|
|
$this->partNumberMarker = $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;
|
|
}
|
|
}
|