com.amazonaws.services.iotsitewise.model

Class ImageFile

java.lang.Object

com.amazonaws.services.iotsitewise.model.ImageFile

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ImageFile
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains an image file.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImageFile()

Method Summary

Modifier and Type	Method and Description
ImageFile	clone()
boolean	equals(Object obj)
ByteBuffer	getData() The image file contents, represented as a base64-encoded string.
String	getType() The file type of the image.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setData(ByteBuffer data) The image file contents, represented as a base64-encoded string.
void	setType(String type) The file type of the image.
String	toString() Returns a string representation of this object.
ImageFile	withData(ByteBuffer data) The image file contents, represented as a base64-encoded string.
ImageFile	withType(ImageFileType type) The file type of the image.
ImageFile	withType(String type) The file type of the image.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImageFile

public ImageFile()

Method Detail

setData

public void setData(ByteBuffer data)

The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

data - The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.

getData

public ByteBuffer getData()

The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

Returns:

The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.

withData

public ImageFile withData(ByteBuffer data)

The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

data - The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.

Returns:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String type)

The file type of the image.

Parameters:

type - The file type of the image.

See Also:

ImageFileType

getType

public String getType()

The file type of the image.

Returns:

The file type of the image.

See Also:

ImageFileType

withType

public ImageFile withType(String type)

The file type of the image.

Parameters:

type - The file type of the image.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ImageFileType

withType

public ImageFile withType(ImageFileType type)

The file type of the image.

Parameters:

type - The file type of the image.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ImageFileType

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ImageFile clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo