software.amazon.awssdk.services.quicksight.model.ComboChartVisual 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.io.Serializable;
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.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;
/**
*
* A combo chart.
*
*
* The ComboChartVisual includes stacked bar combo charts and clustered bar combo charts
*
*
* For more information, see Using combo
* charts in the Amazon QuickSight User Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ComboChartVisual implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField VISUAL_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("VisualId").getter(getter(ComboChartVisual::visualId)).setter(setter(Builder::visualId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VisualId").build()).build();
private static final SdkField TITLE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Title")
.getter(getter(ComboChartVisual::title)).setter(setter(Builder::title)).constructor(VisualTitleLabelOptions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Title").build()).build();
private static final SdkField SUBTITLE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Subtitle")
.getter(getter(ComboChartVisual::subtitle)).setter(setter(Builder::subtitle))
.constructor(VisualSubtitleLabelOptions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Subtitle").build()).build();
private static final SdkField CHART_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ChartConfiguration")
.getter(getter(ComboChartVisual::chartConfiguration)).setter(setter(Builder::chartConfiguration))
.constructor(ComboChartConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ChartConfiguration").build())
.build();
private static final SdkField> ACTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Actions")
.getter(getter(ComboChartVisual::actions))
.setter(setter(Builder::actions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Actions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(VisualCustomAction::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> COLUMN_HIERARCHIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ColumnHierarchies")
.getter(getter(ComboChartVisual::columnHierarchies))
.setter(setter(Builder::columnHierarchies))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ColumnHierarchies").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ColumnHierarchy::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(VISUAL_ID_FIELD, TITLE_FIELD,
SUBTITLE_FIELD, CHART_CONFIGURATION_FIELD, ACTIONS_FIELD, COLUMN_HIERARCHIES_FIELD));
private static final long serialVersionUID = 1L;
private final String visualId;
private final VisualTitleLabelOptions title;
private final VisualSubtitleLabelOptions subtitle;
private final ComboChartConfiguration chartConfiguration;
private final List actions;
private final List columnHierarchies;
private ComboChartVisual(BuilderImpl builder) {
this.visualId = builder.visualId;
this.title = builder.title;
this.subtitle = builder.subtitle;
this.chartConfiguration = builder.chartConfiguration;
this.actions = builder.actions;
this.columnHierarchies = builder.columnHierarchies;
}
/**
*
* The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or
* analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
*
*
* @return The unique identifier of a visual. This identifier must be unique within the context of a dashboard,
* template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
*/
public final String visualId() {
return visualId;
}
/**
*
* The title that is displayed on the visual.
*
*
* @return The title that is displayed on the visual.
*/
public final VisualTitleLabelOptions title() {
return title;
}
/**
*
* The subtitle that is displayed on the visual.
*
*
* @return The subtitle that is displayed on the visual.
*/
public final VisualSubtitleLabelOptions subtitle() {
return subtitle;
}
/**
*
* The configuration settings of the visual.
*
*
* @return The configuration settings of the visual.
*/
public final ComboChartConfiguration chartConfiguration() {
return chartConfiguration;
}
/**
* For responses, this returns true if the service returned a value for the Actions 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 hasActions() {
return actions != null && !(actions instanceof SdkAutoConstructList);
}
/**
*
* The list of custom actions that are configured for a visual.
*
*
* 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 #hasActions} method.
*
*
* @return The list of custom actions that are configured for a visual.
*/
public final List actions() {
return actions;
}
/**
* For responses, this returns true if the service returned a value for the ColumnHierarchies 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 hasColumnHierarchies() {
return columnHierarchies != null && !(columnHierarchies instanceof SdkAutoConstructList);
}
/**
*
* The column hierarchy that is used during drill-downs and drill-ups.
*
*
* 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 #hasColumnHierarchies} method.
*
*
* @return The column hierarchy that is used during drill-downs and drill-ups.
*/
public final List columnHierarchies() {
return columnHierarchies;
}
@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 + Objects.hashCode(visualId());
hashCode = 31 * hashCode + Objects.hashCode(title());
hashCode = 31 * hashCode + Objects.hashCode(subtitle());
hashCode = 31 * hashCode + Objects.hashCode(chartConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(hasActions() ? actions() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasColumnHierarchies() ? columnHierarchies() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ComboChartVisual)) {
return false;
}
ComboChartVisual other = (ComboChartVisual) obj;
return Objects.equals(visualId(), other.visualId()) && Objects.equals(title(), other.title())
&& Objects.equals(subtitle(), other.subtitle())
&& Objects.equals(chartConfiguration(), other.chartConfiguration()) && hasActions() == other.hasActions()
&& Objects.equals(actions(), other.actions()) && hasColumnHierarchies() == other.hasColumnHierarchies()
&& Objects.equals(columnHierarchies(), other.columnHierarchies());
}
/**
* 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("ComboChartVisual").add("VisualId", visualId()).add("Title", title()).add("Subtitle", subtitle())
.add("ChartConfiguration", chartConfiguration()).add("Actions", hasActions() ? actions() : null)
.add("ColumnHierarchies", hasColumnHierarchies() ? columnHierarchies() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "VisualId":
return Optional.ofNullable(clazz.cast(visualId()));
case "Title":
return Optional.ofNullable(clazz.cast(title()));
case "Subtitle":
return Optional.ofNullable(clazz.cast(subtitle()));
case "ChartConfiguration":
return Optional.ofNullable(clazz.cast(chartConfiguration()));
case "Actions":
return Optional.ofNullable(clazz.cast(actions()));
case "ColumnHierarchies":
return Optional.ofNullable(clazz.cast(columnHierarchies()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ComboChartVisual) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The unique identifier of a visual. This identifier must be unique within the context of a dashboard,
* template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
*
*
* @param visualId
* The unique identifier of a visual. This identifier must be unique within the context of a dashboard,
* template, or analysis. Two dashboards, analyses, or templates can have visuals with the same
* identifiers.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder visualId(String visualId);
/**
*
* The title that is displayed on the visual.
*
*
* @param title
* The title that is displayed on the visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder title(VisualTitleLabelOptions title);
/**
*
* The title that is displayed on the visual.
*
* This is a convenience method that creates an instance of the {@link VisualTitleLabelOptions.Builder} avoiding
* the need to create one manually via {@link VisualTitleLabelOptions#builder()}.
*
*
* When the {@link Consumer} completes, {@link VisualTitleLabelOptions.Builder#build()} is called immediately
* and its result is passed to {@link #title(VisualTitleLabelOptions)}.
*
* @param title
* a consumer that will call methods on {@link VisualTitleLabelOptions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #title(VisualTitleLabelOptions)
*/
default Builder title(Consumer title) {
return title(VisualTitleLabelOptions.builder().applyMutation(title).build());
}
/**
*
* The subtitle that is displayed on the visual.
*
*
* @param subtitle
* The subtitle that is displayed on the visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subtitle(VisualSubtitleLabelOptions subtitle);
/**
*
* The subtitle that is displayed on the visual.
*
* This is a convenience method that creates an instance of the {@link VisualSubtitleLabelOptions.Builder}
* avoiding the need to create one manually via {@link VisualSubtitleLabelOptions#builder()}.
*
*
* When the {@link Consumer} completes, {@link VisualSubtitleLabelOptions.Builder#build()} is called immediately
* and its result is passed to {@link #subtitle(VisualSubtitleLabelOptions)}.
*
* @param subtitle
* a consumer that will call methods on {@link VisualSubtitleLabelOptions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #subtitle(VisualSubtitleLabelOptions)
*/
default Builder subtitle(Consumer subtitle) {
return subtitle(VisualSubtitleLabelOptions.builder().applyMutation(subtitle).build());
}
/**
*
* The configuration settings of the visual.
*
*
* @param chartConfiguration
* The configuration settings of the visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder chartConfiguration(ComboChartConfiguration chartConfiguration);
/**
*
* The configuration settings of the visual.
*
* This is a convenience method that creates an instance of the {@link ComboChartConfiguration.Builder} avoiding
* the need to create one manually via {@link ComboChartConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link ComboChartConfiguration.Builder#build()} is called immediately
* and its result is passed to {@link #chartConfiguration(ComboChartConfiguration)}.
*
* @param chartConfiguration
* a consumer that will call methods on {@link ComboChartConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #chartConfiguration(ComboChartConfiguration)
*/
default Builder chartConfiguration(Consumer chartConfiguration) {
return chartConfiguration(ComboChartConfiguration.builder().applyMutation(chartConfiguration).build());
}
/**
*
* The list of custom actions that are configured for a visual.
*
*
* @param actions
* The list of custom actions that are configured for a visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actions(Collection actions);
/**
*
* The list of custom actions that are configured for a visual.
*
*
* @param actions
* The list of custom actions that are configured for a visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actions(VisualCustomAction... actions);
/**
*
* The list of custom actions that are configured for a visual.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.quicksight.model.VisualCustomAction.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.quicksight.model.VisualCustomAction#builder()}
* .
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.quicksight.model.VisualCustomAction.Builder#build()} is called
* immediately and its result is passed to {@link #actions(List)}.
*
* @param actions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.quicksight.model.VisualCustomAction.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #actions(java.util.Collection)
*/
Builder actions(Consumer... actions);
/**
*
* The column hierarchy that is used during drill-downs and drill-ups.
*
*
* @param columnHierarchies
* The column hierarchy that is used during drill-downs and drill-ups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder columnHierarchies(Collection columnHierarchies);
/**
*
* The column hierarchy that is used during drill-downs and drill-ups.
*
*
* @param columnHierarchies
* The column hierarchy that is used during drill-downs and drill-ups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder columnHierarchies(ColumnHierarchy... columnHierarchies);
/**
*
* The column hierarchy that is used during drill-downs and drill-ups.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.quicksight.model.ColumnHierarchy.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.quicksight.model.ColumnHierarchy#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.quicksight.model.ColumnHierarchy.Builder#build()} is called
* immediately and its result is passed to {@link #columnHierarchies(List)}.
*
* @param columnHierarchies
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.quicksight.model.ColumnHierarchy.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #columnHierarchies(java.util.Collection)
*/
Builder columnHierarchies(Consumer... columnHierarchies);
}
static final class BuilderImpl implements Builder {
private String visualId;
private VisualTitleLabelOptions title;
private VisualSubtitleLabelOptions subtitle;
private ComboChartConfiguration chartConfiguration;
private List actions = DefaultSdkAutoConstructList.getInstance();
private List columnHierarchies = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ComboChartVisual model) {
visualId(model.visualId);
title(model.title);
subtitle(model.subtitle);
chartConfiguration(model.chartConfiguration);
actions(model.actions);
columnHierarchies(model.columnHierarchies);
}
public final String getVisualId() {
return visualId;
}
public final void setVisualId(String visualId) {
this.visualId = visualId;
}
@Override
public final Builder visualId(String visualId) {
this.visualId = visualId;
return this;
}
public final VisualTitleLabelOptions.Builder getTitle() {
return title != null ? title.toBuilder() : null;
}
public final void setTitle(VisualTitleLabelOptions.BuilderImpl title) {
this.title = title != null ? title.build() : null;
}
@Override
public final Builder title(VisualTitleLabelOptions title) {
this.title = title;
return this;
}
public final VisualSubtitleLabelOptions.Builder getSubtitle() {
return subtitle != null ? subtitle.toBuilder() : null;
}
public final void setSubtitle(VisualSubtitleLabelOptions.BuilderImpl subtitle) {
this.subtitle = subtitle != null ? subtitle.build() : null;
}
@Override
public final Builder subtitle(VisualSubtitleLabelOptions subtitle) {
this.subtitle = subtitle;
return this;
}
public final ComboChartConfiguration.Builder getChartConfiguration() {
return chartConfiguration != null ? chartConfiguration.toBuilder() : null;
}
public final void setChartConfiguration(ComboChartConfiguration.BuilderImpl chartConfiguration) {
this.chartConfiguration = chartConfiguration != null ? chartConfiguration.build() : null;
}
@Override
public final Builder chartConfiguration(ComboChartConfiguration chartConfiguration) {
this.chartConfiguration = chartConfiguration;
return this;
}
public final List getActions() {
List result = VisualCustomActionListCopier.copyToBuilder(this.actions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setActions(Collection actions) {
this.actions = VisualCustomActionListCopier.copyFromBuilder(actions);
}
@Override
public final Builder actions(Collection actions) {
this.actions = VisualCustomActionListCopier.copy(actions);
return this;
}
@Override
@SafeVarargs
public final Builder actions(VisualCustomAction... actions) {
actions(Arrays.asList(actions));
return this;
}
@Override
@SafeVarargs
public final Builder actions(Consumer... actions) {
actions(Stream.of(actions).map(c -> VisualCustomAction.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getColumnHierarchies() {
List result = ColumnHierarchyListCopier.copyToBuilder(this.columnHierarchies);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setColumnHierarchies(Collection columnHierarchies) {
this.columnHierarchies = ColumnHierarchyListCopier.copyFromBuilder(columnHierarchies);
}
@Override
public final Builder columnHierarchies(Collection columnHierarchies) {
this.columnHierarchies = ColumnHierarchyListCopier.copy(columnHierarchies);
return this;
}
@Override
@SafeVarargs
public final Builder columnHierarchies(ColumnHierarchy... columnHierarchies) {
columnHierarchies(Arrays.asList(columnHierarchies));
return this;
}
@Override
@SafeVarargs
public final Builder columnHierarchies(Consumer... columnHierarchies) {
columnHierarchies(Stream.of(columnHierarchies).map(c -> ColumnHierarchy.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public ComboChartVisual build() {
return new ComboChartVisual(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}