http4s-grpc-google-common-protos
2.18.0+0.0.5
API
Generated with
http4s-grpc-google-common-protos/com.google.rpc.error_details

com.google.rpc.error_details

package com.google.rpc.error_details

Members list

Concise view

Type members

Classlikes

final case class BadRequest(fieldViolations: Seq[FieldViolation], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[BadRequest]

Describes violations in a client request. This error type focuses on the syntactic aspects of the request.

Describes violations in a client request. This error type focuses on the syntactic aspects of the request.

Attributes

fieldViolations

Describes all violations in a client request.

Companion:
object
Source:
BadRequest.scala
Graph
Supertypes
trait Updatable[BadRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object BadRequest extends GeneratedMessageCompanion[BadRequest]

Attributes

Companion:
class
Source:
BadRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[BadRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class DebugInfo(stackEntries: Seq[String], detail: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[DebugInfo]

Describes additional debugging info.

Describes additional debugging info.

Attributes

detail

Additional debugging information provided by the server.

stackEntries

The stack trace entries indicating where the error occurred.

Companion:
object
Source:
DebugInfo.scala
Graph
Supertypes
trait Updatable[DebugInfo]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object DebugInfo extends GeneratedMessageCompanion[DebugInfo]

Attributes

Companion:
class
Source:
DebugInfo.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DebugInfo]
trait Serializable
class Object
trait Matchable
class Any
Self type
object ErrorDetailsProto extends GeneratedFileObject

Attributes

Source:
ErrorDetailsProto.scala
Graph
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class ErrorInfo(reason: String, domain: String, metadata: Map[String, String], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ErrorInfo]

Describes the cause of the error with structured details.

Describes the cause of the error with structured details.

Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled:

{ "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } }

This response indicates that the pubsub.googleapis.com API is not enabled.

Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:

{ "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }

Attributes

domain

The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

metadata

Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.

reason

The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

Companion:
object
Source:
ErrorInfo.scala
Graph
Supertypes
trait Updatable[ErrorInfo]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ErrorInfo extends GeneratedMessageCompanion[ErrorInfo]

Attributes

Companion:
class
Source:
ErrorInfo.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ErrorInfo]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class Help(links: Seq[Link], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Help]

Provides links to documentation or for performing an out of band action.

Provides links to documentation or for performing an out of band action.

For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

Attributes

links

URL(s) pointing to additional information on handling the current error.

Companion:
object
Source:
Help.scala
Graph
Supertypes
trait Updatable[Help]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Help extends GeneratedMessageCompanion[Help]

Attributes

Companion:
class
Source:
Help.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Help]
trait Serializable
class Object
trait Matchable
class Any
Self type
Help.type
final case class LocalizedMessage(locale: String, message: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[LocalizedMessage]

Provides a localized error message that is safe to return to the user which can be attached to an RPC error.

Provides a localized error message that is safe to return to the user which can be attached to an RPC error.

Attributes

locale

The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"

message

The localized error message in the above locale.

Companion:
object
Source:
LocalizedMessage.scala
Graph
Supertypes
trait Updatable[LocalizedMessage]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object LocalizedMessage extends GeneratedMessageCompanion[LocalizedMessage]

Attributes

Companion:
class
Source:
LocalizedMessage.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[LocalizedMessage]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class PreconditionFailure(violations: Seq[Violation], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[PreconditionFailure]

Describes what preconditions have failed.

Describes what preconditions have failed.

For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message.

Attributes

violations

Describes all precondition violations.

Companion:
object
Source:
PreconditionFailure.scala
Graph
Supertypes
trait Updatable[PreconditionFailure]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object PreconditionFailure extends GeneratedMessageCompanion[PreconditionFailure]

Attributes

Companion:
class
Source:
PreconditionFailure.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[PreconditionFailure]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class QuotaFailure(violations: Seq[Violation], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[QuotaFailure]

Describes how a quota check failed.

Describes how a quota check failed.

For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled to true.

Also see RetryInfo and Help types for other details about handling a quota failure.

Attributes

violations

Describes all quota violations.

Companion:
object
Source:
QuotaFailure.scala
Graph
Supertypes
trait Updatable[QuotaFailure]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object QuotaFailure extends GeneratedMessageCompanion[QuotaFailure]

Attributes

Companion:
class
Source:
QuotaFailure.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[QuotaFailure]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class RequestInfo(requestId: String, servingData: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[RequestInfo]

Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.

Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.

Attributes

requestId

An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs.

servingData

Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging.

Companion:
object
Source:
RequestInfo.scala
Graph
Supertypes
trait Updatable[RequestInfo]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object RequestInfo extends GeneratedMessageCompanion[RequestInfo]

Attributes

Companion:
class
Source:
RequestInfo.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RequestInfo]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ResourceInfo(resourceType: String, resourceName: String, owner: String, description: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ResourceInfo]

Describes the resource that is being accessed.

Describes the resource that is being accessed.

Attributes

description

Describes what error is encountered when accessing this resource. For example, updating a cloud project may require the writer permission on the developer console project.

owner

The owner of the resource (optional). For example, "user:<owner email>" or "project:<Google developer project id>".

resourceName

The name of the resource being accessed. For example, a shared calendar name: "[email protected]", if the current error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].

resourceType

A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".

Companion:
object
Source:
ResourceInfo.scala
Graph
Supertypes
trait Updatable[ResourceInfo]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ResourceInfo extends GeneratedMessageCompanion[ResourceInfo]

Attributes

Companion:
class
Source:
ResourceInfo.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ResourceInfo]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class RetryInfo(retryDelay: Option[Duration], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[RetryInfo]

Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses.

Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses.

It's always recommended that clients should use exponential backoff when retrying.

Clients should wait until retry_delay amount of time has passed since receiving the error response before retrying. If retrying requests also fail, clients should use an exponential backoff scheme to gradually increase the delay between retries based on retry_delay, until either a maximum number of retries have been reached or a maximum retry delay cap has been reached.

Attributes

retryDelay

Clients should wait at least this long between retrying the same request.

Companion:
object
Source:
RetryInfo.scala
Graph
Supertypes
trait Updatable[RetryInfo]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object RetryInfo extends GeneratedMessageCompanion[RetryInfo]

Attributes

Companion:
class
Source:
RetryInfo.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RetryInfo]
trait Serializable
class Object
trait Matchable
class Any
Self type
Generated with