Class AnonymousUserDashboardEmbeddingConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.quicksight.model.AnonymousUserDashboardEmbeddingConfiguration
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AnonymousUserDashboardEmbeddingConfiguration.Builder,AnonymousUserDashboardEmbeddingConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class AnonymousUserDashboardEmbeddingConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AnonymousUserDashboardEmbeddingConfiguration.Builder,AnonymousUserDashboardEmbeddingConfiguration>
Information about the dashboard that you want to embed.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAnonymousUserDashboardEmbeddingConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AnonymousUserDashboardEmbeddingConfiguration.Builderbuilder()List<AnonymousUserDashboardEmbeddingConfigurationDisabledFeature>disabledFeatures()A list of all disabled features of a specified anonymous dashboard.List<String>disabledFeaturesAsStrings()A list of all disabled features of a specified anonymous dashboard.List<AnonymousUserDashboardEmbeddingConfigurationEnabledFeature>enabledFeatures()A list of all enabled features of a specified anonymous dashboard.List<String>enabledFeaturesAsStrings()A list of all enabled features of a specified anonymous dashboard.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)AnonymousUserDashboardFeatureConfigurationsfeatureConfigurations()The feature configuration for an embedded dashboard.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDisabledFeatures()For responses, this returns true if the service returned a value for the DisabledFeatures property.booleanhasEnabledFeatures()For responses, this returns true if the service returned a value for the EnabledFeatures property.inthashCode()StringinitialDashboardId()The dashboard ID for the dashboard that you want the user to see first.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends AnonymousUserDashboardEmbeddingConfiguration.Builder>serializableBuilderClass()AnonymousUserDashboardEmbeddingConfiguration.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
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
AuthorizedResourceArnsparameter. Otherwise, the request will fail withInvalidParameterValueException.- 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
AuthorizedResourceArnsparameter. Otherwise, the request will fail withInvalidParameterValueException.
-
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 theisEmpty()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 theisEmpty()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.
-
toBuilder
public AnonymousUserDashboardEmbeddingConfiguration.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AnonymousUserDashboardEmbeddingConfiguration.Builder,AnonymousUserDashboardEmbeddingConfiguration>
-
builder
public static AnonymousUserDashboardEmbeddingConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends AnonymousUserDashboardEmbeddingConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-