azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.batch.F...

580 строки
55 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.batch.FileOperations"
fullName: "com.microsoft.azure.batch.FileOperations"
name: "FileOperations"
nameWithType: "FileOperations"
summary: "Performs file-related operations on an Azure Batch account."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **FileOperations**</br> implements <xref href=\"com.microsoft.azure.batch.IInheritedBehaviors?alt=com.microsoft.azure.batch.IInheritedBehaviors&text=IInheritedBehaviors\" data-throw-if-not-resolved=\"False\" />"
methods:
- uid: "com.microsoft.azure.batch.FileOperations.customBehaviors()"
fullName: "com.microsoft.azure.batch.FileOperations.customBehaviors()"
name: "customBehaviors()"
nameWithType: "FileOperations.customBehaviors()"
summary: "Gets a collection of behaviors that modify or customize requests to the Batch service."
syntax: "public Collection<BatchClientBehavior> customBehaviors()"
desc: "Gets a collection of behaviors that modify or customize requests to the Batch service."
returns:
description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a>&lt;<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.batch.FileOperations.deleteFileFromComputeNode(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.batch.FileOperations.deleteFileFromComputeNode(String poolId, String nodeId, String fileName)"
name: "deleteFileFromComputeNode(String poolId, String nodeId, String fileName)"
nameWithType: "FileOperations.deleteFileFromComputeNode(String poolId, String nodeId, String fileName)"
summary: "Deletes the specified file from the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to delete."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public void deleteFileFromComputeNode(String poolId, String nodeId, String fileName)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Deletes the specified file from the specified compute node."
- uid: "com.microsoft.azure.batch.FileOperations.deleteFileFromComputeNode(java.lang.String,java.lang.String,java.lang.String,java.lang.Boolean)"
fullName: "com.microsoft.azure.batch.FileOperations.deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive)"
name: "deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive)"
nameWithType: "FileOperations.deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive)"
summary: "Deletes the specified file from the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to delete."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If the file-path parameter represents a directory instead of a file, you can set the recursive parameter to true to delete the directory and all of the files and subdirectories in it. If recursive is false or null, then the directory must be empty or deletion will fail."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public void deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Deletes the specified file from the specified compute node."
- uid: "com.microsoft.azure.batch.FileOperations.deleteFileFromComputeNode(java.lang.String,java.lang.String,java.lang.String,java.lang.Boolean,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.FileOperations.deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
name: "deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
nameWithType: "FileOperations.deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
summary: "Deletes the specified file from the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to delete."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If the file-path parameter represents a directory instead of a file, you can set the recursive parameter to true to delete the directory and all of the files and subdirectories in it. If recursive is false or null, then the directory must be empty or deletion will fail."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public void deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Deletes the specified file from the specified compute node."
- uid: "com.microsoft.azure.batch.FileOperations.deleteFileFromTask(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.batch.FileOperations.deleteFileFromTask(String jobId, String taskId, String fileName)"
name: "deleteFileFromTask(String jobId, String taskId, String fileName)"
nameWithType: "FileOperations.deleteFileFromTask(String jobId, String taskId, String fileName)"
summary: "Deletes the specified file from the specified task's directory on its compute node."
parameters:
- description: "The ID of the job containing the task."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to delete."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public void deleteFileFromTask(String jobId, String taskId, String fileName)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Deletes the specified file from the specified task's directory on its compute node."
- uid: "com.microsoft.azure.batch.FileOperations.deleteFileFromTask(java.lang.String,java.lang.String,java.lang.String,java.lang.Boolean)"
fullName: "com.microsoft.azure.batch.FileOperations.deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive)"
name: "deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive)"
nameWithType: "FileOperations.deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive)"
summary: "Deletes the specified file from the specified task's directory on its compute node."
parameters:
- description: "The ID of the job containing the task."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to delete."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If the file-path parameter represents a directory instead of a file, you can set the recursive parameter to true to delete the directory and all of the files and subdirectories in it. If recursive is false or null, then the directory must be empty or deletion will fail."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public void deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Deletes the specified file from the specified task's directory on its compute node."
- uid: "com.microsoft.azure.batch.FileOperations.deleteFileFromTask(java.lang.String,java.lang.String,java.lang.String,java.lang.Boolean,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.FileOperations.deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
name: "deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
nameWithType: "FileOperations.deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
summary: "Deletes the specified file from the specified task's directory on its compute node."
parameters:
- description: "The ID of the job containing the task."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to delete."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If the file-path parameter represents a directory instead of a file, you can set the recursive parameter to true to delete the directory and all of the files and subdirectories in it. If recursive is false or null, then the directory must be empty or deletion will fail."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public void deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Deletes the specified file from the specified task's directory on its compute node."
- uid: "com.microsoft.azure.batch.FileOperations.getFileFromComputeNode(java.lang.String,java.lang.String,java.lang.String,java.io.OutputStream)"
fullName: "com.microsoft.azure.batch.FileOperations.getFileFromComputeNode(String poolId, String nodeId, String fileName, OutputStream outputStream)"
name: "getFileFromComputeNode(String poolId, String nodeId, String fileName, OutputStream outputStream)"
nameWithType: "FileOperations.getFileFromComputeNode(String poolId, String nodeId, String fileName, OutputStream outputStream)"
summary: "Downloads the specified file from the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to download."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A stream into which the file contents will be written."
name: "outputStream"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html\">OutputStream</a>"
syntax: "public void getFileFromComputeNode(String poolId, String nodeId, String fileName, OutputStream outputStream)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Downloads the specified file from the specified compute node."
- uid: "com.microsoft.azure.batch.FileOperations.getFileFromComputeNode(java.lang.String,java.lang.String,java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>,java.io.OutputStream)"
fullName: "com.microsoft.azure.batch.FileOperations.getFileFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
name: "getFileFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
nameWithType: "FileOperations.getFileFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
summary: "Downloads the specified file from the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to download."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />&gt;"
- description: "A stream into which the file contents will be written."
name: "outputStream"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html\">OutputStream</a>"
syntax: "public void getFileFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Downloads the specified file from the specified compute node."
- uid: "com.microsoft.azure.batch.FileOperations.getFileFromTask(java.lang.String,java.lang.String,java.lang.String,java.io.OutputStream)"
fullName: "com.microsoft.azure.batch.FileOperations.getFileFromTask(String jobId, String taskId, String fileName, OutputStream outputStream)"
name: "getFileFromTask(String jobId, String taskId, String fileName, OutputStream outputStream)"
nameWithType: "FileOperations.getFileFromTask(String jobId, String taskId, String fileName, OutputStream outputStream)"
summary: "Downloads the specified file from the specified task's directory on its compute node."
parameters:
- description: "The ID of the job containing the task."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to download."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A stream into which the file contents will be written."
name: "outputStream"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html\">OutputStream</a>"
syntax: "public void getFileFromTask(String jobId, String taskId, String fileName, OutputStream outputStream)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Downloads the specified file from the specified task's directory on its compute node."
- uid: "com.microsoft.azure.batch.FileOperations.getFileFromTask(java.lang.String,java.lang.String,java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>,java.io.OutputStream)"
fullName: "com.microsoft.azure.batch.FileOperations.getFileFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
name: "getFileFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
nameWithType: "FileOperations.getFileFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
summary: "Downloads the specified file from the specified task's directory on its compute node."
parameters:
- description: "The ID of the job containing the task."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to download."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />&gt;"
- description: "A stream into which the file contents will be written."
name: "outputStream"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html\">OutputStream</a>"
syntax: "public void getFileFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Downloads the specified file from the specified task's directory on its compute node."
- uid: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromComputeNode(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName)"
name: "getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName)"
nameWithType: "FileOperations.getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName)"
summary: "Gets information about a file on a compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to retrieve."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileProperties getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Gets information about a file on a compute node."
returns:
description: "A <xref uid=\"com.microsoft.azure.batch.protocol.models.FileProperties\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FileProperties\"></xref> instance containing information about the file."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileProperties?alt=com.microsoft.azure.batch.protocol.models.FileProperties&text=FileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromComputeNode(java.lang.String,java.lang.String,java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
name: "getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
nameWithType: "FileOperations.getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
summary: "Gets information about a file on a compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to retrieve."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public FileProperties getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Gets information about a file on a compute node."
returns:
description: "A <xref uid=\"com.microsoft.azure.batch.protocol.models.FileProperties\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FileProperties\"></xref> instance containing information about the file."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileProperties?alt=com.microsoft.azure.batch.protocol.models.FileProperties&text=FileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromTask(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromTask(String jobId, String taskId, String fileName)"
name: "getFilePropertiesFromTask(String jobId, String taskId, String fileName)"
nameWithType: "FileOperations.getFilePropertiesFromTask(String jobId, String taskId, String fileName)"
summary: "Gets information about a file from the specified task's directory on its compute node."
parameters:
- description: "The ID of the job containing the task."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to retrieve."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileProperties getFilePropertiesFromTask(String jobId, String taskId, String fileName)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Gets information about a file from the specified task's directory on its compute node."
returns:
description: "A <xref uid=\"com.microsoft.azure.batch.protocol.models.FileProperties\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FileProperties\"></xref> instance containing information about the file."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileProperties?alt=com.microsoft.azure.batch.protocol.models.FileProperties&text=FileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromTask(java.lang.String,java.lang.String,java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
name: "getFilePropertiesFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
nameWithType: "FileOperations.getFilePropertiesFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
summary: "Gets information about a file from the specified task's directory on its compute node."
parameters:
- description: "The ID of the job containing the task."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to retrieve."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public FileProperties getFilePropertiesFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Gets information about a file from the specified task's directory on its compute node."
returns:
description: "A <xref uid=\"com.microsoft.azure.batch.protocol.models.FileProperties\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FileProperties\"></xref> instance containing information about the file."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileProperties?alt=com.microsoft.azure.batch.protocol.models.FileProperties&text=FileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.FileOperations.listFilesFromComputeNode(java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.batch.FileOperations.listFilesFromComputeNode(String poolId, String nodeId)"
name: "listFilesFromComputeNode(String poolId, String nodeId)"
nameWithType: "FileOperations.listFilesFromComputeNode(String poolId, String nodeId)"
summary: "Lists files on the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PagedList<NodeFile> listFilesFromComputeNode(String poolId, String nodeId)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Lists files on the specified compute node."
returns:
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.NodeFile\" data-throw-if-not-resolved=\"false\" data-raw-source=\"NodeFile\"></xref> objects."
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.batch.protocol.models.NodeFile?alt=com.microsoft.azure.batch.protocol.models.NodeFile&text=NodeFile\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.batch.FileOperations.listFilesFromComputeNode(java.lang.String,java.lang.String,java.lang.Boolean,com.microsoft.azure.batch.DetailLevel)"
fullName: "com.microsoft.azure.batch.FileOperations.listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel)"
name: "listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel)"
nameWithType: "FileOperations.listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel)"
summary: "Lists files on the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If true, recursively lists all files on the compute node. If false or null, lists only the files in the compute node root directory."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- description: "A <xref uid=\"com.microsoft.azure.batch.DetailLevel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DetailLevel\"></xref> used for filtering the list and for controlling which properties are retrieved from the service."
name: "detailLevel"
type: "<xref href=\"com.microsoft.azure.batch.DetailLevel?alt=com.microsoft.azure.batch.DetailLevel&text=DetailLevel\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PagedList<NodeFile> listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Lists files on the specified compute node."
returns:
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.NodeFile\" data-throw-if-not-resolved=\"false\" data-raw-source=\"NodeFile\"></xref> objects."
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.batch.protocol.models.NodeFile?alt=com.microsoft.azure.batch.protocol.models.NodeFile&text=NodeFile\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.batch.FileOperations.listFilesFromComputeNode(java.lang.String,java.lang.String,java.lang.Boolean,com.microsoft.azure.batch.DetailLevel,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.FileOperations.listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
name: "listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
nameWithType: "FileOperations.listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
summary: "Lists files on the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If true, recursively lists all files on the compute node. If false or null, lists only the files in the compute node root directory."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- description: "A <xref uid=\"com.microsoft.azure.batch.DetailLevel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DetailLevel\"></xref> used for filtering the list and for controlling which properties are retrieved from the service."
name: "detailLevel"
type: "<xref href=\"com.microsoft.azure.batch.DetailLevel?alt=com.microsoft.azure.batch.DetailLevel&text=DetailLevel\" data-throw-if-not-resolved=\"False\" />"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public PagedList<NodeFile> listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Lists files on the specified compute node."
returns:
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.NodeFile\" data-throw-if-not-resolved=\"false\" data-raw-source=\"NodeFile\"></xref> objects."
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.batch.protocol.models.NodeFile?alt=com.microsoft.azure.batch.protocol.models.NodeFile&text=NodeFile\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.batch.FileOperations.listFilesFromTask(java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.batch.FileOperations.listFilesFromTask(String jobId, String taskId)"
name: "listFilesFromTask(String jobId, String taskId)"
nameWithType: "FileOperations.listFilesFromTask(String jobId, String taskId)"
summary: "Lists the files in the specified task's directory on its compute node."
parameters:
- description: "The ID of the job."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PagedList<NodeFile> listFilesFromTask(String jobId, String taskId)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Lists the files in the specified task's directory on its compute node."
returns:
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.NodeFile\" data-throw-if-not-resolved=\"false\" data-raw-source=\"NodeFile\"></xref> objects."
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.batch.protocol.models.NodeFile?alt=com.microsoft.azure.batch.protocol.models.NodeFile&text=NodeFile\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.batch.FileOperations.listFilesFromTask(java.lang.String,java.lang.String,java.lang.Boolean,com.microsoft.azure.batch.DetailLevel)"
fullName: "com.microsoft.azure.batch.FileOperations.listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel)"
name: "listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel)"
nameWithType: "FileOperations.listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel)"
summary: "Lists the files in the specified task's directory on its compute node."
parameters:
- description: "The ID of the job."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If true, performs a recursive list of all files of the task. If false or null, returns only the files in the root task directory."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- description: "A <xref uid=\"com.microsoft.azure.batch.DetailLevel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DetailLevel\"></xref> used for filtering the list and for controlling which properties are retrieved from the service."
name: "detailLevel"
type: "<xref href=\"com.microsoft.azure.batch.DetailLevel?alt=com.microsoft.azure.batch.DetailLevel&text=DetailLevel\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PagedList<NodeFile> listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Lists the files in the specified task's directory on its compute node."
returns:
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.NodeFile\" data-throw-if-not-resolved=\"false\" data-raw-source=\"NodeFile\"></xref> objects."
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.batch.protocol.models.NodeFile?alt=com.microsoft.azure.batch.protocol.models.NodeFile&text=NodeFile\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.batch.FileOperations.listFilesFromTask(java.lang.String,java.lang.String,java.lang.Boolean,com.microsoft.azure.batch.DetailLevel,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.FileOperations.listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
name: "listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
nameWithType: "FileOperations.listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
summary: "Lists the files in the specified task's directory on its compute node."
parameters:
- description: "The ID of the job."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If true, performs a recursive list of all files of the task. If false or null, returns only the files in the root task directory."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- description: "A <xref uid=\"com.microsoft.azure.batch.DetailLevel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DetailLevel\"></xref> used for filtering the list and for controlling which properties are retrieved from the service."
name: "detailLevel"
type: "<xref href=\"com.microsoft.azure.batch.DetailLevel?alt=com.microsoft.azure.batch.DetailLevel&text=DetailLevel\" data-throw-if-not-resolved=\"False\" />"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public PagedList<NodeFile> listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Lists the files in the specified task's directory on its compute node."
returns:
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.NodeFile\" data-throw-if-not-resolved=\"false\" data-raw-source=\"NodeFile\"></xref> objects."
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.batch.protocol.models.NodeFile?alt=com.microsoft.azure.batch.protocol.models.NodeFile&text=NodeFile\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.batch.FileOperations.withCustomBehaviors(java.util.Collection<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.FileOperations.withCustomBehaviors(Collection<BatchClientBehavior> behaviors)"
name: "withCustomBehaviors(Collection<BatchClientBehavior> behaviors)"
nameWithType: "FileOperations.withCustomBehaviors(Collection<BatchClientBehavior> behaviors)"
summary: "Sets a collection of behaviors that modify or customize requests to the Batch service."
parameters:
- description: "The collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances."
name: "behaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a>&lt;<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public IInheritedBehaviors withCustomBehaviors(Collection<BatchClientBehavior> behaviors)"
desc: "Sets a collection of behaviors that modify or customize requests to the Batch service."
returns:
description: "The current instance."
type: "<xref href=\"com.microsoft.azure.batch.IInheritedBehaviors?alt=com.microsoft.azure.batch.IInheritedBehaviors&text=IInheritedBehaviors\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Performs file-related operations on an Azure Batch account."
implements:
- "<xref href=\"com.microsoft.azure.batch.IInheritedBehaviors?alt=com.microsoft.azure.batch.IInheritedBehaviors&text=IInheritedBehaviors\" data-throw-if-not-resolved=\"False\" />"
metadata: {}
package: "com.microsoft.azure.batch"
artifact: com.microsoft.azure:azure-batch:11.2.0