Class AnalyticsS3BucketDestination

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

Contains information about where to publish the analytics results.

See Also:

  • Method Details

    • format

      public final AnalyticsS3ExportFileFormat format()

      Specifies the file format used when exporting data to Amazon S3.

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

      Returns:
      Specifies the file format used when exporting data to Amazon S3.
      See Also:

    • formatAsString

      public final String formatAsString()

      Specifies the file format used when exporting data to Amazon S3.

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

      Returns:
      Specifies the file format used when exporting data to Amazon S3.
      See Also:

    • bucketAccountId

      public final String bucketAccountId()

      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 to which data is exported.

      Returns:
      The Amazon Resource Name (ARN) of the bucket to which data is exported.

    • prefix

      public final String prefix()

      The prefix to use when exporting data. The prefix is prepended to all results.

      Returns:
      The prefix to use when exporting data. The prefix is prepended to all results.

    • toBuilder

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

    • builder

      public static AnalyticsS3BucketDestination.Builder builder()

    • serializableBuilderClass

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