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

Class FileUploadSasUriResponse

java.lang.Object

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

public class FileUploadSasUriResponse
extends Object

The information provided from IoT Hub that can be used with the Azure Storage SDK to upload a file from your device, including authentication.

Constructor Summary

Constructors

Constructor and Description
FileUploadSasUriResponse(String json) Create an instance of the FileUploadSasUriResponse using the information in the provided json.

Method Summary

Modifier and Type	Method and Description
String	getBlobName() Getter for the blob name (aka file name) in Azure storage that this file upload SAS URI allows uploading to.
URI	getBlobUri() Get the full Azure Storage blob uri to upload a file to.
String	getContainerName() Getter for the container name in Azure storage that this file upload SAS URI allows uploading to.
String	getCorrelationId() Getter for the Azure storage correlation identification.
String	getHostName() Getter for the Azure storage host name that this file upload SAS URI allows uploading to.
String	getSasToken() Getter for the file sasToken for authenticating with Azure storage while uploading.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUploadSasUriResponse

public FileUploadSasUriResponse(String json)
                         throws IllegalArgumentException

Create an instance of the FileUploadSasUriResponse using the information in the provided json.

Parameters:

json - is the string that contains a valid json with the FileUpload response.

Throws:

IllegalArgumentException - if the json is null, empty, or not valid.

Method Detail

getCorrelationId

public String getCorrelationId()

Getter for the Azure storage correlation identification. This correlation id should be used when notifying IoT Hub that this file upload has completed.

Returns:

The correlation identification.

getHostName

public String getHostName()

Getter for the Azure storage host name that this file upload SAS URI allows uploading to.

Returns:

The host name.

getContainerName

public String getContainerName()

Getter for the container name in Azure storage that this file upload SAS URI allows uploading to.

Returns:

The container name.

getBlobName

public String getBlobName()

Getter for the blob name (aka file name) in Azure storage that this file upload SAS URI allows uploading to.

Returns:

The blob name.

getSasToken

public String getSasToken()

Getter for the file sasToken for authenticating with Azure storage while uploading.

Returns:

String with the file sasToken.

getBlobUri

public URI getBlobUri()
               throws UnsupportedEncodingException,
                      URISyntaxException

Get the full Azure Storage blob uri to upload a file to. This uri includes authentication information

Returns:

The full Azure Storage blob uri to upload a file to.

Throws:

UnsupportedEncodingException - if UTF-8 encoding is not supported on this device.

URISyntaxException - if building the URI fails for any reason.