@Generated(value="software.amazon.awssdk:codegen") public final class TestAuthorizationRequest extends IotRequest implements ToCopyableBuilder<TestAuthorizationRequest.Builder,TestAuthorizationRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
TestAuthorizationRequest.Builder |
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()
For responses, this returns true if the service returned a value for the AuthInfos property.
|
int |
hashCode() |
boolean |
hasPolicyNamesToAdd()
For responses, this returns true if the service returned a value for the PolicyNamesToAdd property.
|
boolean |
hasPolicyNamesToSkip()
For responses, this returns true if the service returned a value for the PolicyNamesToSkip property.
|
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.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final 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).
public final String cognitoIdentityPoolId()
The Cognito identity pool ID.
public final boolean hasAuthInfos()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAuthInfos()
method.
authInfo
object in the list.public final String clientId()
The MQTT client ID.
public final boolean hasPolicyNamesToAdd()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasPolicyNamesToAdd()
method.
public final boolean hasPolicyNamesToSkip()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasPolicyNamesToSkip()
method.
public TestAuthorizationRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<TestAuthorizationRequest.Builder,TestAuthorizationRequest>
toBuilder
in class IotRequest
public static TestAuthorizationRequest.Builder builder()
public static Class<? extends TestAuthorizationRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2023. All rights reserved.