@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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
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()
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.
You can use hasAuthInfos()
to see if a value was sent in this field.
authInfo
object in the list.public final String clientId()
The MQTT client ID.
public final boolean hasPolicyNamesToAdd()
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.
You can use hasPolicyNamesToAdd()
to see if a value was sent in this field.
public final boolean hasPolicyNamesToSkip()
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.
You can use hasPolicyNamesToSkip()
to see if a value was sent in this field.
public TestAuthorizationRequest.Builder toBuilder()
ToCopyableBuilder
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)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.