Class AnonymousUserDashboardEmbeddingConfiguration

    • Method Detail

      • initialDashboardId

        public final String initialDashboardId()

        The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders this dashboard.

        The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

        Returns:
        The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders this dashboard.

        The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

      • enabledFeatures

        public final List<AnonymousUserDashboardEmbeddingConfigurationEnabledFeature> enabledFeatures()

        A list of all enabled features of a specified anonymous dashboard.

        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 hasEnabledFeatures() method.

        Returns:
        A list of all enabled features of a specified anonymous dashboard.
      • hasEnabledFeatures

        public final boolean hasEnabledFeatures()
        For responses, this returns true if the service returned a value for the EnabledFeatures 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.
      • enabledFeaturesAsStrings

        public final List<String> enabledFeaturesAsStrings()

        A list of all enabled features of a specified anonymous dashboard.

        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 hasEnabledFeatures() method.

        Returns:
        A list of all enabled features of a specified anonymous dashboard.
      • disabledFeatures

        public final List<AnonymousUserDashboardEmbeddingConfigurationDisabledFeature> disabledFeatures()

        A list of all disabled features of a specified anonymous dashboard.

        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 hasDisabledFeatures() method.

        Returns:
        A list of all disabled features of a specified anonymous dashboard.
      • hasDisabledFeatures

        public final boolean hasDisabledFeatures()
        For responses, this returns true if the service returned a value for the DisabledFeatures 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.
      • disabledFeaturesAsStrings

        public final List<String> disabledFeaturesAsStrings()

        A list of all disabled features of a specified anonymous dashboard.

        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 hasDisabledFeatures() method.

        Returns:
        A list of all disabled features of a specified anonymous dashboard.
      • featureConfigurations

        public final AnonymousUserDashboardFeatureConfigurations featureConfigurations()

        The feature configuration for an embedded dashboard.

        Returns:
        The feature configuration for an embedded dashboard.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)