ResourceFile (Microsoft Azure Management Libraries for Java 1.35.0)

java.lang.Object
- com.microsoft.azure.management.batch.ResourceFile

```
public class ResourceFile
extends Object
```
A single file or multiple files to be downloaded to a compute node.

Constructor Summary

Constructors
Constructor and Description

ResourceFile()

Constructors
Constructor and Description
`ResourceFile()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`autoStorageContainerName()` Get the autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
`String`	`blobPrefix()` Get the property is valid only when autoStorageContainerName or storageContainerUrl is used.
`String`	`fileMode()` Get this property applies only to files being downloaded to Linux compute nodes.
`String`	`filePath()` Get if the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename.
`String`	`httpUrl()` Get the autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
`String`	`storageContainerUrl()` Get the autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
`ResourceFile`	`withAutoStorageContainerName(String autoStorageContainerName)` Set the autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
`ResourceFile`	`withBlobPrefix(String blobPrefix)` Set the property is valid only when autoStorageContainerName or storageContainerUrl is used.
`ResourceFile`	`withFileMode(String fileMode)` Set this property applies only to files being downloaded to Linux compute nodes.
`ResourceFile`	`withFilePath(String filePath)` Set if the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename.
`ResourceFile`	`withHttpUrl(String httpUrl)` Set the autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
`ResourceFile`	`withStorageContainerUrl(String storageContainerUrl)` Set the autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ResourceFile
```
public ResourceFile()
```
- Method Detail
  - autoStorageContainerName
```
public String autoStorageContainerName()
```
    Get the autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
    
    Returns:
    
    the autoStorageContainerName value
  - withAutoStorageContainerName
```
public ResourceFile withAutoStorageContainerName(String autoStorageContainerName)
```
    Set the autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
    
    Parameters:
    
    autoStorageContainerName - the autoStorageContainerName value to set
    
    Returns:
    
    the ResourceFile object itself.
  - storageContainerUrl
```
public String storageContainerUrl()
```
    Get the autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.
    
    Returns:
    
    the storageContainerUrl value
  - withStorageContainerUrl
```
public ResourceFile withStorageContainerUrl(String storageContainerUrl)
```
    Set the autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.
    
    Parameters:
    
    storageContainerUrl - the storageContainerUrl value to set
    
    Returns:
    
    the ResourceFile object itself.
  - httpUrl
```
public String httpUrl()
```
    Get the autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.
    
    Returns:
    
    the httpUrl value
  - withHttpUrl
```
public ResourceFile withHttpUrl(String httpUrl)
```
    Set the autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.
    
    Parameters:
    
    httpUrl - the httpUrl value to set
    
    Returns:
    
    the ResourceFile object itself.
  - blobPrefix
```
public String blobPrefix()
```
    Get the property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.
    
    Returns:
    
    the blobPrefix value
  - withBlobPrefix
```
public ResourceFile withBlobPrefix(String blobPrefix)
```
    Set the property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.
    
    Parameters:
    
    blobPrefix - the blobPrefix value to set
    
    Returns:
    
    the ResourceFile object itself.
  - filePath
```
public String filePath()
```
    Get if the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..').
    
    Returns:
    
    the filePath value
  - withFilePath
```
public ResourceFile withFilePath(String filePath)
```
    Set if the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..').
    
    Parameters:
    
    filePath - the filePath value to set
    
    Returns:
    
    the ResourceFile object itself.
  - fileMode
```
public String fileMode()
```
    Get this property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.
    
    Returns:
    
    the fileMode value
  - withFileMode
```
public ResourceFile withFileMode(String fileMode)
```
    Set this property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.
    
    Parameters:
    
    fileMode - the fileMode value to set
    
    Returns:
    
    the ResourceFile object itself.

/** 
* Copyright (c) Microsoft Corporation. All rights reserved. 
* Licensed under the MIT License. See License.txt in the project root for 
* license information. 
*/

Class ResourceFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ResourceFile

Method Detail

autoStorageContainerName

withAutoStorageContainerName

storageContainerUrl

withStorageContainerUrl

httpUrl

withHttpUrl

blobPrefix

withBlobPrefix

filePath

withFilePath

fileMode

withFileMode