Class AuthResult
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AuthResult.Builder,
AuthResult>
The authorizer result.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Allowed
allowed()
The policies and statements that allowed the specified action.final AuthDecision
The final authorization decision of this scenario.final String
The final authorization decision of this scenario.final AuthInfo
authInfo()
Authorization information.static AuthResult.Builder
builder()
final Denied
denied()
The policies and statements that denied the specified action.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MissingContextValues property.Contains any missing context values found while evaluating policy.static Class
<? extends AuthResult.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
authInfo
Authorization information.
- Returns:
- Authorization information.
-
allowed
The policies and statements that allowed the specified action.
- Returns:
- The policies and statements that allowed the specified action.
-
denied
The policies and statements that denied the specified action.
- Returns:
- The policies and statements that denied the specified action.
-
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 returnAuthDecision.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthDecisionAsString()
.- 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:
-
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 returnAuthDecision.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthDecisionAsString()
.- 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:
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<AuthResult.Builder,
AuthResult> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-