Package software.amazon.awssdk.services.chime.model

Class UserError

java.lang.Object

software.amazon.awssdk.services.chime.model.UserError

All Implemented Interfaces:

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

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

The list of errors returned when errors are encountered during the BatchSuspendUser, BatchUnsuspendUser, or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UserError.Builder

Method Summary

Modifier and Type	Method	Description
static UserError.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorCode	errorCode()	The error code.
String	errorCodeAsString()	The error code.
String	errorMessage()	The error message.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends UserError.Builder>	serializableBuilderClass()
UserError.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userId()	The user ID for which the action failed.

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

userId

public final String userId()

The user ID for which the action failed.

Returns:

The user ID for which the action failed.

errorCode

public final ErrorCode errorCode()

The error code.

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

Returns:

The error code.

See Also:

ErrorCode

errorCodeAsString

public final String errorCodeAsString()

The error code.

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

Returns:

The error code.

See Also:

ErrorCode

errorMessage

public final String errorMessage()

The error message.

Returns:

The error message.

toBuilder

public UserError.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UserError.Builder,UserError>

builder

public static UserError.Builder builder()

serializableBuilderClass

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