Skip to content

Commit 810c236

Browse files
authored
Generate the property type for generated objects (#1467)
1 parent ec99987 commit 810c236

File tree

67 files changed

+472
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+472
-0
lines changed

src/Exception/TransactionCanceledException.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,8 @@ final class TransactionCanceledException extends ClientException
113113
{
114114
/**
115115
* A list of cancellation reasons.
116+
*
117+
* @var CancellationReason[]
116118
*/
117119
private $cancellationReasons;
118120

src/Result/BatchGetItemOutput.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ class BatchGetItemOutput extends Result implements \IteratorAggregate
2222
/**
2323
* A map of table name to a list of items. Each object in `Responses` consists of a table name, along with a map of
2424
* attribute data consisting of the data type and attribute value.
25+
*
26+
* @var array<string, array<string, AttributeValue>[]>
2527
*/
2628
private $responses;
2729

@@ -39,6 +41,8 @@ class BatchGetItemOutput extends Result implements \IteratorAggregate
3941
* otherwise, an eventually consistent read is used.
4042
*
4143
* If there are no unprocessed keys remaining, the response contains an empty `UnprocessedKeys` map.
44+
*
45+
* @var array<string, KeysAndAttributes>
4246
*/
4347
private $unprocessedKeys;
4448

@@ -49,6 +53,8 @@ class BatchGetItemOutput extends Result implements \IteratorAggregate
4953
*
5054
* - `TableName` - The table that consumed the provisioned throughput.
5155
* - `CapacityUnits` - The total number of capacity units consumed.
56+
*
57+
* @var ConsumedCapacity[]
5258
*/
5359
private $consumedCapacity;
5460

src/Result/BatchWriteItemOutput.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ class BatchWriteItemOutput extends Result
4444
*
4545
*
4646
* If there are no unprocessed items remaining, the response contains an empty `UnprocessedItems` map.
47+
*
48+
* @var array<string, WriteRequest[]>
4749
*/
4850
private $unprocessedItems;
4951

@@ -61,6 +63,8 @@ class BatchWriteItemOutput extends Result
6163
* estimate to measure whether a local secondary index is approaching its size limit.
6264
*
6365
* The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
66+
*
67+
* @var array<string, ItemCollectionMetrics[]>
6468
*/
6569
private $itemCollectionMetrics;
6670

@@ -71,6 +75,8 @@ class BatchWriteItemOutput extends Result
7175
*
7276
* - `TableName` - The table that consumed the provisioned throughput.
7377
* - `CapacityUnits` - The total number of capacity units consumed.
78+
*
79+
* @var ConsumedCapacity[]
7480
*/
7581
private $consumedCapacity;
7682

src/Result/CreateTableOutput.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ class CreateTableOutput extends Result
2828
{
2929
/**
3030
* Represents the properties of the table.
31+
*
32+
* @var TableDescription|null
3133
*/
3234
private $tableDescription;
3335

src/Result/DeleteItemOutput.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ class DeleteItemOutput extends Result
1717
/**
1818
* A map of attribute names to `AttributeValue` objects, representing the item as it appeared before the `DeleteItem`
1919
* operation. This map appears in the response only if `ReturnValues` was specified as `ALL_OLD` in the request.
20+
*
21+
* @var array<string, AttributeValue>
2022
*/
2123
private $attributes;
2224

@@ -27,6 +29,8 @@ class DeleteItemOutput extends Result
2729
* see Provisioned Throughput [^1] in the *Amazon DynamoDB Developer Guide*.
2830
*
2931
* [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html
32+
*
33+
* @var ConsumedCapacity|null
3034
*/
3135
private $consumedCapacity;
3236

@@ -45,6 +49,8 @@ class DeleteItemOutput extends Result
4549
* this estimate to measure whether a local secondary index is approaching its size limit.
4650
*
4751
* The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
52+
*
53+
* @var ItemCollectionMetrics|null
4854
*/
4955
private $itemCollectionMetrics;
5056

src/Result/DeleteTableOutput.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ class DeleteTableOutput extends Result
2828
{
2929
/**
3030
* Represents the properties of a table.
31+
*
32+
* @var TableDescription|null
3133
*/
3234
private $tableDescription;
3335

src/Result/DescribeEndpointsResponse.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ class DescribeEndpointsResponse extends Result
1010
{
1111
/**
1212
* List of endpoints.
13+
*
14+
* @var Endpoint[]
1315
*/
1416
private $endpoints;
1517

src/Result/DescribeTableOutput.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ class DescribeTableOutput extends Result
2828
{
2929
/**
3030
* The properties of the table.
31+
*
32+
* @var TableDescription|null
3133
*/
3234
private $table;
3335

src/Result/ExecuteStatementOutput.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,22 @@ class ExecuteStatementOutput extends Result
1313
/**
1414
* If a read operation was used, this property will contain the result of the read operation; a map of attribute names
1515
* and their values. For the write operations this value will be empty.
16+
*
17+
* @var array<string, AttributeValue>[]
1618
*/
1719
private $items;
1820

1921
/**
2022
* If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If
2123
* set, you can use that this value in the subsequent request to get the remaining results.
24+
*
25+
* @var string|null
2226
*/
2327
private $nextToken;
2428

29+
/**
30+
* @var ConsumedCapacity|null
31+
*/
2532
private $consumedCapacity;
2633

2734
/**
@@ -30,6 +37,8 @@ class ExecuteStatementOutput extends Result
3037
* of results has been processed and there is no more data to be retrieved. If `LastEvaluatedKey` is not empty, it does
3138
* not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of
3239
* the result set is when `LastEvaluatedKey` is empty.
40+
*
41+
* @var array<string, AttributeValue>
3342
*/
3443
private $lastEvaluatedKey;
3544

src/Result/GetItemOutput.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ class GetItemOutput extends Result
1515
{
1616
/**
1717
* A map of attribute names to `AttributeValue` objects, as specified by `ProjectionExpression`.
18+
*
19+
* @var array<string, AttributeValue>
1820
*/
1921
private $item;
2022

@@ -25,6 +27,8 @@ class GetItemOutput extends Result
2527
* [^1] in the *Amazon DynamoDB Developer Guide*.
2628
*
2729
* [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads
30+
*
31+
* @var ConsumedCapacity|null
2832
*/
2933
private $consumedCapacity;
3034

0 commit comments

Comments
 (0)