Package google.rpc

Indice

• Code (enum)
• Status (messaggio)

Codice

I codici di errore canonici per le API gRPC.

A volte potrebbero essere applicati più codici di errore. I servizi dovrebbero restituire il codice di errore più specifico applicabile. Ad esempio, preferisci OUT_OF_RANGE rispetto a FAILED_PRECONDITION se si applicano entrambi i codici. Allo stesso modo, 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: richiesta chiusa dal client 499
UNKNOWN	Errore sconosciuto. Ad esempio, questo errore potrebbe essere restituito quando un valore Status ricevuto da un altro spazio di indirizzi appartiene a uno spazio di errore non noto in questo spazio degli indirizzi. Anche gli errori generati dalle API che non restituiscono informazioni sufficienti sull'errore potrebbero essere convertiti in questo errore. Mappatura HTTP: errore interno del server 500
INVALID_ARGUMENT	Il client ha specificato un argomento non valido. Tieni presente che questo valore è diverso da FAILED_PRECONDITION. INVALID_ARGUMENT indica gli argomenti problematici indipendentemente dallo stato del sistema (ad es. un nome di file con formato non corretto). Mappatura HTTP: richiesta non valida 400
DEADLINE_EXCEEDED	Il termine è scaduto prima del completamento dell'operazione. Per le operazioni che cambiano lo stato del sistema, questo errore può essere restituito anche se l'operazione è stata completata correttamente. Ad esempio, una risposta corretta da un server potrebbe essere stata ritardata abbastanza a lungo da far scadere la scadenza. Mappatura HTTP: timeout del gateway 504
NOT_FOUND	Alcune entità richieste (ad es. file o directory) non sono state trovate. Nota per gli sviluppatori di server: se una richiesta viene rifiutata per un'intera classe di utenti, ad esempio l'implementazione graduale delle funzionalità o la lista consentita non documentata, è possibile che venga utilizzato NOT_FOUND. Se una richiesta viene rifiutata per alcuni utenti all'interno di una classe di utenti, ad esempio il controllo dell'accesso basato sull'utente, è necessario utilizzare PERMISSION_DENIED. Mappatura HTTP: errore 404 non trovato
ALREADY_EXISTS	L'entità che un client ha tentato di creare (ad es. un file o una directory) esiste già. Mappatura HTTP: conflitto (409)
PERMISSION_DENIED	Il chiamante non dispone dell'autorizzazione per eseguire l'operazione specificata. Non utilizzare PERMISSION_DENIED per rifiuti causati dall'esaurimento di alcune risorse (utilizza RESOURCE_EXHAUSTED per questi errori). PERMISSION_DENIED non deve essere utilizzato se non è possibile identificare il chiamante (utilizza invece UNAUTHENTICATED per questi errori). Questo codice di errore non implica che la richiesta sia valida o che l'entità richiesta esista o soddisfi altre condizioni preliminari. Mappatura HTTP: 403 accesso negato
UNAUTHENTICATED	La richiesta non ha credenziali di autenticazione valide per l'operazione. Mappatura HTTP: 401 non autorizzato
RESOURCE_EXHAUSTED	Alcune risorse sono esaurite, forse una quota per utente o forse l'intero file system ha esaurito lo spazio. Mappatura HTTP: 429 Troppe richieste
FAILED_PRECONDITION	L'operazione è stata rifiutata perché il sistema non si trova nello stato richiesto per l'esecuzione. Ad esempio, la directory da eliminare non è vuota, un'operazione rmdir viene applicata a una directory 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 per la chiamata con esito negativo. (b) Utilizza ABORTED se il client deve riprovare a un livello superiore. Ad esempio, quando un test-and-set specificato dal client ha esito negativo, significa che il client deve riavviare una sequenza di lettura, modifica e scrittura. (c) Utilizza FAILED_PRECONDITION se il client non deve riprovare finché lo stato del sistema non viene risolto esplicitamente. Ad esempio, se un comando "rmdir" non riesce perché la directory non è vuota, dovrebbe essere restituito FAILED_PRECONDITION poiché il client non dovrebbe riprovare a meno che i file non vengano eliminati dalla directory. Mappatura HTTP: richiesta non valida 400
ABORTED	L'operazione è stata interrotta, generalmente a causa di un problema di contemporaneità, come un errore del controllo della sequenziatore o l'interruzione della transazione. Consulta le linee guida sopra riportate per scegliere tra FAILED_PRECONDITION, ABORTED e UNAVAILABLE. Mappatura HTTP: conflitto (409)
OUT_OF_RANGE	L'operazione è stata tentata oltre l'intervallo valido. Ad esempio, la ricerca o la lettura oltre la fine del file. A differenza del criterio 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 con un offset che non rientra nell'intervallo [0,2^32-1], ma genererà OUT_OF_RANGE se viene chiesto di leggere da un offset oltre la dimensione attuale del file. Esiste una leggera sovrapposizione tra FAILED_PRECONDITION e OUT_OF_RANGE. Consigliamo di utilizzare OUT_OF_RANGE (l'errore più specifico) quando è applicabile, in modo che i chiamanti che eseguono l'iterazione attraverso uno spazio possano facilmente cercare un errore OUT_OF_RANGE per rilevare il completamento dell'operazione. Mappatura HTTP: richiesta non valida 400
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 interrotte. Questo codice di errore è riservato a errori gravi. Mappatura HTTP: errore interno del server 500
UNAVAILABLE	Il servizio non è al momento disponibile. Si tratta molto probabilmente di una condizione temporanea, che può essere corretta riprovando con un backoff. Tieni presente che non è sempre sicuro ritentare le operazioni non idempotenti. Consulta le linee guida sopra riportate per scegliere tra FAILED_PRECONDITION, ABORTED e UNAVAILABLE. Mappatura HTTP: servizio 503 non disponibile
DATA_LOSS	Perdita o danneggiamento di dati non recuperabili. Mappatura HTTP: errore interno del server 500

Stato

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

Per ulteriori informazioni su questo modello di errore e su come utilizzarlo, 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 oppure dal client.
details[]	Any Un elenco di messaggi con i dettagli dell'errore. Le API possono utilizzare un insieme comune di tipi di messaggi.