software.amazon.awssdk.services.quicksight.model.RegisteredUserDashboardVisualEmbeddingConfiguration 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.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 experience that you are embedding. You can use this object to generate a url that embeds a visual into your
* application.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RegisteredUserDashboardVisualEmbeddingConfiguration
implements
SdkPojo,
Serializable,
ToCopyableBuilder {
private static final SdkField INITIAL_DASHBOARD_VISUAL_ID_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("InitialDashboardVisualId")
.getter(getter(RegisteredUserDashboardVisualEmbeddingConfiguration::initialDashboardVisualId))
.setter(setter(Builder::initialDashboardVisualId)).constructor(DashboardVisualId::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InitialDashboardVisualId").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays
.asList(INITIAL_DASHBOARD_VISUAL_ID_FIELD));
private static final long serialVersionUID = 1L;
private final DashboardVisualId initialDashboardVisualId;
private RegisteredUserDashboardVisualEmbeddingConfiguration(BuilderImpl builder) {
this.initialDashboardVisualId = builder.initialDashboardVisualId;
}
/**
*
* The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL
* in response is accessed, Amazon QuickSight renders this visual.
*
*
* The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the
* AuthorizedResourceArns parameter. Otherwise, the request will fail with
* InvalidParameterValueException.
*
*
* @return The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When
* the URL in response is accessed, Amazon QuickSight renders this visual.
*
* The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the
* AuthorizedResourceArns parameter. Otherwise, the request will fail with
* InvalidParameterValueException.
*/
public final DashboardVisualId initialDashboardVisualId() {
return initialDashboardVisualId;
}
@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(initialDashboardVisualId());
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 RegisteredUserDashboardVisualEmbeddingConfiguration)) {
return false;
}
RegisteredUserDashboardVisualEmbeddingConfiguration other = (RegisteredUserDashboardVisualEmbeddingConfiguration) obj;
return Objects.equals(initialDashboardVisualId(), other.initialDashboardVisualId());
}
/**
* 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("RegisteredUserDashboardVisualEmbeddingConfiguration")
.add("InitialDashboardVisualId", initialDashboardVisualId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InitialDashboardVisualId":
return Optional.ofNullable(clazz.cast(initialDashboardVisualId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RegisteredUserDashboardVisualEmbeddingConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the
* URL in response is accessed, Amazon QuickSight renders this visual.
*
*
* The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the
* AuthorizedResourceArns parameter. Otherwise, the request will fail with
* InvalidParameterValueException.
*
*
* @param initialDashboardVisualId
* The visual ID for the visual that you want the user to embed. This ID is included in the output URL.
* When the URL in response is accessed, Amazon QuickSight renders this visual.
*
* The Amazon Resource Name (ARN) of the dashboard that the visual belongs to 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 initialDashboardVisualId(DashboardVisualId initialDashboardVisualId);
/**
*
* The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the
* URL in response is accessed, Amazon QuickSight renders this visual.
*
*
* The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the
* AuthorizedResourceArns parameter. Otherwise, the request will fail with
* InvalidParameterValueException.
*
* This is a convenience method that creates an instance of the {@link DashboardVisualId.Builder} avoiding the
* need to create one manually via {@link DashboardVisualId#builder()}.
*
*
* When the {@link Consumer} completes, {@link DashboardVisualId.Builder#build()} is called immediately and its
* result is passed to {@link #initialDashboardVisualId(DashboardVisualId)}.
*
* @param initialDashboardVisualId
* a consumer that will call methods on {@link DashboardVisualId.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #initialDashboardVisualId(DashboardVisualId)
*/
default Builder initialDashboardVisualId(Consumer initialDashboardVisualId) {
return initialDashboardVisualId(DashboardVisualId.builder().applyMutation(initialDashboardVisualId).build());
}
}
static final class BuilderImpl implements Builder {
private DashboardVisualId initialDashboardVisualId;
private BuilderImpl() {
}
private BuilderImpl(RegisteredUserDashboardVisualEmbeddingConfiguration model) {
initialDashboardVisualId(model.initialDashboardVisualId);
}
public final DashboardVisualId.Builder getInitialDashboardVisualId() {
return initialDashboardVisualId != null ? initialDashboardVisualId.toBuilder() : null;
}
public final void setInitialDashboardVisualId(DashboardVisualId.BuilderImpl initialDashboardVisualId) {
this.initialDashboardVisualId = initialDashboardVisualId != null ? initialDashboardVisualId.build() : null;
}
@Override
public final Builder initialDashboardVisualId(DashboardVisualId initialDashboardVisualId) {
this.initialDashboardVisualId = initialDashboardVisualId;
return this;
}
@Override
public RegisteredUserDashboardVisualEmbeddingConfiguration build() {
return new RegisteredUserDashboardVisualEmbeddingConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}