Package google.rpc

Indice

• Code (enum)
• Status (messaggio)

Codice

I codici di errore canonici per le API gRPC.

A volte possono essere applicati più codici di errore. I servizi devono restituire il codice di errore più specifico applicabile. Ad esempio, preferisci OUT_OF_RANGE a FAILED_PRECONDITION se si applicano entrambi i codici. Analogamente, preferisci NOT_FOUND o ALREADY_EXISTS rispetto a FAILED_PRECONDITION.

Enum
OK	Non è un errore; viene restituito in caso di esito positivo. Mappatura HTTP: 200 OK
CANCELLED	L'operazione è stata annullata, in genere dal chiamante. Mappatura HTTP: 499 Richiesta chiusa dal client
UNKNOWN	Errore sconosciuto. Ad esempio, questo errore può essere restituito quando un valore Status ricevuto da un altro spazio di indirizzi appartiene a uno spazio di errore non noto in questo spazio di indirizzi. Anche gli errori generati dalle API che non restituiscono informazioni sufficienti sull'errore possono essere convertiti in questo errore. Mappatura HTTP: 500 Errore interno del server
INVALID_ARGUMENT	Il client ha specificato un argomento non valido. Tieni presente che questo valore è diverso da FAILED_PRECONDITION. INVALID_ARGUMENT indica argomenti problematici indipendentemente dallo stato del sistema (ad esempio, un nome file non valido). Mappatura HTTP: 400 Bad Request
DEADLINE_EXCEEDED	La scadenza è trascorsa prima che l'operazione potesse essere completata. Per le operazioni che modificano lo stato del sistema, questo errore potrebbe essere restituito anche se l'operazione è stata completata correttamente. Ad esempio, una risposta corretta da un server potrebbe essere stata ritardata abbastanza da far scadere la scadenza. Mappatura HTTP: 504 Gateway Timeout
NOT_FOUND	Impossibile trovare un'entità richiesta (ad es. file o directory). Nota per gli sviluppatori di server: se una richiesta viene rifiutata per un'intera classe di utenti, ad esempio per l'implementazione graduale di una funzionalità o per una lista consentita non documentata, è possibile utilizzare NOT_FOUND. Se una richiesta viene rifiutata per alcuni utenti all'interno di una classe di utenti, ad esempio controllo dell'accesso basato sugli utenti, è necessario utilizzare PERMISSION_DENIED. Mappatura HTTP: 404 - Non trovato
ALREADY_EXISTS	L'entità che un client ha tentato di creare (ad es. file o directory) esiste già. Mappatura HTTP: 409 Conflict
PERMISSION_DENIED	Il chiamante non dispone dell'autorizzazione per eseguire l'operazione specificata. PERMISSION_DENIED non deve essere utilizzato per i rifiuti causati dall'esaurimento di una risorsa (per questi errori utilizza invece RESOURCE_EXHAUSTED). PERMISSION_DENIED non deve essere utilizzato se il chiamante non può essere identificato (per questi errori utilizza UNAUTHENTICATED). Questo codice di errore non implica che la richiesta sia valida o che l'entità richiesta esista o soddisfi altre precondizioni. Mappatura HTTP: 403 Forbidden
UNAUTHENTICATED	La richiesta non ha credenziali di autenticazione valide per l'operazione. Mappatura HTTP: 401 Unauthorized
RESOURCE_EXHAUSTED	Alcune risorse sono state esaurite, ad esempio una quota per utente, o forse l'intero file system ha esaurito lo spazio. Mappatura HTTP: 429 Too Many Requests
FAILED_PRECONDITION	L'operazione è stata rifiutata perché il sistema non si trova in uno stato richiesto per l'esecuzione dell'operazione. Ad esempio, la directory da eliminare non è vuota, un'operazione rmdir viene applicata a una non directory e così via. Gli implementatori dei servizi possono utilizzare le seguenti linee guida per decidere tra FAILED_PRECONDITION, ABORTED e UNAVAILABLE: (a) Utilizza UNAVAILABLE se il client può riprovare solo la chiamata non riuscita. (b) Utilizza ABORTED se il client deve riprovare a un livello superiore. Ad esempio, quando un test-and-set specificato dal client non riesce, indicando che il client deve riavviare una sequenza di lettura-modifica-scrittura. (c) Utilizza FAILED_PRECONDITION se il client non deve riprovare finché lo stato del sistema non è stato corretto esplicitamente. Ad esempio, se un comando "rmdir" non va a buon fine perché la directory non è vuota, deve essere restituito FAILED_PRECONDITION, poiché il client non deve riprovare a meno che i file non vengano eliminati dalla directory. Mappatura HTTP: 400 Bad Request
ABORTED	L'operazione è stata interrotta, in genere a causa di un problema di concorrenza, ad esempio un errore di controllo del sequencer o un'interruzione della transazione. Consulta le linee guida riportate sopra per decidere tra FAILED_PRECONDITION, ABORTED e UNAVAILABLE. Mappatura HTTP: 409 Conflict
OUT_OF_RANGE	È stato eseguito un tentativo di operazione oltre l'intervallo valido. Ad esempio, ricerca o lettura oltre la fine del file. A differenza di INVALID_ARGUMENT, questo errore indica un problema che potrebbe essere risolto se lo stato del sistema cambia. Ad esempio, un file system a 32 bit genererà INVALID_ARGUMENT se viene richiesto di leggere un offset non compreso nell'intervallo [0,2^32-1], ma genererà OUT_OF_RANGE se viene richiesto di leggere un offset oltre le dimensioni attuali del file. C'è una discreta sovrapposizione tra FAILED_PRECONDITION e OUT_OF_RANGE. Ti consigliamo di utilizzare OUT_OF_RANGE (l'errore più specifico) quando applicabile, in modo che i chiamanti che eseguono l'iterazione in uno spazio possano cercare facilmente un errore OUT_OF_RANGE per rilevare quando hanno finito. Mappatura HTTP: 400 Bad Request
UNIMPLEMENTED	L'operazione non è implementata o non è supportata/abilitata in questo servizio. Mappatura HTTP: 501 Non implementato
INTERNAL	Errori interni. Ciò significa che alcune invarianti previste dal sistema sottostante sono state violate. Questo codice di errore è riservato a errori gravi. Mappatura HTTP: 500 Errore interno del server
UNAVAILABLE	Il servizio non è attualmente disponibile. Si tratta molto probabilmente di una condizione temporanea, che può essere corretta riprovando con un backoff. Tieni presente che non è sempre sicuro riprovare le operazioni non idempotenti. Consulta le linee guida riportate sopra per decidere tra FAILED_PRECONDITION, ABORTED e UNAVAILABLE. Mappatura HTTP: 503 Service Unavailable
DATA_LOSS	Perdita o danneggiamento dei dati non recuperabili. Mappatura HTTP: 500 Errore interno del server

Stato

Il tipo Status definisce un modello di errore logico adatto a diversi ambienti di programmazione, tra cui API REST e API RPC. Viene utilizzato da gRPC. Ciascun messaggio Status contiene tre tipi di dati: codice di errore, messaggio di errore e dettagli dell'errore.

Per ulteriori informazioni su questo modello di errore e su come gestirlo, consulta la Guida alla progettazione delle API.

Campi
code	int32 Il codice di stato, che deve essere un valore enum di google.rpc.Code.
message	string Un messaggio di errore rivolto agli sviluppatori, che deve essere in inglese. Qualsiasi messaggio di errore rivolto agli utenti deve essere localizzato e inviato nel campo google.rpc.Status.details o localizzato dal client.
details[]	Any Un elenco di messaggi contenenti i dettagli dell'errore. Esiste un insieme comune di tipi di messaggi da utilizzare per le API.