software.amazon.awssdk.services.quicksight.model.GetSessionEmbedUrlRequest 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.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.awscore.AwsRequestOverrideConfiguration;
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 GetSessionEmbedUrlRequest extends QuickSightRequest implements
ToCopyableBuilder {
private static final SdkField AWS_ACCOUNT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AwsAccountId").getter(getter(GetSessionEmbedUrlRequest::awsAccountId))
.setter(setter(Builder::awsAccountId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("AwsAccountId").build()).build();
private static final SdkField ENTRY_POINT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EntryPoint").getter(getter(GetSessionEmbedUrlRequest::entryPoint)).setter(setter(Builder::entryPoint))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("entry-point").build()).build();
private static final SdkField SESSION_LIFETIME_IN_MINUTES_FIELD = SdkField. builder(MarshallingType.LONG)
.memberName("SessionLifetimeInMinutes").getter(getter(GetSessionEmbedUrlRequest::sessionLifetimeInMinutes))
.setter(setter(Builder::sessionLifetimeInMinutes))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("session-lifetime").build())
.build();
private static final SdkField USER_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UserArn").getter(getter(GetSessionEmbedUrlRequest::userArn)).setter(setter(Builder::userArn))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("user-arn").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AWS_ACCOUNT_ID_FIELD,
ENTRY_POINT_FIELD, SESSION_LIFETIME_IN_MINUTES_FIELD, USER_ARN_FIELD));
private final String awsAccountId;
private final String entryPoint;
private final Long sessionLifetimeInMinutes;
private final String userArn;
private GetSessionEmbedUrlRequest(BuilderImpl builder) {
super(builder);
this.awsAccountId = builder.awsAccountId;
this.entryPoint = builder.entryPoint;
this.sessionLifetimeInMinutes = builder.sessionLifetimeInMinutes;
this.userArn = builder.userArn;
}
/**
*
* The ID for the AWS account associated with your QuickSight subscription.
*
*
* @return The ID for the AWS account associated with your QuickSight subscription.
*/
public String awsAccountId() {
return awsAccountId;
}
/**
*
* The URL you use to access the embedded session. The entry point URL is constrained to the following paths:
*
*
* -
*
* /start
*
*
* -
*
* /start/analyses
*
*
* -
*
* /start/dashboards
*
*
* -
*
* /start/favorites
*
*
* -
*
* /dashboards/DashboardId - where DashboardId is the actual ID key from the
* QuickSight console URL of the dashboard
*
*
* -
*
* /analyses/AnalysisId - where AnalysisId is the actual ID key from the
* QuickSight console URL of the analysis
*
*
*
*
* @return The URL you use to access the embedded session. The entry point URL is constrained to the following
* paths:
*
* -
*
* /start
*
*
* -
*
* /start/analyses
*
*
* -
*
* /start/dashboards
*
*
* -
*
* /start/favorites
*
*
* -
*
* /dashboards/DashboardId - where DashboardId is the actual ID key from
* the QuickSight console URL of the dashboard
*
*
* -
*
* /analyses/AnalysisId - where AnalysisId is the actual ID key from the
* QuickSight console URL of the analysis
*
*
*/
public String entryPoint() {
return entryPoint;
}
/**
*
* How many minutes the session is valid. The session lifetime must be 15-600 minutes.
*
*
* @return How many minutes the session is valid. The session lifetime must be 15-600 minutes.
*/
public Long sessionLifetimeInMinutes() {
return sessionLifetimeInMinutes;
}
/**
*
* The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You
* can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to
* be authenticated as one of the following:
*
*
* -
*
* Active Directory (AD) users or group members
*
*
* -
*
* Invited nonfederated users
*
*
* -
*
* IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect,
* or IAM federation
*
*
*
*
* Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
*
*
* @return The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity
* type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or
* admins). They need to be authenticated as one of the following:
*
* -
*
* Active Directory (AD) users or group members
*
*
* -
*
* Invited nonfederated users
*
*
* -
*
* IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID
* Connect, or IAM federation
*
*
*
*
* Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
*/
public String userArn() {
return userArn;
}
@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(awsAccountId());
hashCode = 31 * hashCode + Objects.hashCode(entryPoint());
hashCode = 31 * hashCode + Objects.hashCode(sessionLifetimeInMinutes());
hashCode = 31 * hashCode + Objects.hashCode(userArn());
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 GetSessionEmbedUrlRequest)) {
return false;
}
GetSessionEmbedUrlRequest other = (GetSessionEmbedUrlRequest) obj;
return Objects.equals(awsAccountId(), other.awsAccountId()) && Objects.equals(entryPoint(), other.entryPoint())
&& Objects.equals(sessionLifetimeInMinutes(), other.sessionLifetimeInMinutes())
&& Objects.equals(userArn(), other.userArn());
}
/**
* 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("GetSessionEmbedUrlRequest").add("AwsAccountId", awsAccountId()).add("EntryPoint", entryPoint())
.add("SessionLifetimeInMinutes", sessionLifetimeInMinutes()).add("UserArn", userArn()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AwsAccountId":
return Optional.ofNullable(clazz.cast(awsAccountId()));
case "EntryPoint":
return Optional.ofNullable(clazz.cast(entryPoint()));
case "SessionLifetimeInMinutes":
return Optional.ofNullable(clazz.cast(sessionLifetimeInMinutes()));
case "UserArn":
return Optional.ofNullable(clazz.cast(userArn()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetSessionEmbedUrlRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID for the AWS account associated with your QuickSight subscription.
*
*
* @param awsAccountId
* The ID for the AWS account associated with your QuickSight subscription.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder awsAccountId(String awsAccountId);
/**
*
* The URL you use to access the embedded session. The entry point URL is constrained to the following paths:
*
*
* -
*
* /start
*
*
* -
*
* /start/analyses
*
*
* -
*
* /start/dashboards
*
*
* -
*
* /start/favorites
*
*
* -
*
* /dashboards/DashboardId - where DashboardId is the actual ID key from the
* QuickSight console URL of the dashboard
*
*
* -
*
* /analyses/AnalysisId - where AnalysisId is the actual ID key from the
* QuickSight console URL of the analysis
*
*
*
*
* @param entryPoint
* The URL you use to access the embedded session. The entry point URL is constrained to the following
* paths:
*
* -
*
* /start
*
*
* -
*
* /start/analyses
*
*
* -
*
* /start/dashboards
*
*
* -
*
* /start/favorites
*
*
* -
*
* /dashboards/DashboardId - where DashboardId is the actual ID key
* from the QuickSight console URL of the dashboard
*
*
* -
*
* /analyses/AnalysisId - where AnalysisId is the actual ID key from
* the QuickSight console URL of the analysis
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder entryPoint(String entryPoint);
/**
*
* How many minutes the session is valid. The session lifetime must be 15-600 minutes.
*
*
* @param sessionLifetimeInMinutes
* How many minutes the session is valid. The session lifetime must be 15-600 minutes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sessionLifetimeInMinutes(Long sessionLifetimeInMinutes);
/**
*
* The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.
* You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They
* need to be authenticated as one of the following:
*
*
* -
*
* Active Directory (AD) users or group members
*
*
* -
*
* Invited nonfederated users
*
*
* -
*
* IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID
* Connect, or IAM federation
*
*
*
*
* Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
*
*
* @param userArn
* The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity
* type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or
* admins). They need to be authenticated as one of the following:
*
* -
*
* Active Directory (AD) users or group members
*
*
* -
*
* Invited nonfederated users
*
*
* -
*
* IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML,
* OpenID Connect, or IAM federation
*
*
*
*
* Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userArn(String userArn);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends QuickSightRequest.BuilderImpl implements Builder {
private String awsAccountId;
private String entryPoint;
private Long sessionLifetimeInMinutes;
private String userArn;
private BuilderImpl() {
}
private BuilderImpl(GetSessionEmbedUrlRequest model) {
super(model);
awsAccountId(model.awsAccountId);
entryPoint(model.entryPoint);
sessionLifetimeInMinutes(model.sessionLifetimeInMinutes);
userArn(model.userArn);
}
public final String getAwsAccountId() {
return awsAccountId;
}
@Override
public final Builder awsAccountId(String awsAccountId) {
this.awsAccountId = awsAccountId;
return this;
}
public final void setAwsAccountId(String awsAccountId) {
this.awsAccountId = awsAccountId;
}
public final String getEntryPoint() {
return entryPoint;
}
@Override
public final Builder entryPoint(String entryPoint) {
this.entryPoint = entryPoint;
return this;
}
public final void setEntryPoint(String entryPoint) {
this.entryPoint = entryPoint;
}
public final Long getSessionLifetimeInMinutes() {
return sessionLifetimeInMinutes;
}
@Override
public final Builder sessionLifetimeInMinutes(Long sessionLifetimeInMinutes) {
this.sessionLifetimeInMinutes = sessionLifetimeInMinutes;
return this;
}
public final void setSessionLifetimeInMinutes(Long sessionLifetimeInMinutes) {
this.sessionLifetimeInMinutes = sessionLifetimeInMinutes;
}
public final String getUserArn() {
return userArn;
}
@Override
public final Builder userArn(String userArn) {
this.userArn = userArn;
return this;
}
public final void setUserArn(String userArn) {
this.userArn = userArn;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetSessionEmbedUrlRequest build() {
return new GetSessionEmbedUrlRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}