Class CreateThemeRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateThemeRequest.Builder,
CreateThemeRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID of the Amazon Web Services account where you want to store the new theme.final String
The ID of the theme that a custom theme will inherit from.static CreateThemeRequest.Builder
builder()
final ThemeConfiguration
The theme configuration, which contains the theme display properties.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Permissions property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
A display name for the theme.final List
<ResourcePermission> A valid grouping of resource permissions to apply to the new theme.static Class
<? extends CreateThemeRequest.Builder> tags()
A map of the key-value pairs for the resource tag or tags that you want to add to the resource.final String
themeId()
An ID for the theme that you want to create.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
A display name for the theme.
- Returns:
- A display name for the theme.
-
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
ListThemes
or 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
ListThemes
or choose Themes from within an analysis.
-
versionDescription
A description of the first version of the theme that you're creating. Every time
UpdateTheme
is called, a new version is created. Each version of the theme has a description of the version in theVersionDescription
field.- Returns:
- A description of the first version of the theme that you're creating. Every time
UpdateTheme
is called, a new version is created. Each version of the theme has a description of the version in theVersionDescription
field.
-
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
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
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
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 interfaceToCopyableBuilder<CreateThemeRequest.Builder,
CreateThemeRequest> - Specified by:
toBuilder
in classQuickSightRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-