software.amazon.awssdk.services.iotdeviceadvisor.model

Interface SuiteDefinitionConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SuiteDefinitionConfiguration.Builder,SuiteDefinitionConfiguration>, SdkBuilder<SuiteDefinitionConfiguration.Builder,SuiteDefinitionConfiguration>, SdkPojo

Enclosing class:

SuiteDefinitionConfiguration

public static interface SuiteDefinitionConfiguration.Builder
extends SdkPojo, CopyableBuilder<SuiteDefinitionConfiguration.Builder,SuiteDefinitionConfiguration>

Method Summary

Modifier and Type	Method and Description
SuiteDefinitionConfiguration.Builder	devicePermissionRoleArn(String devicePermissionRoleArn) Gets the device permission ARN.
SuiteDefinitionConfiguration.Builder	devices(Collection<DeviceUnderTest> devices) Gets the devices configured.
SuiteDefinitionConfiguration.Builder	devices(Consumer<DeviceUnderTest.Builder>... devices) Gets the devices configured.
SuiteDefinitionConfiguration.Builder	devices(DeviceUnderTest... devices) Gets the devices configured.
SuiteDefinitionConfiguration.Builder	intendedForQualification(Boolean intendedForQualification) Gets the tests intended for qualification in a suite.
SuiteDefinitionConfiguration.Builder	isLongDurationTest(Boolean isLongDurationTest) Verifies if the test suite is a long duration test.
SuiteDefinitionConfiguration.Builder	protocol(Protocol protocol) Sets the MQTT protocol that is configured in the suite definition.
SuiteDefinitionConfiguration.Builder	protocol(String protocol) Sets the MQTT protocol that is configured in the suite definition.
SuiteDefinitionConfiguration.Builder	rootGroup(String rootGroup) Gets the test suite root group.
SuiteDefinitionConfiguration.Builder	suiteDefinitionName(String suiteDefinitionName) Gets the suite definition name.

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

equalsBySdkFields, 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

suiteDefinitionName

SuiteDefinitionConfiguration.Builder suiteDefinitionName(String suiteDefinitionName)

Gets the suite definition name. This is a required parameter.

Parameters:

suiteDefinitionName - Gets the suite definition name. This is a required parameter.

Returns:

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

devices

SuiteDefinitionConfiguration.Builder devices(Collection<DeviceUnderTest> devices)

Gets the devices configured.

Parameters:

devices - Gets the devices configured.

Returns:

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

devices

SuiteDefinitionConfiguration.Builder devices(DeviceUnderTest... devices)

Gets the devices configured.

Parameters:

devices - Gets the devices configured.

Returns:

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

devices

SuiteDefinitionConfiguration.Builder devices(Consumer<DeviceUnderTest.Builder>... devices)

Gets the devices configured.

This is a convenience method that creates an instance of the DeviceUnderTest.Builder avoiding the need to create one manually via DeviceUnderTest.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #devices(List).

Parameters:

devices - a consumer that will call methods on DeviceUnderTest.Builder

Returns:

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

See Also:

#devices(java.util.Collection)

intendedForQualification

SuiteDefinitionConfiguration.Builder intendedForQualification(Boolean intendedForQualification)

Gets the tests intended for qualification in a suite.

Parameters:

intendedForQualification - Gets the tests intended for qualification in a suite.

Returns:

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

isLongDurationTest

SuiteDefinitionConfiguration.Builder isLongDurationTest(Boolean isLongDurationTest)

Verifies if the test suite is a long duration test.

Parameters:

isLongDurationTest - Verifies if the test suite is a long duration test.

Returns:

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

rootGroup

SuiteDefinitionConfiguration.Builder rootGroup(String rootGroup)

Gets the test suite root group. This is a required parameter. For updating or creating the latest qualification suite, if intendedForQualification is set to true, rootGroup can be an empty string. If intendedForQualification is false, rootGroup cannot be an empty string. If rootGroup is empty, and intendedForQualification is set to true, all the qualification tests are included, and the configuration is default.

For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

Parameters:

rootGroup - Gets the test suite root group. This is a required parameter. For updating or creating the latest qualification suite, if intendedForQualification is set to true, rootGroup can be an empty string. If intendedForQualification is false, rootGroup cannot be an empty string. If rootGroup is empty, and intendedForQualification is set to true, all the qualification tests are included, and the configuration is default.

For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

Returns:

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

devicePermissionRoleArn

SuiteDefinitionConfiguration.Builder devicePermissionRoleArn(String devicePermissionRoleArn)

Gets the device permission ARN. This is a required parameter.

Parameters:

devicePermissionRoleArn - Gets the device permission ARN. This is a required parameter.

Returns:

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

protocol

SuiteDefinitionConfiguration.Builder protocol(String protocol)

Sets the MQTT protocol that is configured in the suite definition.

Parameters:

protocol - Sets the MQTT protocol that is configured in the suite definition.

Returns:

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

See Also:

Protocol, Protocol

protocol

SuiteDefinitionConfiguration.Builder protocol(Protocol protocol)

Sets the MQTT protocol that is configured in the suite definition.

Parameters:

protocol - Sets the MQTT protocol that is configured in the suite definition.

Returns:

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

See Also:

Protocol, Protocol