DataLakeDirectoryClient Classe

Pacote:

com.azure.storage.file.datalake

Artefato Maven:

com.azure:azure-storage-file-datalake:12.19.0

• java.lang.Object
• • com.azure.storage.file.datalake.DataLakePathClient
  • • com.azure.storage.file.datalake.DataLakeDirectoryClient

public class DataLakeDirectoryClient
extends DataLakePathClient

Essa classe fornece um cliente que contém operações de diretório para o Azure Storage Data Lake. As operações fornecidas por esse cliente incluem criar um diretório, excluir um diretório, renomear um diretório, definir metadados e cabeçalhos http, definir e recuperar o controle de acesso, obter propriedades e criar e excluir arquivos e subdiretórios.

Esse cliente é instanciado por meio DataLakePathClientBuilder de ou recuperado por meio de getDirectoryClient(String directoryName).

Consulte o Azure Docs para obter mais informações.

Resumo do método

Modificador e tipo	Método e descrição
DataLakeFileClient	createFile(String fileName) Cria um novo arquivo em um diretório.
DataLakeFileClient	createFile(String fileName, boolean overwrite) Cria um novo arquivo em um diretório.
DataLakeFileClient	createFileIfNotExists(String fileName) Cria um novo arquivo em um diretório se ele não existir.
Response<DataLakeFileClient>	createFileIfNotExistsWithResponse(String fileName, DataLakePathCreateOptions options, Duration timeout, Context context) Cria um novo arquivo em um diretório se ele não existir.
Response<DataLakeFileClient>	createFileWithResponse(String fileName, DataLakePathCreateOptions options, Duration timeout, Context context) Cria um novo arquivo em um diretório.
Response<DataLakeFileClient>	createFileWithResponse(String fileName, String permissions, String umask, PathHttpHeaders headers, Map<String,String> metadata, DataLakeRequestConditions requestConditions, Duration timeout, Context context) Cria um novo arquivo em um diretório.
DataLakeDirectoryClient	createSubdirectory(String subdirectoryName) Cria um novo subdiretório em um diretório.
DataLakeDirectoryClient	createSubdirectory(String subdirectoryName, boolean overwrite) Cria um novo subdiretório em um diretório.
DataLakeDirectoryClient	createSubdirectoryIfNotExists(String subdirectoryName) Cria um novo subdiretório se ele não existir em um diretório.
Response<DataLakeDirectoryClient>	createSubdirectoryIfNotExistsWithResponse(String subdirectoryName, DataLakePathCreateOptions options, Duration timeout, Context context) Cria um novo subdiretório em um diretório se ele não existir.
Response<DataLakeDirectoryClient>	createSubdirectoryWithResponse(String subdirectoryName, DataLakePathCreateOptions options, Duration timeout, Context context) Cria um novo subdiretório em um diretório.
Response<DataLakeDirectoryClient>	createSubdirectoryWithResponse(String subdirectoryName, String permissions, String umask, PathHttpHeaders headers, Map<String,String> metadata, DataLakeRequestConditions requestConditions, Duration timeout, Context context) Cria um novo subdiretório em um diretório.
void	delete() Exclui um diretório.
void	deleteFile(String fileName) Exclui o arquivo especificado no diretório.
boolean	deleteFileIfExists(String fileName) Exclui o arquivo especificado no diretório se ele existir.
Response<Boolean>	deleteFileIfExistsWithResponse(String fileName, DataLakePathDeleteOptions options, Duration timeout, Context context) Exclui o arquivo especificado no diretório se ele existir.
Response<Void>	deleteFileWithResponse(String fileName, DataLakeRequestConditions requestConditions, Duration timeout, Context context) Exclui o arquivo especificado no diretório.
boolean	deleteIfExists() Exclui um diretório se ele existir.
Response<Boolean>	deleteIfExistsWithResponse(DataLakePathDeleteOptions options, Duration timeout, Context context) Exclui um diretório se ele existir.
void	deleteRecursively() Exclui recursivamente um diretório e todo o conteúdo dentro do diretório.
Response<Void>	deleteRecursivelyWithResponse(DataLakeRequestConditions requestConditions, Duration timeout, Context context) Exclui recursivamente um diretório e todo o conteúdo dentro do diretório.
void	deleteSubdirectory(String subdirectoryName) Exclui o subdiretório especificado no diretório.
boolean	deleteSubdirectoryIfExists(String subdirectoryName) Exclui o subdiretório especificado no diretório se ele existir.
Response<Boolean>	deleteSubdirectoryIfExistsWithResponse(String subdirectoryName, DataLakePathDeleteOptions options, Duration timeout, Context context) Exclui o subdiretório especificado no diretório se ele existir.
Response<Void>	deleteSubdirectoryWithResponse(String subdirectoryName, boolean recursive, DataLakeRequestConditions requestConditions, Duration timeout, Context context) Exclui o subdiretório especificado no diretório.
Response<Void>	deleteWithResponse(boolean recursive, DataLakeRequestConditions requestConditions, Duration timeout, Context context) Exclui um diretório.
DataLakeDirectoryClient	getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey) Cria um novo DataLakeDirectoryClient com o customerProvidedKey especificado.
String	getDirectoryName() Obtém o nome desse diretório, sem incluir seu caminho completo.
String	getDirectoryPath() Obtém o caminho desse diretório, sem incluir o nome do recurso em si.
String	getDirectoryUrl() Obtém a URL do diretório representado por esse cliente no serviço Data Lake.
DataLakeFileClient	getFileClient(String fileName) Inicializa um novoobjeto Data LakeFileClient concatenando o nome do arquivoao final da URL do cliente do DataLakeDirectory.
DataLakeDirectoryClient	getSubdirectoryClient(String subdirectoryName) Inicializa um novo objeto Cliente do Diretório DataLakeconcatenando o Nome do diretórioao final da URL do Cliente do DiretórioDataLake.
PagedIterable<PathItem>	listPaths() Retorna uma lista de arquivos/diretórios carregados lentamente neste diretório.
PagedIterable<PathItem>	listPaths(boolean recursive, boolean userPrincipleNameReturned, Integer maxResults, Duration timeout) Retorna uma lista de arquivos/diretórios carregados lentamente neste diretório.
DataLakeDirectoryClient	rename(String destinationFileSystem, String destinationPath) Move o diretório para outro local dentro do sistema de arquivos.
Response<DataLakeDirectoryClient>	renameWithResponse(String destinationFileSystem, String destinationPath, DataLakeRequestConditions sourceRequestConditions, DataLakeRequestConditions destinationRequestConditions, Duration timeout, Context context) Move o diretório para outro local dentro do sistema de arquivos.

Métodos herdados de DataLakePathClient

create create createIfNotExists createIfNotExistsWithResponse createWithResponse createWithResponse deleteIfExists deleteIfExistsWithResponse exists existsWithResponse generateSas generateSas generateUserDelegationSas generateUserDelegationSas getAccessControl getAccessControlWithResponse getAccountName getCustomerProvidedKey getCustomerProvidedKeyClient getFileSystemName getHttpPipeline getProperties getProperties getPropertiesWithResponse getServiceVersion removeAccessControlRecursive removeAccessControlRecursiveWithResponse setAccessControlList setAccessControlListWithResponse setAccessControlRecursive setAccessControlRecursiveWithResponse setHttpHeaders setHttpHeadersWithResponse setMetadata setMetadataWithResponse setPermissions setPermissionsWithResponse updateAccessControlRecursive updateAccessControlRecursiveWithResponse

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do método

createFile

public DataLakeFileClient createFile(String fileName)

Cria um novo arquivo em um diretório. Por padrão, esse método não substituirá um arquivo existente. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

DataLakeFileClient fileClient = client.createFile(fileName);

Parameters:

fileName - Nome do arquivo que será criado.

Returns:

Um DataLakeFileClient usado para interagir com o arquivo criado.

createFile

public DataLakeFileClient createFile(String fileName, boolean overwrite)

Cria um novo arquivo em um diretório. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

boolean overwrite = false; /* Default value. */
 DataLakeFileClient fClient = client.createFile(fileName, overwrite);

Parameters:

fileName - Nome do arquivo que será criado.

overwrite - Independentemente de substituir ou não, se houver um arquivo.

Returns:

Um DataLakeFileClient usado para interagir com o arquivo criado.

createFileIfNotExists

public DataLakeFileClient createFileIfNotExists(String fileName)

Cria um novo arquivo em um diretório se ele não existir. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

DataLakeFileClient fileClient = client.createFileIfNotExists(fileName);

Parameters:

fileName - Nome do arquivo que será criado.

Returns:

Um DataLakeFileClient usado para interagir com o arquivo criado.

createFileIfNotExistsWithResponse

public Response createFileIfNotExistsWithResponse(String fileName, DataLakePathCreateOptions options, Duration timeout, Context context)

Cria um novo arquivo em um diretório se ele não existir. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

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:

fileName - Nome do arquivo que será criado.

options - DataLakePathCreateOptions chave ou valor de metadados, ele deve ser removido ou codificado.

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

context - Contexto adicional que é passado pelo pipeline Http durante a chamada de serviço.

Returns:

Um Response<T> cujo value contém o DataLakeFileAsyncClient usado para interagir com o arquivo criado. Se Response<T>o código status for 201, um novo arquivo será criado com êxito. Se status código for 409, um arquivo com o mesmo nome já existirá nesse local.

createFileWithResponse

public Response createFileWithResponse(String fileName, DataLakePathCreateOptions options, Duration timeout, Context context)

Cria um novo arquivo em um diretório. Se já existir um arquivo com o mesmo nome, o arquivo será substituído. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

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:

fileName - Nome do arquivo que será criado.

options - DataLakePathCreateOptions

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

context - Contexto adicional que é passado pelo pipeline Http durante a chamada de serviço.

Returns:

Um Response<T> cujo value contém o DataLakeFileClient usado para interagir com o arquivo criado.

createFileWithResponse

public Response createFileWithResponse(String fileName, String permissions, String umask, PathHttpHeaders headers, Map metadata, DataLakeRequestConditions requestConditions, Duration timeout, Context context)

Cria um novo arquivo em um diretório. Se já existir um arquivo com o mesmo nome, o arquivo será substituído. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

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:

fileName - Nome do arquivo que será criado.

permissions - Permissões de acesso POSIX para o proprietário do arquivo, o grupo proprietário do arquivo e outros.

umask - Restringe as permissões do arquivo a ser criado.

headers - PathHttpHeaders

metadata - Metadados a serem associados ao arquivo. Se houver espaço em branco à esquerda ou à direita em qualquer chave ou valor de metadados, ele deverá ser removido ou codificado.

requestConditions - DataLakeRequestConditions

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

context - Contexto adicional que é passado pelo pipeline Http durante a chamada de serviço.

Returns:

Um Response<T> cujo value contém o DataLakeFileClient usado para interagir com o arquivo criado.

createSubdirectory

public DataLakeDirectoryClient createSubdirectory(String subdirectoryName)

Cria um novo subdiretório em um diretório. Por padrão, esse método não substituirá um subdiretório existente. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

DataLakeDirectoryClient directoryClient = client.createSubdirectory(directoryName);

Parameters:

subdirectoryName - Nome do subdiretório a ser criado.

Returns:

Um DataLakeDirectoryClient usado para interagir com o subdiretório criado.

createSubdirectory

public DataLakeDirectoryClient createSubdirectory(String subdirectoryName, boolean overwrite)

Cria um novo subdiretório em um diretório. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

boolean overwrite = false; /* Default value. */
 DataLakeDirectoryClient dClient = client.createSubdirectory(fileName, overwrite);

Parameters:

subdirectoryName - Nome do subdiretório a ser criado.

overwrite - Independentemente de substituir ou não, se o subdiretório existir.

Returns:

Um DataLakeDirectoryClient usado para interagir com o subdiretório criado.

createSubdirectoryIfNotExists

public DataLakeDirectoryClient createSubdirectoryIfNotExists(String subdirectoryName)

Cria um novo subdiretório se ele não existir em um diretório. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

DataLakeDirectoryClient directoryClient = client.createSubdirectoryIfNotExists(directoryName);

Parameters:

subdirectoryName - Nome do subdiretório a ser criado.

Returns:

Um DataLakeDirectoryClient usado para interagir com o subdiretório criado.

createSubdirectoryIfNotExistsWithResponse

public Response createSubdirectoryIfNotExistsWithResponse(String subdirectoryName, DataLakePathCreateOptions options, Duration timeout, Context context)

Cria um novo subdiretório em um diretório se ele não existir. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

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:

subdirectoryName - Nome do subdiretório a ser criado.

options - DataLakePathCreateOptions

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

context - Contexto adicional que é passado pelo pipeline Http durante a chamada de serviço.

Returns:

Um Response<T> cujo value contém o DataLakeDirectoryClient usado para interagir com o subdiretório criado. Se Response<T>o código status for 201, um novo subdiretório foi criado com êxito. Se status código for 409, um subdiretório com o mesmo nome já existirá nesse local.

createSubdirectoryWithResponse

public Response createSubdirectoryWithResponse(String subdirectoryName, DataLakePathCreateOptions options, Duration timeout, Context context)

Cria um novo subdiretório em um diretório. Se já existir um subdiretório com o mesmo nome, o subdiretório será substituído. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

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:

subdirectoryName - Nome do subdiretório a ser criado.

options - DataLakePathCreateOptions

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

context - Contexto adicional que é passado pelo pipeline Http durante a chamada de serviço.

Returns:

Um Response<T> cujo value contém um DataLakeDirectoryClient usado para interagir com o subdiretório criado.

createSubdirectoryWithResponse

public Response createSubdirectoryWithResponse(String subdirectoryName, String permissions, String umask, PathHttpHeaders headers, Map metadata, DataLakeRequestConditions requestConditions, Duration timeout, Context context)

Cria um novo subdiretório em um diretório. Se já existir um subdiretório com o mesmo nome, o subdiretório será substituído. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

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:

subdirectoryName - Nome do subdiretório a ser criado.

permissions - Permissões de acesso POSIX para o proprietário do subdiretório, o grupo proprietário do subdiretório e outros.

umask - Restringe as permissões do subdiretório a ser criado.

headers - PathHttpHeaders

metadata - Metadados a serem associados ao recurso. Se houver espaço em branco à esquerda ou à direita em qualquer chave ou valor de metadados, ele deverá ser removido ou codificado.

requestConditions - DataLakeRequestConditions

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

context - Contexto adicional que é passado pelo pipeline Http durante a chamada de serviço.

Returns:

Um Response<T> cujo value contém um DataLakeDirectoryClient usado para interagir com o subdiretório criado.

delete

public void delete()

Exclui um diretório.

Exemplos de código

client.delete();
 System.out.println("Delete request completed");

Para obter mais informações, consulte o Azure Docs

deleteFile

public void deleteFile(String fileName)

Exclui o arquivo especificado no diretório. Se o arquivo não existir, a operação falhará. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

client.deleteFile(fileName);
 System.out.println("Delete request completed");

Parameters:

fileName - Nome do arquivo a ser excluído.

deleteFileIfExists

public boolean deleteFileIfExists(String fileName)

Exclui o arquivo especificado no diretório se ele existir. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

boolean result = client.deleteFileIfExists(fileName);
 System.out.println("Delete request completed: " + result);

Parameters:

fileName - Nome do arquivo a ser excluído.

Returns:

true se o arquivo for excluído com êxito, false se o arquivo não existir.

deleteFileIfExistsWithResponse

public Response deleteFileIfExistsWithResponse(String fileName, DataLakePathDeleteOptions options, Duration timeout, Context context)

Exclui o arquivo especificado no diretório se ele existir. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

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:

fileName - Nome do arquivo a ser excluído.

options - DataLakePathDeleteOptions

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

context - Contexto adicional que é passado pelo pipeline Http durante a chamada de serviço.

Returns:

Uma resposta que contém status código e cabeçalhos HTTP. Se Response<T>o código de status for 200, o arquivo especificado foi excluído com êxito. Se status código for 404, o arquivo especificado não existirá.

deleteFileWithResponse

public Response deleteFileWithResponse(String fileName, DataLakeRequestConditions requestConditions, Duration timeout, Context context)

Exclui o arquivo especificado no diretório. Se o arquivo não existir, a operação falhará. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);

 client.deleteFileWithResponse(fileName, requestConditions, timeout, new Context(key1, value1));
 System.out.println("Delete request completed");

Parameters:

fileName - Nome do arquivo a ser excluído.

requestConditions - DataLakeRequestConditions

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

context - Contexto adicional que é passado pelo pipeline Http durante a chamada de serviço.

Returns:

Uma resposta que contém status código e cabeçalhos HTTP

deleteIfExists

public boolean deleteIfExists()

Exclui um diretório se ele existir.

Exemplos de código

boolean result = client.deleteIfExists();
 System.out.println("Delete request completed: " + result);

Para obter mais informações, consulte o Azure Docs

Overrides:

DataLakeDirectoryClient.deleteIfExists()

Returns:

true se o diretório for excluído com êxito, false se o diretório não existir.

deleteIfExistsWithResponse

public Response deleteIfExistsWithResponse(DataLakePathDeleteOptions options, Duration timeout, Context context)

Exclui um diretório se ele existir.

Exemplos de código

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());
 }

Para obter mais informações, consulte o Azure Docs

Overrides:

DataLakeDirectoryClient.deleteIfExistsWithResponse(DataLakePathDeleteOptions options, Duration timeout, Context context)

Parameters:

options - DataLakePathDeleteOptions

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

context - Contexto adicional que é passado pelo pipeline Http durante a chamada de serviço.

Returns:

Uma resposta que contém status código e cabeçalhos HTTP. Se Response<T>o código status for 200, o diretório foi excluído com êxito. Se status código for 404, o diretório não existirá.

deleteRecursively

public void deleteRecursively()

Exclui recursivamente um diretório e todo o conteúdo dentro do diretório.

Exemplos de código

client.deleteRecursively();
 System.out.println("Delete request completed");

Para obter mais informações, consulte o Azure Docs

deleteRecursivelyWithResponse

public Response deleteRecursivelyWithResponse(DataLakeRequestConditions requestConditions, Duration timeout, Context context)

Exclui recursivamente um diretório e todo o conteúdo dentro do diretório.

Exemplos de código

DataLakeRequestConditions deleteRequestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);
 client.deleteRecursivelyWithResponse(deleteRequestConditions, timeout, new Context(key1, value1));
 System.out.println("Delete request completed");

Para obter mais informações, consulte o Azure Docs

Parameters:

requestConditions - DataLakeRequestConditions

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

context - Contexto adicional que é passado pelo pipeline Http durante a chamada de serviço.

Returns:

Uma resposta reativa sinalizando a conclusão.

deleteSubdirectory

public void deleteSubdirectory(String subdirectoryName)

Exclui o subdiretório especificado no diretório. Se o subdiretório não existir ou não estiver vazio, a operação falhará. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

client.deleteSubdirectory(directoryName);
 System.out.println("Delete request completed");

Parameters:

subdirectoryName - Nome do subdiretório a ser excluído.

deleteSubdirectoryIfExists

public boolean deleteSubdirectoryIfExists(String subdirectoryName)

Exclui o subdiretório especificado no diretório se ele existir. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

boolean result = client.deleteSubdirectoryIfExists(directoryName);
 System.out.println("Delete request completed: " + result);

Parameters:

subdirectoryName - Nome do subdiretório a ser excluído.

Returns:

true se o subdiretório for excluído com êxito, false se o subdiretório não existir.

deleteSubdirectoryIfExistsWithResponse

public Response deleteSubdirectoryIfExistsWithResponse(String subdirectoryName, DataLakePathDeleteOptions options, Duration timeout, Context context)

Exclui o subdiretório especificado no diretório se ele existir. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

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:

subdirectoryName - Nome do subdiretório a ser excluído.

options - DataLakePathDeleteOptions

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

context - Contexto adicional que é passado pelo pipeline Http durante a chamada de serviço.

Returns:

Uma resposta que contém status código e cabeçalhos HTTP. Se Response<T>o código de status for 200, o subdiretório especificado foi excluído com êxito. Se status código for 404, o subdiretório especificado não existirá.

deleteSubdirectoryWithResponse

public Response deleteSubdirectoryWithResponse(String subdirectoryName, boolean recursive, DataLakeRequestConditions requestConditions, Duration timeout, Context context)

Exclui o subdiretório especificado no diretório. Se o subdiretório não existir ou não estiver vazio, a operação falhará. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

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:

subdirectoryName - Nome do subdiretório a ser excluído.

recursive - Se deseja ou não excluir todos os caminhos abaixo do subdiretório.

requestConditions - DataLakeRequestConditions

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

context - Contexto adicional que é passado pelo pipeline Http durante a chamada de serviço.

Returns:

Uma resposta que contém status código e cabeçalhos HTTP

deleteWithResponse

public Response deleteWithResponse(boolean recursive, DataLakeRequestConditions requestConditions, Duration timeout, Context context)

Exclui um diretório.

Exemplos de código

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");

Para obter mais informações, consulte o Azure Docs

Parameters:

recursive - Se deseja ou não excluir todos os caminhos abaixo do diretório.

requestConditions - DataLakeRequestConditions

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

context - Contexto adicional que é passado pelo pipeline Http durante a chamada de serviço.

Returns:

Uma resposta reativa sinalizando a conclusão.

getCustomerProvidedKeyClient

public DataLakeDirectoryClient getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)

Cria um novo DataLakeDirectoryClient com o customerProvidedKey especificado.

Overrides:

DataLakeDirectoryClient.getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)

Parameters:

customerProvidedKey - para CustomerProvidedKey o diretório, passe null para usar nenhuma chave fornecida pelo cliente.

Returns:

um DataLakeDirectoryClient com o especificado customerProvidedKey.

getDirectoryName

public String getDirectoryName()

Obtém o nome desse diretório, sem incluir seu caminho completo.

Returns:

O nome do diretório.

getDirectoryPath

public String getDirectoryPath()

Obtém o caminho desse diretório, sem incluir o nome do recurso em si.

Returns:

O caminho do diretório.

getDirectoryUrl

public String getDirectoryUrl()

Obtém a URL do diretório representado por esse cliente no serviço Data Lake.

Returns:

a URL.

getFileClient

public DataLakeFileClient getFileClient(String fileName)

Inicializa um novo objeto DataLakeFileClient concatenando fileName ao final da URL de DataLakeDirectoryClient. O novo DataLakeFileClient usa o mesmo pipeline de política de solicitação que o DataLakeDirectoryClient.

Parameters:

fileName - Um String que representa o nome do arquivo. Exemplos de código

 DataLakeFileClient dataLakeFileClient = client.getFileClient(fileName);
 

Returns:

Um novo DataLakeFileClient objeto que faz referência ao arquivo com o nome especificado neste diretório.

getSubdirectoryClient

public DataLakeDirectoryClient getSubdirectoryClient(String subdirectoryName)

Inicializa um novo objeto DataLakeDirectoryClient concatenando directoryName ao final da URL de DataLakeDirectoryClient. O novo DataLakeDirectoryClient usa o mesmo pipeline de política de solicitação que o DataLakeDirectoryClient.

Parameters:

subdirectoryName - Um String que representa o nome do subdiretório. Exemplos de código

 DataLakeDirectoryClient dataLakeDirectoryClient = client.getSubdirectoryClient(directoryName);
 

Returns:

Um novo DataLakeDirectoryClient objeto que faz referência ao subdiretório com o nome especificado neste diretório

listPaths

public PagedIterable listPaths()

Retorna uma lista de arquivos/diretórios carregados lentamente neste diretório. O retornado PagedIterable<T> pode ser consumido enquanto novos itens são recuperados automaticamente conforme necessário. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

client.listPaths().forEach(path -> System.out.printf("Name: %s%n", path.getName()));

Returns:

A lista de arquivos/diretórios.

listPaths

public PagedIterable listPaths(boolean recursive, boolean userPrincipleNameReturned, Integer maxResults, Duration timeout)

Retorna uma lista de arquivos/diretórios carregados lentamente neste diretório. O retornado PagedIterable<T> pode ser consumido enquanto novos itens são recuperados automaticamente conforme necessário. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

client.listPaths(false, false, 10, timeout)
     .forEach(path -> System.out.printf("Name: %s%n", path.getName()));

Parameters:

recursive - Especifica se a chamada deve incluir recursivamente todos os caminhos.

userPrincipleNameReturned - Se "true", os valores de identidade do usuário retornados nos cabeçalhos de resposta x-ms-owner, x-ms-group e x-ms-acl serão transformados de IDs de objeto do Azure Active Directory para nomes principais de usuário. Se "false", os valores serão retornados como IDs de objeto do Azure Active Directory. O valor padrão é false. Observe que as IDs de objeto de grupo e aplicativo não são traduzidas porque não têm nomes amigáveis exclusivos.

maxResults - Especifica o número máximo de blobs a serem retornados por página, incluindo todos os elementos BlobPrefix. Se a solicitação não especificar maxResults ou especificar um valor maior que 5.000, o servidor retornará até 5.000 itens por página. Se estiver iterando por página, o tamanho da página passado para métodos byPage, como PagedIterable#iterableByPage(int) , será preferencial em relação a esse valor.

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

Returns:

A lista de arquivos/diretórios.

rename

public DataLakeDirectoryClient rename(String destinationFileSystem, String destinationPath)

Move o diretório para outro local dentro do sistema de arquivos. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

DataLakeDirectoryClient renamedClient = client.rename(fileSystemName, destinationPath);
 System.out.println("Directory Client has been renamed");

Parameters:

destinationFileSystem - O sistema de arquivos do destino dentro da conta. null para o sistema de arquivos atual.

destinationPath - O caminho relativo do sistema de arquivos para o qual renomear o diretório exclui o nome do sistema de arquivos. Por exemplo, se você quiser mover um diretório com fileSystem = "myfilesystem", path = "mydir/mysubdir" para outro caminho em myfilesystem (ex: newdir), defina o destinationPath = "newdir"

Returns:

Um DataLakeDirectoryClient usado para interagir com o novo diretório criado.

renameWithResponse

public Response renameWithResponse(String destinationFileSystem, String destinationPath, DataLakeRequestConditions sourceRequestConditions, DataLakeRequestConditions destinationRequestConditions, Duration timeout, Context context)

Move o diretório para outro local dentro do sistema de arquivos. Para obter mais informações, consulte o Azure Docs.

Exemplos de código

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:

destinationFileSystem - O sistema de arquivos do destino dentro da conta. null para o sistema de arquivos atual.

destinationPath - O caminho relativo do sistema de arquivos para o qual renomear o diretório exclui o nome do sistema de arquivos. Por exemplo, se você quiser mover um diretório com fileSystem = "myfilesystem", path = "mydir/mysubdir" para outro caminho em myfilesystem (ex: newdir), defina o destinationPath = "newdir"

sourceRequestConditions - DataLakeRequestConditions contra a origem.

destinationRequestConditions - DataLakeRequestConditions em relação ao destino.

timeout - Um valor de tempo limite opcional além do qual um RuntimeException será gerado.

context - Contexto adicional que é passado pelo pipeline Http durante a chamada de serviço.

Returns:

Um Response<T> cujo value que contém um DataLakeDirectoryClient usado para interagir com o diretório criado.