Class CommandParameter

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

A map of key-value pairs that describe the command.

See Also:

  • Method Details

    • name

      public final String name()

      The name of a specific parameter used in a command and command execution.

      Returns:
      The name of a specific parameter used in a command and command execution.

    • type

      public final CommandParameterType type()

      The type of the command parameter.

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

      Returns:
      The type of the command parameter.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the command parameter.

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

      Returns:
      The type of the command parameter.
      See Also:

    • value

      public final CommandParameterValue value()

      Parameter value that overrides the default value, if set.

      Returns:
      Parameter value that overrides the default value, if set.

    • defaultValue

      public final CommandParameterValue defaultValue()

      The default value used to describe the command. This is the value assumed by the parameter if no other value is assigned to it.

      Returns:
      The default value used to describe the command. This is the value assumed by the parameter if no other value is assigned to it.

    • hasValueConditions

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

    • valueConditions

      public final List<CommandParameterValueCondition> valueConditions()

      The list of conditions that a command parameter value must satisfy to create a command execution.

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

      Returns:
      The list of conditions that a command parameter value must satisfy to create a command execution.

    • description

      public final String description()

      The description of the command parameter.

      Returns:
      The description of the command parameter.

    • toBuilder

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

    • builder

      public static CommandParameter.Builder builder()

    • serializableBuilderClass

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