@Generated(value="software.amazon.awssdk:codegen") public final class AuthResult extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AuthResult.Builder,AuthResult>
The authorizer result.
Modifier and Type | Class and Description |
---|---|
static interface |
AuthResult.Builder |
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.
|
copy
public final AuthInfo authInfo()
Authorization information.
public final Allowed allowed()
The policies and statements that allowed the specified action.
public final Denied denied()
The policies and statements that denied the specified action.
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()
.
AuthDecision
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()
.
AuthDecision
public final boolean hasMissingContextValues()
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.
public AuthResult.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<AuthResult.Builder,AuthResult>
public static AuthResult.Builder builder()
public static Class<? extends AuthResult.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()