com.microsoft.azure.sdk.iot.deps.serializer

Class FileUploadStatusParser

java.lang.Object

com.microsoft.azure.sdk.iot.deps.serializer.FileUploadStatusParser

public class FileUploadStatusParser
extends Object

Representation of the status of a single file for the File Upload, with a Json serializer. Ex of JSON format: { "correlationId": "{correlation ID received from the initial request}", "isSuccess": bool, "statusCode": XXX, "statusDescription": "Description of status" }

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileUploadStatusParser() Empty constructor: Used only to keep GSON happy.
	FileUploadStatusParser(String correlationId, Boolean isSuccess, Integer statusCode, String statusDescription) CONSTRUCTOR Create an instance of the FileUploadStatusParser for a single file in Azure Storage.

Method Summary

Modifier and Type	Method and Description
String	toJson() Convert this class in a valid json.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileUploadStatusParser

public FileUploadStatusParser(String correlationId,
                              Boolean isSuccess,
                              Integer statusCode,
                              String statusDescription)
                       throws IllegalArgumentException

CONSTRUCTOR Create an instance of the FileUploadStatusParser for a single file in Azure Storage.

Parameters:

correlationId - is an unique file identification.

isSuccess - is a Boolean representing whether the file was uploaded successfully.

statusCode - is the status for the upload of the file to storage.

statusDescription - is the description of the status code.

Throws:

IllegalArgumentException - if one of the parameters is null, empty, or not valid.

FileUploadStatusParser

protected FileUploadStatusParser()

Empty constructor: Used only to keep GSON happy.

Method Detail

toJson

public String toJson()

Convert this class in a valid json.

Returns:

a valid json that represents the content of this class.