software.amazon.awssdk.services.iot.model

Interface TestAuthorizationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<TestAuthorizationRequest.Builder,TestAuthorizationRequest>, IotRequest.Builder, SdkBuilder<TestAuthorizationRequest.Builder,TestAuthorizationRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

TestAuthorizationRequest

public static interface TestAuthorizationRequest.Builder
extends IotRequest.Builder, SdkPojo, CopyableBuilder<TestAuthorizationRequest.Builder,TestAuthorizationRequest>

Method Summary

Modifier and Type	Method and Description
TestAuthorizationRequest.Builder	authInfos(AuthInfo... authInfos) A list of authorization info objects.
TestAuthorizationRequest.Builder	authInfos(Collection<AuthInfo> authInfos) A list of authorization info objects.
TestAuthorizationRequest.Builder	authInfos(Consumer<AuthInfo.Builder>... authInfos) A list of authorization info objects.
TestAuthorizationRequest.Builder	clientId(String clientId) The MQTT client ID.
TestAuthorizationRequest.Builder	cognitoIdentityPoolId(String cognitoIdentityPoolId) The Cognito identity pool ID.
TestAuthorizationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
TestAuthorizationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
TestAuthorizationRequest.Builder	policyNamesToAdd(Collection<String> policyNamesToAdd) When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
TestAuthorizationRequest.Builder	policyNamesToAdd(String... policyNamesToAdd) When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
TestAuthorizationRequest.Builder	policyNamesToSkip(Collection<String> policyNamesToSkip) When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
TestAuthorizationRequest.Builder	policyNamesToSkip(String... policyNamesToSkip) When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
TestAuthorizationRequest.Builder	principal(String principal) The principal.

Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

principal

TestAuthorizationRequest.Builder principal(String principal)

The principal.

Parameters:

principal - The principal.

Returns:

Returns a reference to this object so that method calls can be chained together.

cognitoIdentityPoolId

TestAuthorizationRequest.Builder cognitoIdentityPoolId(String cognitoIdentityPoolId)

The Cognito identity pool ID.

Parameters:

cognitoIdentityPoolId - The Cognito identity pool ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

authInfos

TestAuthorizationRequest.Builder authInfos(Collection<AuthInfo> authInfos)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

authInfos

TestAuthorizationRequest.Builder authInfos(AuthInfo... authInfos)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

authInfos

TestAuthorizationRequest.Builder authInfos(Consumer<AuthInfo.Builder>... authInfos)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #authInfos(List).

Parameters:

authInfos - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#authInfos(List)

clientId

TestAuthorizationRequest.Builder clientId(String clientId)

The MQTT client ID.

Parameters:

clientId - The MQTT client ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

policyNamesToAdd

TestAuthorizationRequest.Builder policyNamesToAdd(Collection<String> policyNamesToAdd)

When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

Parameters:

policyNamesToAdd - When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

Returns:

Returns a reference to this object so that method calls can be chained together.

policyNamesToAdd

TestAuthorizationRequest.Builder policyNamesToAdd(String... policyNamesToAdd)

When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

Parameters:

policyNamesToAdd - When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

Returns:

Returns a reference to this object so that method calls can be chained together.

policyNamesToSkip

TestAuthorizationRequest.Builder policyNamesToSkip(Collection<String> policyNamesToSkip)

When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

Parameters:

policyNamesToSkip - When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

Returns:

Returns a reference to this object so that method calls can be chained together.

policyNamesToSkip

TestAuthorizationRequest.Builder policyNamesToSkip(String... policyNamesToSkip)

When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

Parameters:

policyNamesToSkip - When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

TestAuthorizationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

TestAuthorizationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.