AdlsClient Classe

Definição

Namespace:

Microsoft.Azure.DataLake.Store

Assembly:

Microsoft.Azure.DataLake.Store.dll

Pacote:

Microsoft.Azure.DataLake.Store v1.1.24

Cliente do Azure Data Lake Store. Ele contém as APIs públicas para executar operações da API REST que são mais fáceis de chamar e mais utilizáveis do que as APIs Principais. As APIs principais fornecem mais liberdade, mas o ADLSClient fornece formulários mais comumente usados. Ele encapsula o token de autorização e a atualização de token. Contém métodos de fábrica que utilizam um ServiceClientCredential ou um token de autenticação de cadeia de caracteres e retorna a instância dessa classe. Para cada operação, ele fornece uma versão assíncrona e de sincronização. Cada método de sincronização é uma espera no método assíncrono, com exceção de Create e Acréscimo simultâneo. Todas as APIs são thread-safe com algumas exceções em CreateFile e GetAppendStream. CreateFile e GetAppendStream não podem ser chamados para o mesmo caminho de threads diferentes porque a gravação é feita com uma concessão, portanto, haverá conflitos de concessão Se um aplicativo quiser executar operações multi-threaded usando esse SDK, é altamente recomendável definir ServicePointManager.DefaultConnectionLimit para o número de threads que o aplicativo deseja que o sdk use antes de criar qualquer instância de AdlsClient. Por padrão, ServicePointManager.DefaultConnectionLimit é definido como 2. Os Adls usam NLog para registro em log. adls.dotnet.* é o nome do agente para obter todos os logs.

public class AdlsClient

type AdlsClient = class

Public Class AdlsClient

Herança

Object

AdlsClient

Derivado

Microsoft.Azure.DataLake.Store.MockAdlsFileSystem.MockAdlsClient

Construtores

AdlsClient()

Construtor protegido para testes de moq

Campos

ClientLogger

Agente para registrar informações (depuração/erro/rastreamento) em relação ao cliente

Propriedades

AccountFQDN	Nome da conta do Azure Data Lake Store, incluindo nome de domínio completo
ClientId	ID do objeto do cliente
DefaultNumThreads	Número padrão de threads usados por ferramentas como uploader/downloader, alteração de acl recursiva e outras ferramentas multi-threaded usando o SDK. Pode ser usado para definir ServicePointManager.DefaultConnectionLimit se você quiser que o SDK decida o número de threads que ele usa para ferramentas com vários threads.

Métodos

AddUserAgentSuffix(String)	Adiciona o sufixo do agente do usuário
BulkDownload(String, String, Int32, IfExists, Boolean, IProgress<TransferStatus>, Boolean, Boolean, CancellationToken)	Baixe o diretório ou o arquivo do servidor remoto para o local. Transfere o conteúdo no diretório de origem no diretório de destino. Transfere o arquivo de origem e o salva como o caminho de destino. Esse método não gera nenhuma exceção para a falha de transferência de qualquer entrada. Consulte o valor TransferStatus retornado para obter o status/exceção da transferência de cada entrada. Por padrão, registra o progresso da transferência no caminho temporário do sistema, para que o usuário possa se recuperar usando resume se o upload tiver falhado. Esse log de progresso pode ser desabilitado usando disableTransferLogging. É altamente recomendável definir ServicePointManager.DefaultConnectionLimit como o número de threads que o aplicativo deseja que o sdk use antes de criar qualquer instância de AdlsClient. Por padrão, ServicePointManager.DefaultConnectionLimit é definido como 2.
BulkDownload(String, String, Int32, IfExists, IProgress<TransferStatus>, Boolean, Boolean, CancellationToken)	Baixe o diretório ou o arquivo do servidor remoto para o local. Transfere o conteúdo no diretório de origem no diretório de destino. Transfere o arquivo de origem e o salva como o caminho de destino. Esse método não gera nenhuma exceção para a falha de transferência de qualquer entrada. Consulte o valor TransferStatus retornado para obter o status/exceção da transferência de cada entrada. É altamente recomendável definir ServicePointManager.DefaultConnectionLimit como o número de threads que o aplicativo deseja que o sdk use antes de criar qualquer instância de AdlsClient. Por padrão, ServicePointManager.DefaultConnectionLimit é definido como 2.
BulkUpload(String, String, Int32, IfExists, Boolean, IProgress<TransferStatus>, Boolean, Boolean, Boolean, CancellationToken)	Carregue o diretório ou o arquivo do local para o remoto. Transfere o conteúdo no diretório de origem no diretório de destino. Transfere o arquivo de origem e o salva como o caminho de destino. Esse método não gera nenhuma exceção para a falha de transferência de qualquer entrada. Consulte o valor TransferStatus retornado para obter o status/exceção da transferência de cada entrada. Por padrão, registra o progresso da transferência no caminho temporário do sistema, para que o usuário possa se recuperar usando resume se o upload tiver falhado. Esse log de progresso pode ser desabilitado usando disableTransferLogging. É altamente recomendável definir ServicePointManager.DefaultConnectionLimit como o número de threads que o aplicativo deseja que o sdk use antes de criar qualquer instância de AdlsClient. Por padrão, ServicePointManager.DefaultConnectionLimit é definido como 2. Por padrão, os arquivos são carregados em novos limites de linha. No entanto, se os arquivos não tiverem uma nova linha dentro de partes de 4 MB, a transferência falhará. Nesse caso, é necessário passar true para isBinary para evitar uploads em limites de nova linha.
BulkUpload(String, String, Int32, IfExists, IProgress<TransferStatus>, Boolean, Boolean, Boolean, CancellationToken)	Carregue o diretório ou o arquivo do local para o remoto. Transfere o conteúdo no diretório de origem no diretório de destino. Transfere o arquivo de origem e o salva como o caminho de destino. Esse método não gera nenhuma exceção para a falha de transferência de qualquer entrada. Consulte o valor TransferStatus retornado para obter o status/exceção da transferência de cada entrada. É altamente recomendável definir ServicePointManager.DefaultConnectionLimit como o número de threads que o aplicativo deseja que o sdk use antes de criar qualquer instância de AdlsClient. Por padrão, ServicePointManager.DefaultConnectionLimit é definido como 2. Por padrão, os arquivos são carregados em novos limites de linha. No entanto, se os arquivos não tiverem uma nova linha dentro de partes de 4 MB, a transferência falhará. Nesse caso, é necessário passar true para isBinary para evitar uploads em limites de nova linha.
ChangeAcl(String, List<AclEntry>, RequestedAclType, Int32)	Alterar acl (modificar, definir e remover) recursivamente em uma árvore de diretório é altamente recomendável definir ServicePointManager.DefaultConnectionLimit como o número de threads que o aplicativo deseja que o sdk use antes de criar qualquer instância do AdlsClient. Por padrão, ServicePointManager.DefaultConnectionLimit é definido como 2.
ChangeAcl(String, List<AclEntry>, RequestedAclType, Int32, IProgress<AclProcessorStats>, CancellationToken)	Alterar acl (modificar, definir e remover) recursivamente em uma árvore de diretório é altamente recomendável definir ServicePointManager.DefaultConnectionLimit como o número de threads que o aplicativo deseja que o sdk use antes de criar qualquer instância do AdlsClient. Por padrão, ServicePointManager.DefaultConnectionLimit é definido como 2.
CheckAccess(String, String, CancellationToken)	Verifica se o usuário/grupo especificou o acesso do caminho fornecido
CheckAccessAsync(String, String, CancellationToken)	Verifica de forma assíncrona se o usuário/grupo especificou o acesso do caminho fornecido
CheckExists(String)	Verifica se o arquivo ou diretório existe
ConcatenateFiles(String, List<String>, Boolean, CancellationToken)	API síncrona para concatenar arquivos de origem para um arquivo de destino
ConcatenateFilesAsync(String, List<String>, Boolean, CancellationToken)	API assíncrona para concatenar arquivos de origem em um arquivo de destino
ConcurrentAppend(String, Boolean, Byte[], Int32, Int32)	API síncrona para executar acréscimo simultâneo no servidor. O deslocamento no qual o acréscimo ocorrerá é determinado pelo servidor. É altamente recomendável chamar essa API com tamanho de dados menor que 4 MB. O back-end faz acréscimos atômicos de 4 MB.
ConcurrentAppendAsync(String, Boolean, Byte[], Int32, Int32, CancellationToken)	API assíncrona para executar acréscimo simultâneo no servidor. O deslocamento no qual o acréscimo ocorrerá é determinado pelo servidor. Operação assíncrona. É altamente recomendável chamar essa API com tamanho de dados menor que 4 MB. O back-end faz acréscimos atômicos de 4 MB.
CreateClient(String, ServiceClientCredentials)	Método de fábrica que cria uma instância de AdlsClient usando ServiceClientCredential. Se um aplicativo quiser executar operações com vários threads usando esse SDK, é altamente recomendável definir ServicePointManager.DefaultConnectionLimit como o número de threads que o aplicativo deseja que o sdk use antes de criar qualquer instância do AdlsClient. Por padrão, ServicePointManager.DefaultConnectionLimit é definido como 2.
CreateClient(String, String)	Método de fábrica que cria uma instância AdlsClient usando a chave de token. Se um aplicativo quiser executar operações com vários threads usando esse SDK, é altamente recomendável definir ServicePointManager.DefaultConnectionLimit como o número de threads que o aplicativo deseja que o sdk use antes de criar qualquer instância do AdlsClient. Por padrão, ServicePointManager.DefaultConnectionLimit é definido como 2.
CreateDirectory(String, String, CancellationToken)	API síncrona para criar um diretório
CreateDirectoryAsync(String, String, CancellationToken)	API assíncrona para criar um diretório.
CreateFile(String, IfExists, String, Boolean)	A API síncrona que cria um arquivo e retorna o fluxo para gravar dados nesse arquivo no ADLS. O arquivo é aberto com acesso exclusivo – qualquer tentativa de abrir o mesmo arquivo para acréscimo falhará enquanto esse fluxo estiver aberto. Threading: o fluxo retornado não é thread-safe.
CreateFileAsync(String, IfExists, String, Boolean, CancellationToken)	A API assíncrona que cria um arquivo e retorna o fluxo para gravar dados nesse arquivo no ADLS. O arquivo é aberto com acesso exclusivo – qualquer tentativa de abrir o mesmo arquivo para acréscimo falhará enquanto esse fluxo estiver aberto. Threading: o fluxo retornado não é thread-safe.
Delete(String, CancellationToken)	API síncrona para excluir um arquivo ou diretório. Para o diretório, ele só será excluído se estiver vazio.
DeleteAsync(String, CancellationToken)	API assíncrona para excluir um arquivo ou diretório. Para o diretório, ele só será excluído se estiver vazio.
DeleteRecursive(String, CancellationToken)	API síncrona para excluir um arquivo ou diretório recursivamente. Se for um diretório não vazio, ele excluirá os subdiretórios ou arquivos.
DeleteRecursiveAsync(String, CancellationToken)	API assíncrona para excluir um arquivo ou diretório recursivamente
EnumerateDeletedItems(String, String, Int32, IProgress<EnumerateDeletedItemsProgress>, CancellationToken)	Pesquise lixo em uma conta com dica e um ponto de partida. Essa é uma operação de execução longa e o usuário é atualizado com progresso periodicamente. Cuidado: desmarcando arquivos é uma operação de melhor esforço. Não há garantias de que um arquivo possa ser restaurado depois que ele for excluído. O uso dessa API é habilitado por meio da lista de permissões. Se sua conta do ADL não estiver na lista de permissões, o uso dessa api gerará exceção Não immplemented. Para obter mais informações e assistência, entre em contato com o suporte da Microsoft.
EnumerateDeletedItemsAsync(String, String, Int32, IProgress<EnumerateDeletedItemsProgress>, CancellationToken)	Obtém as entradas de lixo de forma assíncrona Cuidado: desativar arquivos é uma operação de melhor esforço. Não há garantias de que um arquivo possa ser restaurado depois que ele for excluído. O uso dessa API é habilitado por meio da lista de permissões. Se sua conta do ADL não estiver na lista de permissões, o uso dessa api gerará exceção Não immplemented. Para obter mais informações e assistência, entre em contato com o suporte da Microsoft.
EnumerateDirectory(String, UserGroupRepresentation, CancellationToken)	Retorna um enumerável que enumera os subdiretórios ou arquivos contidos em um diretório. Por padrão, listAfter e listBefore estão vazios e enumeramos todas as entradas de diretório.
GetAclStatus(String, UserGroupRepresentation, CancellationToken)	Obtém a lista de entradas de ACL, a ID do proprietário, a ID do grupo, a permissão octal e o bit autoadesiva (somente para um diretório) do arquivo/diretório
GetAclStatusAsync(String, UserGroupRepresentation, CancellationToken)	Obtém de forma assíncrona a lista de entradas de ACL, a ID do proprietário, a ID do grupo, a permissão octal e o bit autoadesiva (somente para um diretório) do arquivo/diretório
GetAppendStream(String, CancellationToken)	API síncrona que retorna o fluxo para gravar dados em um arquivo no ADLS. O arquivo é aberto com acesso exclusivo – qualquer tentativa de abrir o mesmo arquivo para acréscimo falhará enquanto esse fluxo estiver aberto. Threading: o fluxo retornado não é thread-safe.
GetAppendStreamAsync(String, CancellationToken)	API assíncrona que retorna o fluxo para gravar dados em um arquivo no ADLS. O arquivo é aberto com acesso exclusivo – qualquer tentativa de abrir o mesmo arquivo para acréscimo falhará enquanto esse fluxo estiver aberto. Threading: o fluxo retornado não é thread-safe.
GetContentSummary(String, Int32, CancellationToken)	Obtém o resumo de conteúdo de um arquivo ou diretório. É altamente recomendável definir ServicePointManager.DefaultConnectionLimit como o número de threads que o aplicativo deseja que o sdk use antes de criar qualquer instância do AdlsClient. Por padrão, ServicePointManager.DefaultConnectionLimit é definido como 2.
GetDirectoryEntry(String, UserGroupRepresentation, CancellationToken)	Obtém metadados de forma síncrona, como caminho completo, tipo (arquivo ou diretório), grupo, usuário, permissão, comprimento, hora do último acesso, hora da última modificação, tempo de expiração, acl Bit, fator de replicação
GetDirectoryEntryAsync(String, UserGroupRepresentation, CancellationToken)	Obtém metadados de forma assíncrona, como caminho completo, tipo (arquivo ou diretório), grupo, usuário, permissão, comprimento, hora do último acesso, hora da última modificação, tempo de expiração, acl Bit, fator de replicação
GetExceptionFromResponse(OperationResponse, String)	Retorna uma exceção do ADLS com base na resposta do servidor
GetFileProperties(String, Boolean, String, Boolean, Boolean, Int32, Boolean, Boolean, Int64, CancellationToken)	Despeja recursivamente a propriedade de arquivo de todos os diretórios ou/e arquivos no caminho fornecido para um arquivo local ou adl. A propriedade file pode ser uso de disco ou Acl ou ambos. É altamente recomendável definir ServicePointManager.DefaultConnectionLimit como o número de threads que o aplicativo deseja que o sdk use antes de criar qualquer instância do AdlsClient. Por padrão, ServicePointManager.DefaultConnectionLimit é definido como 2.
GetReadStream(String, CancellationToken)	API síncrona que retorna o fluxo para ler dados do arquivo no ADLS
GetReadStream(String, Int32, CancellationToken)	API síncrona que retorna o fluxo para ler dados do arquivo no ADLS
GetReadStreamAsync(String, CancellationToken)	API assíncrona que retorna o fluxo para ler dados do arquivo no ADLS
GetReadStreamAsync(String, Int32, CancellationToken)	API assíncrona que retorna o fluxo para ler dados do arquivo no ADLS
ModifyAclEntries(String, List<AclEntry>, CancellationToken)	Modifica entradas acl de um arquivo ou diretório com determinada lista de ACL. Ele mescla a lista de ACL exisitng com determinada lista.
ModifyAclEntriesAsync(String, List<AclEntry>, CancellationToken)	Modifica de forma assíncrona as entradas acl de um arquivo ou diretório com determinada lista de ACL. Ele mescla a lista de ACL exisitng com determinada lista.
RemoveAclEntries(String, List<AclEntry>, CancellationToken)	Remove as Entradas de Acl especificadas para um arquivo ou diretório.
RemoveAclEntriesAsync(String, List<AclEntry>, CancellationToken)	Remove de forma assíncrona as Entradas de Acl especificadas para um arquivo ou diretório.
RemoveAllAcls(String, CancellationToken)	Remove todas as Entradas de Acl para um arquivo ou diretório.
RemoveAllAclsAsync(String, CancellationToken)	Remove de forma assíncrona todas as Entradas acl de um arquivo ou diretório.
RemoveDefaultAcls(String, CancellationToken)	Remove todas as entradas acl do padrão AclScope para um arquivo ou diretório.
RemoveDefaultAclsAsync(String, CancellationToken)	Remove de forma assíncrona todas as Entradas acl do padrão AclScope para um arquivo ou diretório.
Rename(String, String, Boolean, CancellationToken)	API síncrona para renomear um arquivo ou diretório. Para renomear o diretório: se o destino existir, ele colocará o diretório de origem um nível abaixo do destino.
RenameAsync(String, String, Boolean, CancellationToken)	API assíncrona para renomear um arquivo ou diretório. Para renomear o diretório: se o destino existir, ele colocará o diretório de origem um nível abaixo do destino.
RestoreDeletedItems(String, String, String, String, CancellationToken)	Restaura de forma síncrona a entrada de lixo Cuidado: desabilitar arquivos é uma operação de melhor esforço. Não há garantias de que um arquivo possa ser restaurado depois que ele for excluído. O uso dessa API é habilitado por meio da lista de permissões. Se sua conta do ADL não estiver na lista de permissões, o uso dessa api gerará exceção Não immplemented. Para obter mais informações e assistência, entre em contato com o suporte da Microsoft.
RestoreDeletedItemsAsync(String, String, String, String, CancellationToken)	Restaura de forma assíncrona a entrada de lixo Cuidado: a descompanhamento de arquivos é uma operação de melhor esforço. Não há garantias de que um arquivo possa ser restaurado depois que ele for excluído. O uso dessa API é habilitado por meio da lista de permissões. Se sua conta do ADL não estiver na lista de permissões, o uso dessa api gerará exceção Não immplemented. Para obter mais informações e assistência, entre em contato com o suporte da Microsoft.
SetAcl(String, List<AclEntry>, CancellationToken)	Define entradas acl para um arquivo ou diretório. Ele apaga as entradas acl existentes para o caminho.
SetAclAsync(String, List<AclEntry>, CancellationToken)	Define as entradas acl de forma assíncrona para um arquivo ou diretório. Ele apaga as entradas acl existentes para o caminho.
SetConditionalCreateWithOverwrite(Boolean)	Define se a criação condicional deve ser executada com substituição. Ajuda a resolver problemas atômicos com repetições
SetExpiryTime(String, ExpiryOption, Int64, CancellationToken)	Define de forma síncrona o tempo de expiração
SetExpiryTimeAsync(String, ExpiryOption, Int64, CancellationToken)	Define de forma assíncrona o tempo de expiração
SetOwner(String, String, String, CancellationToken)	Define o proprietário ou/e o grupo do caminho
SetOwnerAsync(String, String, String, CancellationToken)	Define de forma assíncrona o proprietário ou/e o grupo do caminho
SetPermission(String, String, CancellationToken)	Define a permissão do caminho especificado
SetPermissionAsync(String, String, CancellationToken)	Define de forma assíncrona a permissão do caminho especificado
SetPerRequestTimeout(TimeSpan)	Define o tempo limite por solicitação. Altamente recomendado para defini-lo depois de criar o cliente. Não é recomendável defini-lo enquanto as solicitações estão em andamento de um thread diferente.
SetToken(String)	Define o token de autenticação.