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

Class CredentialPair

java.lang.Object

software.amazon.awssdk.services.quicksight.model.CredentialPair

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CredentialPair.Builder,CredentialPair>

@Generated("software.amazon.awssdk:codegen")
public final class CredentialPair
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CredentialPair.Builder,CredentialPair>

The combination of user name and password that are used as credentials.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CredentialPair.Builder

Method Summary

Modifier and Type	Method	Description
List<DataSourceParameters>	alternateDataSourceParameters()	A set of alternate data source parameters that you want to share for these credentials.
static CredentialPair.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAlternateDataSourceParameters()	For responses, this returns true if the service returned a value for the AlternateDataSourceParameters property.
int	hashCode()
String	password()	Password.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CredentialPair.Builder>	serializableBuilderClass()
CredentialPair.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	username()	User name.

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

username

public final String username()

User name.

Returns:

User name.

password

public final String password()

Password.

Returns:

Password.

hasAlternateDataSourceParameters

public final boolean hasAlternateDataSourceParameters()

For responses, this returns true if the service returned a value for the AlternateDataSourceParameters 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.

alternateDataSourceParameters

public final List<DataSourceParameters> alternateDataSourceParameters()

A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.

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 hasAlternateDataSourceParameters() method.

Returns:

A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.

toBuilder

public CredentialPair.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CredentialPair.Builder,CredentialPair>

builder

public static CredentialPair.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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