Package software.amazon.awssdk.services.iot.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CommandParameter.Builder

Method Summary

Modifier and Type	Method	Description
static CommandParameter.Builder	builder()
CommandParameterValue	defaultValue()	The default value used to describe the command.
String	description()	The description of the command parameter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of a specific parameter used in a command and command execution.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CommandParameter.Builder>	serializableBuilderClass()
CommandParameter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
CommandParameterValue	value()	The value used to describe the command.

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

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.

value

public final CommandParameterValue value()

The value used to describe the command. When you assign a value to a parameter, it will override any default value that you had already specified.

Returns:

The value used to describe the command. When you assign a value to a parameter, it will override any default value that you had already specified.

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.

description

public final String description()

The description of the command parameter.

Returns:

The description of the command parameter.

toBuilder

public CommandParameter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CommandParameter.Builder,CommandParameter>

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)

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo