Class S3BucketConfiguration

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

An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon Quick Sight bucket.

See Also:

  • Method Details

    • bucketName

      public final String bucketName()

      The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

      Returns:
      The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

    • bucketPrefix

      public final String bucketPrefix()

      The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

      Returns:
      The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

    • bucketRegion

      public final String bucketRegion()

      The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

      Returns:
      The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

    • toBuilder

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

    • builder

      public static S3BucketConfiguration.Builder builder()

    • serializableBuilderClass

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