TestAuthorizationRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.iot.model.IotRequest
    - - software.amazon.awssdk.services.iot.model.TestAuthorizationRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<TestAuthorizationRequest.Builder,TestAuthorizationRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class TestAuthorizationRequest
extends IotRequest
implements ToCopyableBuilder<TestAuthorizationRequest.Builder,TestAuthorizationRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TestAuthorizationRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TestAuthorizationRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AuthInfo>`	`authInfos()` A list of authorization info objects.
`static TestAuthorizationRequest.Builder`	`builder()`
`String`	`clientId()` The MQTT client ID.
`String`	`cognitoIdentityPoolId()` The Cognito identity pool ID.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAuthInfos()` Returns true if the AuthInfos property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasPolicyNamesToAdd()` Returns true if the PolicyNamesToAdd property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasPolicyNamesToSkip()` Returns true if the PolicyNamesToSkip property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<String>`	`policyNamesToAdd()` When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
`List<String>`	`policyNamesToSkip()` When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
`String`	`principal()` The principal.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TestAuthorizationRequest.Builder>`	`serializableBuilderClass()`
`TestAuthorizationRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - principal
```
public String principal()
```
    The principal.
    
    Returns:
    
    The principal.
  - cognitoIdentityPoolId
```
public String cognitoIdentityPoolId()
```
    The Cognito identity pool ID.
    
    Returns:
    
    The Cognito identity pool ID.
  - hasAuthInfos
```
public boolean hasAuthInfos()
```
    Returns true if the AuthInfos property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - authInfos
```
public List<AuthInfo> authInfos()
```
    A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAuthInfos() to see if a value was sent in this field.
    
    Returns:
    
    A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
  - clientId
```
public String clientId()
```
    The MQTT client ID.
    
    Returns:
    
    The MQTT client ID.
  - hasPolicyNamesToAdd
```
public boolean hasPolicyNamesToAdd()
```
    Returns true if the PolicyNamesToAdd property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - policyNamesToAdd
```
public List<String> policyNamesToAdd()
```
    When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasPolicyNamesToAdd() to see if a value was sent in this field.
    
    Returns:
    
    When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
  - hasPolicyNamesToSkip
```
public boolean hasPolicyNamesToSkip()
```
    Returns true if the PolicyNamesToSkip property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - policyNamesToSkip
```
public List<String> policyNamesToSkip()
```
    When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasPolicyNamesToSkip() to see if a value was sent in this field.
    
    Returns:
    
    When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
  - toBuilder
```
public TestAuthorizationRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TestAuthorizationRequest.Builder,TestAuthorizationRequest>
    
    Specified by:
    
    toBuilder in class IotRequest
  - builder
```
public static TestAuthorizationRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TestAuthorizationRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class TestAuthorizationRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

principal

cognitoIdentityPoolId

hasAuthInfos

authInfos

clientId

hasPolicyNamesToAdd

policyNamesToAdd

hasPolicyNamesToSkip

policyNamesToSkip

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields