Class AssetOptions

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

An array of analysis level configurations.

See Also:

  • Method Details

    • timezone

      public final String timezone()

      Determines the timezone for the analysis.

      Returns:
      Determines the timezone for the analysis.

    • weekStart

      public final DayOfTheWeek weekStart()

      Determines the week start day for an analysis.

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

      Returns:
      Determines the week start day for an analysis.
      See Also:

    • weekStartAsString

      public final String weekStartAsString()

      Determines the week start day for an analysis.

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

      Returns:
      Determines the week start day for an analysis.
      See Also:

    • qBusinessInsightsStatus

      public final QBusinessInsightsStatus qBusinessInsightsStatus()

      Determines whether insight summaries from Amazon Q Business are allowed in Dashboard Q&A.

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

      Returns:
      Determines whether insight summaries from Amazon Q Business are allowed in Dashboard Q&A.
      See Also:

    • qBusinessInsightsStatusAsString

      public final String qBusinessInsightsStatusAsString()

      Determines whether insight summaries from Amazon Q Business are allowed in Dashboard Q&A.

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

      Returns:
      Determines whether insight summaries from Amazon Q Business are allowed in Dashboard Q&A.
      See Also:

    • hasExcludedDataSetArns

      public final boolean hasExcludedDataSetArns()
      For responses, this returns true if the service returned a value for the ExcludedDataSetArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • excludedDataSetArns

      public final List<String> excludedDataSetArns()

      A list of dataset ARNS to exclude from Dashboard Q&A.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExcludedDataSetArns() method.

      Returns:
      A list of dataset ARNS to exclude from Dashboard Q&A.

    • customActionDefaults

      public final VisualCustomActionDefaults customActionDefaults()

      A list of visual custom actions for the analysis.

      Returns:
      A list of visual custom actions for the analysis.

    • toBuilder

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

    • builder

      public static AssetOptions.Builder builder()

    • serializableBuilderClass

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