software.amazon.awssdk.services.quicksight.model.SectionBasedLayoutConfiguration 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;
/**
*
* The configuration for a section-based layout.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SectionBasedLayoutConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> HEADER_SECTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("HeaderSections")
.getter(getter(SectionBasedLayoutConfiguration::headerSections))
.setter(setter(Builder::headerSections))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HeaderSections").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(HeaderFooterSectionConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> BODY_SECTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("BodySections")
.getter(getter(SectionBasedLayoutConfiguration::bodySections))
.setter(setter(Builder::bodySections))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BodySections").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(BodySectionConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> FOOTER_SECTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("FooterSections")
.getter(getter(SectionBasedLayoutConfiguration::footerSections))
.setter(setter(Builder::footerSections))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FooterSections").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(HeaderFooterSectionConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CANVAS_SIZE_OPTIONS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("CanvasSizeOptions")
.getter(getter(SectionBasedLayoutConfiguration::canvasSizeOptions)).setter(setter(Builder::canvasSizeOptions))
.constructor(SectionBasedLayoutCanvasSizeOptions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CanvasSizeOptions").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(HEADER_SECTIONS_FIELD,
BODY_SECTIONS_FIELD, FOOTER_SECTIONS_FIELD, CANVAS_SIZE_OPTIONS_FIELD));
private static final long serialVersionUID = 1L;
private final List headerSections;
private final List bodySections;
private final List footerSections;
private final SectionBasedLayoutCanvasSizeOptions canvasSizeOptions;
private SectionBasedLayoutConfiguration(BuilderImpl builder) {
this.headerSections = builder.headerSections;
this.bodySections = builder.bodySections;
this.footerSections = builder.footerSections;
this.canvasSizeOptions = builder.canvasSizeOptions;
}
/**
* For responses, this returns true if the service returned a value for the HeaderSections 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 hasHeaderSections() {
return headerSections != null && !(headerSections instanceof SdkAutoConstructList);
}
/**
*
* A list of header section configurations.
*
*
* 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 #hasHeaderSections} method.
*
*
* @return A list of header section configurations.
*/
public final List headerSections() {
return headerSections;
}
/**
* For responses, this returns true if the service returned a value for the BodySections 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 hasBodySections() {
return bodySections != null && !(bodySections instanceof SdkAutoConstructList);
}
/**
*
* A list of body section configurations.
*
*
* 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 #hasBodySections} method.
*
*
* @return A list of body section configurations.
*/
public final List bodySections() {
return bodySections;
}
/**
* For responses, this returns true if the service returned a value for the FooterSections 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 hasFooterSections() {
return footerSections != null && !(footerSections instanceof SdkAutoConstructList);
}
/**
*
* A list of footer section configurations.
*
*
* 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 #hasFooterSections} method.
*
*
* @return A list of footer section configurations.
*/
public final List footerSections() {
return footerSections;
}
/**
*
* The options for the canvas of a section-based layout.
*
*
* @return The options for the canvas of a section-based layout.
*/
public final SectionBasedLayoutCanvasSizeOptions canvasSizeOptions() {
return canvasSizeOptions;
}
@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(hasHeaderSections() ? headerSections() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasBodySections() ? bodySections() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasFooterSections() ? footerSections() : null);
hashCode = 31 * hashCode + Objects.hashCode(canvasSizeOptions());
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 SectionBasedLayoutConfiguration)) {
return false;
}
SectionBasedLayoutConfiguration other = (SectionBasedLayoutConfiguration) obj;
return hasHeaderSections() == other.hasHeaderSections() && Objects.equals(headerSections(), other.headerSections())
&& hasBodySections() == other.hasBodySections() && Objects.equals(bodySections(), other.bodySections())
&& hasFooterSections() == other.hasFooterSections() && Objects.equals(footerSections(), other.footerSections())
&& Objects.equals(canvasSizeOptions(), other.canvasSizeOptions());
}
/**
* 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("SectionBasedLayoutConfiguration")
.add("HeaderSections", hasHeaderSections() ? headerSections() : null)
.add("BodySections", hasBodySections() ? bodySections() : null)
.add("FooterSections", hasFooterSections() ? footerSections() : null)
.add("CanvasSizeOptions", canvasSizeOptions()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "HeaderSections":
return Optional.ofNullable(clazz.cast(headerSections()));
case "BodySections":
return Optional.ofNullable(clazz.cast(bodySections()));
case "FooterSections":
return Optional.ofNullable(clazz.cast(footerSections()));
case "CanvasSizeOptions":
return Optional.ofNullable(clazz.cast(canvasSizeOptions()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SectionBasedLayoutConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A list of header section configurations.
*
*
* @param headerSections
* A list of header section configurations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder headerSections(Collection headerSections);
/**
*
* A list of header section configurations.
*
*
* @param headerSections
* A list of header section configurations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder headerSections(HeaderFooterSectionConfiguration... headerSections);
/**
*
* A list of header section configurations.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.quicksight.model.HeaderFooterSectionConfiguration.Builder} avoiding
* the need to create one manually via
* {@link software.amazon.awssdk.services.quicksight.model.HeaderFooterSectionConfiguration#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.quicksight.model.HeaderFooterSectionConfiguration.Builder#build()} is
* called immediately and its result is passed to {@link
* #headerSections(List)}.
*
* @param headerSections
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.quicksight.model.HeaderFooterSectionConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #headerSections(java.util.Collection)
*/
Builder headerSections(Consumer... headerSections);
/**
*
* A list of body section configurations.
*
*
* @param bodySections
* A list of body section configurations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bodySections(Collection bodySections);
/**
*
* A list of body section configurations.
*
*
* @param bodySections
* A list of body section configurations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bodySections(BodySectionConfiguration... bodySections);
/**
*
* A list of body section configurations.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.quicksight.model.BodySectionConfiguration.Builder} avoiding the need
* to create one manually via
* {@link software.amazon.awssdk.services.quicksight.model.BodySectionConfiguration#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.quicksight.model.BodySectionConfiguration.Builder#build()} is called
* immediately and its result is passed to {@link #bodySections(List)}.
*
* @param bodySections
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.quicksight.model.BodySectionConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #bodySections(java.util.Collection)
*/
Builder bodySections(Consumer... bodySections);
/**
*
* A list of footer section configurations.
*
*
* @param footerSections
* A list of footer section configurations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder footerSections(Collection footerSections);
/**
*
* A list of footer section configurations.
*
*
* @param footerSections
* A list of footer section configurations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder footerSections(HeaderFooterSectionConfiguration... footerSections);
/**
*
* A list of footer section configurations.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.quicksight.model.HeaderFooterSectionConfiguration.Builder} avoiding
* the need to create one manually via
* {@link software.amazon.awssdk.services.quicksight.model.HeaderFooterSectionConfiguration#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.quicksight.model.HeaderFooterSectionConfiguration.Builder#build()} is
* called immediately and its result is passed to {@link
* #footerSections(List)}.
*
* @param footerSections
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.quicksight.model.HeaderFooterSectionConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #footerSections(java.util.Collection)
*/
Builder footerSections(Consumer... footerSections);
/**
*
* The options for the canvas of a section-based layout.
*
*
* @param canvasSizeOptions
* The options for the canvas of a section-based layout.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder canvasSizeOptions(SectionBasedLayoutCanvasSizeOptions canvasSizeOptions);
/**
*
* The options for the canvas of a section-based layout.
*
* This is a convenience method that creates an instance of the
* {@link SectionBasedLayoutCanvasSizeOptions.Builder} avoiding the need to create one manually via
* {@link SectionBasedLayoutCanvasSizeOptions#builder()}.
*
*
* When the {@link Consumer} completes, {@link SectionBasedLayoutCanvasSizeOptions.Builder#build()} is called
* immediately and its result is passed to {@link #canvasSizeOptions(SectionBasedLayoutCanvasSizeOptions)}.
*
* @param canvasSizeOptions
* a consumer that will call methods on {@link SectionBasedLayoutCanvasSizeOptions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #canvasSizeOptions(SectionBasedLayoutCanvasSizeOptions)
*/
default Builder canvasSizeOptions(Consumer canvasSizeOptions) {
return canvasSizeOptions(SectionBasedLayoutCanvasSizeOptions.builder().applyMutation(canvasSizeOptions).build());
}
}
static final class BuilderImpl implements Builder {
private List headerSections = DefaultSdkAutoConstructList.getInstance();
private List bodySections = DefaultSdkAutoConstructList.getInstance();
private List footerSections = DefaultSdkAutoConstructList.getInstance();
private SectionBasedLayoutCanvasSizeOptions canvasSizeOptions;
private BuilderImpl() {
}
private BuilderImpl(SectionBasedLayoutConfiguration model) {
headerSections(model.headerSections);
bodySections(model.bodySections);
footerSections(model.footerSections);
canvasSizeOptions(model.canvasSizeOptions);
}
public final List getHeaderSections() {
List result = HeaderFooterSectionConfigurationListCopier
.copyToBuilder(this.headerSections);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setHeaderSections(Collection headerSections) {
this.headerSections = HeaderFooterSectionConfigurationListCopier.copyFromBuilder(headerSections);
}
@Override
public final Builder headerSections(Collection headerSections) {
this.headerSections = HeaderFooterSectionConfigurationListCopier.copy(headerSections);
return this;
}
@Override
@SafeVarargs
public final Builder headerSections(HeaderFooterSectionConfiguration... headerSections) {
headerSections(Arrays.asList(headerSections));
return this;
}
@Override
@SafeVarargs
public final Builder headerSections(Consumer... headerSections) {
headerSections(Stream.of(headerSections)
.map(c -> HeaderFooterSectionConfiguration.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getBodySections() {
List result = BodySectionConfigurationListCopier.copyToBuilder(this.bodySections);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setBodySections(Collection bodySections) {
this.bodySections = BodySectionConfigurationListCopier.copyFromBuilder(bodySections);
}
@Override
public final Builder bodySections(Collection bodySections) {
this.bodySections = BodySectionConfigurationListCopier.copy(bodySections);
return this;
}
@Override
@SafeVarargs
public final Builder bodySections(BodySectionConfiguration... bodySections) {
bodySections(Arrays.asList(bodySections));
return this;
}
@Override
@SafeVarargs
public final Builder bodySections(Consumer... bodySections) {
bodySections(Stream.of(bodySections).map(c -> BodySectionConfiguration.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getFooterSections() {
List result = HeaderFooterSectionConfigurationListCopier
.copyToBuilder(this.footerSections);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFooterSections(Collection footerSections) {
this.footerSections = HeaderFooterSectionConfigurationListCopier.copyFromBuilder(footerSections);
}
@Override
public final Builder footerSections(Collection footerSections) {
this.footerSections = HeaderFooterSectionConfigurationListCopier.copy(footerSections);
return this;
}
@Override
@SafeVarargs
public final Builder footerSections(HeaderFooterSectionConfiguration... footerSections) {
footerSections(Arrays.asList(footerSections));
return this;
}
@Override
@SafeVarargs
public final Builder footerSections(Consumer... footerSections) {
footerSections(Stream.of(footerSections)
.map(c -> HeaderFooterSectionConfiguration.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final SectionBasedLayoutCanvasSizeOptions.Builder getCanvasSizeOptions() {
return canvasSizeOptions != null ? canvasSizeOptions.toBuilder() : null;
}
public final void setCanvasSizeOptions(SectionBasedLayoutCanvasSizeOptions.BuilderImpl canvasSizeOptions) {
this.canvasSizeOptions = canvasSizeOptions != null ? canvasSizeOptions.build() : null;
}
@Override
public final Builder canvasSizeOptions(SectionBasedLayoutCanvasSizeOptions canvasSizeOptions) {
this.canvasSizeOptions = canvasSizeOptions;
return this;
}
@Override
public SectionBasedLayoutConfiguration build() {
return new SectionBasedLayoutConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}