Class TestAuthorizationRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<TestAuthorizationRequest.Builder,
TestAuthorizationRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA list of authorization info objects.builder()
final String
clientId()
The MQTT client ID.final String
The Cognito identity pool ID.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AuthInfos property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PolicyNamesToAdd property.final boolean
For responses, this returns true if the service returned a value for the PolicyNamesToSkip property.When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.final String
The principal.static Class
<? extends TestAuthorizationRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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:
- 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).
-
cognitoIdentityPoolId
The Cognito identity pool ID.
- Returns:
- The Cognito identity pool ID.
-
hasAuthInfos
public final boolean hasAuthInfos()For responses, this returns true if the service returned a value for the AuthInfos property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- A list of authorization info objects. Simulating authorization will create a response for each
authInfo
object in the list.
-
clientId
The MQTT client ID.
- Returns:
- The MQTT client ID.
-
hasPolicyNamesToAdd
public final boolean hasPolicyNamesToAdd()For responses, this returns true if the service returned a value for the PolicyNamesToAdd property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
-
hasPolicyNamesToSkip
public final boolean hasPolicyNamesToSkip()For responses, this returns true if the service returned a value for the PolicyNamesToSkip property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<TestAuthorizationRequest.Builder,
TestAuthorizationRequest> - Specified by:
toBuilder
in classIotRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-