ConnectionRetryPolicy Klasa

Dziedziczenie
azure.core.pipeline.policies._retry.RetryPolicy
ConnectionRetryPolicy

Konstruktor

ConnectionRetryPolicy(**kwargs)

Metody

configure_retries

Konfiguruje ustawienia ponawiania.

get_backoff_time

Zwraca bieżący czas wycofywania.

get_retry_after

Pobierz wartość Retry-After w sekundach.

increment

Zwiększ liczniki ponawiania prób.

is_exhausted

Sprawdza, czy jakiekolwiek ponawianie prób zostało pozostawione.

is_retry

Sprawdza, czy kod metody/stanu można ponowić próbę.

Na podstawie list dozwolonych i zmiennych sterujących, takich jak liczba dozwolonych ponownych prób, czy należy przestrzegać nagłówka Retry-After, czy ten nagłówek jest obecny, oraz czy zwrócony kod stanu znajduje się na liście kodów stanu, które mają zostać ponawiane na obecności wyżej wymienionego nagłówka.

Zachowanie jest następujące:

  •   If status_code < 400: don't retry
    
  •   Else if Retry-After present: retry
    
  •   Else: retry based on the safe status code list ([408, 429, 500, 502, 503, 504])
    
no_retries

Wyłącz ponawianie prób.

parse_retry_after

Pomocnik do analizowania Retry-After i uzyskiwania wartości w sekundach.

send

Wysyła obiekt PipelineRequest do następnych zasad. W razie potrzeby używa ustawień ponawiania prób. Wymusza również bezwzględny limit czasu po stronie klienta, który obejmuje wiele ponownych prób.

sleep

Uśpij między próbami ponawiania prób.

Ta metoda będzie uwzględniać nagłówek odpowiedzi serwera Retry-After i uśpi czas trwania żądanego czasu. Jeśli tak nie jest, użyje wycofywania wykładniczego. Domyślnie współczynnik wycofywania wynosi 0, a ta metoda zwróci natychmiast.

update_context

Aktualizacje historię ponawiania prób w kontekście potoku.

configure_retries

Konfiguruje ustawienia ponawiania.

configure_retries(options: Dict[str, Any]) -> Dict[str, Any]

Parametry

Nazwa Opis
options
Wymagane

argumenty słowa kluczowego z kontekstu.

Zwraca

Typ Opis

Dykt zawierający ustawienia i historię ponownych prób.

get_backoff_time

Zwraca bieżący czas wycofywania.

get_backoff_time(settings: Dict[str, Any]) -> float

Parametry

Nazwa Opis
settings
Wymagane

Ustawienia ponawiania.

Zwraca

Typ Opis

Bieżąca wartość wycofywania.

get_retry_after

Pobierz wartość Retry-After w sekundach.

get_retry_after(response: PipelineResponse[Any, AllHttpResponseType]) -> float | None

Parametry

Nazwa Opis
response
Wymagane

Obiekt PipelineResponse

Zwraca

Typ Opis

Wartość Retry-After w sekundach.

increment

Zwiększ liczniki ponawiania prób.

increment(settings: Dict[str, Any], response: PipelineRequest[HTTPRequestType] | PipelineResponse[HTTPRequestType, AllHttpResponseType] | None = None, error: Exception | None = None) -> bool

Parametry

Nazwa Opis
settings
Wymagane

Ustawienia ponawiania.

response

Obiekt odpowiedzi potoku.

wartość domyślna: None
error

Błąd napotkany podczas żądania lub Brak, jeśli odpowiedź została odebrana pomyślnie.

wartość domyślna: None

Zwraca

Typ Opis

Czy jakakolwiek próba ponawiania jest dostępna wartość True, jeśli więcej ponownych prób jest dostępnych, w przeciwnym razie wartość False

is_exhausted

Sprawdza, czy jakiekolwiek ponawianie prób zostało pozostawione.

is_exhausted(settings: Dict[str, Any]) -> bool

Parametry

Nazwa Opis
settings
Wymagane

ustawienia ponawiania prób

Zwraca

Typ Opis

Fałsz, jeśli ma więcej ponownych prób. Wartość True, jeśli ponowne próby zostały wyczerpane.

is_retry

Sprawdza, czy kod metody/stanu można ponowić próbę.

Na podstawie list dozwolonych i zmiennych sterujących, takich jak liczba dozwolonych ponownych prób, czy należy przestrzegać nagłówka Retry-After, czy ten nagłówek jest obecny, oraz czy zwrócony kod stanu znajduje się na liście kodów stanu, które mają zostać ponawiane na obecności wyżej wymienionego nagłówka.

Zachowanie jest następujące:

  •   If status_code < 400: don't retry
    
  •   Else if Retry-After present: retry
    
  •   Else: retry based on the safe status code list ([408, 429, 500, 502, 503, 504])
    
is_retry(settings: Dict[str, Any], response: PipelineResponse[HTTPRequestType, AllHttpResponseType]) -> bool

Parametry

Nazwa Opis
settings
Wymagane

Ustawienia ponawiania.

response
Wymagane

Obiekt PipelineResponse

Zwraca

Typ Opis

Wartość True, jeśli kod metody/stanu można ponowić próbę. Fałsz, jeśli nie można ponowić próby.

no_retries

Wyłącz ponawianie prób.

no_retries() -> ClsRetryPolicy

Zwraca

Typ Opis

Zasady ponawiania z wyłączonymi ponownymi próbami.

parse_retry_after

Pomocnik do analizowania Retry-After i uzyskiwania wartości w sekundach.

parse_retry_after(retry_after: str) -> float

Parametry

Nazwa Opis
retry_after
Wymagane
str

nagłówek Retry-After

Zwraca

Typ Opis

Wartość Retry-After w sekundach.

send

Wysyła obiekt PipelineRequest do następnych zasad. W razie potrzeby używa ustawień ponawiania prób. Wymusza również bezwzględny limit czasu po stronie klienta, który obejmuje wiele ponownych prób.

send(request)

Parametry

Nazwa Opis
request
Wymagane

Obiekt PipelineRequest

Zwraca

Typ Opis

Zwraca wartość PipelineResponse lub zgłasza błąd w przypadku przekroczenia maksymalnej liczby ponownych prób.

Wyjątki

Typ Opis

Przekroczono maksymalną liczbę ponownych prób.

Przekroczono określony limit czasu.

Nie można przeprowadzić uwierzytelniania.

sleep

Uśpij między próbami ponawiania prób.

Ta metoda będzie uwzględniać nagłówek odpowiedzi serwera Retry-After i uśpi czas trwania żądanego czasu. Jeśli tak nie jest, użyje wycofywania wykładniczego. Domyślnie współczynnik wycofywania wynosi 0, a ta metoda zwróci natychmiast.

sleep(settings: Dict[str, Any], transport: HttpTransport[HTTPRequestType, HTTPResponseType], response: PipelineResponse[HTTPRequestType, HTTPResponseType] | None = None) -> None

Parametry

Nazwa Opis
settings
Wymagane

Ustawienia ponawiania.

transport
Wymagane

Typ transportu HTTP.

response

Obiekt PipelineResponse.

wartość domyślna: None

update_context

Aktualizacje historię ponawiania prób w kontekście potoku.

update_context(context: PipelineContext, retry_settings: Dict[str, Any]) -> None

Parametry

Nazwa Opis
context
Wymagane

Kontekst potoku.

retry_settings
Wymagane

Ustawienia ponawiania.

Atrybuty

BACKOFF_MAX

Maksymalny czas wycofywania.

BACKOFF_MAX = 120

next

Wskaźnik do następnych zasad lub transportu (opakowany jako zasady). Zostanie ustawiona podczas tworzenia potoku.

next: HTTPPolicy[HTTPRequestType, HTTPResponseType]