TestAuthorizationRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.iot.model.TestAuthorizationRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class TestAuthorizationRequest
extends AmazonWebServiceRequest
implements Serializable
```
Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

TestAuthorizationRequest()

Constructors
Constructor and Description
`TestAuthorizationRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`List<AuthInfo>`	`getAuthInfos()` A list of authorization info objects.
`String`	`getClientId()` The MQTT client ID.
`String`	`getCognitoIdentityPoolId()` The Cognito identity pool ID.
`List<String>`	`getPolicyNamesToAdd()` When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
`List<String>`	`getPolicyNamesToSkip()` When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
`String`	`getPrincipal()` The principal.
`int`	`hashCode()`
`void`	`setAuthInfos(Collection<AuthInfo> authInfos)` A list of authorization info objects.
`void`	`setClientId(String clientId)` The MQTT client ID.
`void`	`setCognitoIdentityPoolId(String cognitoIdentityPoolId)` The Cognito identity pool ID.
`void`	`setPolicyNamesToAdd(Collection<String> policyNamesToAdd)` When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
`void`	`setPolicyNamesToSkip(Collection<String> policyNamesToSkip)` When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
`void`	`setPrincipal(String principal)` The principal.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`TestAuthorizationRequest`	`withAuthInfos(AuthInfo... authInfos)` A list of authorization info objects.
`TestAuthorizationRequest`	`withAuthInfos(Collection<AuthInfo> authInfos)` A list of authorization info objects.
`TestAuthorizationRequest`	`withClientId(String clientId)` The MQTT client ID.
`TestAuthorizationRequest`	`withCognitoIdentityPoolId(String cognitoIdentityPoolId)` The Cognito identity pool ID.
`TestAuthorizationRequest`	`withPolicyNamesToAdd(Collection<String> policyNamesToAdd)` When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
`TestAuthorizationRequest`	`withPolicyNamesToAdd(String... policyNamesToAdd)` When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
`TestAuthorizationRequest`	`withPolicyNamesToSkip(Collection<String> policyNamesToSkip)` When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
`TestAuthorizationRequest`	`withPolicyNamesToSkip(String... policyNamesToSkip)` When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
`TestAuthorizationRequest`	`withPrincipal(String principal)` The principal.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - TestAuthorizationRequest
```
public TestAuthorizationRequest()
```
- Method Detail
  - getPrincipal
```
public String getPrincipal()
```
    The principal.
    
    Returns:
    
    The principal.
  - setPrincipal
```
public void setPrincipal(String principal)
```
    The principal.
    
    Parameters:
    
    principal -
    The principal.
  - withPrincipal
```
public TestAuthorizationRequest withPrincipal(String principal)
```
    The principal.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    principal -
    The principal.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCognitoIdentityPoolId
```
public String getCognitoIdentityPoolId()
```
    The Cognito identity pool ID.
    
    Returns:
    
    The Cognito identity pool ID.
  - setCognitoIdentityPoolId
```
public void setCognitoIdentityPoolId(String cognitoIdentityPoolId)
```
    The Cognito identity pool ID.
    
    Parameters:
    
    cognitoIdentityPoolId -
    The Cognito identity pool ID.
  - withCognitoIdentityPoolId
```
public TestAuthorizationRequest withCognitoIdentityPoolId(String cognitoIdentityPoolId)
```
    The Cognito identity pool ID.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    cognitoIdentityPoolId -
    The Cognito identity pool ID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAuthInfos
```
public List<AuthInfo> getAuthInfos()
```
    A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
    
    Returns:
    
    A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
  - setAuthInfos
```
public void setAuthInfos(Collection<AuthInfo> authInfos)
```
    A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
    
    Parameters:
    
    authInfos -
    A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
  - withAuthInfos
```
public TestAuthorizationRequest withAuthInfos(AuthInfo... authInfos)
```
    A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    authInfos -
    A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAuthInfos
```
public TestAuthorizationRequest withAuthInfos(Collection<AuthInfo> authInfos)
```
    A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    authInfos -
    A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientId
```
public String getClientId()
```
    The MQTT client ID.
    
    Returns:
    
    The MQTT client ID.
  - setClientId
```
public void setClientId(String clientId)
```
    The MQTT client ID.
    
    Parameters:
    
    clientId -
    The MQTT client ID.
  - withClientId
```
public TestAuthorizationRequest withClientId(String clientId)
```
    The MQTT client ID.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    clientId -
    The MQTT client ID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPolicyNamesToAdd
```
public List<String> getPolicyNamesToAdd()
```
    When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
    
    Returns:
    
    When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
  - setPolicyNamesToAdd
```
public void setPolicyNamesToAdd(Collection<String> policyNamesToAdd)
```
    When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
    
    Parameters:
    
    policyNamesToAdd -
    When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
  - withPolicyNamesToAdd
```
public TestAuthorizationRequest withPolicyNamesToAdd(String... policyNamesToAdd)
```
    When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    policyNamesToAdd -
    When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withPolicyNamesToAdd
```
public TestAuthorizationRequest withPolicyNamesToAdd(Collection<String> policyNamesToAdd)
```
    When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    policyNamesToAdd -
    When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPolicyNamesToSkip
```
public List<String> getPolicyNamesToSkip()
```
    When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
    
    Returns:
    
    When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
  - setPolicyNamesToSkip
```
public void setPolicyNamesToSkip(Collection<String> policyNamesToSkip)
```
    When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
    
    Parameters:
    
    policyNamesToSkip -
    When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
  - withPolicyNamesToSkip
```
public TestAuthorizationRequest withPolicyNamesToSkip(String... policyNamesToSkip)
```
    When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    policyNamesToSkip -
    When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withPolicyNamesToSkip
```
public TestAuthorizationRequest withPolicyNamesToSkip(Collection<String> policyNamesToSkip)
```
    When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    policyNamesToSkip -
    When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class TestAuthorizationRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

TestAuthorizationRequest

Method Detail

getPrincipal

setPrincipal

withPrincipal

getCognitoIdentityPoolId

setCognitoIdentityPoolId

withCognitoIdentityPoolId

getAuthInfos

setAuthInfos

withAuthInfos

withAuthInfos

getClientId

setClientId

withClientId

getPolicyNamesToAdd

setPolicyNamesToAdd

withPolicyNamesToAdd

withPolicyNamesToAdd

getPolicyNamesToSkip

setPolicyNamesToSkip

withPolicyNamesToSkip

withPolicyNamesToSkip

toString

hashCode

equals