Type Members

1.  final case class BadRequest(fieldViolations: Seq[FieldViolation] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[BadRequest] with Product with Serializable

   Describes violations in a client request.

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

   fieldViolations

   Describes all violations in a client request.

   Annotations

   @SerialVersionUID()

2.  sealed abstract class Code extends GeneratedEnum

   The canonical error codes for Google APIs.

   The canonical error codes for Google APIs.

   Sometimes multiple error codes may apply. Services should return the most specific error code that applies. For example, prefer OUT_OF_RANGE over FAILED_PRECONDITION if both codes apply. Similarly prefer NOT_FOUND or ALREADY_EXISTS over FAILED_PRECONDITION.

3.  final case class DebugInfo(stackEntries: Seq[String] = _root_.scala.Seq.empty, detail: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[DebugInfo] with Product with Serializable

   Describes additional debugging info.

   Describes additional debugging info.

   stackEntries

   The stack trace entries indicating where the error occurred.

   detail

   Additional debugging information provided by the server.

   Annotations

   @SerialVersionUID()

4.  final case class Help(links: Seq[Link] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Help] with Product with Serializable

   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.

   links

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

   Annotations

   @SerialVersionUID()

5.  final case class LocalizedMessage(locale: String = "", message: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[LocalizedMessage] with Product with Serializable

   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.

   locale

   The locale used following the specification defined at http://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.

   Annotations

   @SerialVersionUID()

6.  final case class PreconditionFailure(violations: Seq[Violation] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[PreconditionFailure] with Product with Serializable

   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.

   violations

   Describes all precondition violations.

   Annotations

   @SerialVersionUID()

7.  final case class QuotaFailure(violations: Seq[Violation] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[QuotaFailure] with Product with Serializable

   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 RetryDetail and Help types for other details about handling a quota failure.

   violations

   Describes all quota violations.

   Annotations

   @SerialVersionUID()

8.  final case class RequestInfo(requestId: String = "", servingData: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[RequestInfo] with Product with Serializable

   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.

   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.

   Annotations

   @SerialVersionUID()

9.  final case class ResourceInfo(resourceType: String = "", resourceName: String = "", owner: String = "", description: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ResourceInfo] with Product with Serializable

   Describes the resource that is being accessed.

   Describes the resource that is being accessed.

   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".

   resourceName

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

   owner

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

   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.

   Annotations

   @SerialVersionUID()

10.  final case class RetryInfo(retryDelay: Option[Duration] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[RetryInfo] with Product with Serializable

    Describes when the clients can retry a failed request.

    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 retires have been reached or a maximum retry delay cap has been reached.

    retryDelay

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

    Annotations

    @SerialVersionUID()

11.  final case class Status(code: Int = 0, message: String = "", details: Seq[Any] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Status] with Product with Serializable

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be:

    - Simple to use and understand for most users - Flexible enough to meet unexpected needs

    # Overview

    The Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.

    # Language mapping

    The Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.

    # Other uses

    The error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.

    Example uses of this error model include:

    - Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.

    - Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.

    - Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.

    - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.

    - Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.

    code

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    message

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    details

    A list of messages that carry the error details. There is a common set of message types for APIs to use.

    Annotations

    @SerialVersionUID()