Class CreateThemeRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.quicksight.model.QuickSightRequest
-
- software.amazon.awssdk.services.quicksight.model.CreateThemeRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateThemeRequest.Builder,CreateThemeRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateThemeRequest extends QuickSightRequest implements ToCopyableBuilder<CreateThemeRequest.Builder,CreateThemeRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateThemeRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringawsAccountId()The ID of the Amazon Web Services account where you want to store the new theme.StringbaseThemeId()The ID of the theme that a custom theme will inherit from.static CreateThemeRequest.Builderbuilder()ThemeConfigurationconfiguration()The theme configuration, which contains the theme display properties.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasPermissions()For responses, this returns true if the service returned a value for the Permissions property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringname()A display name for the theme.List<ResourcePermission>permissions()A valid grouping of resource permissions to apply to the new theme.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateThemeRequest.Builder>serializableBuilderClass()List<Tag>tags()A map of the key-value pairs for the resource tag or tags that you want to add to the resource.StringthemeId()An ID for the theme that you want to create.CreateThemeRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringversionDescription()A description of the first version of the theme that you're creating.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
awsAccountId
public final String awsAccountId()
The ID of the Amazon Web Services account where you want to store the new theme.
- Returns:
- The ID of the Amazon Web Services account where you want to store the new theme.
-
themeId
public final String themeId()
An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.
- Returns:
- An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.
-
name
public final String name()
A display name for the theme.
- Returns:
- A display name for the theme.
-
baseThemeId
public final String baseThemeId()
The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use
ListThemesor choose Themes from within an analysis.- Returns:
- The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting
themes defined by Amazon QuickSight. For a list of the starting themes, use
ListThemesor choose Themes from within an analysis.
-
versionDescription
public final String versionDescription()
A description of the first version of the theme that you're creating. Every time
UpdateThemeis called, a new version is created. Each version of the theme has a description of the version in theVersionDescriptionfield.- Returns:
- A description of the first version of the theme that you're creating. Every time
UpdateThemeis called, a new version is created. Each version of the theme has a description of the version in theVersionDescriptionfield.
-
configuration
public final ThemeConfiguration configuration()
The theme configuration, which contains the theme display properties.
- Returns:
- The theme configuration, which contains the theme display properties.
-
hasPermissions
public final boolean hasPermissions()
For responses, this returns true if the service returned a value for the Permissions 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.
-
permissions
public final List<ResourcePermission> permissions()
A valid grouping of resource permissions to apply to the new theme.
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
hasPermissions()method.- Returns:
- A valid grouping of resource permissions to apply to the new theme.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags 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.
-
tags
public final List<Tag> tags()
A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
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
hasTags()method.- Returns:
- A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
-
toBuilder
public CreateThemeRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateThemeRequest.Builder,CreateThemeRequest>- Specified by:
toBuilderin classQuickSightRequest
-
builder
public static CreateThemeRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateThemeRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-