Class BulkOperationUsage

java.lang.Object
software.amazon.awssdk.services.dynamodb.model.BulkOperationUsage
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BulkOperationUsage.Builder,BulkOperationUsage>
@Generated("software.amazon.awssdk:codegen") public final class BulkOperationUsage extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BulkOperationUsage.Builder,BulkOperationUsage>

Contains the bytes used during a bulk operation, including a breakdown for the table and its indexes.

See Also:

  • Method Details

    • tableName

      public final String tableName()

      The name or ARN of the table associated with the reported usage.

      Returns:
      The name or ARN of the table associated with the reported usage.

    • bulkPutBytes

      public final Long bulkPutBytes()

      The total number of bulk put bytes used by the operation. This value excludes bulk put vector bytes.

      Returns:
      The total number of bulk put bytes used by the operation. This value excludes bulk put vector bytes.

    • table

      public final BulkOperationBytes table()

      The number of bulk put bytes for the table, excluding its indexes.

      Returns:
      The number of bulk put bytes for the table, excluding its indexes.

    • hasLocalSecondaryIndexes

      public final boolean hasLocalSecondaryIndexes()
      For responses, this returns true if the service returned a value for the LocalSecondaryIndexes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • localSecondaryIndexes

      public final Map<String,BulkOperationBytes> localSecondaryIndexes()

      The bulk put bytes used on each local secondary index affected by the operation, keyed by index name.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLocalSecondaryIndexes() method.

      Returns:
      The bulk put bytes used on each local secondary index affected by the operation, keyed by index name.

    • hasGlobalSecondaryIndexes

      public final boolean hasGlobalSecondaryIndexes()
      For responses, this returns true if the service returned a value for the GlobalSecondaryIndexes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • globalSecondaryIndexes

      public final Map<String,BulkOperationBytes> globalSecondaryIndexes()

      The bulk put bytes used on each global secondary index affected by the operation, keyed by index name.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGlobalSecondaryIndexes() method.

      Returns:
      The bulk put bytes used on each global secondary index affected by the operation, keyed by index name.

    • hasVectorIndexes

      public final boolean hasVectorIndexes()
      For responses, this returns true if the service returned a value for the VectorIndexes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • vectorIndexes

      public final Map<String,BulkOperationVectorBytes> vectorIndexes()

      The bulk put vector bytes used on each vector index affected by the operation, keyed by index name.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVectorIndexes() method.

      Returns:
      The bulk put vector bytes used on each vector index affected by the operation, keyed by index name.

    • toBuilder

      public BulkOperationUsage.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<BulkOperationUsage.Builder,BulkOperationUsage>
      Returns:
      a builder for type T

    • builder

      public static BulkOperationUsage.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BulkOperationUsage.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.