87 строки
7.3 KiB
YAML
87 строки
7.3 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.device.fileupload.FileUpload"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.fileupload.FileUpload"
|
|
name: "FileUpload"
|
|
nameWithType: "FileUpload"
|
|
summary: "Provide means to upload file in the Azure Storage using the Io<wbr>THub."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public final class **FileUpload**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.fileupload.FileUpload.FileUpload(com.microsoft.azure.sdk.iot.device.DeviceClientConfig)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.fileupload.FileUpload.FileUpload(DeviceClientConfig config)"
|
|
name: "FileUpload(DeviceClientConfig config)"
|
|
nameWithType: "FileUpload.FileUpload(DeviceClientConfig config)"
|
|
summary: "CONSTRUCTOR"
|
|
parameters:
|
|
- description: "is the set of device client configurations."
|
|
name: "config"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.DeviceClientConfig?alt=com.microsoft.azure.sdk.iot.device.DeviceClientConfig&text=DeviceClientConfig\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public FileUpload(DeviceClientConfig config)"
|
|
exceptions:
|
|
- description: "if one of the parameters is null."
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "if one of the parameters is null."
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "CONSTRUCTOR"
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.fileupload.FileUpload.closeNow()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.fileupload.FileUpload.closeNow()"
|
|
name: "closeNow()"
|
|
nameWithType: "FileUpload.closeNow()"
|
|
summary: "Close the file upload cancelling all existing uploads and shutting down the thread pool."
|
|
syntax: "public void closeNow()"
|
|
exceptions:
|
|
- description: "if an I/O error occurs in the inputStream."
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Close the file upload cancelling all existing uploads and shutting down the thread pool."
|
|
- uid: "com.microsoft.azure.sdk.iot.device.fileupload.FileUpload.uploadToBlobAsync(java.lang.String,java.io.InputStream,long,com.microsoft.azure.sdk.iot.device.IotHubEventCallback,java.lang.Object)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.fileupload.FileUpload.uploadToBlobAsync(String blobName, InputStream inputStream, long streamLength, IotHubEventCallback statusCallback, Object statusCallbackContext)"
|
|
name: "uploadToBlobAsync(String blobName, InputStream inputStream, long streamLength, IotHubEventCallback statusCallback, Object statusCallbackContext)"
|
|
nameWithType: "FileUpload.uploadToBlobAsync(String blobName, InputStream inputStream, long streamLength, IotHubEventCallback statusCallback, Object statusCallbackContext)"
|
|
summary: "Upload the file to container, which was associated to the iothub."
|
|
modifiers:
|
|
- "synchronized"
|
|
parameters:
|
|
- description: "is the name of the file in the container."
|
|
name: "blobName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "is the input stream."
|
|
name: "inputStream"
|
|
type: "<xref href=\"java.io.InputStream?alt=java.io.InputStream&text=InputStream\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "is the stream length."
|
|
name: "streamLength"
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "is the callback to notify that the upload is completed (with status)."
|
|
name: "statusCallback"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.IotHubEventCallback?alt=com.microsoft.azure.sdk.iot.device.IotHubEventCallback&text=IotHubEventCallback\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "is the context of the callback, allowing multiple uploads in parallel."
|
|
name: "statusCallbackContext"
|
|
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public synchronized void uploadToBlobAsync(String blobName, InputStream inputStream, long streamLength, IotHubEventCallback statusCallback, Object statusCallbackContext)"
|
|
exceptions:
|
|
- description: "if one of the parameters is invalid.\n blobName is <code>null</code> or empty,\n inputStream is <code>null</code> or not available,\n streamLength is negative,\n statusCallback is <code>null</code>"
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "if one of the parameters is invalid.\n blobName is <code>null</code> or empty,\n inputStream is <code>null</code> or not available,\n streamLength is negative,\n statusCallback is <code>null</code>"
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Upload the file to container, which was associated to the iothub. This function will start the upload process, and back the execution to the caller. The upload process will be executed in background. When it is completed, the background thread will trigger the callback with the upload status."
|
|
type: "class"
|
|
desc: "Provide means to upload file in the Azure Storage using the IoTHub."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.device.fileupload"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-device-client:1.30.1
|