AuthResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iot.model.AuthResult

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AuthResult
extends Object
implements Serializable, Cloneable, StructuredPojo

The authorizer result.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

AuthResult()

Constructors
Constructor and Description
`AuthResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthResult`	`clone()`
`boolean`	`equals(Object obj)`
`Allowed`	`getAllowed()` The policies and statements that allowed the specified action.
`String`	`getAuthDecision()` The final authorization decision of this scenario.
`AuthInfo`	`getAuthInfo()` Authorization information.
`Denied`	`getDenied()` The policies and statements that denied the specified action.
`List<String>`	`getMissingContextValues()` Contains any missing context values found while evaluating policy.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAllowed(Allowed allowed)` The policies and statements that allowed the specified action.
`void`	`setAuthDecision(String authDecision)` The final authorization decision of this scenario.
`void`	`setAuthInfo(AuthInfo authInfo)` Authorization information.
`void`	`setDenied(Denied denied)` The policies and statements that denied the specified action.
`void`	`setMissingContextValues(Collection<String> missingContextValues)` Contains any missing context values found while evaluating policy.
`String`	`toString()` Returns a string representation of this object.
`AuthResult`	`withAllowed(Allowed allowed)` The policies and statements that allowed the specified action.
`AuthResult`	`withAuthDecision(AuthDecision authDecision)` The final authorization decision of this scenario.
`AuthResult`	`withAuthDecision(String authDecision)` The final authorization decision of this scenario.
`AuthResult`	`withAuthInfo(AuthInfo authInfo)` Authorization information.
`AuthResult`	`withDenied(Denied denied)` The policies and statements that denied the specified action.
`AuthResult`	`withMissingContextValues(Collection<String> missingContextValues)` Contains any missing context values found while evaluating policy.
`AuthResult`	`withMissingContextValues(String... missingContextValues)` Contains any missing context values found while evaluating policy.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AuthResult
```
public AuthResult()
```
- Method Detail
  - setAuthInfo
```
public void setAuthInfo(AuthInfo authInfo)
```
    Authorization information.
    
    Parameters:
    
    authInfo - Authorization information.
  - getAuthInfo
```
public AuthInfo getAuthInfo()
```
    Authorization information.
    
    Returns:
    
    Authorization information.
  - withAuthInfo
```
public AuthResult withAuthInfo(AuthInfo authInfo)
```
    Authorization information.
    
    Parameters:
    
    authInfo - Authorization information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAllowed
```
public void setAllowed(Allowed allowed)
```
    The policies and statements that allowed the specified action.
    
    Parameters:
    
    allowed - The policies and statements that allowed the specified action.
  - getAllowed
```
public Allowed getAllowed()
```
    The policies and statements that allowed the specified action.
    
    Returns:
    
    The policies and statements that allowed the specified action.
  - withAllowed
```
public AuthResult withAllowed(Allowed allowed)
```
    The policies and statements that allowed the specified action.
    
    Parameters:
    
    allowed - The policies and statements that allowed the specified action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDenied
```
public void setDenied(Denied denied)
```
    The policies and statements that denied the specified action.
    
    Parameters:
    
    denied - The policies and statements that denied the specified action.
  - getDenied
```
public Denied getDenied()
```
    The policies and statements that denied the specified action.
    
    Returns:
    
    The policies and statements that denied the specified action.
  - withDenied
```
public AuthResult withDenied(Denied denied)
```
    The policies and statements that denied the specified action.
    
    Parameters:
    
    denied - The policies and statements that denied the specified action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthDecision
```
public void setAuthDecision(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    AuthDecision
  - getAuthDecision
```
public String getAuthDecision()
```
    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.
    
    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
  - withAuthDecision
```
public AuthResult withAuthDecision(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthDecision
  - withAuthDecision
```
public AuthResult withAuthDecision(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthDecision
  - getMissingContextValues
```
public List<String> getMissingContextValues()
```
    Contains any missing context values found while evaluating policy.
    
    Returns:
    
    Contains any missing context values found while evaluating policy.
  - setMissingContextValues
```
public void setMissingContextValues(Collection<String> missingContextValues)
```
    Contains any missing context values found while evaluating policy.
    
    Parameters:
    
    missingContextValues - Contains any missing context values found while evaluating policy.
  - withMissingContextValues
```
public AuthResult withMissingContextValues(String... missingContextValues)
```
    Contains any missing context values found while evaluating policy.
    
    NOTE: This method appends the values to the existing list (if any). Use setMissingContextValues(java.util.Collection) or withMissingContextValues(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    missingContextValues - Contains any missing context values found while evaluating policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMissingContextValues
```
public AuthResult withMissingContextValues(Collection<String> missingContextValues)
```
    Contains any missing context values found while evaluating policy.
    
    Parameters:
    
    missingContextValues - Contains any missing context values found while evaluating policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AuthResult clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class AuthResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AuthResult

Method Detail

setAuthInfo

getAuthInfo

withAuthInfo

setAllowed

getAllowed

withAllowed

setDenied

getDenied

withDenied

setAuthDecision

getAuthDecision

withAuthDecision

withAuthDecision

getMissingContextValues

setMissingContextValues

withMissingContextValues

withMissingContextValues

toString

equals

hashCode

clone

marshall