A classe RetryParams
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
RetryParams é fornecido pela biblioteca de cliente do App Engine para Cloud Storage contida
em src/cloudstorage. Essa classe permite alterar as configurações padrão usadas para processar tempos limite e novas tentativas.
Introdução
A biblioteca de cliente do App Engine para Cloud Storage usa configurações padrão a fim de processar tempos limite e novas tentativas quando você estiver tentando entrar em contato com os servidores do Google Cloud Storage.
Essa classe permite alterar essas configurações, seja em todo o aplicativo
ou para uma invocação específica de uma função
de biblioteca (copy2, delete, listbucket, open, stat). Você precisa alterar apenas
a configuração específica em que está interessado, porque todas as outras são mantidas,
a menos que sejam explicitamente substituídas. Cada instância de RetryParams é exclusiva por thread
e por solicitação.
Para alterar uma configuração padrão em todo o aplicativo, crie um objeto RetryParams,
especifique as configurações que você quer alterar e forneça esse objeto à
função cloudstorage.set_default_retry_params() da seguinte maneira:
my_default_retry_params = cloudstorage.RetryParams(initial_delay=0.2,
max_delay=5.0,
backoff_factor=2,
max_retry_period=15)
cloudstorage.set_default_retry_params(my_default_retry_params)
Para alterar as configurações padrão apenas para uma invocação de função específica, crie
um objeto RetryParams e forneça-o diretamente para a função no
parâmetro retry_params da seguinte maneira:
write_retry_params = cloudstorage.RetryParams(backoff_factor=1.1)
gcs_file = cloudstorage.open(filename,
'w',
content_type='text/plain',
options={'x-goog-meta-foo': 'foo',
'x-goog-meta-bar': 'bar'},
retry_params=write_retry_params)
Ela não entra em vigor nas configurações padrão usadas pelo app ou por outras invocações de função.
Propriedades da instância
Uma instância RetryParams tem as seguintes propriedades:
- initial_delay
- O número de segundos de atraso antes de uma nova tentativa. O padrão é
0.1. O atraso ajuda
a distribuir a carga no servidor do Google Cloud Storage.
- backoff_factor
- O multiplicador de retirada exponencial, usado para determinar a taxa de processamento
ideal. O padrão é
2.0. Para uma descrição e recomendações para definir esse
valor, consulte a documentação do Google Cloud Storage em retirada.
- max_delay
- O número máximo de segundos para aguardar entre novas tentativas. O padrão é
10.0.
- min_retries
- O número mínimo de vezes de nova tentativa. O padrão é
3.
- max_retries
- O número máximo de vezes de nova tentativa. Defina esse valor como 0 caso você não queira novas tentativas. O padrão é
6.
- max_retry_period
- O número máximo de segundos que podem ser gastos em todas as novas tentativas de uma
determinada solicitação. O padrão é
30.0. Uma nova tentativa é parada quando este período passa E
min_retries foi tentado.
- urlfetch_timeout
- O número de segundos de espera de UrlFetch para entrar em contato com os
servidores do Google Cloud Storage antes de retornar um erro de tempo limite. Por padrão,
isso é definido como
None, o que significa usar o prazo padrão de UrlFetch,
que é de cinco segundos. É possível defini-lo como qualquer valor de até 60 segundos, no máximo.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-09-04 UTC.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-09-04 UTC."],[[["\u003cp\u003e\u003ccode\u003eRetryParams\u003c/code\u003e allows customization of timeout and retry settings for the App Engine client library's interactions with Cloud Storage.\u003c/p\u003e\n"],["\u003cp\u003eYou can adjust settings such as \u003ccode\u003einitial_delay\u003c/code\u003e, \u003ccode\u003ebackoff_factor\u003c/code\u003e, \u003ccode\u003emax_delay\u003c/code\u003e, \u003ccode\u003emin_retries\u003c/code\u003e, \u003ccode\u003emax_retries\u003c/code\u003e, \u003ccode\u003emax_retry_period\u003c/code\u003e, and \u003ccode\u003eurlfetch_timeout\u003c/code\u003e to control retry behavior.\u003c/p\u003e\n"],["\u003cp\u003eSettings can be changed application-wide using \u003ccode\u003ecloudstorage.set_default_retry_params()\u003c/code\u003e or for specific function calls by providing \u003ccode\u003eretry_params\u003c/code\u003e to the function directly.\u003c/p\u003e\n"],["\u003cp\u003eEach \u003ccode\u003eRetryParams\u003c/code\u003e instance is specific to a thread and request, allowing for granular control over retries without affecting other parts of the application.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eurlfetch_timeout\u003c/code\u003e setting lets users determine how many seconds to wait for UrlFetch to contact the Cloud Storage servers, defaulting to 5 seconds, but going as high as 60 seconds.\u003c/p\u003e\n"]]],[],null,["# The RetryParams Class\n\n`RetryParams` is provided by the App Engine client library for Cloud Storage contained\nin `src/cloudstorage`. This class lets you change default settings used to\nhandle timeouts and retries.\n\nIntroduction\n------------\n\nThe App Engine client library for Cloud Storage uses default settings for handling\ntimeouts and retries during attempts to contact Google Cloud Storage servers.\nThis class allows you to change those settings, either on an application-wide\nbasis, or for a specific invocation of a library\nfunction (`copy2`, `delete`, `listbucket`, `open`, `stat`). You need change only\nthe specific setting you are interested in, as all other settings are retained\nunless explicitly overwritten. Each `RetryParams` instance is unique per thread\nand per request.\n\nTo change a default setting application-wide, you create a `RetryParams`\nobject, specify whatever settings you wish to change, and supply this object to\nthe `cloudstorage.set_default_retry_params()` function as follows: \n\n my_default_retry_params = cloudstorage.RetryParams(initial_delay=0.2,\n max_delay=5.0,\n backoff_factor=2,\n max_retry_period=15)\n cloudstorage.set_default_retry_params(my_default_retry_params)\n\nTo change default settings for a specific function invocation only, create\na `RetryParams` object and supply it directly to the function in its\n`retry_params` parameter, as follows: \n\n write_retry_params = cloudstorage.RetryParams(backoff_factor=1.1)\n gcs_file = cloudstorage.open(filename,\n 'w',\n content_type='text/plain',\n options={'x-goog-meta-foo': 'foo',\n 'x-goog-meta-bar': 'bar'},\n retry_params=write_retry_params)\n\nThis has no effect on the default settings used by the app or by other\nfunction invocations.\n\nInstance properties\n-------------------\n\nA `RetryParams` instance has the following properties:\n\ninitial_delay\n: The number of seconds to delay before a retry. Default is `0.1`. Delay helps\n distribute load at the Google Cloud Storage server.\n\nbackoff_factor\n: The exponential back-off multiplier, used to determine optimal processing\n rate. Default is `2.0`. For a description and recommendations for setting this\n value, see the Google Cloud Storage documentation on [backoff](/storage/docs/exponential-backoff).\n\nmax_delay\n: The maximum number of seconds to wait between retries. Default is `10.0`.\n\nmin_retries\n: The minimum number of times to retry. Default is `3`.\n\nmax_retries\n: The maximum number of times to retry. Set this value to 0 if\n you don't want any retries. Default is `6`.\n\nmax_retry_period\n: The maximum number of seconds that can be spent on all retries of a\n given request. Default is `30.0`. Retry stops when this period passed AND\n `min_retries` has been attempted.\n\nurlfetch_timeout\n: The number of seconds to wait for UrlFetch to contact the\n Google Cloud Storage servers before returning a timeout error. By default,\n this is set to `None`, which means use the [default UrlFetch deadline](/appengine/docs/legacy/standard/python/issue-requests),\n which is five seconds. You can set this to any value up to a maximum of 60\n seconds."]]
