software.amazon.awssdk.services.iot.model

Class OTAUpdateFile

java.lang.Object

software.amazon.awssdk.services.iot.model.OTAUpdateFile

All Implemented Interfaces:

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

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

Describes a file to be associated with an OTA update.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OTAUpdateFile.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	attributes() A list of name/attribute pairs.
static OTAUpdateFile.Builder	builder()
CodeSigning	codeSigning() The code signing method of the file.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FileLocation	fileLocation() The location of the updated firmware.
String	fileName() The name of the file.
Integer	fileType() An integer value you can include in the job document to allow your devices to identify the type of file received from the cloud.
String	fileVersion() The file version.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends OTAUpdateFile.Builder>	serializableBuilderClass()
OTAUpdateFile.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

fileName

public final String fileName()

The name of the file.

Returns:

The name of the file.

fileType

public final Integer fileType()

An integer value you can include in the job document to allow your devices to identify the type of file received from the cloud.

Returns:

An integer value you can include in the job document to allow your devices to identify the type of file received from the cloud.

fileVersion

public final String fileVersion()

The file version.

Returns:

The file version.

fileLocation

public final FileLocation fileLocation()

The location of the updated firmware.

Returns:

The location of the updated firmware.

codeSigning

public final CodeSigning codeSigning()

The code signing method of the file.

Returns:

The code signing method of the file.

hasAttributes

public final boolean hasAttributes()

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

attributes

public final Map<String,String> attributes()

A list of name/attribute pairs.

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

Returns:

A list of name/attribute pairs.

toBuilder

public OTAUpdateFile.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OTAUpdateFile.Builder,OTAUpdateFile>

builder

public static OTAUpdateFile.Builder builder()

serializableBuilderClass

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