Class InventoryTableConfigurationResult

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

The inventory table configuration for an S3 Metadata configuration.

See Also:

  • Method Details

    • configurationState

      public final InventoryConfigurationState configurationState()

      The configuration state of the inventory table, indicating whether the inventory table is enabled or disabled.

      If the service returns an enum value that is not available in the current SDK version, configurationState will return InventoryConfigurationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configurationStateAsString().

      Returns:
      The configuration state of the inventory table, indicating whether the inventory table is enabled or disabled.
      See Also:

    • configurationStateAsString

      public final String configurationStateAsString()

      The configuration state of the inventory table, indicating whether the inventory table is enabled or disabled.

      If the service returns an enum value that is not available in the current SDK version, configurationState will return InventoryConfigurationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configurationStateAsString().

      Returns:
      The configuration state of the inventory table, indicating whether the inventory table is enabled or disabled.
      See Also:

    • tableStatus

      public final String tableStatus()

      The status of the inventory table. The status values are:

      • CREATING - The inventory table is in the process of being created in the specified Amazon Web Services managed table bucket.

      • BACKFILLING - The inventory table is in the process of being backfilled. When you enable the inventory table for your metadata configuration, the table goes through a process known as backfilling, during which Amazon S3 scans your general purpose bucket to retrieve the initial metadata for all objects in the bucket. Depending on the number of objects in your bucket, this process can take several hours. When the backfilling process is finished, the status of your inventory table changes from BACKFILLING to ACTIVE. After backfilling is completed, updates to your objects are reflected in the inventory table within one hour.

      • ACTIVE - The inventory table has been created successfully, and records are being delivered to the table.

      • FAILED - Amazon S3 is unable to create the inventory table, or Amazon S3 is unable to deliver records.

      Returns:
      The status of the inventory table. The status values are:

      • CREATING - The inventory table is in the process of being created in the specified Amazon Web Services managed table bucket.

      • BACKFILLING - The inventory table is in the process of being backfilled. When you enable the inventory table for your metadata configuration, the table goes through a process known as backfilling, during which Amazon S3 scans your general purpose bucket to retrieve the initial metadata for all objects in the bucket. Depending on the number of objects in your bucket, this process can take several hours. When the backfilling process is finished, the status of your inventory table changes from BACKFILLING to ACTIVE. After backfilling is completed, updates to your objects are reflected in the inventory table within one hour.

      • ACTIVE - The inventory table has been created successfully, and records are being delivered to the table.

      • FAILED - Amazon S3 is unable to create the inventory table, or Amazon S3 is unable to deliver records.

    • error

      public final ErrorDetails error()
      Returns the value of the Error property for this object.
      Returns:
      The value of the Error property for this object.

    • tableName

      public final String tableName()

      The name of the inventory table.

      Returns:
      The name of the inventory table.

    • tableArn

      public final String tableArn()

      The Amazon Resource Name (ARN) for the inventory table.

      Returns:
      The Amazon Resource Name (ARN) for the inventory table.

    • toBuilder

      public InventoryTableConfigurationResult.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<InventoryTableConfigurationResult.Builder,InventoryTableConfigurationResult>
      Returns:
      a builder for type T

    • builder

      public static InventoryTableConfigurationResult.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InventoryTableConfigurationResult.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.