Package software.amazon.awssdk.services.quicksight.model

Class GenerateEmbedUrlForRegisteredUserWithIdentityRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.quicksight.model.QuickSightRequest

software.amazon.awssdk.services.quicksight.model.GenerateEmbedUrlForRegisteredUserWithIdentityRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builder,GenerateEmbedUrlForRegisteredUserWithIdentityRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GenerateEmbedUrlForRegisteredUserWithIdentityRequest
extends QuickSightRequest
implements ToCopyableBuilder<GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builder,GenerateEmbedUrlForRegisteredUserWithIdentityRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	allowedDomains()	A list of domains to be allowed to generate the embed URL.
String	awsAccountId()	The ID of the Amazon Web Services registered user.
static GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
RegisteredUserEmbeddingExperienceConfiguration	experienceConfiguration()	Returns the value of the ExperienceConfiguration property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAllowedDomains()	For responses, this returns true if the service returned a value for the AllowedDomains property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builder>	serializableBuilderClass()
Long	sessionLifetimeInMinutes()	The validity of the session in minutes.
GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

awsAccountId

public final String awsAccountId()

The ID of the Amazon Web Services registered user.

Returns:

The ID of the Amazon Web Services registered user.

sessionLifetimeInMinutes

public final Long sessionLifetimeInMinutes()

The validity of the session in minutes.

Returns:

The validity of the session in minutes.

experienceConfiguration

public final RegisteredUserEmbeddingExperienceConfiguration experienceConfiguration()

Returns the value of the ExperienceConfiguration property for this object.

Returns:

The value of the ExperienceConfiguration property for this object.

hasAllowedDomains

public final boolean hasAllowedDomains()

For responses, this returns true if the service returned a value for the AllowedDomains property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

allowedDomains

public final List<String> allowedDomains()

A list of domains to be allowed to generate the embed URL.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowedDomains() method.

Returns:

A list of domains to be allowed to generate the embed URL.

toBuilder

public GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builder,GenerateEmbedUrlForRegisteredUserWithIdentityRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo