DataLakeDirectoryClient Classe
- java.
lang. Object - com.
azure. storage. file. datalake. DataLakePathClient - com.
azure. storage. file. datalake. DataLakeDirectoryClient
- com.
- com.
public class DataLakeDirectoryClient
extends DataLakePathClient
Cette classe fournit un client qui contient des opérations d’annuaire pour Azure Storage Data Lake. Les opérations fournies par ce client incluent la création d’un répertoire, la suppression d’un répertoire, le renommage d’un répertoire, la définition de métadonnées et d’en-têtes HTTP, la définition et la récupération du contrôle d’accès, l’obtention de propriétés et la création et la suppression de fichiers et de sous-répertoires.
Ce client est instancié via DataLakePathClientBuilder ou récupéré via getDirectoryClient(String directoryName).
Pour plus d’informations, consultez Azure Docs .
Résumé de la méthode
Méthodes héritées de DataLakePathClient
Méthodes héritées de java.lang.Object
Détails de la méthode
createFile
public DataLakeFileClient createFile(String fileName)
Crée un fichier dans un répertoire. Par défaut, cette méthode ne remplace pas un fichier existant. Pour plus d’informations, consultez Azure Docs.
Exemples de code
DataLakeFileClient fileClient = client.createFile(fileName);
Parameters:
Returns:
createFile
public DataLakeFileClient createFile(String fileName, boolean overwrite)
Crée un fichier dans un répertoire. Pour plus d’informations, consultez Azure Docs.
Exemples de code
boolean overwrite = false; /* Default value. */
DataLakeFileClient fClient = client.createFile(fileName, overwrite);
Parameters:
Returns:
createFileIfNotExists
public DataLakeFileClient createFileIfNotExists(String fileName)
Crée un fichier dans un répertoire s’il n’existe pas. Pour plus d’informations, consultez Azure Docs.
Exemples de code
DataLakeFileClient fileClient = client.createFileIfNotExists(fileName);
Parameters:
Returns:
createFileIfNotExistsWithResponse
public Response
Crée un fichier dans un répertoire s’il n’existe pas. Pour plus d’informations, consultez Azure Docs.
Exemples de code
PathHttpHeaders headers = new PathHttpHeaders().setContentLanguage("en-US").setContentType("binary");
String permissions = "permissions";
String umask = "umask";
DataLakePathCreateOptions options = new DataLakePathCreateOptions()
.setPermissions(permissions)
.setUmask(umask)
.setPathHttpHeaders(headers)
.setMetadata(Collections.singletonMap("metadata", "value"));
Response<DataLakeFileClient> response = client.createFileIfNotExistsWithResponse(fileName, options, timeout,
new Context(key1, value1));
if (response.getStatusCode() == 409) {
System.out.println("Already existed.");
} else {
System.out.printf("Create completed with status %d%n", response.getStatusCode());
}
Parameters:
Returns:
createFileWithResponse
public Response
Crée un fichier dans un répertoire. Si un fichier portant le même nom existe déjà, le fichier est remplacé. Pour plus d’informations, consultez Azure Docs.
Exemples de code
PathHttpHeaders httpHeaders = new PathHttpHeaders()
.setContentLanguage("en-US")
.setContentType("binary");
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
Map<String, String> metadata = Collections.singletonMap("metadata", "value");
String permissions = "permissions";
String umask = "umask";
String owner = "rwx";
String group = "r--";
String leaseId = CoreUtils.randomUuid().toString();
Integer duration = 15;
DataLakePathCreateOptions options = new DataLakePathCreateOptions()
.setPermissions(permissions)
.setUmask(umask)
.setOwner(owner)
.setGroup(group)
.setPathHttpHeaders(httpHeaders)
.setRequestConditions(requestConditions)
.setMetadata(metadata)
.setProposedLeaseId(leaseId)
.setLeaseDuration(duration);
Response<DataLakeFileClient> newFileClient = client.createFileWithResponse(fileName, options, timeout,
new Context(key1, value1));
Parameters:
Returns:
createFileWithResponse
public Response
Crée un fichier dans un répertoire. Si un fichier portant le même nom existe déjà, le fichier est remplacé. Pour plus d’informations, consultez Azure Docs.
Exemples de code
PathHttpHeaders httpHeaders = new PathHttpHeaders()
.setContentLanguage("en-US")
.setContentType("binary");
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
String permissions = "permissions";
String umask = "umask";
Response<DataLakeFileClient> newFileClient = client.createFileWithResponse(fileName, permissions, umask, httpHeaders,
Collections.singletonMap("metadata", "value"), requestConditions,
timeout, new Context(key1, value1));
Parameters:
Returns:
createSubdirectory
public DataLakeDirectoryClient createSubdirectory(String subdirectoryName)
Crée un sous-répertoire dans un répertoire. Par défaut, cette méthode ne remplace pas un sous-répertoire existant. Pour plus d’informations, consultez Azure Docs.
Exemples de code
DataLakeDirectoryClient directoryClient = client.createSubdirectory(directoryName);
Parameters:
Returns:
createSubdirectory
public DataLakeDirectoryClient createSubdirectory(String subdirectoryName, boolean overwrite)
Crée un sous-répertoire dans un répertoire. Pour plus d’informations, consultez Azure Docs.
Exemples de code
boolean overwrite = false; /* Default value. */
DataLakeDirectoryClient dClient = client.createSubdirectory(fileName, overwrite);
Parameters:
Returns:
createSubdirectoryIfNotExists
public DataLakeDirectoryClient createSubdirectoryIfNotExists(String subdirectoryName)
Crée un sous-répertoire s’il n’existe pas dans un répertoire. Pour plus d’informations, consultez Azure Docs.
Exemples de code
DataLakeDirectoryClient directoryClient = client.createSubdirectoryIfNotExists(directoryName);
Parameters:
Returns:
createSubdirectoryIfNotExistsWithResponse
public Response
Crée un sous-répertoire dans un répertoire s’il n’existe pas. Pour plus d’informations, consultez Azure Docs.
Exemples de code
PathHttpHeaders headers = new PathHttpHeaders()
.setContentLanguage("en-US")
.setContentType("binary");
String permissions = "permissions";
String umask = "umask";
DataLakePathCreateOptions options = new DataLakePathCreateOptions()
.setPermissions(permissions)
.setUmask(umask)
.setPathHttpHeaders(headers)
.setMetadata(Collections.singletonMap("metadata", "value"));
Response<DataLakeDirectoryClient> response = client.createSubdirectoryIfNotExistsWithResponse(directoryName,
options, timeout, new Context(key1, value1));
if (response.getStatusCode() == 409) {
System.out.println("Already existed.");
} else {
System.out.printf("Create completed with status %d%n", response.getStatusCode());
}
Parameters:
Returns:
createSubdirectoryWithResponse
public Response
Crée un sous-répertoire dans un répertoire. Si un sous-répertoire portant le même nom existe déjà, le sous-répertoire est remplacé. Pour plus d’informations, consultez Azure Docs.
Exemples de code
PathHttpHeaders httpHeaders = new PathHttpHeaders()
.setContentLanguage("en-US")
.setContentType("binary");
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
Map<String, String> metadata = Collections.singletonMap("metadata", "value");
String permissions = "permissions";
String umask = "umask";
String owner = "rwx";
String group = "r--";
String leaseId = CoreUtils.randomUuid().toString();
Integer duration = 15;
DataLakePathCreateOptions options = new DataLakePathCreateOptions()
.setPermissions(permissions)
.setUmask(umask)
.setOwner(owner)
.setGroup(group)
.setPathHttpHeaders(httpHeaders)
.setRequestConditions(requestConditions)
.setMetadata(metadata)
.setProposedLeaseId(leaseId)
.setLeaseDuration(duration);
Response<DataLakeDirectoryClient> newDirectoryClient = client.createSubdirectoryWithResponse(directoryName,
options, timeout, new Context(key1, value1));
Parameters:
Returns:
createSubdirectoryWithResponse
public Response
Crée un sous-répertoire dans un répertoire. Si un sous-répertoire portant le même nom existe déjà, le sous-répertoire est remplacé. Pour plus d’informations, consultez Azure Docs.
Exemples de code
PathHttpHeaders httpHeaders = new PathHttpHeaders()
.setContentLanguage("en-US")
.setContentType("binary");
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
String permissions = "permissions";
String umask = "umask";
Response<DataLakeDirectoryClient> newDirectoryClient = client.createSubdirectoryWithResponse(directoryName,
permissions, umask, httpHeaders, Collections.singletonMap("metadata", "value"), requestConditions, timeout,
new Context(key1, value1));
Parameters:
Returns:
delete
public void delete()
Supprime un répertoire.
Exemples de code
client.delete();
System.out.println("Delete request completed");
Pour plus d’informations, consultez Azure Docs.
deleteFile
public void deleteFile(String fileName)
Supprime le fichier spécifié dans le répertoire . Si le fichier n’existe pas, l’opération échoue. Pour plus d’informations, consultez Azure Docs.
Exemples de code
client.deleteFile(fileName);
System.out.println("Delete request completed");
Parameters:
deleteFileIfExists
public boolean deleteFileIfExists(String fileName)
Supprime le fichier spécifié dans le répertoire s’il existe. Pour plus d’informations, consultez Azure Docs.
Exemples de code
boolean result = client.deleteFileIfExists(fileName);
System.out.println("Delete request completed: " + result);
Parameters:
Returns:
true
si le fichier est supprimé avec succès, false
si le fichier n’existe pas.deleteFileIfExistsWithResponse
public Response
Supprime le fichier spécifié dans le répertoire s’il existe. Pour plus d’informations, consultez Azure Docs.
Exemples de code
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
DataLakePathDeleteOptions options = new DataLakePathDeleteOptions().setIsRecursive(false)
.setRequestConditions(requestConditions);
Response<Boolean> response = client.deleteFileIfExistsWithResponse(fileName, options, timeout,
new Context(key1, value1));
if (response.getStatusCode() == 404) {
System.out.println("Does not exist.");
} else {
System.out.printf("Delete completed with status %d%n", response.getStatusCode());
}
Parameters:
Returns:
deleteFileWithResponse
public Response
Supprime le fichier spécifié dans le répertoire. Si le fichier n’existe pas, l’opération échoue. Pour plus d’informations, consultez Azure Docs.
Exemples de code
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
client.deleteFileWithResponse(fileName, requestConditions, timeout, new Context(key1, value1));
System.out.println("Delete request completed");
Parameters:
Returns:
deleteIfExists
public boolean deleteIfExists()
Supprime un répertoire s’il existe.
Exemples de code
boolean result = client.deleteIfExists();
System.out.println("Delete request completed: " + result);
Pour plus d’informations, consultez Azure Docs
Overrides:
DataLakeDirectoryClient.deleteIfExists()Returns:
true
si le répertoire est supprimé avec succès, false
si le répertoire n’existe pas.deleteIfExistsWithResponse
public Response
Supprime un répertoire s’il existe.
Exemples de code
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
boolean recursive = false; // Default value
DataLakePathDeleteOptions options = new DataLakePathDeleteOptions().setIsRecursive(recursive)
.setRequestConditions(requestConditions);
Response<Boolean> response = client.deleteIfExistsWithResponse(options, timeout, new Context(key1, value1));
if (response.getStatusCode() == 404) {
System.out.println("Does not exist.");
} else {
System.out.printf("Delete completed with status %d%n", response.getStatusCode());
}
Pour plus d’informations, consultez Azure Docs
Overrides:
DataLakeDirectoryClient.deleteIfExistsWithResponse(DataLakePathDeleteOptions options, Duration timeout, Context context)Parameters:
Returns:
deleteRecursively
public void deleteRecursively()
Supprime de manière récursive un répertoire et tout le contenu du répertoire.
Exemples de code
client.deleteRecursively();
System.out.println("Delete request completed");
Pour plus d’informations, consultez Azure Docs
deleteRecursivelyWithResponse
public Response
Supprime de manière récursive un répertoire et tout le contenu du répertoire.
Exemples de code
DataLakeRequestConditions deleteRequestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
client.deleteRecursivelyWithResponse(deleteRequestConditions, timeout, new Context(key1, value1));
System.out.println("Delete request completed");
Pour plus d’informations, consultez Azure Docs
Parameters:
Returns:
deleteSubdirectory
public void deleteSubdirectory(String subdirectoryName)
Supprime le sous-répertoire spécifié dans le répertoire. Si le sous-répertoire n’existe pas ou n’est pas vide, l’opération échoue. Pour plus d’informations, consultez Azure Docs.
Exemples de code
client.deleteSubdirectory(directoryName);
System.out.println("Delete request completed");
Parameters:
deleteSubdirectoryIfExists
public boolean deleteSubdirectoryIfExists(String subdirectoryName)
Supprime le sous-répertoire spécifié dans le répertoire s’il existe. Pour plus d’informations, consultez Azure Docs.
Exemples de code
boolean result = client.deleteSubdirectoryIfExists(directoryName);
System.out.println("Delete request completed: " + result);
Parameters:
Returns:
true
si le sous-répertoire est supprimé avec succès, false
si le sous-répertoire n’existe pas.deleteSubdirectoryIfExistsWithResponse
public Response
Supprime le sous-répertoire spécifié dans le répertoire s’il existe. Pour plus d’informations, consultez Azure Docs.
Exemples de code
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
boolean recursive = false; // Default value
DataLakePathDeleteOptions options = new DataLakePathDeleteOptions().setIsRecursive(recursive)
.setRequestConditions(requestConditions);
Response<Boolean> response = client.deleteSubdirectoryIfExistsWithResponse(directoryName, options,
timeout, new Context(key1, value1));
if (response.getStatusCode() == 404) {
System.out.println("Does not exist.");
} else {
System.out.printf("Delete completed with status %d%n", response.getStatusCode());
}
Parameters:
Returns:
deleteSubdirectoryWithResponse
public Response
Supprime le sous-répertoire spécifié dans le répertoire. Si le sous-répertoire n’existe pas ou n’est pas vide, l’opération échoue. Pour plus d’informations, consultez Azure Docs.
Exemples de code
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
boolean recursive = false; // Default value
client.deleteSubdirectoryWithResponse(directoryName, recursive, requestConditions, timeout,
new Context(key1, value1));
System.out.println("Delete request completed");
Parameters:
Returns:
deleteWithResponse
public Response
Supprime un répertoire.
Exemples de code
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
boolean recursive = false; // Default value
client.deleteWithResponse(recursive, requestConditions, timeout, new Context(key1, value1));
System.out.println("Delete request completed");
Pour plus d’informations, consultez Azure Docs
Parameters:
Returns:
getCustomerProvidedKeyClient
public DataLakeDirectoryClient getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)
Crée un nouveau DataLakeDirectoryClient avec le customerProvidedKey
spécifié.
Overrides:
DataLakeDirectoryClient.getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)Parameters:
null
à n’utiliser aucune clé fournie par le CustomerProvidedKey client.
Returns:
customerProvidedKey
.getDirectoryName
public String getDirectoryName()
Obtient le nom de ce répertoire, sans inclure son chemin d’accès complet.
Returns:
getDirectoryPath
public String getDirectoryPath()
Obtient le chemin d’accès de ce répertoire, sans inclure le nom de la ressource elle-même.
Returns:
getDirectoryUrl
public String getDirectoryUrl()
Obtient l’URL du répertoire représenté par ce client sur le service Data Lake.
Returns:
getFileClient
public DataLakeFileClient getFileClient(String fileName)
Initialise un nouvel objet DataLakeFileClient en concaténant fileName à la fin de l’URL de DataLakeDirectoryClient. Le nouveau DataLakeFileClient utilise le même pipeline de stratégie de requête que DataLakeDirectoryClient.
Parameters:
String
représentant le nom du fichier.
Exemples de code
DataLakeFileClient dataLakeFileClient = client.getFileClient(fileName);
Returns:
getSubdirectoryClient
public DataLakeDirectoryClient getSubdirectoryClient(String subdirectoryName)
Initialise un nouvel objet DataLakeDirectoryClient en concaténant directoryName à la fin de l’URL de DataLakeDirectoryClient. Le nouveau DataLakeDirectoryClient utilise le même pipeline de stratégie de requête que le DataLakeDirectoryClient.
Parameters:
String
représentant le nom du sous-répertoire.
Exemples de code
DataLakeDirectoryClient dataLakeDirectoryClient = client.getSubdirectoryClient(directoryName);
Returns:
listPaths
public PagedIterable
Retourne une liste chargée différée de fichiers/répertoires dans ce répertoire. Le retourné PagedIterable<T> peut être consommé pendant que les nouveaux éléments sont récupérés automatiquement en fonction des besoins. Pour plus d’informations, consultez Azure Docs.
Exemples de code
client.listPaths().forEach(path -> System.out.printf("Name: %s%n", path.getName()));
Returns:
listPaths
public PagedIterable
Retourne une liste chargée différée de fichiers/répertoires dans ce répertoire. Le retourné PagedIterable<T> peut être consommé pendant que les nouveaux éléments sont récupérés automatiquement en fonction des besoins. Pour plus d’informations, consultez Azure Docs.
Exemples de code
client.listPaths(false, false, 10, timeout)
.forEach(path -> System.out.printf("Name: %s%n", path.getName()));
Parameters:
Returns:
rename
public DataLakeDirectoryClient rename(String destinationFileSystem, String destinationPath)
Déplace le répertoire vers un autre emplacement dans le système de fichiers. Pour plus d’informations, consultez Azure Docs.
Exemples de code
DataLakeDirectoryClient renamedClient = client.rename(fileSystemName, destinationPath);
System.out.println("Directory Client has been renamed");
Parameters:
null
pour le système de fichiers actuel.
Returns:
renameWithResponse
public Response
Déplace le répertoire vers un autre emplacement dans le système de fichiers. Pour plus d’informations, consultez Azure Docs.
Exemples de code
DataLakeRequestConditions sourceRequestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
DataLakeRequestConditions destinationRequestConditions = new DataLakeRequestConditions();
DataLakeDirectoryClient newRenamedClient = client.renameWithResponse(fileSystemName, destinationPath,
sourceRequestConditions, destinationRequestConditions, timeout, new Context(key1, value1)).getValue();
System.out.println("Directory Client has been renamed");
Parameters:
null
pour le système de fichiers actuel.
Returns:
S’applique à
Azure SDK for Java