var File_google_rpc_error_details_proto protoreflect.FileDescriptor
Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
type BadRequest struct {
// Describes all violations in a client request.
FieldViolations []*BadRequest_FieldViolation `protobuf:"bytes,1,rep,name=field_violations,json=fieldViolations,proto3" json:"field_violations,omitempty"`
// contains filtered or unexported fields
}
func (*BadRequest) Descriptor() ([]byte, []int)
Deprecated: Use BadRequest.ProtoReflect.Descriptor instead.
func (x *BadRequest) GetFieldViolations() []*BadRequest_FieldViolation
func (*BadRequest) ProtoMessage()
func (x *BadRequest) ProtoReflect() protoreflect.Message
func (x *BadRequest) Reset()
func (x *BadRequest) String() string
A message type used to describe a single bad request field.
type BadRequest_FieldViolation struct {
// A path that leads to a field in the request body. The value will be a
// sequence of dot-separated identifiers that identify a protocol buffer
// field.
//
// Consider the following:
//
// message CreateContactRequest {
// message EmailAddress {
// enum Type {
// TYPE_UNSPECIFIED = 0;
// HOME = 1;
// WORK = 2;
// }
//
// optional string email = 1;
// repeated EmailType type = 2;
// }
//
// string full_name = 1;
// repeated EmailAddress email_addresses = 2;
// }
//
// In this example, in proto `field` could take one of the following values:
//
// - `full_name` for a violation in the `full_name` value
// - `email_addresses[1].email` for a violation in the `email` field of the
// first `email_addresses` message
// - `email_addresses[3].type[2]` for a violation in the second `type`
// value in the third `email_addresses` message.
//
// In JSON, the same values are represented as:
//
// - `fullName` for a violation in the `fullName` value
// - `emailAddresses[1].email` for a violation in the `email` field of the
// first `emailAddresses` message
// - `emailAddresses[3].type[2]` for a violation in the second `type`
// value in the third `emailAddresses` message.
Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
// A description of why the request element is bad.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
func (*BadRequest_FieldViolation) Descriptor() ([]byte, []int)
Deprecated: Use BadRequest_FieldViolation.ProtoReflect.Descriptor instead.
func (x *BadRequest_FieldViolation) GetDescription() string
func (x *BadRequest_FieldViolation) GetField() string
func (*BadRequest_FieldViolation) ProtoMessage()
func (x *BadRequest_FieldViolation) ProtoReflect() protoreflect.Message
func (x *BadRequest_FieldViolation) Reset()
func (x *BadRequest_FieldViolation) String() string
Describes additional debugging info.
type DebugInfo struct {
// The stack trace entries indicating where the error occurred.
StackEntries []string `protobuf:"bytes,1,rep,name=stack_entries,json=stackEntries,proto3" json:"stack_entries,omitempty"`
// Additional debugging information provided by the server.
Detail string `protobuf:"bytes,2,opt,name=detail,proto3" json:"detail,omitempty"`
// contains filtered or unexported fields
}
func (*DebugInfo) Descriptor() ([]byte, []int)
Deprecated: Use DebugInfo.ProtoReflect.Descriptor instead.
func (x *DebugInfo) GetDetail() string
func (x *DebugInfo) GetStackEntries() []string
func (*DebugInfo) ProtoMessage()
func (x *DebugInfo) ProtoReflect() protoreflect.Message
func (x *DebugInfo) Reset()
func (x *DebugInfo) String() string
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"
}
}
type ErrorInfo struct {
// 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.
Reason string `protobuf:"bytes,1,opt,name=reason,proto3" json:"reason,omitempty"`
// 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".
Domain string `protobuf:"bytes,2,opt,name=domain,proto3" json:"domain,omitempty"`
// 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.
Metadata map[string]string `protobuf:"bytes,3,rep,name=metadata,proto3" json:"metadata,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*ErrorInfo) Descriptor() ([]byte, []int)
Deprecated: Use ErrorInfo.ProtoReflect.Descriptor instead.
func (x *ErrorInfo) GetDomain() string
func (x *ErrorInfo) GetMetadata() map[string]string
func (x *ErrorInfo) GetReason() string
func (*ErrorInfo) ProtoMessage()
func (x *ErrorInfo) ProtoReflect() protoreflect.Message
func (x *ErrorInfo) Reset()
func (x *ErrorInfo) String() string
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.
type Help struct {
// URL(s) pointing to additional information on handling the current error.
Links []*Help_Link `protobuf:"bytes,1,rep,name=links,proto3" json:"links,omitempty"`
// contains filtered or unexported fields
}
func (*Help) Descriptor() ([]byte, []int)
Deprecated: Use Help.ProtoReflect.Descriptor instead.
func (x *Help) GetLinks() []*Help_Link
func (*Help) ProtoMessage()
func (x *Help) ProtoReflect() protoreflect.Message
func (x *Help) Reset()
func (x *Help) String() string
Describes a URL link.
type Help_Link struct {
// Describes what the link offers.
Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
// The URL of the link.
Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
// contains filtered or unexported fields
}
func (*Help_Link) Descriptor() ([]byte, []int)
Deprecated: Use Help_Link.ProtoReflect.Descriptor instead.
func (x *Help_Link) GetDescription() string
func (x *Help_Link) GetUrl() string
func (*Help_Link) ProtoMessage()
func (x *Help_Link) ProtoReflect() protoreflect.Message
func (x *Help_Link) Reset()
func (x *Help_Link) String() string
Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
type LocalizedMessage struct {
// 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"
Locale string `protobuf:"bytes,1,opt,name=locale,proto3" json:"locale,omitempty"`
// The localized error message in the above locale.
Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
// contains filtered or unexported fields
}
func (*LocalizedMessage) Descriptor() ([]byte, []int)
Deprecated: Use LocalizedMessage.ProtoReflect.Descriptor instead.
func (x *LocalizedMessage) GetLocale() string
func (x *LocalizedMessage) GetMessage() string
func (*LocalizedMessage) ProtoMessage()
func (x *LocalizedMessage) ProtoReflect() protoreflect.Message
func (x *LocalizedMessage) Reset()
func (x *LocalizedMessage) String() string
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.
type PreconditionFailure struct {
// Describes all precondition violations.
Violations []*PreconditionFailure_Violation `protobuf:"bytes,1,rep,name=violations,proto3" json:"violations,omitempty"`
// contains filtered or unexported fields
}
func (*PreconditionFailure) Descriptor() ([]byte, []int)
Deprecated: Use PreconditionFailure.ProtoReflect.Descriptor instead.
func (x *PreconditionFailure) GetViolations() []*PreconditionFailure_Violation
func (*PreconditionFailure) ProtoMessage()
func (x *PreconditionFailure) ProtoReflect() protoreflect.Message
func (x *PreconditionFailure) Reset()
func (x *PreconditionFailure) String() string
A message type used to describe a single precondition failure.
type PreconditionFailure_Violation struct {
// The type of PreconditionFailure. We recommend using a service-specific
// enum type to define the supported precondition violation subjects. For
// example, "TOS" for "Terms of Service violation".
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
// The subject, relative to the type, that failed.
// For example, "google.com/cloud" relative to the "TOS" type would indicate
// which terms of service is being referenced.
Subject string `protobuf:"bytes,2,opt,name=subject,proto3" json:"subject,omitempty"`
// A description of how the precondition failed. Developers can use this
// description to understand how to fix the failure.
//
// For example: "Terms of service not accepted".
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
func (*PreconditionFailure_Violation) Descriptor() ([]byte, []int)
Deprecated: Use PreconditionFailure_Violation.ProtoReflect.Descriptor instead.
func (x *PreconditionFailure_Violation) GetDescription() string
func (x *PreconditionFailure_Violation) GetSubject() string
func (x *PreconditionFailure_Violation) GetType() string
func (*PreconditionFailure_Violation) ProtoMessage()
func (x *PreconditionFailure_Violation) ProtoReflect() protoreflect.Message
func (x *PreconditionFailure_Violation) Reset()
func (x *PreconditionFailure_Violation) String() string
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.
type QuotaFailure struct {
// Describes all quota violations.
Violations []*QuotaFailure_Violation `protobuf:"bytes,1,rep,name=violations,proto3" json:"violations,omitempty"`
// contains filtered or unexported fields
}
func (*QuotaFailure) Descriptor() ([]byte, []int)
Deprecated: Use QuotaFailure.ProtoReflect.Descriptor instead.
func (x *QuotaFailure) GetViolations() []*QuotaFailure_Violation
func (*QuotaFailure) ProtoMessage()
func (x *QuotaFailure) ProtoReflect() protoreflect.Message
func (x *QuotaFailure) Reset()
func (x *QuotaFailure) String() string
A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
type QuotaFailure_Violation struct {
// The subject on which the quota check failed.
// For example, "clientip:<ip address of client>" or "project:<Google
// developer project id>".
Subject string `protobuf:"bytes,1,opt,name=subject,proto3" json:"subject,omitempty"`
// A description of how the quota check failed. Clients can use this
// description to find more about the quota configuration in the service's
// public documentation, or find the relevant quota limit to adjust through
// developer console.
//
// For example: "Service disabled" or "Daily Limit for read operations
// exceeded".
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
func (*QuotaFailure_Violation) Descriptor() ([]byte, []int)
Deprecated: Use QuotaFailure_Violation.ProtoReflect.Descriptor instead.
func (x *QuotaFailure_Violation) GetDescription() string
func (x *QuotaFailure_Violation) GetSubject() string
func (*QuotaFailure_Violation) ProtoMessage()
func (x *QuotaFailure_Violation) ProtoReflect() protoreflect.Message
func (x *QuotaFailure_Violation) Reset()
func (x *QuotaFailure_Violation) String() string
Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.
type RequestInfo struct {
// 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.
RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// 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.
ServingData string `protobuf:"bytes,2,opt,name=serving_data,json=servingData,proto3" json:"serving_data,omitempty"`
// contains filtered or unexported fields
}
func (*RequestInfo) Descriptor() ([]byte, []int)
Deprecated: Use RequestInfo.ProtoReflect.Descriptor instead.
func (x *RequestInfo) GetRequestId() string
func (x *RequestInfo) GetServingData() string
func (*RequestInfo) ProtoMessage()
func (x *RequestInfo) ProtoReflect() protoreflect.Message
func (x *RequestInfo) Reset()
func (x *RequestInfo) String() string
Describes the resource that is being accessed.
type ResourceInfo struct {
// 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".
ResourceType string `protobuf:"bytes,1,opt,name=resource_type,json=resourceType,proto3" json:"resource_type,omitempty"`
// 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].
ResourceName string `protobuf:"bytes,2,opt,name=resource_name,json=resourceName,proto3" json:"resource_name,omitempty"`
// The owner of the resource (optional).
// For example, "user:<owner email>" or "project:<Google developer project
// id>".
Owner string `protobuf:"bytes,3,opt,name=owner,proto3" json:"owner,omitempty"`
// 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.
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
func (*ResourceInfo) Descriptor() ([]byte, []int)
Deprecated: Use ResourceInfo.ProtoReflect.Descriptor instead.
func (x *ResourceInfo) GetDescription() string
func (x *ResourceInfo) GetOwner() string
func (x *ResourceInfo) GetResourceName() string
func (x *ResourceInfo) GetResourceType() string
func (*ResourceInfo) ProtoMessage()
func (x *ResourceInfo) ProtoReflect() protoreflect.Message
func (x *ResourceInfo) Reset()
func (x *ResourceInfo) String() string
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.
type RetryInfo struct {
// Clients should wait at least this long between retrying the same request.
RetryDelay *durationpb.Duration `protobuf:"bytes,1,opt,name=retry_delay,json=retryDelay,proto3" json:"retry_delay,omitempty"`
// contains filtered or unexported fields
}
func (*RetryInfo) Descriptor() ([]byte, []int)
Deprecated: Use RetryInfo.ProtoReflect.Descriptor instead.
func (x *RetryInfo) GetRetryDelay() *durationpb.Duration
func (*RetryInfo) ProtoMessage()
func (x *RetryInfo) ProtoReflect() protoreflect.Message
func (x *RetryInfo) Reset()
func (x *RetryInfo) String() string