software.amazon.awssdk.services.quicksight.model.AnonymousUserDashboardEmbeddingConfiguration Maven / Gradle / Ivy

Go to download
/*
 * 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.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;

/**
 * 
 * Information about the dashboard that you want to embed.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class AnonymousUserDashboardEmbeddingConfiguration implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField INITIAL_DASHBOARD_ID_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("InitialDashboardId").getter(getter(AnonymousUserDashboardEmbeddingConfiguration::initialDashboardId))
            .setter(setter(Builder::initialDashboardId))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InitialDashboardId").build())
            .build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INITIAL_DASHBOARD_ID_FIELD));

    private static final long serialVersionUID = 1L;

    private final String initialDashboardId;

    private AnonymousUserDashboardEmbeddingConfiguration(BuilderImpl builder) {
        this.initialDashboardId = builder.initialDashboardId;
    }

    /**
     * 
     * The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL.
     * When the URL in response is accessed, Amazon QuickSight renders this dashboard.
     * 
     * 
     * The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns
     * parameter. Otherwise, the request will fail with InvalidParameterValueException.
     * 
     * 
     * @return The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output
     *         URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.
     *         
     *         The Amazon Resource Name (ARN) of this dashboard must be included in the
     *         AuthorizedResourceArns parameter. Otherwise, the request will fail with
     *         InvalidParameterValueException.
     */
    public final String initialDashboardId() {
        return initialDashboardId;
    }

    @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(initialDashboardId());
        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 AnonymousUserDashboardEmbeddingConfiguration)) {
            return false;
        }
        AnonymousUserDashboardEmbeddingConfiguration other = (AnonymousUserDashboardEmbeddingConfiguration) obj;
        return Objects.equals(initialDashboardId(), other.initialDashboardId());
    }

    /**
     * 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("AnonymousUserDashboardEmbeddingConfiguration").add("InitialDashboardId", initialDashboardId())
                .build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "InitialDashboardId":
            return Optional.ofNullable(clazz.cast(initialDashboardId()));
        default:
            return Optional.empty();
        }
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    private static  Function getter(Function g) {
        return obj -> g.apply((AnonymousUserDashboardEmbeddingConfiguration) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 

         * The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output
         * URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.
         * 
         * 
         * The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns
         * parameter. Otherwise, the request will fail with InvalidParameterValueException.
         * 
         * 
         * @param initialDashboardId
         *        The dashboard ID for the dashboard that you want the user to see first. This ID is included in the
         *        output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.
         *        
         *        The Amazon Resource Name (ARN) of this dashboard must be included in the
         *        AuthorizedResourceArns parameter. Otherwise, the request will fail with
         *        InvalidParameterValueException.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder initialDashboardId(String initialDashboardId);
    }

    static final class BuilderImpl implements Builder {
        private String initialDashboardId;

        private BuilderImpl() {
        }

        private BuilderImpl(AnonymousUserDashboardEmbeddingConfiguration model) {
            initialDashboardId(model.initialDashboardId);
        }

        public final String getInitialDashboardId() {
            return initialDashboardId;
        }

        public final void setInitialDashboardId(String initialDashboardId) {
            this.initialDashboardId = initialDashboardId;
        }

        @Override
        public final Builder initialDashboardId(String initialDashboardId) {
            this.initialDashboardId = initialDashboardId;
            return this;
        }

        @Override
        public AnonymousUserDashboardEmbeddingConfiguration build() {
            return new AnonymousUserDashboardEmbeddingConfiguration(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}