software.amazon.awssdk.services.quicksight.model.CreateThemeRequest Maven / Gradle / Ivy
Show all versions of quicksight Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.quicksight.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateThemeRequest extends QuickSightRequest implements
ToCopyableBuilder {
private static final SdkField AWS_ACCOUNT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AwsAccountId").getter(getter(CreateThemeRequest::awsAccountId)).setter(setter(Builder::awsAccountId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("AwsAccountId").build()).build();
private static final SdkField THEME_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ThemeId").getter(getter(CreateThemeRequest::themeId)).setter(setter(Builder::themeId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("ThemeId").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(CreateThemeRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField BASE_THEME_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("BaseThemeId").getter(getter(CreateThemeRequest::baseThemeId)).setter(setter(Builder::baseThemeId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BaseThemeId").build()).build();
private static final SdkField VERSION_DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("VersionDescription").getter(getter(CreateThemeRequest::versionDescription))
.setter(setter(Builder::versionDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VersionDescription").build())
.build();
private static final SdkField CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Configuration")
.getter(getter(CreateThemeRequest::configuration)).setter(setter(Builder::configuration))
.constructor(ThemeConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Configuration").build()).build();
private static final SdkField> PERMISSIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Permissions")
.getter(getter(CreateThemeRequest::permissions))
.setter(setter(Builder::permissions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Permissions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ResourcePermission::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateThemeRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AWS_ACCOUNT_ID_FIELD,
THEME_ID_FIELD, NAME_FIELD, BASE_THEME_ID_FIELD, VERSION_DESCRIPTION_FIELD, CONFIGURATION_FIELD, PERMISSIONS_FIELD,
TAGS_FIELD));
private final String awsAccountId;
private final String themeId;
private final String name;
private final String baseThemeId;
private final String versionDescription;
private final ThemeConfiguration configuration;
private final List permissions;
private final List tags;
private CreateThemeRequest(BuilderImpl builder) {
super(builder);
this.awsAccountId = builder.awsAccountId;
this.themeId = builder.themeId;
this.name = builder.name;
this.baseThemeId = builder.baseThemeId;
this.versionDescription = builder.versionDescription;
this.configuration = builder.configuration;
this.permissions = builder.permissions;
this.tags = builder.tags;
}
/**
*
* The ID of the Amazon Web Services account where you want to store the new theme.
*
*
* @return The ID of the Amazon Web Services account where you want to store the new theme.
*/
public final String awsAccountId() {
return awsAccountId;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String themeId() {
return themeId;
}
/**
*
* A display name for the theme.
*
*
* @return A display name for the theme.
*/
public final String name() {
return name;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String baseThemeId() {
return baseThemeId;
}
/**
*
* 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 the
* VersionDescription field.
*
*
* @return 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 the
* VersionDescription field.
*/
public final String versionDescription() {
return versionDescription;
}
/**
*
* The theme configuration, which contains the theme display properties.
*
*
* @return The theme configuration, which contains the theme display properties.
*/
public final ThemeConfiguration configuration() {
return configuration;
}
/**
* 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 the {@code 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.
*/
public final boolean hasPermissions() {
return permissions != null && !(permissions instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasPermissions} method.
*
*
* @return A valid grouping of resource permissions to apply to the new theme.
*/
public final List permissions() {
return permissions;
}
/**
* 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 the {@code 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.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasTags} method.
*
*
* @return A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
*/
public final List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(awsAccountId());
hashCode = 31 * hashCode + Objects.hashCode(themeId());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(baseThemeId());
hashCode = 31 * hashCode + Objects.hashCode(versionDescription());
hashCode = 31 * hashCode + Objects.hashCode(configuration());
hashCode = 31 * hashCode + Objects.hashCode(hasPermissions() ? permissions() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateThemeRequest)) {
return false;
}
CreateThemeRequest other = (CreateThemeRequest) obj;
return Objects.equals(awsAccountId(), other.awsAccountId()) && Objects.equals(themeId(), other.themeId())
&& Objects.equals(name(), other.name()) && Objects.equals(baseThemeId(), other.baseThemeId())
&& Objects.equals(versionDescription(), other.versionDescription())
&& Objects.equals(configuration(), other.configuration()) && hasPermissions() == other.hasPermissions()
&& Objects.equals(permissions(), other.permissions()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CreateThemeRequest").add("AwsAccountId", awsAccountId()).add("ThemeId", themeId())
.add("Name", name()).add("BaseThemeId", baseThemeId()).add("VersionDescription", versionDescription())
.add("Configuration", configuration()).add("Permissions", hasPermissions() ? permissions() : null)
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AwsAccountId":
return Optional.ofNullable(clazz.cast(awsAccountId()));
case "ThemeId":
return Optional.ofNullable(clazz.cast(themeId()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "BaseThemeId":
return Optional.ofNullable(clazz.cast(baseThemeId()));
case "VersionDescription":
return Optional.ofNullable(clazz.cast(versionDescription()));
case "Configuration":
return Optional.ofNullable(clazz.cast(configuration()));
case "Permissions":
return Optional.ofNullable(clazz.cast(permissions()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateThemeRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID of the Amazon Web Services account where you want to store the new theme.
*
*
* @param awsAccountId
* The ID of the Amazon Web Services account where you want to store the new theme.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder awsAccountId(String awsAccountId);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder themeId(String themeId);
/**
*
* A display name for the theme.
*
*
* @param name
* A display name for the theme.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder baseThemeId(String baseThemeId);
/**
*
* 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 the
* VersionDescription field.
*
*
* @param 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 the VersionDescription field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder versionDescription(String versionDescription);
/**
*
* The theme configuration, which contains the theme display properties.
*
*
* @param configuration
* The theme configuration, which contains the theme display properties.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder configuration(ThemeConfiguration configuration);
/**
*
* The theme configuration, which contains the theme display properties.
*
* This is a convenience method that creates an instance of the {@link ThemeConfiguration.Builder} avoiding the
* need to create one manually via {@link ThemeConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link ThemeConfiguration.Builder#build()} is called immediately and its
* result is passed to {@link #configuration(ThemeConfiguration)}.
*
* @param configuration
* a consumer that will call methods on {@link ThemeConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #configuration(ThemeConfiguration)
*/
default Builder configuration(Consumer configuration) {
return configuration(ThemeConfiguration.builder().applyMutation(configuration).build());
}
/**
*
* A valid grouping of resource permissions to apply to the new theme.
*
*
* @param permissions
* A valid grouping of resource permissions to apply to the new theme.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder permissions(Collection permissions);
/**
*
* A valid grouping of resource permissions to apply to the new theme.
*
*
* @param permissions
* A valid grouping of resource permissions to apply to the new theme.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder permissions(ResourcePermission... permissions);
/**
*
* A valid grouping of resource permissions to apply to the new theme.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.quicksight.model.ResourcePermission.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.quicksight.model.ResourcePermission#builder()}
* .
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.quicksight.model.ResourcePermission.Builder#build()} is called
* immediately and its result is passed to {@link #permissions(List)}.
*
* @param permissions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.quicksight.model.ResourcePermission.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #permissions(java.util.Collection)
*/
Builder permissions(Consumer... permissions);
/**
*
* A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
*
*
* @param tags
* A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
*
*
* @param tags
* A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.quicksight.model.Tag.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.quicksight.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.quicksight.model.Tag.Builder#build()} is called immediately and its
* result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.quicksight.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends QuickSightRequest.BuilderImpl implements Builder {
private String awsAccountId;
private String themeId;
private String name;
private String baseThemeId;
private String versionDescription;
private ThemeConfiguration configuration;
private List permissions = DefaultSdkAutoConstructList.getInstance();
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateThemeRequest model) {
super(model);
awsAccountId(model.awsAccountId);
themeId(model.themeId);
name(model.name);
baseThemeId(model.baseThemeId);
versionDescription(model.versionDescription);
configuration(model.configuration);
permissions(model.permissions);
tags(model.tags);
}
public final String getAwsAccountId() {
return awsAccountId;
}
public final void setAwsAccountId(String awsAccountId) {
this.awsAccountId = awsAccountId;
}
@Override
public final Builder awsAccountId(String awsAccountId) {
this.awsAccountId = awsAccountId;
return this;
}
public final String getThemeId() {
return themeId;
}
public final void setThemeId(String themeId) {
this.themeId = themeId;
}
@Override
public final Builder themeId(String themeId) {
this.themeId = themeId;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getBaseThemeId() {
return baseThemeId;
}
public final void setBaseThemeId(String baseThemeId) {
this.baseThemeId = baseThemeId;
}
@Override
public final Builder baseThemeId(String baseThemeId) {
this.baseThemeId = baseThemeId;
return this;
}
public final String getVersionDescription() {
return versionDescription;
}
public final void setVersionDescription(String versionDescription) {
this.versionDescription = versionDescription;
}
@Override
public final Builder versionDescription(String versionDescription) {
this.versionDescription = versionDescription;
return this;
}
public final ThemeConfiguration.Builder getConfiguration() {
return configuration != null ? configuration.toBuilder() : null;
}
public final void setConfiguration(ThemeConfiguration.BuilderImpl configuration) {
this.configuration = configuration != null ? configuration.build() : null;
}
@Override
public final Builder configuration(ThemeConfiguration configuration) {
this.configuration = configuration;
return this;
}
public final List getPermissions() {
List result = ResourcePermissionListCopier.copyToBuilder(this.permissions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setPermissions(Collection permissions) {
this.permissions = ResourcePermissionListCopier.copyFromBuilder(permissions);
}
@Override
public final Builder permissions(Collection permissions) {
this.permissions = ResourcePermissionListCopier.copy(permissions);
return this;
}
@Override
@SafeVarargs
public final Builder permissions(ResourcePermission... permissions) {
permissions(Arrays.asList(permissions));
return this;
}
@Override
@SafeVarargs
public final Builder permissions(Consumer... permissions) {
permissions(Stream.of(permissions).map(c -> ResourcePermission.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateThemeRequest build() {
return new CreateThemeRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}