software.amazon.awssdk.services.quicksight.model.SheetVisualScopingConfiguration Maven / Gradle / Ivy
/*
* 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.Function;
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 filter that is applied to the options.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SheetVisualScopingConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField SHEET_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SheetId").getter(getter(SheetVisualScopingConfiguration::sheetId)).setter(setter(Builder::sheetId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SheetId").build()).build();
private static final SdkField SCOPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Scope")
.getter(getter(SheetVisualScopingConfiguration::scopeAsString)).setter(setter(Builder::scope))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Scope").build()).build();
private static final SdkField> VISUAL_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("VisualIds")
.getter(getter(SheetVisualScopingConfiguration::visualIds))
.setter(setter(Builder::visualIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VisualIds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SHEET_ID_FIELD, SCOPE_FIELD,
VISUAL_IDS_FIELD));
private static final long serialVersionUID = 1L;
private final String sheetId;
private final String scope;
private final List visualIds;
private SheetVisualScopingConfiguration(BuilderImpl builder) {
this.sheetId = builder.sheetId;
this.scope = builder.scope;
this.visualIds = builder.visualIds;
}
/**
*
* The selected sheet that the filter is applied to.
*
*
* @return The selected sheet that the filter is applied to.
*/
public final String sheetId() {
return sheetId;
}
/**
*
* The scope of the applied entities. Choose one of the following options:
*
*
* -
*
* ALL_VISUALS
*
*
* -
*
* SELECTED_VISUALS
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #scope} will return
* {@link FilterVisualScope#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #scopeAsString}.
*
*
* @return The scope of the applied entities. Choose one of the following options:
*
* -
*
* ALL_VISUALS
*
*
* -
*
* SELECTED_VISUALS
*
*
* @see FilterVisualScope
*/
public final FilterVisualScope scope() {
return FilterVisualScope.fromValue(scope);
}
/**
*
* The scope of the applied entities. Choose one of the following options:
*
*
* -
*
* ALL_VISUALS
*
*
* -
*
* SELECTED_VISUALS
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #scope} will return
* {@link FilterVisualScope#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #scopeAsString}.
*
*
* @return The scope of the applied entities. Choose one of the following options:
*
* -
*
* ALL_VISUALS
*
*
* -
*
* SELECTED_VISUALS
*
*
* @see FilterVisualScope
*/
public final String scopeAsString() {
return scope;
}
/**
* For responses, this returns true if the service returned a value for the VisualIds 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 hasVisualIds() {
return visualIds != null && !(visualIds instanceof SdkAutoConstructList);
}
/**
*
* The selected visuals that the filter is applied to.
*
*
* 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 #hasVisualIds} method.
*
*
* @return The selected visuals that the filter is applied to.
*/
public final List visualIds() {
return visualIds;
}
@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(sheetId());
hashCode = 31 * hashCode + Objects.hashCode(scopeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasVisualIds() ? visualIds() : 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 SheetVisualScopingConfiguration)) {
return false;
}
SheetVisualScopingConfiguration other = (SheetVisualScopingConfiguration) obj;
return Objects.equals(sheetId(), other.sheetId()) && Objects.equals(scopeAsString(), other.scopeAsString())
&& hasVisualIds() == other.hasVisualIds() && Objects.equals(visualIds(), other.visualIds());
}
/**
* 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("SheetVisualScopingConfiguration").add("SheetId", sheetId()).add("Scope", scopeAsString())
.add("VisualIds", hasVisualIds() ? visualIds() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SheetId":
return Optional.ofNullable(clazz.cast(sheetId()));
case "Scope":
return Optional.ofNullable(clazz.cast(scopeAsString()));
case "VisualIds":
return Optional.ofNullable(clazz.cast(visualIds()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SheetVisualScopingConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The selected sheet that the filter is applied to.
*
*
* @param sheetId
* The selected sheet that the filter is applied to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sheetId(String sheetId);
/**
*
* The scope of the applied entities. Choose one of the following options:
*
*
* -
*
* ALL_VISUALS
*
*
* -
*
* SELECTED_VISUALS
*
*
*
*
* @param scope
* The scope of the applied entities. Choose one of the following options:
*
* -
*
* ALL_VISUALS
*
*
* -
*
* SELECTED_VISUALS
*
*
* @see FilterVisualScope
* @return Returns a reference to this object so that method calls can be chained together.
* @see FilterVisualScope
*/
Builder scope(String scope);
/**
*
* The scope of the applied entities. Choose one of the following options:
*
*
* -
*
* ALL_VISUALS
*
*
* -
*
* SELECTED_VISUALS
*
*
*
*
* @param scope
* The scope of the applied entities. Choose one of the following options:
*
* -
*
* ALL_VISUALS
*
*
* -
*
* SELECTED_VISUALS
*
*
* @see FilterVisualScope
* @return Returns a reference to this object so that method calls can be chained together.
* @see FilterVisualScope
*/
Builder scope(FilterVisualScope scope);
/**
*
* The selected visuals that the filter is applied to.
*
*
* @param visualIds
* The selected visuals that the filter is applied to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder visualIds(Collection visualIds);
/**
*
* The selected visuals that the filter is applied to.
*
*
* @param visualIds
* The selected visuals that the filter is applied to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder visualIds(String... visualIds);
}
static final class BuilderImpl implements Builder {
private String sheetId;
private String scope;
private List visualIds = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(SheetVisualScopingConfiguration model) {
sheetId(model.sheetId);
scope(model.scope);
visualIds(model.visualIds);
}
public final String getSheetId() {
return sheetId;
}
public final void setSheetId(String sheetId) {
this.sheetId = sheetId;
}
@Override
public final Builder sheetId(String sheetId) {
this.sheetId = sheetId;
return this;
}
public final String getScope() {
return scope;
}
public final void setScope(String scope) {
this.scope = scope;
}
@Override
public final Builder scope(String scope) {
this.scope = scope;
return this;
}
@Override
public final Builder scope(FilterVisualScope scope) {
this.scope(scope == null ? null : scope.toString());
return this;
}
public final Collection getVisualIds() {
if (visualIds instanceof SdkAutoConstructList) {
return null;
}
return visualIds;
}
public final void setVisualIds(Collection visualIds) {
this.visualIds = FilteredVisualsListCopier.copy(visualIds);
}
@Override
public final Builder visualIds(Collection visualIds) {
this.visualIds = FilteredVisualsListCopier.copy(visualIds);
return this;
}
@Override
@SafeVarargs
public final Builder visualIds(String... visualIds) {
visualIds(Arrays.asList(visualIds));
return this;
}
@Override
public SheetVisualScopingConfiguration build() {
return new SheetVisualScopingConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}