com.amazonaws.services.iot.model

Class TestAuthorizationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.TestAuthorizationRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TestAuthorizationRequest
extends AmazonWebServiceRequest
implements java.io.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()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<AuthInfo>	getAuthInfos() A list of authorization info objects.
java.lang.String	getClientId() The MQTT client ID.
java.lang.String	getCognitoIdentityPoolId() The Cognito identity pool ID.
java.util.List<java.lang.String>	getPolicyNamesToAdd() When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
java.util.List<java.lang.String>	getPolicyNamesToSkip() When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
java.lang.String	getPrincipal() The principal.
int	hashCode()
void	setAuthInfos(java.util.Collection<AuthInfo> authInfos) A list of authorization info objects.
void	setClientId(java.lang.String clientId) The MQTT client ID.
void	setCognitoIdentityPoolId(java.lang.String cognitoIdentityPoolId) The Cognito identity pool ID.
void	setPolicyNamesToAdd(java.util.Collection<java.lang.String> policyNamesToAdd) When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
void	setPolicyNamesToSkip(java.util.Collection<java.lang.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(java.lang.String principal) The principal.
java.lang.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(java.util.Collection<AuthInfo> authInfos) A list of authorization info objects.
TestAuthorizationRequest	withClientId(java.lang.String clientId) The MQTT client ID.
TestAuthorizationRequest	withCognitoIdentityPoolId(java.lang.String cognitoIdentityPoolId) The Cognito identity pool ID.
TestAuthorizationRequest	withPolicyNamesToAdd(java.util.Collection<java.lang.String> policyNamesToAdd) When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
TestAuthorizationRequest	withPolicyNamesToAdd(java.lang.String... policyNamesToAdd) When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
TestAuthorizationRequest	withPolicyNamesToSkip(java.util.Collection<java.lang.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(java.lang.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(java.lang.String principal) The principal.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TestAuthorizationRequest

public TestAuthorizationRequest()

Method Detail

getPrincipal

public java.lang.String getPrincipal()

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

Returns:

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup /groupName) and CognitoId (region:id).

setPrincipal

public void setPrincipal(java.lang.String principal)

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

Parameters:

principal -

The principal. Valid principals are CertificateArn (arn:aws:iot :region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup /groupName) and CognitoId (region:id).

withPrincipal

public TestAuthorizationRequest withPrincipal(java.lang.String principal)

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

Returns a reference to this object so that method calls can be chained together.

Parameters:

principal -

The principal. Valid principals are CertificateArn (arn:aws:iot :region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup /groupName) and CognitoId (region:id).

Returns:

A reference to this updated object so that method calls can be chained together.

getCognitoIdentityPoolId

public java.lang.String getCognitoIdentityPoolId()

The Cognito identity pool ID.

Returns:

The Cognito identity pool ID.

setCognitoIdentityPoolId

public void setCognitoIdentityPoolId(java.lang.String cognitoIdentityPoolId)

The Cognito identity pool ID.

Parameters:

cognitoIdentityPoolId -

The Cognito identity pool ID.

withCognitoIdentityPoolId

public TestAuthorizationRequest withCognitoIdentityPoolId(java.lang.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 java.util.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(java.util.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(java.util.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 java.lang.String getClientId()

The MQTT client ID.

Returns:

The MQTT client ID.

setClientId

public void setClientId(java.lang.String clientId)

The MQTT client ID.

Parameters:

clientId -

The MQTT client ID.

withClientId

public TestAuthorizationRequest withClientId(java.lang.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 java.util.List<java.lang.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(java.util.Collection<java.lang.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(java.lang.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(java.util.Collection<java.lang.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 java.util.List<java.lang.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(java.util.Collection<java.lang.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(java.lang.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(java.util.Collection<java.lang.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 java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object