Package software.amazon.awssdk.services.s3.model

Class InventoryS3BucketDestination

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

Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

See Also:

  • Method Details

    • accountId

      public final String accountId()

      The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

      Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

      Returns:
      The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

      Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

    • bucket

      public final String bucket()

      The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

      Returns:
      The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

    • format

      public final InventoryFormat format()

      Specifies the output format of the inventory results.

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

      Returns:
      Specifies the output format of the inventory results.
      See Also:

    • formatAsString

      public final String formatAsString()

      Specifies the output format of the inventory results.

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

      Returns:
      Specifies the output format of the inventory results.
      See Also:

    • prefix

      public final String prefix()

      The prefix that is prepended to all inventory results.

      Returns:
      The prefix that is prepended to all inventory results.

    • encryption

      public final InventoryEncryption encryption()

      Contains the type of server-side encryption used to encrypt the inventory results.

      Returns:
      Contains the type of server-side encryption used to encrypt the inventory results.

    • toBuilder

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

    • builder

      public static InventoryS3BucketDestination.Builder builder()

    • serializableBuilderClass

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