Class SuiteDefinitionConfiguration

java.lang.Object
software.amazon.awssdk.services.iotdeviceadvisor.model.SuiteDefinitionConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SuiteDefinitionConfiguration.Builder,SuiteDefinitionConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class SuiteDefinitionConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SuiteDefinitionConfiguration.Builder,SuiteDefinitionConfiguration>

Gets the suite definition configuration.

See Also:

  • Method Details

    • suiteDefinitionName

      public final String suiteDefinitionName()

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

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

    • hasDevices

      public final boolean hasDevices()
      For responses, this returns true if the service returned a value for the Devices 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.

    • devices

      public final List<DeviceUnderTest> devices()

      Gets the devices configured.

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

      Returns:
      Gets the devices configured.

    • intendedForQualification

      public final Boolean intendedForQualification()

      Gets the tests intended for qualification in a suite.

      Returns:
      Gets the tests intended for qualification in a suite.

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

    • rootGroup

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

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

    • devicePermissionRoleArn

      public final String devicePermissionRoleArn()

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

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

    • protocol

      public final Protocol protocol()

      Sets 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:
      Sets the MQTT protocol that is configured in the suite definition.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      Sets 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:
      Sets the MQTT protocol that is configured in the suite definition.
      See Also:

    • toBuilder

      public SuiteDefinitionConfiguration.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<SuiteDefinitionConfiguration.Builder,SuiteDefinitionConfiguration>
      Returns:
      a builder for type T

    • builder

      public static SuiteDefinitionConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SuiteDefinitionConfiguration.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)
      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)

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.