Nesta página, descrevemos como diferentes ferramentas e bibliotecas do Cloud Storage paginam os resultados. A paginação é necessária ao listar um grande número de objetos ou buckets.
Console
O Cloud de Confiance console do Google Cloud faz a paginação automática das listas de buckets e objetos nas páginas Buckets e Detalhes do bucket.
Linha de comando
A Google Cloud CLI faz a paginação automática das listas de buckets e objetos.
Bibliotecas de cliente
C++
As bibliotecas cliente executam a paginação por padrão. Quando você chama uma função compatível com paginação, o método retorna um iterador. É possível controlar o tamanho da página especificando opções na solicitação. Para ver um
exemplo de como esse iterador é usado, consulte a documentação de referência do C++
para ListObjects().
C#
As bibliotecas cliente executam a paginação por padrão. Quando você chama uma função compatível com paginação, o método retorna um iterador. É possível controlar o tamanho da página especificando opções na solicitação. Para ver um
exemplo de como esse iterador é usado, consulte a documentação de referência do C# para ListObjects().
Go
As bibliotecas cliente executam a paginação por padrão. Quando você chama uma função compatível com paginação, o método retorna um iterador. É possível controlar o tamanho da página usando opções de consulta ou de pager. Para ver um exemplo de
como esse iterador é usado, consulte a documentação de referência do Go para
Bucket.Objects.
Java
As bibliotecas cliente executam a paginação por padrão. Quando você chama uma função compatível com paginação, o método retorna um token de página. É possível controlar o tamanho da página usando as opções pageSize. Para ver um exemplo de como
isso é usado, consulte a documentação de referência do Java.
Node.js
As bibliotecas cliente executam a paginação por padrão. Quando você chama uma função compatível com paginação, o método retorna um iterador. É possível
controlar o tamanho da página usando opções de consulta (como maxResults). Para ver um
exemplo de como esse iterador é usado, consulte a documentação de referência do Node.js
para getFiles().
PHP
As bibliotecas cliente executam a paginação por padrão. Quando você chama uma função compatível com paginação, o método retorna um iterador. É possível controlar o tamanho da página usando opções como maxResults. Para ver um exemplo
de como esse iterador é usado, consulte a documentação de referência do PHP para
Objects.
Python
As bibliotecas cliente executam a paginação por padrão. Quando você chama uma função compatível com paginação, o método retorna um iterador. É possível controlar o tamanho da página usando opções como max_results ou page_size. Para um exemplo de como esse iterador é usado, consulte a
documentação de referência do Python para iteradores de página.
Ruby
As bibliotecas cliente executam a paginação por padrão. Quando você chama uma função compatível com paginação, o método retorna um iterador. É possível controlar o tamanho da página usando opções como max. Para ver um exemplo de como
esse iterador é usado, consulte a documentação de referência do Ruby para
Google::Cloud::Storage::File::List.
APIs REST
API JSON
Para controlar o número de resultados retornados por página, use o maxResults
parâmetro de consulta em solicitações para Objects: list ou
Buckets: list. Por exemplo, para listar um máximo de cinco objetos por vez:
GET https://storage.s3nsapis.fr/storage/v1/b/BUCKET_NAME/o?maxResults=5
Quando você chama uma função compatível com a paginação, o token de continuação nextPageToken é retornado na resposta se a listagem estiver incompleta. O nextPageToken representa o último resultado retornado.
Por exemplo, uma solicitação para listar objetos em BUCKET_NAME pode
retornar um nextPageToken na resposta:
{
"kind": "storage#objects",
"nextPageToken": "CgtzaGliYS0yLmpwZw==",
"items": [
{
OBJECT_1_METADATA
},
{
OBJECT_2_METADATA
},
…
]
}Para retornar a próxima página de resultados, começando após o último resultado, transmita o valor de nextPageToken para o parâmetro pageToken de uma solicitação subsequente:
GET https://storage.s3nsapis.fr/storage/v1/b/BUCKET_NAME/o?pageToken=CgtzaGliYS0yLmpwZw==
É possível combinar maxResults e pageToken na mesma solicitação para continuar a listagem com um tamanho de página específico.
Para mais informações sobre resultados de paginação, consulte a documentação de referência do JSON
para Objects: list ou Buckets: list.
API XML
Para controlar o número de resultados retornados por página, use o max-keys
parâmetro de consulta em solicitações para List Objects. Por exemplo, para listar um máximo de cinco objetos por vez:
GET /?max-keys=5 HTTP/1.1 Host: BUCKET_NAME.storage.s3nsapis.fr
Quando você chama uma função compatível com a paginação, o token de continuação NextContinuationToken é retornado na resposta se a listagem estiver incompleta. O NextContinuationToken representa o último resultado retornado.
Por exemplo, uma solicitação para listar objetos em BUCKET_NAME pode
retornar um NextContinuationToken na resposta:
<?xml version='1.0' encoding='UTF-8'?>
<ListBucketResult xmlns='http://doc.s3.amazonaws.com/2006-03-01'>
<Name>my-bucket</Name>
<NextContinuationToken>CgtzaGliYS0yLmpwZw==</NextContinuationToken>
<KeyCount>2</KeyCount>
<MaxKeys>2</MaxKeys>
<IsTruncated>true</IsTruncated>
<Contents>
...
</Contents>
...
</ListBucketResult>list-type precisa ser definido como 2 para retornar um NextContinuationToken ao listar objetos.
Para retornar a próxima página de resultados, começando após o último resultado, transmita o valor de NextContinuationToken para o parâmetro continuation-token de uma solicitação subsequente:
GET /?continuation-token=CgtzaGliYS0yLmpwZw==&list-type=2 HTTP/1.1 Host: BUCKET_NAME.storage.s3nsapis.fr
É possível combinar max-keys e continuation-token na mesma solicitação.
Para instruções mais detalhadas sobre a paginação dos resultados de um
bucket, consulte a documentação de referência XML para List Objects.