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

Class VersionUpdateByJobsConfig

java.lang.Object

software.amazon.awssdk.services.iot.model.VersionUpdateByJobsConfig

All Implemented Interfaces:

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

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

Configuration to manage IoT Job's package version reporting. If configured, Jobs updates the thing's reserved named shadow with the package version information up on successful job completion.

Note: For each job, the destinationPackageVersions attribute has to be set with the correct data for Jobs to report to the thing shadow.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VersionUpdateByJobsConfig.Builder

Method Summary

Modifier and Type	Method	Description
static VersionUpdateByJobsConfig.Builder	builder()
Boolean	enabled()	Indicates whether the Job is enabled or not.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	roleArn()	The Amazon Resource Name (ARN) of the role that grants permission to the IoT jobs service to update the reserved named shadow when the job successfully completes.
List<SdkField<?>>	sdkFields()
static Class<? extends VersionUpdateByJobsConfig.Builder>	serializableBuilderClass()
VersionUpdateByJobsConfig.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

enabled

public final Boolean enabled()

Indicates whether the Job is enabled or not.

Returns:

Indicates whether the Job is enabled or not.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the role that grants permission to the IoT jobs service to update the reserved named shadow when the job successfully completes.

Returns:

The Amazon Resource Name (ARN) of the role that grants permission to the IoT jobs service to update the reserved named shadow when the job successfully completes.

toBuilder

public VersionUpdateByJobsConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VersionUpdateByJobsConfig.Builder,VersionUpdateByJobsConfig>

builder

public static VersionUpdateByJobsConfig.Builder builder()

serializableBuilderClass

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