software.amazon.awssdk.services.iot.model

Class AuthResult

java.lang.Object

software.amazon.awssdk.services.iot.model.AuthResult

All Implemented Interfaces:

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

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

The authorizer result.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AuthResult.Builder

Method Summary

Modifier and Type	Method and Description
Allowed	allowed() The policies and statements that allowed the specified action.
AuthDecision	authDecision() The final authorization decision of this scenario.
String	authDecisionAsString() The final authorization decision of this scenario.
AuthInfo	authInfo() Authorization information.
static AuthResult.Builder	builder()
Denied	denied() The policies and statements that denied the specified action.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMissingContextValues() For responses, this returns true if the service returned a value for the MissingContextValues property.
List<String>	missingContextValues() Contains any missing context values found while evaluating policy.
List<SdkField<?>>	sdkFields()
static Class<? extends AuthResult.Builder>	serializableBuilderClass()
AuthResult.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

authInfo

public final AuthInfo authInfo()

Authorization information.

Returns:

Authorization information.

allowed

public final Allowed allowed()

The policies and statements that allowed the specified action.

Returns:

The policies and statements that allowed the specified action.

denied

public final Denied denied()

The policies and statements that denied the specified action.

Returns:

The policies and statements that denied the specified action.

authDecision

public final AuthDecision authDecision()

The final authorization decision of this scenario. Multiple statements are taken into account when determining the authorization decision. An explicit deny statement can override multiple allow statements.

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

Returns:

The final authorization decision of this scenario. Multiple statements are taken into account when determining the authorization decision. An explicit deny statement can override multiple allow statements.

See Also:

AuthDecision

authDecisionAsString

public final String authDecisionAsString()

The final authorization decision of this scenario. Multiple statements are taken into account when determining the authorization decision. An explicit deny statement can override multiple allow statements.

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

Returns:

The final authorization decision of this scenario. Multiple statements are taken into account when determining the authorization decision. An explicit deny statement can override multiple allow statements.

See Also:

AuthDecision

hasMissingContextValues

public final boolean hasMissingContextValues()

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

missingContextValues

public final List<String> missingContextValues()

Contains any missing context values found while evaluating policy.

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

Returns:

Contains any missing context values found while evaluating policy.

toBuilder

public AuthResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AuthResult.Builder,AuthResult>

builder

public static AuthResult.Builder builder()

serializableBuilderClass

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