Nesta página, você verá como usar as retenções de objeto, incluindo a colocação de retenções por padrão em novos objetos e a colocação de retenções em objetos individuais. Para detalhes sobre esse recurso, incluindo os tipos de retenção que podem ser colocados em objetos, consulte Retenções de objeto.
Pré-requisitos
Para usar esse recurso no Cloud Storage, o seguinte é necessário:
Ter permissão suficiente para ver e atualizar intervalos e objetos no Cloud Storage:
Se você é proprietário do projeto que contém o intervalo, provavelmente já tem as permissões necessárias.
Para usar o IAM, é necessário ter
storage.buckets.update
,storage.buckets.get
,storage.objects.update
e permissõesstorage.objects.get
do intervalo pertinente. Consulte Como usar permissões do IAM para instruções sobre como conseguir um papel, por exemplo,roles/storage.admin
, com essas permissões.Se você usar ACLs, precisará da permissão PROPRIETÁRIO no intervalo em questão e nos objetos dentro dele. Consulte Como configurar ACLs para instruções sobre como fazer isso.
Como trabalhar com a propriedade de retenção baseada em evento padrão
As tarefas a seguir mostram como ativar, ver e desativar a propriedade de retenção baseada em eventos padrão em um intervalo. Quando essa propriedade é ativada, novos objetos adicionados ao intervalo recebem automaticamente uma retenção baseada em evento.
Como ativar a propriedade de retenção baseada em evento padrão
Para colocar uma retenção baseada em eventos automaticamente em cada novo objeto adicionado a um intervalo:
Console
- Abra o navegador do Cloud Storage no Console do Google Cloud Platform.
Abra o navegador do Cloud Storage Na lista de intervalos, clique no nome do intervalo para o qual você quer ativar a propriedade de retenção baseada em eventos padrão.
Selecione a guia Bloqueio de intervalo no topo da página.
Na entrada Retenções baseadas em eventos por padrão, clique no botão Desativadas.
gsutil
Use o comando gsutil retention event-default set
:
gsutil retention event-default set gs://[BUCKET_NAME]
em que [BUCKET_NAME]
é o nome do intervalo pertinente. Por exemplo, my-bucket
.
Amostras de código
C++
Para saber mais, consulte a documentação de referência da API Cloud Storage C++ .
C#
Para saber mais, consulte a documentação de referência da API Cloud Storage C# .
Go
Para saber mais, consulte a documentação de referência da API Cloud Storage Go .
Java
Para saber mais, consulte a documentação de referência da API Cloud Storage Java .
Node.js
Para saber mais, consulte a documentação de referência da API Cloud Storage Node.js .
PHP
Para saber mais, consulte a documentação de referência da API Cloud Storage PHP .
Python
Para saber mais, consulte a documentação de referência da API Cloud Storage para Python .
Ruby
Para saber mais, consulte a documentação de referência da API Cloud Storage Ruby .
APIs REST
API JSON
- Receba um token de acesso de autorização do OAuth 2.0 Playground. Configure o Playground para usar suas credenciais do OAuth.
Crie um arquivo .json com as informações a seguir:
{ "defaultEventBasedHold": true }
Use
cURL
para chamar a API JSON API com umaPATCH
solicitação de Intervalo:curl -X PATCH --data-binary @[JSON_FILE_NAME].json \ -H "Authorization: Bearer [OAUTH2_TOKEN]" \ -H "Content-Type: application/json" \ "https://www.googleapis.com/storage/v1/b/[BUCKET_NAME]?fields=defaultEventBasedHold"
em que:
[JSON_FILE_NAME]
é o nome do arquivo criado na Etapa 2.[OAUTH2_TOKEN]
é o token de acesso gerado na Etapa 1;[BUCKET_NAME]
é o nome do intervalo pertinente. Por exemplo,my-bucket
.
API XML
A API XML não pode ser usada para trabalhar com retenções de objeto. Use uma das outras ferramentas do Cloud Storage, como o gsutil.
Como conseguir o status de retenção padrão de um intervalo
Para verificar se um intervalo coloca as retenções baseadas em eventos em novos objetos por padrão:
Console
- Abra o navegador do Cloud Storage no Console do Google Cloud Platform.
Abra o navegador do Cloud Storage Na lista de intervalos, clique no nome do intervalo para o qual você quer verificar o status baseado em eventos padrão.
Selecione a guia Bloqueio de intervalo no topo da página.
O status aparece na entrada retenções baseadas em eventos por padrão.
gsutil
Use o seguinte gsutil ls
comando:
gsutil ls -L -b gs://[BUCKET_NAME]/
em que [BUCKET_NAME]
é o nome do intervalo pertinente. Por exemplo, my-bucket
.
A resposta terá esta aparência:
gs://[BUCKET_NAME]/ : Storage class: STANDARD ... ... Default Event-Based Hold: On ...
Amostras de código
C++
Para saber mais, consulte a documentação de referência da API Cloud Storage C++ .
C#
Para saber mais, consulte a documentação de referência da API Cloud Storage C# .
Go
Para saber mais, consulte a documentação de referência da API Cloud Storage Go .
Java
Para saber mais, consulte a documentação de referência da API Cloud Storage Java .
Node.js
Para saber mais, consulte a documentação de referência da API Cloud Storage Node.js .
PHP
Para saber mais, consulte a documentação de referência da API Cloud Storage PHP .
Python
Para saber mais, consulte a documentação de referência da API Cloud Storage para Python .
Ruby
Para saber mais, consulte a documentação de referência da API Cloud Storage Ruby .
APIs REST
API JSON
- Receba um token de acesso de autorização do OAuth 2.0 Playground. Configure o Playground para usar suas credenciais do OAuth.
Use
cURL
para chamar a API JSON com uma solicitação deGET
Intervalo que inclui osfields
desejados:curl -X GET -H "Authorization: Bearer [OAUTH2_TOKEN]" \ "https://www.googleapis.com/storage/v1/b/[BUCKET_NAME]?fields=defaultEventBasedHold"
em que
[OAUTH2_TOKEN]
é o token de acesso gerado na Etapa 1;[BUCKET_NAME]
é o nome do intervalo pertinente. Por exemplo,my-bucket
.
Se o intervalo tiver uma retenção baseada em evento padrão ativada para ele, a resposta será semelhante ao exemplo a seguir:
{ "retentionPolicy": true }
API XML
A API XML não pode ser usada para trabalhar com retenções de objeto. Use uma das outras ferramentas do Cloud Storage, como o gsutil.
Como desativar uma retenção baseada em eventos padrão
Para desativar uma retenção baseada em eventos padrão em um intervalo:
Console
- Abra o navegador do Cloud Storage no Console do Google Cloud Platform.
Abra o navegador do Cloud Storage Na lista de intervalos, clique no nome do intervalo no qual você quer desativar a retenção baseada em eventos padrão.
Selecione a guia Bloqueio de intervalo no topo da página.
Na entrada retenções baseadas em eventos por padrão, clique no botão Ativadas.
gsutil
Use o comando gsutil retention event-default release
:
gsutil retention event-default release gs://[BUCKET_NAME]
em que [BUCKET_NAME]
é o nome do intervalo pertinente. Por exemplo, my-bucket
.
Amostras de código
C++
Para saber mais, consulte a documentação de referência da API Cloud Storage C++ .
C#
Para saber mais, consulte a documentação de referência da API Cloud Storage C# .
Go
Para saber mais, consulte a documentação de referência da API Cloud Storage Go .
Java
Para saber mais, consulte a documentação de referência da API Cloud Storage Java .
Node.js
Para saber mais, consulte a documentação de referência da API Cloud Storage Node.js .
PHP
Para saber mais, consulte a documentação de referência da API Cloud Storage PHP .
Python
Para saber mais, consulte a documentação de referência da API Cloud Storage para Python .
Ruby
Para saber mais, consulte a documentação de referência da API Cloud Storage Ruby .
APIs REST
API JSON
- Receba um token de acesso de autorização do OAuth 2.0 Playground. Configure o Playground para usar suas credenciais do OAuth.
Crie um arquivo .json com as informações a seguir:
{ "defaultEventBasedHold": false }
Use
cURL
para chamar a API JSON API com umaPATCH
solicitação de Intervalo:curl -X PATCH --data-binary @[JSON_FILE_NAME].json \ -H "Authorization: Bearer [OAUTH2_TOKEN]" \ -H "Content-Type: application/json" \ "https://www.googleapis.com/storage/v1/b/[BUCKET_NAME]?fields=defaultEventBasedHold"
em que:
[JSON_FILE_NAME]
é o nome do arquivo criado na Etapa 2.[OAUTH2_TOKEN]
é o token de acesso gerado na Etapa 1;[BUCKET_NAME]
é o nome do intervalo pertinente. Por exemplo,my-bucket
.
API XML
A API XML não pode ser usada para trabalhar com retenções de objeto. Use uma das outras ferramentas do Cloud Storage, como o gsutil.
Como trabalhar com retenções de objeto
As tarefas a seguir mostram como colocar, exibir e liberar retenções em objetos.
Como colocar uma retenção de objeto
Para colocar uma retenção em um objeto no seu intervalo:
Console
- Abra o navegador do Cloud Storage no Console do Google Cloud Platform.
Abra o navegador do Cloud Storage Na lista de intervalos, clique no nome do intervalo que contém os objetos em que você quer colocar retenções.
Marque a caixa de seleção ao lado dos nomes dos objetos que você quer colocar retenções.
Clique no botão Gerenciar retenções.
A janela Gerenciar retenções é exibida.
Selecione a caixa de seleção para os tipos de retenção que você quer colocar nos objetos selecionados
Clique em Salvar configurações de retenção.
gsutil
Use o comando gsutil retention
:
gsutil retention [HOLD_TYPE] set gs://[BUCKET_NAME]/[OBJECT_NAME]
em que:
[HOLD_TYPE]
é o tipo de retenção que você quer aplicar ao seu objeto. Por exemplo,temp
ouevent
. Consulte Retenções de objetos para saber mais sobre os tipos de retenção.[BUCKET_NAME]
é o nome do intervalo pertinente. Por exemplo,my-bucket
.[OBJECT_NAME]
é o nome do objeto pertinente. Por exemplo,pets/dog.png
.
Amostras de código
C++
Para saber mais, consulte a documentação de referência da API Cloud Storage C++ .
A amostra a seguir define uma retenção baseada em evento em um objeto:
A amostra a seguir define uma retenção temporária em um objeto:
C#
Para saber mais, consulte a documentação de referência da API Cloud Storage C# .
A amostra a seguir define uma retenção baseada em evento em um objeto:
A amostra a seguir define uma retenção temporária em um objeto:
Go
Para saber mais, consulte a documentação de referência da API Cloud Storage Go .
A amostra a seguir define uma retenção baseada em evento em um objeto:
A amostra a seguir define uma retenção temporária em um objeto:
Java
Para saber mais, consulte a documentação de referência da API Cloud Storage Java .
A amostra a seguir define uma retenção baseada em evento em um objeto:
A amostra a seguir define uma retenção temporária em um objeto:
Node.js
Para saber mais, consulte a documentação de referência da API Cloud Storage Node.js .
A amostra a seguir define uma retenção baseada em evento em um objeto:
A amostra a seguir define uma retenção temporária em um objeto:
PHP
Para saber mais, consulte a documentação de referência da API Cloud Storage PHP .
A amostra a seguir define uma retenção baseada em evento em um objeto:
A amostra a seguir define uma retenção temporária em um objeto:
Python
Para saber mais, consulte a documentação de referência da API Cloud Storage para Python .
A amostra a seguir define uma retenção baseada em evento em um objeto:
A amostra a seguir define uma retenção temporária em um objeto:
Ruby
Para saber mais, consulte a documentação de referência da API Cloud Storage Ruby .
A amostra a seguir define uma retenção baseada em evento em um objeto:
A amostra a seguir define uma retenção temporária em um objeto:
APIs REST
API JSON
- Receba um token de acesso de autorização do OAuth 2.0 Playground. Configure o Playground para usar suas credenciais do OAuth.
Crie um arquivo .json com as informações a seguir:
{ "[HOLD_TYPE]": true }
Onde
[HOLD_TYPE]
é o tipo de retenção que você quer aplicar ao seu objeto. Por exemplo,temporaryHold
oueventBasedHold
. Consulte Retenções de objetos para saber mais sobre os tipos de retenção.Use
cURL
para chamar a API JSON com uma solicitação dePATCH
Objeto:curl -X PATCH --data-binary @[JSON_FILE_NAME].json \ -H "Authorization: Bearer [OAUTH2_TOKEN]" \ -H "Content-Type: application/json" \ "https://www.googleapis.com/storage/v1/b/[BUCKET_NAME]/o/[OBJECT_NAME]"
em que:
[JSON_FILE_NAME]
é o nome do arquivo criado na Etapa 2.[OAUTH2_TOKEN]
é o token de acesso gerado na Etapa 1;[BUCKET_NAME]
é o nome do intervalo pertinente. Por exemplo,my-bucket
.[OBJECT_NAME]
é o nome do objeto pertinente. Por exemplo,pets/dog.png
.
API XML
A API XML não pode ser usada para trabalhar com retenções de objeto. Use uma das outras ferramentas do Cloud Storage, como o gsutil.
Como conseguir o status de retenção de um objeto
Para ver quais retenções existem em um objeto, se houver alguma, siga as instruções gerais sobre Como ver metadados de objeto.
Como liberar uma retenção de objeto
Para liberar a retenção de um objeto no seu intervalo:
Console
- Abra o navegador do Cloud Storage no Console do Google Cloud Platform.
Abra o navegador do Cloud Storage Na lista de intervalos, clique no nome do intervalo que contém os objetos de que você remove retenções.
Marque a caixa de seleção ao lado dos nomes dos objetos de que você quer remover as retenções.
Clique no botão Gerenciar retenções.
A janela Gerenciar retenções é exibida.
Desmarque a caixa de seleção das retenções que você quer remover.
Clique em Salvar configurações de retenção.
gsutil
Use o comando gsutil retention
:
gsutil retention [HOLD_TYPE] release gs://[BUCKET_NAME]/[OBJECT_NAME]
em que:
[HOLD_TYPE]
é o tipo de retenção que você quer liberar a partir do seu objeto. Por exemplo,temp
ouevent
. Consulte Retenções de objetos para saber mais sobre os tipos de retenção.[BUCKET_NAME]
é o nome do intervalo pertinente. Por exemplo,my-bucket
.[OBJECT_NAME]
é o nome do objeto pertinente. Por exemplo,pets/dog.png
.
Amostras de código
C++
Para saber mais, consulte a documentação de referência da API Cloud Storage C++ .
A amostra a seguir define uma retenção baseada em evento em um objeto:
A amostra a seguir define uma retenção temporária em um objeto:
C#
Para saber mais, consulte a documentação de referência da API Cloud Storage C# .
A amostra a seguir libera uma retenção baseada em evento em um objeto:
O exemplo a seguir libera uma retenção temporária em um objeto:
Go
Para saber mais, consulte a documentação de referência da API Cloud Storage Go .
A amostra a seguir libera uma retenção baseada em evento em um objeto:
O exemplo a seguir libera uma retenção temporária em um objeto:
Java
Para saber mais, consulte a documentação de referência da API Cloud Storage Java .
A amostra a seguir libera uma retenção baseada em evento em um objeto:
O exemplo a seguir libera uma retenção temporária em um objeto:
Node.js
Para saber mais, consulte a documentação de referência da API Cloud Storage Node.js .
A amostra a seguir libera uma retenção baseada em evento em um objeto:
O exemplo a seguir libera uma retenção temporária em um objeto:
PHP
Para saber mais, consulte a documentação de referência da API Cloud Storage PHP .
A amostra a seguir libera uma retenção baseada em evento em um objeto:
O exemplo a seguir libera uma retenção temporária em um objeto:
Python
Para saber mais, consulte a documentação de referência da API Cloud Storage para Python .
A amostra a seguir libera uma retenção baseada em evento em um objeto:
O exemplo a seguir libera uma retenção temporária em um objeto:
Ruby
Para saber mais, consulte a documentação de referência da API Cloud Storage Ruby .
A amostra a seguir libera uma retenção baseada em evento em um objeto:
O exemplo a seguir libera uma retenção temporária em um objeto:
APIs REST
API JSON
- Receba um token de acesso de autorização do OAuth 2.0 Playground. Configure o Playground para usar suas credenciais do OAuth.
Crie um arquivo .json com as informações a seguir:
{ "[HOLD_TYPE]": false }
Onde
[HOLD_TYPE]
é o tipo de retenção que você quer liberar a partir do seu objeto. Por exemplo,temporaryHold
oueventBasedHold
. Consulte Retenções de objetos para saber mais sobre os tipos de retenção.Use
cURL
para chamar a API JSON com uma solicitação dePATCH
Objeto:curl -X PATCH --data-binary @[JSON_FILE_NAME].json \ -H "Authorization: Bearer [OAUTH2_TOKEN]" \ -H "Content-Type: application/json" \ "https://www.googleapis.com/storage/v1/b/[BUCKET_NAME]/o/[OBJECT_NAME]"
em que:
[JSON_FILE_NAME]
é o nome do arquivo criado na Etapa 2.[OAUTH2_TOKEN]
é o token de acesso gerado na Etapa 1;[BUCKET_NAME]
é o nome do intervalo pertinente. Por exemplo,my-bucket
.[OBJECT_NAME]
é o nome do objeto pertinente. Por exemplo,pets/dog.png
.
API XML
A API XML não pode ser usada para trabalhar com retenções de objeto. Use uma das outras ferramentas do Cloud Storage, como o gsutil.
A seguir
- Saiba mais sobre as retenções de objetos, incluindo os diferentes tipos de retenções que um objeto pode ter.
- Aprenda a usar as políticas de retenção.