software.amazon.awssdk.services.iot.model

Class TestAuthorizationRequest

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

Method Summary

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.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

principal

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).

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

public final String cognitoIdentityPoolId()

The Cognito identity pool ID.

Returns:

The Cognito identity pool ID.

hasAuthInfos

public final 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 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.

Returns:

A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

clientId

public final String clientId()

The MQTT client ID.

Returns:

The MQTT client ID.

hasPolicyNamesToAdd

public final 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 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.

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()

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 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.

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()

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 interface ToCopyableBuilder<TestAuthorizationRequest.Builder,TestAuthorizationRequest>

Specified by:

toBuilder in class IotRequest

Returns:

a builder for type T

builder

public static TestAuthorizationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends TestAuthorizationRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

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

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.