@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()
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()
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.
|
overrideConfigurationcopypublic 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()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<TestAuthorizationRequest.Builder,TestAuthorizationRequest>toBuilder in class IotRequestpublic static TestAuthorizationRequest.Builder builder()
public static Class<? extends TestAuthorizationRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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 SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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 SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.