software.amazon.awssdk.services.quicksight.model.PivotTableFieldOptions 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 field options for a pivot table visual.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PivotTableFieldOptions implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> SELECTED_FIELD_OPTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SelectedFieldOptions")
.getter(getter(PivotTableFieldOptions::selectedFieldOptions))
.setter(setter(Builder::selectedFieldOptions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SelectedFieldOptions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PivotTableFieldOption::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> DATA_PATH_OPTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("DataPathOptions")
.getter(getter(PivotTableFieldOptions::dataPathOptions))
.setter(setter(Builder::dataPathOptions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DataPathOptions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PivotTableDataPathOption::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> COLLAPSE_STATE_OPTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("CollapseStateOptions")
.getter(getter(PivotTableFieldOptions::collapseStateOptions))
.setter(setter(Builder::collapseStateOptions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CollapseStateOptions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PivotTableFieldCollapseStateOption::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SELECTED_FIELD_OPTIONS_FIELD,
DATA_PATH_OPTIONS_FIELD, COLLAPSE_STATE_OPTIONS_FIELD));
private static final long serialVersionUID = 1L;
private final List selectedFieldOptions;
private final List dataPathOptions;
private final List collapseStateOptions;
private PivotTableFieldOptions(BuilderImpl builder) {
this.selectedFieldOptions = builder.selectedFieldOptions;
this.dataPathOptions = builder.dataPathOptions;
this.collapseStateOptions = builder.collapseStateOptions;
}
/**
* For responses, this returns true if the service returned a value for the SelectedFieldOptions 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 hasSelectedFieldOptions() {
return selectedFieldOptions != null && !(selectedFieldOptions instanceof SdkAutoConstructList);
}
/**
*
* The selected field options for the pivot table field options.
*
*
* 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 #hasSelectedFieldOptions} method.
*
*
* @return The selected field options for the pivot table field options.
*/
public final List selectedFieldOptions() {
return selectedFieldOptions;
}
/**
* For responses, this returns true if the service returned a value for the DataPathOptions 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 hasDataPathOptions() {
return dataPathOptions != null && !(dataPathOptions instanceof SdkAutoConstructList);
}
/**
*
* The data path options for the pivot table field options.
*
*
* 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 #hasDataPathOptions} method.
*
*
* @return The data path options for the pivot table field options.
*/
public final List dataPathOptions() {
return dataPathOptions;
}
/**
* For responses, this returns true if the service returned a value for the CollapseStateOptions 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 hasCollapseStateOptions() {
return collapseStateOptions != null && !(collapseStateOptions instanceof SdkAutoConstructList);
}
/**
*
* The collapse state options for the pivot table field options.
*
*
* 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 #hasCollapseStateOptions} method.
*
*
* @return The collapse state options for the pivot table field options.
*/
public final List collapseStateOptions() {
return collapseStateOptions;
}
@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(hasSelectedFieldOptions() ? selectedFieldOptions() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasDataPathOptions() ? dataPathOptions() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasCollapseStateOptions() ? collapseStateOptions() : 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 PivotTableFieldOptions)) {
return false;
}
PivotTableFieldOptions other = (PivotTableFieldOptions) obj;
return hasSelectedFieldOptions() == other.hasSelectedFieldOptions()
&& Objects.equals(selectedFieldOptions(), other.selectedFieldOptions())
&& hasDataPathOptions() == other.hasDataPathOptions()
&& Objects.equals(dataPathOptions(), other.dataPathOptions())
&& hasCollapseStateOptions() == other.hasCollapseStateOptions()
&& Objects.equals(collapseStateOptions(), other.collapseStateOptions());
}
/**
* 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("PivotTableFieldOptions")
.add("SelectedFieldOptions", hasSelectedFieldOptions() ? selectedFieldOptions() : null)
.add("DataPathOptions", hasDataPathOptions() ? dataPathOptions() : null)
.add("CollapseStateOptions", hasCollapseStateOptions() ? collapseStateOptions() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SelectedFieldOptions":
return Optional.ofNullable(clazz.cast(selectedFieldOptions()));
case "DataPathOptions":
return Optional.ofNullable(clazz.cast(dataPathOptions()));
case "CollapseStateOptions":
return Optional.ofNullable(clazz.cast(collapseStateOptions()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PivotTableFieldOptions) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The selected field options for the pivot table field options.
*
*
* @param selectedFieldOptions
* The selected field options for the pivot table field options.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder selectedFieldOptions(Collection selectedFieldOptions);
/**
*
* The selected field options for the pivot table field options.
*
*
* @param selectedFieldOptions
* The selected field options for the pivot table field options.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder selectedFieldOptions(PivotTableFieldOption... selectedFieldOptions);
/**
*
* The selected field options for the pivot table field options.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.quicksight.model.PivotTableFieldOption.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.quicksight.model.PivotTableFieldOption#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.quicksight.model.PivotTableFieldOption.Builder#build()} is called
* immediately and its result is passed to {@link #selectedFieldOptions(List)}.
*
* @param selectedFieldOptions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.quicksight.model.PivotTableFieldOption.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #selectedFieldOptions(java.util.Collection)
*/
Builder selectedFieldOptions(Consumer... selectedFieldOptions);
/**
*
* The data path options for the pivot table field options.
*
*
* @param dataPathOptions
* The data path options for the pivot table field options.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataPathOptions(Collection dataPathOptions);
/**
*
* The data path options for the pivot table field options.
*
*
* @param dataPathOptions
* The data path options for the pivot table field options.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataPathOptions(PivotTableDataPathOption... dataPathOptions);
/**
*
* The data path options for the pivot table field options.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.quicksight.model.PivotTableDataPathOption.Builder} avoiding the need
* to create one manually via
* {@link software.amazon.awssdk.services.quicksight.model.PivotTableDataPathOption#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.quicksight.model.PivotTableDataPathOption.Builder#build()} is called
* immediately and its result is passed to {@link #dataPathOptions(List)}.
*
* @param dataPathOptions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.quicksight.model.PivotTableDataPathOption.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #dataPathOptions(java.util.Collection)
*/
Builder dataPathOptions(Consumer... dataPathOptions);
/**
*
* The collapse state options for the pivot table field options.
*
*
* @param collapseStateOptions
* The collapse state options for the pivot table field options.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder collapseStateOptions(Collection collapseStateOptions);
/**
*
* The collapse state options for the pivot table field options.
*
*
* @param collapseStateOptions
* The collapse state options for the pivot table field options.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder collapseStateOptions(PivotTableFieldCollapseStateOption... collapseStateOptions);
/**
*
* The collapse state options for the pivot table field options.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.quicksight.model.PivotTableFieldCollapseStateOption.Builder} avoiding
* the need to create one manually via
* {@link software.amazon.awssdk.services.quicksight.model.PivotTableFieldCollapseStateOption#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.quicksight.model.PivotTableFieldCollapseStateOption.Builder#build()}
* is called immediately and its result is passed to {@link
* #collapseStateOptions(List)}.
*
* @param collapseStateOptions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.quicksight.model.PivotTableFieldCollapseStateOption.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #collapseStateOptions(java.util.Collection)
*/
Builder collapseStateOptions(Consumer... collapseStateOptions);
}
static final class BuilderImpl implements Builder {
private List selectedFieldOptions = DefaultSdkAutoConstructList.getInstance();
private List dataPathOptions = DefaultSdkAutoConstructList.getInstance();
private List collapseStateOptions = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(PivotTableFieldOptions model) {
selectedFieldOptions(model.selectedFieldOptions);
dataPathOptions(model.dataPathOptions);
collapseStateOptions(model.collapseStateOptions);
}
public final List getSelectedFieldOptions() {
List result = PivotTableFieldOptionListCopier.copyToBuilder(this.selectedFieldOptions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setSelectedFieldOptions(Collection selectedFieldOptions) {
this.selectedFieldOptions = PivotTableFieldOptionListCopier.copyFromBuilder(selectedFieldOptions);
}
@Override
public final Builder selectedFieldOptions(Collection selectedFieldOptions) {
this.selectedFieldOptions = PivotTableFieldOptionListCopier.copy(selectedFieldOptions);
return this;
}
@Override
@SafeVarargs
public final Builder selectedFieldOptions(PivotTableFieldOption... selectedFieldOptions) {
selectedFieldOptions(Arrays.asList(selectedFieldOptions));
return this;
}
@Override
@SafeVarargs
public final Builder selectedFieldOptions(Consumer... selectedFieldOptions) {
selectedFieldOptions(Stream.of(selectedFieldOptions)
.map(c -> PivotTableFieldOption.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getDataPathOptions() {
List result = PivotTableDataPathOptionListCopier
.copyToBuilder(this.dataPathOptions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDataPathOptions(Collection dataPathOptions) {
this.dataPathOptions = PivotTableDataPathOptionListCopier.copyFromBuilder(dataPathOptions);
}
@Override
public final Builder dataPathOptions(Collection dataPathOptions) {
this.dataPathOptions = PivotTableDataPathOptionListCopier.copy(dataPathOptions);
return this;
}
@Override
@SafeVarargs
public final Builder dataPathOptions(PivotTableDataPathOption... dataPathOptions) {
dataPathOptions(Arrays.asList(dataPathOptions));
return this;
}
@Override
@SafeVarargs
public final Builder dataPathOptions(Consumer... dataPathOptions) {
dataPathOptions(Stream.of(dataPathOptions).map(c -> PivotTableDataPathOption.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getCollapseStateOptions() {
List result = PivotTableFieldCollapseStateOptionListCopier
.copyToBuilder(this.collapseStateOptions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setCollapseStateOptions(Collection collapseStateOptions) {
this.collapseStateOptions = PivotTableFieldCollapseStateOptionListCopier.copyFromBuilder(collapseStateOptions);
}
@Override
public final Builder collapseStateOptions(Collection collapseStateOptions) {
this.collapseStateOptions = PivotTableFieldCollapseStateOptionListCopier.copy(collapseStateOptions);
return this;
}
@Override
@SafeVarargs
public final Builder collapseStateOptions(PivotTableFieldCollapseStateOption... collapseStateOptions) {
collapseStateOptions(Arrays.asList(collapseStateOptions));
return this;
}
@Override
@SafeVarargs
public final Builder collapseStateOptions(Consumer... collapseStateOptions) {
collapseStateOptions(Stream.of(collapseStateOptions)
.map(c -> PivotTableFieldCollapseStateOption.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public PivotTableFieldOptions build() {
return new PivotTableFieldOptions(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}