Class StorageLensConfiguration

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

A container for the Amazon S3 Storage Lens configuration.

See Also:

  • Method Details

    • id

      public final String id()

      A container for the Amazon S3 Storage Lens configuration ID.

      Returns:
      A container for the Amazon S3 Storage Lens configuration ID.

    • accountLevel

      public final AccountLevel accountLevel()

      A container for all the account-level configurations of your S3 Storage Lens configuration.

      Returns:
      A container for all the account-level configurations of your S3 Storage Lens configuration.

    • include

      public final Include include()

      A container for what is included in this configuration. This container can only be valid if there is no Exclude container submitted, and it's not empty.

      Returns:
      A container for what is included in this configuration. This container can only be valid if there is no Exclude container submitted, and it's not empty.

    • exclude

      public final Exclude exclude()

      A container for what is excluded in this configuration. This container can only be valid if there is no Include container submitted, and it's not empty.

      Returns:
      A container for what is excluded in this configuration. This container can only be valid if there is no Include container submitted, and it's not empty.

    • dataExport

      public final StorageLensDataExport dataExport()

      A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.

      Returns:
      A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.

    • expandedPrefixesDataExport

      public final StorageLensExpandedPrefixesDataExport expandedPrefixesDataExport()

      A container that configures your S3 Storage Lens expanded prefixes metrics report.

      Returns:
      A container that configures your S3 Storage Lens expanded prefixes metrics report.

    • isEnabled

      public final Boolean isEnabled()

      A container for whether the S3 Storage Lens configuration is enabled.

      Returns:
      A container for whether the S3 Storage Lens configuration is enabled.

    • awsOrg

      public final StorageLensAwsOrg awsOrg()

      A container for the Amazon Web Services organization for this S3 Storage Lens configuration.

      Returns:
      A container for the Amazon Web Services organization for this S3 Storage Lens configuration.

    • storageLensArn

      public final String storageLensArn()

      The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name

      Returns:
      The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name

    • prefixDelimiter

      public final String prefixDelimiter()

      A container for all prefix delimiters that are used for object keys in this S3 Storage Lens configuration. The prefix delimiters determine how S3 Storage Lens counts prefix depth, by separating the hierarchical levels in object keys.

      • If either a prefix delimiter or existing delimiter is undefined, Amazon S3 uses the delimiter that’s defined.

      • If both the prefix delimiter and existing delimiter are undefined, S3 uses / as the default delimiter.

      • When custom delimiters are used, both the prefix delimiter and existing delimiter must specify the same special character. Otherwise, your request results in an error.

      Returns:
      A container for all prefix delimiters that are used for object keys in this S3 Storage Lens configuration. The prefix delimiters determine how S3 Storage Lens counts prefix depth, by separating the hierarchical levels in object keys.

      • If either a prefix delimiter or existing delimiter is undefined, Amazon S3 uses the delimiter that’s defined.

      • If both the prefix delimiter and existing delimiter are undefined, S3 uses / as the default delimiter.

      • When custom delimiters are used, both the prefix delimiter and existing delimiter must specify the same special character. Otherwise, your request results in an error.

    • toBuilder

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

    • builder

      public static StorageLensConfiguration.Builder builder()

    • serializableBuilderClass

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