Class AwsJsonSubstitutionCommandPreprocessorConfig

java.lang.Object

software.amazon.awssdk.services.iot.model.AwsJsonSubstitutionCommandPreprocessorConfig

All Implemented Interfaces:

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

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

Configures the command to treat the payloadTemplate as a JSON document for preprocessing. This preprocessor substitutes placeholders with parameter values to generate the command execution request payload.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AwsJsonSubstitutionCommandPreprocessorConfig.Builder

Method Summary

Modifier and Type	Method	Description
static AwsJsonSubstitutionCommandPreprocessorConfig.Builder	builder()
final boolean	equals(Object obj)
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 int	hashCode()
final OutputFormat	outputFormat()	Converts the command preprocessor result to the format defined by this parameter, before sending it to the device.
final String	outputFormatAsString()	Converts the command preprocessor result to the format defined by this parameter, before sending it to the device.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends AwsJsonSubstitutionCommandPreprocessorConfig.Builder>	serializableBuilderClass()
AwsJsonSubstitutionCommandPreprocessorConfig.Builder	toBuilder()	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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

outputFormat

public final OutputFormat outputFormat()

Converts the command preprocessor result to the format defined by this parameter, before sending it to the device.

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

Returns:

Converts the command preprocessor result to the format defined by this parameter, before sending it to the device.

See Also:

• OutputFormat

outputFormatAsString

public final String outputFormatAsString()

Converts the command preprocessor result to the format defined by this parameter, before sending it to the device.

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

Returns:

Converts the command preprocessor result to the format defined by this parameter, before sending it to the device.

See Also:

• OutputFormat

toBuilder

public AwsJsonSubstitutionCommandPreprocessorConfig.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<AwsJsonSubstitutionCommandPreprocessorConfig.Builder,AwsJsonSubstitutionCommandPreprocessorConfig>

Returns:

a builder for type T

builder

public static AwsJsonSubstitutionCommandPreprocessorConfig.Builder builder()

serializableBuilderClass

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