Compartilhar via

Listar contêineres de blob com o Java

  • Artigo

Ao listar contêineres em uma conta de Armazenamento do Microsoft Azure do seu código, você pode especificar várias opções para gerenciar o modo como os resultados são retornados do Armazenamento do Microsoft Azure. Esse artigo mostra como listar contêineres usando a biblioteca de clientes do Armazenamento do Microsoft Azure para Java.

Pré-requisitos

  • Este artigo pressupõe que você já tenha um projeto configurado para trabalhar com a biblioteca de clientes do Armazenamento de Blobs do Azure para Java. Para saber mais sobre como configurar seu projeto, incluindo a instalação de pacote, a adição de diretivas import e a criação de um objeto do cliente autorizado, consulte Introdução ao Armazenamento do Microsoft Azure e Java.
  • O mecanismo de autorização deve ter permissões para listar contêineres de blob. Para saber mais, consulte as diretrizes de autorização para as seguintes operações de API REST:

Sobre as opções de listagem de contêineres

Ao listar contêineres do código, você pode especificar opções para gerenciar como os resultados são retornados do Armazenamento do Azure. Você pode especificar o número de resultados a serem retornados em cada conjunto de resultados e, em seguida, recuperar os conjuntos subsequentes. Você também pode filtrar os resultados por um prefixo e retornar metadados de contêiner com os resultados. Essas opções são descritas nas seções a seguir.

Para listar contêineres em uma conta de armazenamento, chame o seguinte método:

Esse método retorna um iterável do tipo BlobContainerItem. Os contêineres são ordenados lexicograficamente pelo nome.

Gerenciar quantos resultados são retornados

Por padrão, uma operação de listagem retorna até 5.000 resultados por vez. Para retornar um conjunto menor de resultados, forneça um valor diferente de zero para o tamanho da página de resultados a serem retornados. Você pode definir esse valor usando o seguinte método:

Os exemplos apresentados neste artigo mostram como retornar resultados em páginas. Para saber mais sobre os conceitos de paginação, confira Paginação com o SDK do Azure para Java.

Filtrar resultados com um prefixo

Para filtrar a lista de contêineres, especifique uma cadeia de caracteres para o parâmetro prefix. A cadeia de caracteres de prefixo pode incluir um ou mais caracteres. O Armazenamento do Azure então retorna somente os contêineres cujos nomes começam com esse prefixo. Você pode definir esse valor usando o seguinte método:

Incluir metadados de contêiner

Para incluir metadados de contêiner com os resultados, crie uma instância BlobContainerListDetails e passe true para o seguinte método:

Em seguida, passe o objeto BlobContainerListDetails para o seguinte método:

Incluir contêineres excluídos

Para incluir contêineres com exclusão reversível com os resultados, crie uma instância BlobContainerListDetails e passe true para o seguinte método:

Em seguida, passe o objeto BlobContainerListDetails para o seguinte método:

Exemplos de código

O exemplo a seguir lista contêineres e filtra os resultados por um prefixo especificado:

public void listContainers(BlobServiceClient blobServiceClient) {
    // Set a prefix to filter results based on a specified character or string
    ListBlobContainersOptions options = new ListBlobContainersOptions()
            .setPrefix("container-");

    System.out.println("List containers:");
    for (BlobContainerItem blobContainerItem : blobServiceClient.listBlobContainers(options, null)) {
        System.out.printf("Container name: %s%n", blobContainerItem.getName());
    }
}

Você também pode retornar um conjunto menor de resultados especificando o tamanho da página de resultados a ser retornada:

public void listContainersWithPaging(BlobServiceClient blobServiceClient) {
    // Set a prefix to filter results and specify a page limit
    ListBlobContainersOptions options = new ListBlobContainersOptions()
            .setMaxResultsPerPage(2)  // Low number for demonstration purposes
            .setPrefix("container-");

    int i = 0;
    Iterable<PagedResponse<BlobContainerItem>> blobContainerPages = blobServiceClient
            .listBlobContainers(options, null).iterableByPage();
    for (PagedResponse<BlobContainerItem> page : blobContainerPages) {
        System.out.printf("Page %d%n", ++i);
        page.getElements().forEach(container -> {
            System.out.printf("Name: %s%n", container.getName());
        });
    }
}

Recursos

Para saber mais sobre como listar contêineres usando a biblioteca de clientes do Armazenamento de Blobs do Azure para Java, consulte os recursos a seguir.

Operações da API REST

O SDK do Azure para Java contém bibliotecas que criam sobre a API REST do Azure, permitindo a interação com as operações de API REST por meio de paradigmas conhecidos do Java. Os métodos da biblioteca de clientes para listar contêineres usam a seguinte operação de API REST:

Exemplos de código

Recursos da biblioteca de clientes

Confira também