com.amazonaws.services.iot.model

Class TestAuthorizationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.TestAuthorizationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
TestAuthorizationRequest()

Method Summary

Modifier and Type	Method and Description
TestAuthorizationRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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.
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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TestAuthorizationRequest

public TestAuthorizationRequest()

Method Detail

setPrincipal

public void setPrincipal(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).

getPrincipal

public 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).

withPrincipal

public TestAuthorizationRequest withPrincipal(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).

Returns:

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

setCognitoIdentityPoolId

public void setCognitoIdentityPoolId(String cognitoIdentityPoolId)

The Cognito identity pool ID.

Parameters:

cognitoIdentityPoolId - The Cognito identity pool ID.

getCognitoIdentityPoolId

public String getCognitoIdentityPoolId()

The Cognito identity pool ID.

Returns:

The Cognito identity pool ID.

withCognitoIdentityPoolId

public TestAuthorizationRequest withCognitoIdentityPoolId(String cognitoIdentityPoolId)

The Cognito identity pool ID.

Parameters:

cognitoIdentityPoolId - The Cognito identity pool ID.

Returns:

Returns a reference to this 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.

NOTE: This method appends the values to the existing list (if any). Use setAuthInfos(java.util.Collection) or withAuthInfos(java.util.Collection) if you want to override the existing values.

Parameters:

authInfos - A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

Returns:

Returns a reference to this 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.

Parameters:

authInfos - A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

Returns:

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

setClientId

public void setClientId(String clientId)

The MQTT client ID.

Parameters:

clientId - The MQTT client ID.

getClientId

public String getClientId()

The MQTT client ID.

Returns:

The MQTT client ID.

withClientId

public TestAuthorizationRequest withClientId(String clientId)

The MQTT client ID.

Parameters:

clientId - The MQTT client ID.

Returns:

Returns a reference to this 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.

NOTE: This method appends the values to the existing list (if any). Use setPolicyNamesToAdd(java.util.Collection) or withPolicyNamesToAdd(java.util.Collection) if you want to override the existing values.

Parameters:

policyNamesToAdd - When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

Returns:

Returns a reference to this 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.

Parameters:

policyNamesToAdd - When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

Returns:

Returns a reference to this 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.

NOTE: This method appends the values to the existing list (if any). Use setPolicyNamesToSkip(java.util.Collection) or withPolicyNamesToSkip(java.util.Collection) if you want to override the existing values.

Parameters:

policyNamesToSkip - When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

Returns:

Returns a reference to this 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.

Parameters:

policyNamesToSkip - When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

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 TestAuthorizationRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()