software.amazon.awssdk.services.quicksight.model.GetDashboardEmbedUrlResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of quicksight Show documentation
Show all versions of quicksight Show documentation
The AWS Java SDK for QuickSight module holds the client classes that are used for
communicating with QuickSight.
/*
* 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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetDashboardEmbedUrlResponse extends QuickSightResponse implements
ToCopyableBuilder {
private static final SdkField EMBED_URL_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(GetDashboardEmbedUrlResponse::embedUrl)).setter(setter(Builder::embedUrl))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EmbedUrl").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.getter(getter(GetDashboardEmbedUrlResponse::status)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.STATUS_CODE).locationName("Status").build()).build();
private static final SdkField REQUEST_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(GetDashboardEmbedUrlResponse::requestId)).setter(setter(Builder::requestId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RequestId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(EMBED_URL_FIELD, STATUS_FIELD,
REQUEST_ID_FIELD));
private final String embedUrl;
private final Integer status;
private final String requestId;
private GetDashboardEmbedUrlResponse(BuilderImpl builder) {
super(builder);
this.embedUrl = builder.embedUrl;
this.status = builder.status;
this.requestId = builder.requestId;
}
/**
*
* An URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes,
* and the resulting session is valid for 10 hours. The API provides the URL with an auth_code value
* that enables a single sign-on session.
*
*
* @return An URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5
* minutes, and the resulting session is valid for 10 hours. The API provides the URL with an
* auth_code value that enables a single sign-on session.
*/
public String embedUrl() {
return embedUrl;
}
/**
*
* The HTTP status of the request.
*
*
* @return The HTTP status of the request.
*/
public Integer status() {
return status;
}
/**
*
* The AWS request ID for this operation.
*
*
* @return The AWS request ID for this operation.
*/
public String requestId() {
return requestId;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(embedUrl());
hashCode = 31 * hashCode + Objects.hashCode(status());
hashCode = 31 * hashCode + Objects.hashCode(requestId());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetDashboardEmbedUrlResponse)) {
return false;
}
GetDashboardEmbedUrlResponse other = (GetDashboardEmbedUrlResponse) obj;
return Objects.equals(embedUrl(), other.embedUrl()) && Objects.equals(status(), other.status())
&& Objects.equals(requestId(), other.requestId());
}
/**
* 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 String toString() {
return ToString.builder("GetDashboardEmbedUrlResponse")
.add("EmbedUrl", embedUrl() == null ? null : "*** Sensitive Data Redacted ***").add("Status", status())
.add("RequestId", requestId()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "EmbedUrl":
return Optional.ofNullable(clazz.cast(embedUrl()));
case "Status":
return Optional.ofNullable(clazz.cast(status()));
case "RequestId":
return Optional.ofNullable(clazz.cast(requestId()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetDashboardEmbedUrlResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends QuickSightResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* An URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5
* minutes, and the resulting session is valid for 10 hours. The API provides the URL with an
* auth_code value that enables a single sign-on session.
*
*
* @param embedUrl
* An URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5
* minutes, and the resulting session is valid for 10 hours. The API provides the URL with an
* auth_code value that enables a single sign-on session.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder embedUrl(String embedUrl);
/**
*
* The HTTP status of the request.
*
*
* @param status
* The HTTP status of the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder status(Integer status);
/**
*
* The AWS request ID for this operation.
*
*
* @param requestId
* The AWS request ID for this operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder requestId(String requestId);
}
static final class BuilderImpl extends QuickSightResponse.BuilderImpl implements Builder {
private String embedUrl;
private Integer status;
private String requestId;
private BuilderImpl() {
}
private BuilderImpl(GetDashboardEmbedUrlResponse model) {
super(model);
embedUrl(model.embedUrl);
status(model.status);
requestId(model.requestId);
}
public final String getEmbedUrl() {
return embedUrl;
}
@Override
public final Builder embedUrl(String embedUrl) {
this.embedUrl = embedUrl;
return this;
}
public final void setEmbedUrl(String embedUrl) {
this.embedUrl = embedUrl;
}
public final Integer getStatus() {
return status;
}
@Override
public final Builder status(Integer status) {
this.status = status;
return this;
}
public final void setStatus(Integer status) {
this.status = status;
}
public final String getRequestId() {
return requestId;
}
@Override
public final Builder requestId(String requestId) {
this.requestId = requestId;
return this;
}
public final void setRequestId(String requestId) {
this.requestId = requestId;
}
@Override
public GetDashboardEmbedUrlResponse build() {
return new GetDashboardEmbedUrlResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}