software.amazon.awssdk.services.iotdeviceadvisor.model

Class SuiteDefinitionInformation

java.lang.Object

software.amazon.awssdk.services.iotdeviceadvisor.model.SuiteDefinitionInformation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SuiteDefinitionInformation.Builder,SuiteDefinitionInformation>

@Generated(value="software.amazon.awssdk:codegen")
public final class SuiteDefinitionInformation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SuiteDefinitionInformation.Builder,SuiteDefinitionInformation>

Information about the suite definition.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SuiteDefinitionInformation.Builder

Method Summary

Modifier and Type	Method and Description
static SuiteDefinitionInformation.Builder	builder()
Instant	createdAt() Date (in Unix epoch time) when the test suite was created.
List<DeviceUnderTest>	defaultDevices() Specifies the devices that are under test for the test suite.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDefaultDevices() For responses, this returns true if the service returned a value for the DefaultDevices property.
int	hashCode()
Boolean	intendedForQualification() Specifies if the test suite is intended for qualification.
Boolean	isLongDurationTest() Verifies if the test suite is a long duration test.
Protocol	protocol() Gets the MQTT protocol that is configured in the suite definition.
String	protocolAsString() Gets the MQTT protocol that is configured in the suite definition.
List<SdkField<?>>	sdkFields()
static Class<? extends SuiteDefinitionInformation.Builder>	serializableBuilderClass()
String	suiteDefinitionId() Suite definition ID of the test suite.
String	suiteDefinitionName() Suite name of the test suite.
SuiteDefinitionInformation.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

suiteDefinitionId

public final String suiteDefinitionId()

Suite definition ID of the test suite.

Returns:

Suite definition ID of the test suite.

suiteDefinitionName

public final String suiteDefinitionName()

Suite name of the test suite.

Returns:

Suite name of the test suite.

hasDefaultDevices

public final boolean hasDefaultDevices()

For responses, this returns true if the service returned a value for the DefaultDevices property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

defaultDevices

public final List<DeviceUnderTest> defaultDevices()

Specifies the devices that are under test for the test suite.

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 hasDefaultDevices() method.

Returns:

Specifies the devices that are under test for the test suite.

intendedForQualification

public final Boolean intendedForQualification()

Specifies if the test suite is intended for qualification.

Returns:

Specifies if the test suite is intended for qualification.

isLongDurationTest

public final Boolean isLongDurationTest()

Verifies if the test suite is a long duration test.

Returns:

Verifies if the test suite is a long duration test.

protocol

public final Protocol protocol()

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

If the service returns an enum value that is not available in the current SDK version, protocol will return Protocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

Returns:

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

See Also:

Protocol

protocolAsString

public final String protocolAsString()

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

If the service returns an enum value that is not available in the current SDK version, protocol will return Protocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

Returns:

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

See Also:

Protocol

createdAt

public final Instant createdAt()

Date (in Unix epoch time) when the test suite was created.

Returns:

Date (in Unix epoch time) when the test suite was created.

toBuilder

public SuiteDefinitionInformation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SuiteDefinitionInformation.Builder,SuiteDefinitionInformation>

builder

public static SuiteDefinitionInformation.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo