-
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathListBucketsRequest.php
More file actions
171 lines (146 loc) · 4.83 KB
/
Copy pathListBucketsRequest.php
File metadata and controls
171 lines (146 loc) · 4.83 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
<?php
namespace AsyncAws\S3\Input;
use AsyncAws\Core\Input;
use AsyncAws\Core\Request;
use AsyncAws\Core\Stream\StreamFactory;
final class ListBucketsRequest extends Input
{
/**
* Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are
* owned by an Amazon Web Services account, return all the buckets in response.
*
* @var int|null
*/
private $maxBuckets;
/**
* `ContinuationToken` indicates to Amazon S3 that the list is being continued on this bucket with a token.
* `ContinuationToken` is obfuscated and is not a real key. You can use this `ContinuationToken` for pagination of the
* list results.
*
* Length Constraints: Minimum length of 0. Maximum length of 1024.
*
* Required: No.
*
* > If you specify the `bucket-region`, `prefix`, or `continuation-token` query parameters without using `max-buckets`
* > to set the maximum number of buckets returned in the response, Amazon S3 applies a default page size of 10,000 and
* > provides a continuation token if there are more buckets.
*
* @var string|null
*/
private $continuationToken;
/**
* Limits the response to bucket names that begin with the specified bucket name prefix.
*
* @var string|null
*/
private $prefix;
/**
* Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services
* Region must be expressed according to the Amazon Web Services Region code, such as `us-west-2` for the US West
* (Oregon) Region. For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints
* [^1].
*
* > Requests made to a Regional endpoint that is different from the `bucket-region` parameter are not supported. For
* > example, if you want to limit the response to your buckets in Region `us-west-2`, the request must be made to an
* > endpoint in Region `us-west-2`.
*
* [^1]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
*
* @var string|null
*/
private $bucketRegion;
/**
* @param array{
* MaxBuckets?: int|null,
* ContinuationToken?: string|null,
* Prefix?: string|null,
* BucketRegion?: string|null,
* '@region'?: string|null,
* } $input
*/
public function __construct(array $input = [])
{
$this->maxBuckets = $input['MaxBuckets'] ?? null;
$this->continuationToken = $input['ContinuationToken'] ?? null;
$this->prefix = $input['Prefix'] ?? null;
$this->bucketRegion = $input['BucketRegion'] ?? null;
parent::__construct($input);
}
/**
* @param array{
* MaxBuckets?: int|null,
* ContinuationToken?: string|null,
* Prefix?: string|null,
* BucketRegion?: string|null,
* '@region'?: string|null,
* }|ListBucketsRequest $input
*/
public static function create($input): self
{
return $input instanceof self ? $input : new self($input);
}
public function getBucketRegion(): ?string
{
return $this->bucketRegion;
}
public function getContinuationToken(): ?string
{
return $this->continuationToken;
}
public function getMaxBuckets(): ?int
{
return $this->maxBuckets;
}
public function getPrefix(): ?string
{
return $this->prefix;
}
/**
* @internal
*/
public function request(): Request
{
// Prepare headers
$headers = ['content-type' => 'application/xml'];
// Prepare query
$query = [];
if (null !== $this->maxBuckets) {
$query['max-buckets'] = (string) $this->maxBuckets;
}
if (null !== $this->continuationToken) {
$query['continuation-token'] = $this->continuationToken;
}
if (null !== $this->prefix) {
$query['prefix'] = $this->prefix;
}
if (null !== $this->bucketRegion) {
$query['bucket-region'] = $this->bucketRegion;
}
// Prepare URI
$uriString = '/';
// Prepare Body
$body = '';
// Return the Request
return new Request('GET', $uriString, $query, $headers, StreamFactory::create($body));
}
public function setBucketRegion(?string $value): self
{
$this->bucketRegion = $value;
return $this;
}
public function setContinuationToken(?string $value): self
{
$this->continuationToken = $value;
return $this;
}
public function setMaxBuckets(?int $value): self
{
$this->maxBuckets = $value;
return $this;
}
public function setPrefix(?string $value): self
{
$this->prefix = $value;
return $this;
}
}