Package software.amazon.awssdk.services.elasticache.model

Class AuthenticationMode

java.lang.Object

software.amazon.awssdk.services.elasticache.model.AuthenticationMode

All Implemented Interfaces:

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

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

Specifies the authentication mode to use.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AuthenticationMode.Builder

Method Summary

Modifier and Type	Method	Description
static AuthenticationMode.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPasswords()	For responses, this returns true if the service returned a value for the Passwords property.
List<String>	passwords()	Specifies the passwords to use for authentication if Type is set to password.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AuthenticationMode.Builder>	serializableBuilderClass()
AuthenticationMode.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
InputAuthenticationType	type()	Specifies the authentication type.
String	typeAsString()	Specifies the authentication type.

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

type

public final InputAuthenticationType type()

Specifies the authentication type. Possible options are IAM authentication, password and no password.

If the service returns an enum value that is not available in the current SDK version, type will return InputAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Specifies the authentication type. Possible options are IAM authentication, password and no password.

See Also:

InputAuthenticationType

typeAsString

public final String typeAsString()

Specifies the authentication type. Possible options are IAM authentication, password and no password.

If the service returns an enum value that is not available in the current SDK version, type will return InputAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Specifies the authentication type. Possible options are IAM authentication, password and no password.

See Also:

InputAuthenticationType

hasPasswords

public final boolean hasPasswords()

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

passwords

public final List<String> passwords()

Specifies the passwords to use for authentication if Type is set to password.

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

Returns:

Specifies the passwords to use for authentication if Type is set to password.

toBuilder

public AuthenticationMode.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AuthenticationMode.Builder,AuthenticationMode>

builder

public static AuthenticationMode.Builder builder()

serializableBuilderClass

public static Class<? extends AuthenticationMode.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