software.amazon.awssdk.services.greengrassv2.model

Class ComponentConfigurationUpdate

java.lang.Object

software.amazon.awssdk.services.greengrassv2.model.ComponentConfigurationUpdate

All Implemented Interfaces:

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

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

Contains information about a deployment's update to a component's configuration on Greengrass core devices. For more information, see Update component configurations in the IoT Greengrass V2 Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ComponentConfigurationUpdate.Builder

Method Summary

Modifier and Type	Method and Description
static ComponentConfigurationUpdate.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReset() For responses, this returns true if the service returned a value for the Reset property.
String	merge() A serialized JSON string that contains the configuration object to merge to target devices.
List<String>	reset() The list of configuration nodes to reset to default values on target devices.
List<SdkField<?>>	sdkFields()
static Class<? extends ComponentConfigurationUpdate.Builder>	serializableBuilderClass()
ComponentConfigurationUpdate.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

merge

public final String merge()

A serialized JSON string that contains the configuration object to merge to target devices. The core device merges this configuration with the component's existing configuration. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object. For more information, see Merge configuration updates in the IoT Greengrass V2 Developer Guide.

Returns:

A serialized JSON string that contains the configuration object to merge to target devices. The core device merges this configuration with the component's existing configuration. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object. For more information, see Merge configuration updates in the IoT Greengrass V2 Developer Guide.

hasReset

public final boolean hasReset()

For responses, this returns true if the service returned a value for the Reset 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.

reset

public final List<String> reset()

The list of configuration nodes to reset to default values on target devices. Use JSON pointers to specify each node to reset. JSON pointers start with a forward slash (/) and use forward slashes to separate the key for each level in the object. For more information, see the JSON pointer specification and Reset configuration updates in the IoT Greengrass V2 Developer Guide.

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

Returns:

The list of configuration nodes to reset to default values on target devices. Use JSON pointers to specify each node to reset. JSON pointers start with a forward slash (/) and use forward slashes to separate the key for each level in the object. For more information, see the JSON pointer specification and Reset configuration updates in the IoT Greengrass V2 Developer Guide.

toBuilder

public ComponentConfigurationUpdate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComponentConfigurationUpdate.Builder,ComponentConfigurationUpdate>

builder

public static ComponentConfigurationUpdate.Builder builder()

serializableBuilderClass

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