forked from aws/aws-sdk-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBatchWriteItemResult.java
More file actions
615 lines (581 loc) · 34.8 KB
/
BatchWriteItemResult.java
File metadata and controls
615 lines (581 loc) · 34.8 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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
/*
* Copyright 2010-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.dynamodbv2.model;
import java.io.Serializable;
/**
* <p>
* Represents the output of a <i>BatchWriteItem</i> operation.
* </p>
*/
public class BatchWriteItemResult implements Serializable {
/**
* A map of tables and requests against those tables that were not
* processed. The <i>UnprocessedKeys</i> value is in the same form as
* <i>RequestItems</i>, so you can provide this value directly to a
* subsequent <i>BatchGetItem</i> operation. For more information, see
* <i>RequestItems</i> in the Request Parameters section. <p>Each
* <i>UnprocessedItems</i> entry consists of a table name and, for that
* table, a list of operations to perform (<i>DeleteRequest</i> or
* <i>PutRequest</i>). <ul> <li> <p><i>DeleteRequest</i> - Perform a
* <i>DeleteItem</i> operation on the specified item. The item to be
* deleted is identified by a <i>Key</i> subelement: <ul> <li>
* <p><i>Key</i> - A map of primary key attribute values that uniquely
* identify the item. Each entry in this map consists of an attribute
* name and an attribute value. </li> </ul> </li> <li>
* <p><i>PutRequest</i> - Perform a <i>PutItem</i> operation on the
* specified item. The item to be put is identified by an <i>Item</i>
* subelement: <ul> <li> <p><i>Item</i> - A map of attributes and their
* values. Each entry in this map consists of an attribute name and an
* attribute value. Attribute values must not be null; string and binary
* type attributes must have lengths greater than zero; and set type
* attributes must not be empty. Requests that contain empty values will
* be rejected with a <i>ValidationException</i>. <p>If you specify any
* attributes that are part of an index key, then the data types for
* those attributes must match those of the schema in the table's
* attribute definition.</li> </ul> </li> </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 25<br/>
*/
private java.util.Map<String,java.util.List<WriteRequest>> unprocessedItems;
/**
* A list of tables that were processed by <i>BatchWriteItem</i> and, for
* each table, information about any item collections that were affected
* by individual <i>DeleteItem</i> or <i>PutItem</i> operations. <p>Each
* entry consists of the following subelements: <ul> <li>
* <p><i>ItemCollectionKey</i> - The hash key value of the item
* collection. This is the same as the hash key of the item. </li> <li>
* <p><i>SizeEstimateRange</i> - An estimate of item collection size,
* expressed in GB. This is a two-element array containing a lower bound
* and an upper bound for the estimate. The estimate includes the size of
* all the items in the table, plus the size of all attributes projected
* into all of the secondary indexes on the table. Use this estimate to
* measure whether a secondary index is approaching its size limit.
* <p>The estimate is subject to change over time; therefore, do not rely
* on the precision or accuracy of the estimate. </li> </ul>
*/
private java.util.Map<String,java.util.List<ItemCollectionMetrics>> itemCollectionMetrics;
/**
* The capacity units consumed by the operation. <p>Each element consists
* of: <ul> <li> <p><i>TableName</i> - The table that consumed the
* provisioned throughput. </li> <li> <p><i>CapacityUnits</i> - The total
* number of capacity units consumed. </li> </ul>
*/
private com.amazonaws.internal.ListWithAutoConstructFlag<ConsumedCapacity> consumedCapacity;
/**
* A map of tables and requests against those tables that were not
* processed. The <i>UnprocessedKeys</i> value is in the same form as
* <i>RequestItems</i>, so you can provide this value directly to a
* subsequent <i>BatchGetItem</i> operation. For more information, see
* <i>RequestItems</i> in the Request Parameters section. <p>Each
* <i>UnprocessedItems</i> entry consists of a table name and, for that
* table, a list of operations to perform (<i>DeleteRequest</i> or
* <i>PutRequest</i>). <ul> <li> <p><i>DeleteRequest</i> - Perform a
* <i>DeleteItem</i> operation on the specified item. The item to be
* deleted is identified by a <i>Key</i> subelement: <ul> <li>
* <p><i>Key</i> - A map of primary key attribute values that uniquely
* identify the item. Each entry in this map consists of an attribute
* name and an attribute value. </li> </ul> </li> <li>
* <p><i>PutRequest</i> - Perform a <i>PutItem</i> operation on the
* specified item. The item to be put is identified by an <i>Item</i>
* subelement: <ul> <li> <p><i>Item</i> - A map of attributes and their
* values. Each entry in this map consists of an attribute name and an
* attribute value. Attribute values must not be null; string and binary
* type attributes must have lengths greater than zero; and set type
* attributes must not be empty. Requests that contain empty values will
* be rejected with a <i>ValidationException</i>. <p>If you specify any
* attributes that are part of an index key, then the data types for
* those attributes must match those of the schema in the table's
* attribute definition.</li> </ul> </li> </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 25<br/>
*
* @return A map of tables and requests against those tables that were not
* processed. The <i>UnprocessedKeys</i> value is in the same form as
* <i>RequestItems</i>, so you can provide this value directly to a
* subsequent <i>BatchGetItem</i> operation. For more information, see
* <i>RequestItems</i> in the Request Parameters section. <p>Each
* <i>UnprocessedItems</i> entry consists of a table name and, for that
* table, a list of operations to perform (<i>DeleteRequest</i> or
* <i>PutRequest</i>). <ul> <li> <p><i>DeleteRequest</i> - Perform a
* <i>DeleteItem</i> operation on the specified item. The item to be
* deleted is identified by a <i>Key</i> subelement: <ul> <li>
* <p><i>Key</i> - A map of primary key attribute values that uniquely
* identify the item. Each entry in this map consists of an attribute
* name and an attribute value. </li> </ul> </li> <li>
* <p><i>PutRequest</i> - Perform a <i>PutItem</i> operation on the
* specified item. The item to be put is identified by an <i>Item</i>
* subelement: <ul> <li> <p><i>Item</i> - A map of attributes and their
* values. Each entry in this map consists of an attribute name and an
* attribute value. Attribute values must not be null; string and binary
* type attributes must have lengths greater than zero; and set type
* attributes must not be empty. Requests that contain empty values will
* be rejected with a <i>ValidationException</i>. <p>If you specify any
* attributes that are part of an index key, then the data types for
* those attributes must match those of the schema in the table's
* attribute definition.</li> </ul> </li> </ul>
*/
public java.util.Map<String,java.util.List<WriteRequest>> getUnprocessedItems() {
return unprocessedItems;
}
/**
* A map of tables and requests against those tables that were not
* processed. The <i>UnprocessedKeys</i> value is in the same form as
* <i>RequestItems</i>, so you can provide this value directly to a
* subsequent <i>BatchGetItem</i> operation. For more information, see
* <i>RequestItems</i> in the Request Parameters section. <p>Each
* <i>UnprocessedItems</i> entry consists of a table name and, for that
* table, a list of operations to perform (<i>DeleteRequest</i> or
* <i>PutRequest</i>). <ul> <li> <p><i>DeleteRequest</i> - Perform a
* <i>DeleteItem</i> operation on the specified item. The item to be
* deleted is identified by a <i>Key</i> subelement: <ul> <li>
* <p><i>Key</i> - A map of primary key attribute values that uniquely
* identify the item. Each entry in this map consists of an attribute
* name and an attribute value. </li> </ul> </li> <li>
* <p><i>PutRequest</i> - Perform a <i>PutItem</i> operation on the
* specified item. The item to be put is identified by an <i>Item</i>
* subelement: <ul> <li> <p><i>Item</i> - A map of attributes and their
* values. Each entry in this map consists of an attribute name and an
* attribute value. Attribute values must not be null; string and binary
* type attributes must have lengths greater than zero; and set type
* attributes must not be empty. Requests that contain empty values will
* be rejected with a <i>ValidationException</i>. <p>If you specify any
* attributes that are part of an index key, then the data types for
* those attributes must match those of the schema in the table's
* attribute definition.</li> </ul> </li> </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 25<br/>
*
* @param unprocessedItems A map of tables and requests against those tables that were not
* processed. The <i>UnprocessedKeys</i> value is in the same form as
* <i>RequestItems</i>, so you can provide this value directly to a
* subsequent <i>BatchGetItem</i> operation. For more information, see
* <i>RequestItems</i> in the Request Parameters section. <p>Each
* <i>UnprocessedItems</i> entry consists of a table name and, for that
* table, a list of operations to perform (<i>DeleteRequest</i> or
* <i>PutRequest</i>). <ul> <li> <p><i>DeleteRequest</i> - Perform a
* <i>DeleteItem</i> operation on the specified item. The item to be
* deleted is identified by a <i>Key</i> subelement: <ul> <li>
* <p><i>Key</i> - A map of primary key attribute values that uniquely
* identify the item. Each entry in this map consists of an attribute
* name and an attribute value. </li> </ul> </li> <li>
* <p><i>PutRequest</i> - Perform a <i>PutItem</i> operation on the
* specified item. The item to be put is identified by an <i>Item</i>
* subelement: <ul> <li> <p><i>Item</i> - A map of attributes and their
* values. Each entry in this map consists of an attribute name and an
* attribute value. Attribute values must not be null; string and binary
* type attributes must have lengths greater than zero; and set type
* attributes must not be empty. Requests that contain empty values will
* be rejected with a <i>ValidationException</i>. <p>If you specify any
* attributes that are part of an index key, then the data types for
* those attributes must match those of the schema in the table's
* attribute definition.</li> </ul> </li> </ul>
*/
public void setUnprocessedItems(java.util.Map<String,java.util.List<WriteRequest>> unprocessedItems) {
this.unprocessedItems = unprocessedItems;
}
/**
* A map of tables and requests against those tables that were not
* processed. The <i>UnprocessedKeys</i> value is in the same form as
* <i>RequestItems</i>, so you can provide this value directly to a
* subsequent <i>BatchGetItem</i> operation. For more information, see
* <i>RequestItems</i> in the Request Parameters section. <p>Each
* <i>UnprocessedItems</i> entry consists of a table name and, for that
* table, a list of operations to perform (<i>DeleteRequest</i> or
* <i>PutRequest</i>). <ul> <li> <p><i>DeleteRequest</i> - Perform a
* <i>DeleteItem</i> operation on the specified item. The item to be
* deleted is identified by a <i>Key</i> subelement: <ul> <li>
* <p><i>Key</i> - A map of primary key attribute values that uniquely
* identify the item. Each entry in this map consists of an attribute
* name and an attribute value. </li> </ul> </li> <li>
* <p><i>PutRequest</i> - Perform a <i>PutItem</i> operation on the
* specified item. The item to be put is identified by an <i>Item</i>
* subelement: <ul> <li> <p><i>Item</i> - A map of attributes and their
* values. Each entry in this map consists of an attribute name and an
* attribute value. Attribute values must not be null; string and binary
* type attributes must have lengths greater than zero; and set type
* attributes must not be empty. Requests that contain empty values will
* be rejected with a <i>ValidationException</i>. <p>If you specify any
* attributes that are part of an index key, then the data types for
* those attributes must match those of the schema in the table's
* attribute definition.</li> </ul> </li> </ul>
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 25<br/>
*
* @param unprocessedItems A map of tables and requests against those tables that were not
* processed. The <i>UnprocessedKeys</i> value is in the same form as
* <i>RequestItems</i>, so you can provide this value directly to a
* subsequent <i>BatchGetItem</i> operation. For more information, see
* <i>RequestItems</i> in the Request Parameters section. <p>Each
* <i>UnprocessedItems</i> entry consists of a table name and, for that
* table, a list of operations to perform (<i>DeleteRequest</i> or
* <i>PutRequest</i>). <ul> <li> <p><i>DeleteRequest</i> - Perform a
* <i>DeleteItem</i> operation on the specified item. The item to be
* deleted is identified by a <i>Key</i> subelement: <ul> <li>
* <p><i>Key</i> - A map of primary key attribute values that uniquely
* identify the item. Each entry in this map consists of an attribute
* name and an attribute value. </li> </ul> </li> <li>
* <p><i>PutRequest</i> - Perform a <i>PutItem</i> operation on the
* specified item. The item to be put is identified by an <i>Item</i>
* subelement: <ul> <li> <p><i>Item</i> - A map of attributes and their
* values. Each entry in this map consists of an attribute name and an
* attribute value. Attribute values must not be null; string and binary
* type attributes must have lengths greater than zero; and set type
* attributes must not be empty. Requests that contain empty values will
* be rejected with a <i>ValidationException</i>. <p>If you specify any
* attributes that are part of an index key, then the data types for
* those attributes must match those of the schema in the table's
* attribute definition.</li> </ul> </li> </ul>
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public BatchWriteItemResult withUnprocessedItems(java.util.Map<String,java.util.List<WriteRequest>> unprocessedItems) {
setUnprocessedItems(unprocessedItems);
return this;
}
/**
* A map of tables and requests against those tables that were not
* processed. The <i>UnprocessedKeys</i> value is in the same form as
* <i>RequestItems</i>, so you can provide this value directly to a
* subsequent <i>BatchGetItem</i> operation. For more information, see
* <i>RequestItems</i> in the Request Parameters section. <p>Each
* <i>UnprocessedItems</i> entry consists of a table name and, for that
* table, a list of operations to perform (<i>DeleteRequest</i> or
* <i>PutRequest</i>). <ul> <li> <p><i>DeleteRequest</i> - Perform a
* <i>DeleteItem</i> operation on the specified item. The item to be
* deleted is identified by a <i>Key</i> subelement: <ul> <li>
* <p><i>Key</i> - A map of primary key attribute values that uniquely
* identify the item. Each entry in this map consists of an attribute
* name and an attribute value. </li> </ul> </li> <li>
* <p><i>PutRequest</i> - Perform a <i>PutItem</i> operation on the
* specified item. The item to be put is identified by an <i>Item</i>
* subelement: <ul> <li> <p><i>Item</i> - A map of attributes and their
* values. Each entry in this map consists of an attribute name and an
* attribute value. Attribute values must not be null; string and binary
* type attributes must have lengths greater than zero; and set type
* attributes must not be empty. Requests that contain empty values will
* be rejected with a <i>ValidationException</i>. <p>If you specify any
* attributes that are part of an index key, then the data types for
* those attributes must match those of the schema in the table's
* attribute definition.</li> </ul> </li> </ul>
* <p>
* The method adds a new key-value pair into UnprocessedItems parameter,
* and returns a reference to this object so that method calls can be
* chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 25<br/>
*
* @param key The key of the entry to be added into UnprocessedItems.
* @param value The corresponding value of the entry to be added into UnprocessedItems.
*/
public BatchWriteItemResult addUnprocessedItemsEntry(String key, java.util.List<WriteRequest> value) {
if (null == this.unprocessedItems) {
this.unprocessedItems = new java.util.HashMap<String,java.util.List<WriteRequest>>();
}
if (this.unprocessedItems.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.unprocessedItems.put(key, value);
return this;
}
/**
* Removes all the entries added into UnprocessedItems.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*/
public BatchWriteItemResult clearUnprocessedItemsEntries() {
this.unprocessedItems = null;
return this;
}
/**
* A list of tables that were processed by <i>BatchWriteItem</i> and, for
* each table, information about any item collections that were affected
* by individual <i>DeleteItem</i> or <i>PutItem</i> operations. <p>Each
* entry consists of the following subelements: <ul> <li>
* <p><i>ItemCollectionKey</i> - The hash key value of the item
* collection. This is the same as the hash key of the item. </li> <li>
* <p><i>SizeEstimateRange</i> - An estimate of item collection size,
* expressed in GB. This is a two-element array containing a lower bound
* and an upper bound for the estimate. The estimate includes the size of
* all the items in the table, plus the size of all attributes projected
* into all of the secondary indexes on the table. Use this estimate to
* measure whether a secondary index is approaching its size limit.
* <p>The estimate is subject to change over time; therefore, do not rely
* on the precision or accuracy of the estimate. </li> </ul>
*
* @return A list of tables that were processed by <i>BatchWriteItem</i> and, for
* each table, information about any item collections that were affected
* by individual <i>DeleteItem</i> or <i>PutItem</i> operations. <p>Each
* entry consists of the following subelements: <ul> <li>
* <p><i>ItemCollectionKey</i> - The hash key value of the item
* collection. This is the same as the hash key of the item. </li> <li>
* <p><i>SizeEstimateRange</i> - An estimate of item collection size,
* expressed in GB. This is a two-element array containing a lower bound
* and an upper bound for the estimate. The estimate includes the size of
* all the items in the table, plus the size of all attributes projected
* into all of the secondary indexes on the table. Use this estimate to
* measure whether a secondary index is approaching its size limit.
* <p>The estimate is subject to change over time; therefore, do not rely
* on the precision or accuracy of the estimate. </li> </ul>
*/
public java.util.Map<String,java.util.List<ItemCollectionMetrics>> getItemCollectionMetrics() {
return itemCollectionMetrics;
}
/**
* A list of tables that were processed by <i>BatchWriteItem</i> and, for
* each table, information about any item collections that were affected
* by individual <i>DeleteItem</i> or <i>PutItem</i> operations. <p>Each
* entry consists of the following subelements: <ul> <li>
* <p><i>ItemCollectionKey</i> - The hash key value of the item
* collection. This is the same as the hash key of the item. </li> <li>
* <p><i>SizeEstimateRange</i> - An estimate of item collection size,
* expressed in GB. This is a two-element array containing a lower bound
* and an upper bound for the estimate. The estimate includes the size of
* all the items in the table, plus the size of all attributes projected
* into all of the secondary indexes on the table. Use this estimate to
* measure whether a secondary index is approaching its size limit.
* <p>The estimate is subject to change over time; therefore, do not rely
* on the precision or accuracy of the estimate. </li> </ul>
*
* @param itemCollectionMetrics A list of tables that were processed by <i>BatchWriteItem</i> and, for
* each table, information about any item collections that were affected
* by individual <i>DeleteItem</i> or <i>PutItem</i> operations. <p>Each
* entry consists of the following subelements: <ul> <li>
* <p><i>ItemCollectionKey</i> - The hash key value of the item
* collection. This is the same as the hash key of the item. </li> <li>
* <p><i>SizeEstimateRange</i> - An estimate of item collection size,
* expressed in GB. This is a two-element array containing a lower bound
* and an upper bound for the estimate. The estimate includes the size of
* all the items in the table, plus the size of all attributes projected
* into all of the secondary indexes on the table. Use this estimate to
* measure whether a secondary index is approaching its size limit.
* <p>The estimate is subject to change over time; therefore, do not rely
* on the precision or accuracy of the estimate. </li> </ul>
*/
public void setItemCollectionMetrics(java.util.Map<String,java.util.List<ItemCollectionMetrics>> itemCollectionMetrics) {
this.itemCollectionMetrics = itemCollectionMetrics;
}
/**
* A list of tables that were processed by <i>BatchWriteItem</i> and, for
* each table, information about any item collections that were affected
* by individual <i>DeleteItem</i> or <i>PutItem</i> operations. <p>Each
* entry consists of the following subelements: <ul> <li>
* <p><i>ItemCollectionKey</i> - The hash key value of the item
* collection. This is the same as the hash key of the item. </li> <li>
* <p><i>SizeEstimateRange</i> - An estimate of item collection size,
* expressed in GB. This is a two-element array containing a lower bound
* and an upper bound for the estimate. The estimate includes the size of
* all the items in the table, plus the size of all attributes projected
* into all of the secondary indexes on the table. Use this estimate to
* measure whether a secondary index is approaching its size limit.
* <p>The estimate is subject to change over time; therefore, do not rely
* on the precision or accuracy of the estimate. </li> </ul>
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param itemCollectionMetrics A list of tables that were processed by <i>BatchWriteItem</i> and, for
* each table, information about any item collections that were affected
* by individual <i>DeleteItem</i> or <i>PutItem</i> operations. <p>Each
* entry consists of the following subelements: <ul> <li>
* <p><i>ItemCollectionKey</i> - The hash key value of the item
* collection. This is the same as the hash key of the item. </li> <li>
* <p><i>SizeEstimateRange</i> - An estimate of item collection size,
* expressed in GB. This is a two-element array containing a lower bound
* and an upper bound for the estimate. The estimate includes the size of
* all the items in the table, plus the size of all attributes projected
* into all of the secondary indexes on the table. Use this estimate to
* measure whether a secondary index is approaching its size limit.
* <p>The estimate is subject to change over time; therefore, do not rely
* on the precision or accuracy of the estimate. </li> </ul>
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public BatchWriteItemResult withItemCollectionMetrics(java.util.Map<String,java.util.List<ItemCollectionMetrics>> itemCollectionMetrics) {
setItemCollectionMetrics(itemCollectionMetrics);
return this;
}
/**
* A list of tables that were processed by <i>BatchWriteItem</i> and, for
* each table, information about any item collections that were affected
* by individual <i>DeleteItem</i> or <i>PutItem</i> operations. <p>Each
* entry consists of the following subelements: <ul> <li>
* <p><i>ItemCollectionKey</i> - The hash key value of the item
* collection. This is the same as the hash key of the item. </li> <li>
* <p><i>SizeEstimateRange</i> - An estimate of item collection size,
* expressed in GB. This is a two-element array containing a lower bound
* and an upper bound for the estimate. The estimate includes the size of
* all the items in the table, plus the size of all attributes projected
* into all of the secondary indexes on the table. Use this estimate to
* measure whether a secondary index is approaching its size limit.
* <p>The estimate is subject to change over time; therefore, do not rely
* on the precision or accuracy of the estimate. </li> </ul>
* <p>
* The method adds a new key-value pair into ItemCollectionMetrics
* parameter, and returns a reference to this object so that method calls
* can be chained together.
*
* @param key The key of the entry to be added into ItemCollectionMetrics.
* @param value The corresponding value of the entry to be added into ItemCollectionMetrics.
*/
public BatchWriteItemResult addItemCollectionMetricsEntry(String key, java.util.List<ItemCollectionMetrics> value) {
if (null == this.itemCollectionMetrics) {
this.itemCollectionMetrics = new java.util.HashMap<String,java.util.List<ItemCollectionMetrics>>();
}
if (this.itemCollectionMetrics.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.itemCollectionMetrics.put(key, value);
return this;
}
/**
* Removes all the entries added into ItemCollectionMetrics.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*/
public BatchWriteItemResult clearItemCollectionMetricsEntries() {
this.itemCollectionMetrics = null;
return this;
}
/**
* The capacity units consumed by the operation. <p>Each element consists
* of: <ul> <li> <p><i>TableName</i> - The table that consumed the
* provisioned throughput. </li> <li> <p><i>CapacityUnits</i> - The total
* number of capacity units consumed. </li> </ul>
*
* @return The capacity units consumed by the operation. <p>Each element consists
* of: <ul> <li> <p><i>TableName</i> - The table that consumed the
* provisioned throughput. </li> <li> <p><i>CapacityUnits</i> - The total
* number of capacity units consumed. </li> </ul>
*/
public java.util.List<ConsumedCapacity> getConsumedCapacity() {
return consumedCapacity;
}
/**
* The capacity units consumed by the operation. <p>Each element consists
* of: <ul> <li> <p><i>TableName</i> - The table that consumed the
* provisioned throughput. </li> <li> <p><i>CapacityUnits</i> - The total
* number of capacity units consumed. </li> </ul>
*
* @param consumedCapacity The capacity units consumed by the operation. <p>Each element consists
* of: <ul> <li> <p><i>TableName</i> - The table that consumed the
* provisioned throughput. </li> <li> <p><i>CapacityUnits</i> - The total
* number of capacity units consumed. </li> </ul>
*/
public void setConsumedCapacity(java.util.Collection<ConsumedCapacity> consumedCapacity) {
if (consumedCapacity == null) {
this.consumedCapacity = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag<ConsumedCapacity> consumedCapacityCopy = new com.amazonaws.internal.ListWithAutoConstructFlag<ConsumedCapacity>(consumedCapacity.size());
consumedCapacityCopy.addAll(consumedCapacity);
this.consumedCapacity = consumedCapacityCopy;
}
/**
* The capacity units consumed by the operation. <p>Each element consists
* of: <ul> <li> <p><i>TableName</i> - The table that consumed the
* provisioned throughput. </li> <li> <p><i>CapacityUnits</i> - The total
* number of capacity units consumed. </li> </ul>
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param consumedCapacity The capacity units consumed by the operation. <p>Each element consists
* of: <ul> <li> <p><i>TableName</i> - The table that consumed the
* provisioned throughput. </li> <li> <p><i>CapacityUnits</i> - The total
* number of capacity units consumed. </li> </ul>
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public BatchWriteItemResult withConsumedCapacity(ConsumedCapacity... consumedCapacity) {
if (getConsumedCapacity() == null) setConsumedCapacity(new java.util.ArrayList<ConsumedCapacity>(consumedCapacity.length));
for (ConsumedCapacity value : consumedCapacity) {
getConsumedCapacity().add(value);
}
return this;
}
/**
* The capacity units consumed by the operation. <p>Each element consists
* of: <ul> <li> <p><i>TableName</i> - The table that consumed the
* provisioned throughput. </li> <li> <p><i>CapacityUnits</i> - The total
* number of capacity units consumed. </li> </ul>
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param consumedCapacity The capacity units consumed by the operation. <p>Each element consists
* of: <ul> <li> <p><i>TableName</i> - The table that consumed the
* provisioned throughput. </li> <li> <p><i>CapacityUnits</i> - The total
* number of capacity units consumed. </li> </ul>
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public BatchWriteItemResult withConsumedCapacity(java.util.Collection<ConsumedCapacity> consumedCapacity) {
if (consumedCapacity == null) {
this.consumedCapacity = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag<ConsumedCapacity> consumedCapacityCopy = new com.amazonaws.internal.ListWithAutoConstructFlag<ConsumedCapacity>(consumedCapacity.size());
consumedCapacityCopy.addAll(consumedCapacity);
this.consumedCapacity = consumedCapacityCopy;
}
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getUnprocessedItems() != null) sb.append("UnprocessedItems: " + getUnprocessedItems() + ",");
if (getItemCollectionMetrics() != null) sb.append("ItemCollectionMetrics: " + getItemCollectionMetrics() + ",");
if (getConsumedCapacity() != null) sb.append("ConsumedCapacity: " + getConsumedCapacity() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUnprocessedItems() == null) ? 0 : getUnprocessedItems().hashCode());
hashCode = prime * hashCode + ((getItemCollectionMetrics() == null) ? 0 : getItemCollectionMetrics().hashCode());
hashCode = prime * hashCode + ((getConsumedCapacity() == null) ? 0 : getConsumedCapacity().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof BatchWriteItemResult == false) return false;
BatchWriteItemResult other = (BatchWriteItemResult)obj;
if (other.getUnprocessedItems() == null ^ this.getUnprocessedItems() == null) return false;
if (other.getUnprocessedItems() != null && other.getUnprocessedItems().equals(this.getUnprocessedItems()) == false) return false;
if (other.getItemCollectionMetrics() == null ^ this.getItemCollectionMetrics() == null) return false;
if (other.getItemCollectionMetrics() != null && other.getItemCollectionMetrics().equals(this.getItemCollectionMetrics()) == false) return false;
if (other.getConsumedCapacity() == null ^ this.getConsumedCapacity() == null) return false;
if (other.getConsumedCapacity() != null && other.getConsumedCapacity().equals(this.getConsumedCapacity()) == false) return false;
return true;
}
}