software.amazon.awssdk.services.quicksight.model.LegendOptions 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.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 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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The options for the legend setup of a visual.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class LegendOptions implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField VISIBILITY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Visibility").getter(getter(LegendOptions::visibilityAsString)).setter(setter(Builder::visibility))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Visibility").build()).build();
private static final SdkField TITLE_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Title").getter(getter(LegendOptions::title)).setter(setter(Builder::title))
.constructor(LabelOptions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Title").build()).build();
private static final SdkField POSITION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Position").getter(getter(LegendOptions::positionAsString)).setter(setter(Builder::position))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Position").build()).build();
private static final SdkField WIDTH_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Width")
.getter(getter(LegendOptions::width)).setter(setter(Builder::width))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Width").build()).build();
private static final SdkField HEIGHT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Height")
.getter(getter(LegendOptions::height)).setter(setter(Builder::height))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Height").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(VISIBILITY_FIELD, TITLE_FIELD,
POSITION_FIELD, WIDTH_FIELD, HEIGHT_FIELD));
private static final long serialVersionUID = 1L;
private final String visibility;
private final LabelOptions title;
private final String position;
private final String width;
private final String height;
private LegendOptions(BuilderImpl builder) {
this.visibility = builder.visibility;
this.title = builder.title;
this.position = builder.position;
this.width = builder.width;
this.height = builder.height;
}
/**
*
* Determines whether or not the legend is visible.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #visibility} will
* return {@link Visibility#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #visibilityAsString}.
*
*
* @return Determines whether or not the legend is visible.
* @see Visibility
*/
public final Visibility visibility() {
return Visibility.fromValue(visibility);
}
/**
*
* Determines whether or not the legend is visible.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #visibility} will
* return {@link Visibility#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #visibilityAsString}.
*
*
* @return Determines whether or not the legend is visible.
* @see Visibility
*/
public final String visibilityAsString() {
return visibility;
}
/**
*
* The custom title for the legend.
*
*
* @return The custom title for the legend.
*/
public final LabelOptions title() {
return title;
}
/**
*
* The positions for the legend. Choose one of the following options:
*
*
* -
*
* AUTO
*
*
* -
*
* RIGHT
*
*
* -
*
* BOTTOM
*
*
* -
*
* LEFT
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #position} will
* return {@link LegendPosition#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #positionAsString}.
*
*
* @return The positions for the legend. Choose one of the following options:
*
* -
*
* AUTO
*
*
* -
*
* RIGHT
*
*
* -
*
* BOTTOM
*
*
* -
*
* LEFT
*
*
* @see LegendPosition
*/
public final LegendPosition position() {
return LegendPosition.fromValue(position);
}
/**
*
* The positions for the legend. Choose one of the following options:
*
*
* -
*
* AUTO
*
*
* -
*
* RIGHT
*
*
* -
*
* BOTTOM
*
*
* -
*
* LEFT
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #position} will
* return {@link LegendPosition#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #positionAsString}.
*
*
* @return The positions for the legend. Choose one of the following options:
*
* -
*
* AUTO
*
*
* -
*
* RIGHT
*
*
* -
*
* BOTTOM
*
*
* -
*
* LEFT
*
*
* @see LegendPosition
*/
public final String positionAsString() {
return position;
}
/**
*
* The width of the legend. If this value is omitted, a default width is used when rendering.
*
*
* @return The width of the legend. If this value is omitted, a default width is used when rendering.
*/
public final String width() {
return width;
}
/**
*
* The height of the legend. If this value is omitted, a default height is used when rendering.
*
*
* @return The height of the legend. If this value is omitted, a default height is used when rendering.
*/
public final String height() {
return height;
}
@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(visibilityAsString());
hashCode = 31 * hashCode + Objects.hashCode(title());
hashCode = 31 * hashCode + Objects.hashCode(positionAsString());
hashCode = 31 * hashCode + Objects.hashCode(width());
hashCode = 31 * hashCode + Objects.hashCode(height());
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 LegendOptions)) {
return false;
}
LegendOptions other = (LegendOptions) obj;
return Objects.equals(visibilityAsString(), other.visibilityAsString()) && Objects.equals(title(), other.title())
&& Objects.equals(positionAsString(), other.positionAsString()) && Objects.equals(width(), other.width())
&& Objects.equals(height(), other.height());
}
/**
* 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("LegendOptions").add("Visibility", visibilityAsString()).add("Title", title())
.add("Position", positionAsString()).add("Width", width()).add("Height", height()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Visibility":
return Optional.ofNullable(clazz.cast(visibilityAsString()));
case "Title":
return Optional.ofNullable(clazz.cast(title()));
case "Position":
return Optional.ofNullable(clazz.cast(positionAsString()));
case "Width":
return Optional.ofNullable(clazz.cast(width()));
case "Height":
return Optional.ofNullable(clazz.cast(height()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((LegendOptions) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Determines whether or not the legend is visible.
*
*
* @param visibility
* Determines whether or not the legend is visible.
* @see Visibility
* @return Returns a reference to this object so that method calls can be chained together.
* @see Visibility
*/
Builder visibility(String visibility);
/**
*
* Determines whether or not the legend is visible.
*
*
* @param visibility
* Determines whether or not the legend is visible.
* @see Visibility
* @return Returns a reference to this object so that method calls can be chained together.
* @see Visibility
*/
Builder visibility(Visibility visibility);
/**
*
* The custom title for the legend.
*
*
* @param title
* The custom title for the legend.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder title(LabelOptions title);
/**
*
* The custom title for the legend.
*
* This is a convenience method that creates an instance of the {@link LabelOptions.Builder} avoiding the need
* to create one manually via {@link LabelOptions#builder()}.
*
*
* When the {@link Consumer} completes, {@link LabelOptions.Builder#build()} is called immediately and its
* result is passed to {@link #title(LabelOptions)}.
*
* @param title
* a consumer that will call methods on {@link LabelOptions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #title(LabelOptions)
*/
default Builder title(Consumer title) {
return title(LabelOptions.builder().applyMutation(title).build());
}
/**
*
* The positions for the legend. Choose one of the following options:
*
*
* -
*
* AUTO
*
*
* -
*
* RIGHT
*
*
* -
*
* BOTTOM
*
*
* -
*
* LEFT
*
*
*
*
* @param position
* The positions for the legend. Choose one of the following options:
*
* -
*
* AUTO
*
*
* -
*
* RIGHT
*
*
* -
*
* BOTTOM
*
*
* -
*
* LEFT
*
*
* @see LegendPosition
* @return Returns a reference to this object so that method calls can be chained together.
* @see LegendPosition
*/
Builder position(String position);
/**
*
* The positions for the legend. Choose one of the following options:
*
*
* -
*
* AUTO
*
*
* -
*
* RIGHT
*
*
* -
*
* BOTTOM
*
*
* -
*
* LEFT
*
*
*
*
* @param position
* The positions for the legend. Choose one of the following options:
*
* -
*
* AUTO
*
*
* -
*
* RIGHT
*
*
* -
*
* BOTTOM
*
*
* -
*
* LEFT
*
*
* @see LegendPosition
* @return Returns a reference to this object so that method calls can be chained together.
* @see LegendPosition
*/
Builder position(LegendPosition position);
/**
*
* The width of the legend. If this value is omitted, a default width is used when rendering.
*
*
* @param width
* The width of the legend. If this value is omitted, a default width is used when rendering.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder width(String width);
/**
*
* The height of the legend. If this value is omitted, a default height is used when rendering.
*
*
* @param height
* The height of the legend. If this value is omitted, a default height is used when rendering.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder height(String height);
}
static final class BuilderImpl implements Builder {
private String visibility;
private LabelOptions title;
private String position;
private String width;
private String height;
private BuilderImpl() {
}
private BuilderImpl(LegendOptions model) {
visibility(model.visibility);
title(model.title);
position(model.position);
width(model.width);
height(model.height);
}
public final String getVisibility() {
return visibility;
}
public final void setVisibility(String visibility) {
this.visibility = visibility;
}
@Override
public final Builder visibility(String visibility) {
this.visibility = visibility;
return this;
}
@Override
public final Builder visibility(Visibility visibility) {
this.visibility(visibility == null ? null : visibility.toString());
return this;
}
public final LabelOptions.Builder getTitle() {
return title != null ? title.toBuilder() : null;
}
public final void setTitle(LabelOptions.BuilderImpl title) {
this.title = title != null ? title.build() : null;
}
@Override
public final Builder title(LabelOptions title) {
this.title = title;
return this;
}
public final String getPosition() {
return position;
}
public final void setPosition(String position) {
this.position = position;
}
@Override
public final Builder position(String position) {
this.position = position;
return this;
}
@Override
public final Builder position(LegendPosition position) {
this.position(position == null ? null : position.toString());
return this;
}
public final String getWidth() {
return width;
}
public final void setWidth(String width) {
this.width = width;
}
@Override
public final Builder width(String width) {
this.width = width;
return this;
}
public final String getHeight() {
return height;
}
public final void setHeight(String height) {
this.height = height;
}
@Override
public final Builder height(String height) {
this.height = height;
return this;
}
@Override
public LegendOptions build() {
return new LegendOptions(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}