Class SuiteDefinitionInformation
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SuiteDefinitionInformation.Builder,
SuiteDefinitionInformation>
Information about the suite definition.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
Date (in Unix epoch time) when the test suite was created.final List
<DeviceUnderTest> Specifies the devices that are under test for the test suite.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) final boolean
For responses, this returns true if the service returned a value for the DefaultDevices property.final int
hashCode()
final Boolean
Specifies if the test suite is intended for qualification.final Boolean
Verifies if the test suite is a long duration test.final Protocol
protocol()
Gets the MQTT protocol that is configured in the suite definition.final String
Gets the MQTT protocol that is configured in the suite definition.static Class
<? extends SuiteDefinitionInformation.Builder> final String
Suite definition ID of the test suite.final String
Suite name of the test suite.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
suiteDefinitionId
Suite definition ID of the test suite.
- Returns:
- Suite definition ID of the test suite.
-
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 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. -
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
Specifies if the test suite is intended for qualification.
- Returns:
- Specifies if the test suite is intended for qualification.
-
isLongDurationTest
Verifies if the test suite is a long duration test.
- Returns:
- Verifies if the test suite is a long duration test.
-
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 returnProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolAsString()
.- Returns:
- Gets the MQTT protocol that is configured in the suite definition.
- See Also:
-
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 returnProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolAsString()
.- Returns:
- Gets the MQTT protocol that is configured in the suite definition.
- See Also:
-
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
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<SuiteDefinitionInformation.Builder,
SuiteDefinitionInformation> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-