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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMissingContextValues() Returns true if the MissingContextValues property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	missingContextValues() Contains any missing context values found while evaluating policy.
List<SdkField<?>>	sdkFields()
static Class<? extends AuthResult.Builder>	serializableBuilderClass()
AuthResult.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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()

Returns true if the MissingContextValues property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasMissingContextValues() to see if a value was sent in this field.

Returns:

Contains any missing context values found while evaluating policy.

toBuilder

public AuthResult.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AuthResult.Builder,AuthResult>

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.