...
ActiveGo 1.8Package errdetails
Overview ▹
Index ▹
type BadRequest ¶
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" json:"field_violations,omitempty"`
}
func (*BadRequest) Descriptor ¶
func (*BadRequest) Descriptor() ([]byte, []int)
func (*BadRequest) GetFieldViolations ¶
func (m *BadRequest) GetFieldViolations() []*BadRequest_FieldViolation
func (*BadRequest) ProtoMessage ¶
func (*BadRequest) ProtoMessage()
func (*BadRequest) Reset ¶
func (m *BadRequest) Reset()
func (*BadRequest) String ¶
func (m *BadRequest) String() string
type BadRequest_FieldViolation ¶
A message type used to describe a single bad request field.
type BadRequest_FieldViolation struct {
// A path leading to a field in the request body. The value will be a
// sequence of dot-separated identifiers that identify a protocol buffer
// field. E.g., "field_violations.field" would identify this field.
Field string `protobuf:"bytes,1,opt,name=field" json:"field,omitempty"`
// A description of why the request element is bad.
Description string `protobuf:"bytes,2,opt,name=description" json:"description,omitempty"`
}
func (*BadRequest_FieldViolation) Descriptor ¶
func (*BadRequest_FieldViolation) Descriptor() ([]byte, []int)
func (*BadRequest_FieldViolation) GetDescription ¶
func (m *BadRequest_FieldViolation) GetDescription() string
func (*BadRequest_FieldViolation) GetField ¶
func (m *BadRequest_FieldViolation) GetField() string
func (*BadRequest_FieldViolation) ProtoMessage ¶
func (*BadRequest_FieldViolation) ProtoMessage()
func (*BadRequest_FieldViolation) Reset ¶
func (m *BadRequest_FieldViolation) Reset()
func (*BadRequest_FieldViolation) String ¶
func (m *BadRequest_FieldViolation) String() string
type DebugInfo ¶
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" json:"stack_entries,omitempty"`
// Additional debugging information provided by the server.
Detail string `protobuf:"bytes,2,opt,name=detail" json:"detail,omitempty"`
}
func (*DebugInfo) Descriptor ¶
func (*DebugInfo) Descriptor() ([]byte, []int)
func (*DebugInfo) GetDetail ¶
func (m *DebugInfo) GetDetail() string
func (*DebugInfo) GetStackEntries ¶
func (m *DebugInfo) GetStackEntries() []string
func (*DebugInfo) ProtoMessage ¶
func (*DebugInfo) ProtoMessage()
func (*DebugInfo) Reset ¶
func (m *DebugInfo) Reset()
func (*DebugInfo) String ¶
func (m *DebugInfo) String() string
type Help ¶
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" json:"links,omitempty"`
}
func (*Help) Descriptor ¶
func (*Help) Descriptor() ([]byte, []int)
func (*Help) GetLinks ¶
func (m *Help) GetLinks() []*Help_Link
func (*Help) ProtoMessage ¶
func (*Help) ProtoMessage()
func (*Help) Reset ¶
func (m *Help) Reset()
func (*Help) String ¶
func (m *Help) String() string
type Help_Link ¶
Describes a URL link.
type Help_Link struct {
// Describes what the link offers.
Description string `protobuf:"bytes,1,opt,name=description" json:"description,omitempty"`
// The URL of the link.
Url string `protobuf:"bytes,2,opt,name=url" json:"url,omitempty"`
}
func (*Help_Link) Descriptor ¶
func (*Help_Link) Descriptor() ([]byte, []int)
func (*Help_Link) GetDescription ¶
func (m *Help_Link) GetDescription() string
func (*Help_Link) GetUrl ¶
func (m *Help_Link) GetUrl() string
func (*Help_Link) ProtoMessage ¶
func (*Help_Link) ProtoMessage()
func (*Help_Link) Reset ¶
func (m *Help_Link) Reset()
func (*Help_Link) String ¶
func (m *Help_Link) String() string
type LocalizedMessage ¶
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
// http://www.rfc-editor.org/rfc/bcp/bcp47.txt.
// Examples are: "en-US", "fr-CH", "es-MX"
Locale string `protobuf:"bytes,1,opt,name=locale" json:"locale,omitempty"`
// The localized error message in the above locale.
Message string `protobuf:"bytes,2,opt,name=message" json:"message,omitempty"`
}
func (*LocalizedMessage) Descriptor ¶
func (*LocalizedMessage) Descriptor() ([]byte, []int)
func (*LocalizedMessage) GetLocale ¶
func (m *LocalizedMessage) GetLocale() string
func (*LocalizedMessage) GetMessage ¶
func (m *LocalizedMessage) GetMessage() string
func (*LocalizedMessage) ProtoMessage ¶
func (*LocalizedMessage) ProtoMessage()
func (*LocalizedMessage) Reset ¶
func (m *LocalizedMessage) Reset()
func (*LocalizedMessage) String ¶
func (m *LocalizedMessage) String() string
type QuotaFailure ¶
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.
type QuotaFailure struct {
// Describes all quota violations.
Violations []*QuotaFailure_Violation `protobuf:"bytes,1,rep,name=violations" json:"violations,omitempty"`
}
func (*QuotaFailure) Descriptor ¶
func (*QuotaFailure) Descriptor() ([]byte, []int)
func (*QuotaFailure) GetViolations ¶
func (m *QuotaFailure) GetViolations() []*QuotaFailure_Violation
func (*QuotaFailure) ProtoMessage ¶
func (*QuotaFailure) ProtoMessage()
func (*QuotaFailure) Reset ¶
func (m *QuotaFailure) Reset()
func (*QuotaFailure) String ¶
func (m *QuotaFailure) String() string
type QuotaFailure_Violation ¶
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" 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" json:"description,omitempty"`
}
func (*QuotaFailure_Violation) Descriptor ¶
func (*QuotaFailure_Violation) Descriptor() ([]byte, []int)
func (*QuotaFailure_Violation) GetDescription ¶
func (m *QuotaFailure_Violation) GetDescription() string
func (*QuotaFailure_Violation) GetSubject ¶
func (m *QuotaFailure_Violation) GetSubject() string
func (*QuotaFailure_Violation) ProtoMessage ¶
func (*QuotaFailure_Violation) ProtoMessage()
func (*QuotaFailure_Violation) Reset ¶
func (m *QuotaFailure_Violation) Reset()
func (*QuotaFailure_Violation) String ¶
func (m *QuotaFailure_Violation) String() string
type RequestInfo ¶
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" 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" json:"serving_data,omitempty"`
}
func (*RequestInfo) Descriptor ¶
func (*RequestInfo) Descriptor() ([]byte, []int)
func (*RequestInfo) GetRequestId ¶
func (m *RequestInfo) GetRequestId() string
func (*RequestInfo) GetServingData ¶
func (m *RequestInfo) GetServingData() string
func (*RequestInfo) ProtoMessage ¶
func (*RequestInfo) ProtoMessage()
func (*RequestInfo) Reset ¶
func (m *RequestInfo) Reset()
func (*RequestInfo) String ¶
func (m *RequestInfo) String() string
type ResourceInfo ¶
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" 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" 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" 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" json:"description,omitempty"`
}
func (*ResourceInfo) Descriptor ¶
func (*ResourceInfo) Descriptor() ([]byte, []int)
func (*ResourceInfo) GetDescription ¶
func (m *ResourceInfo) GetDescription() string
func (*ResourceInfo) GetOwner ¶
func (m *ResourceInfo) GetOwner() string
func (*ResourceInfo) GetResourceName ¶
func (m *ResourceInfo) GetResourceName() string
func (*ResourceInfo) GetResourceType ¶
func (m *ResourceInfo) GetResourceType() string
func (*ResourceInfo) ProtoMessage ¶
func (*ResourceInfo) ProtoMessage()
func (*ResourceInfo) Reset ¶
func (m *ResourceInfo) Reset()
func (*ResourceInfo) String ¶
func (m *ResourceInfo) String() string
type 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.
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.
type RetryInfo struct {
// Clients should wait at least this long between retrying the same request.
RetryDelay *google_protobuf.Duration `protobuf:"bytes,1,opt,name=retry_delay,json=retryDelay" json:"retry_delay,omitempty"`
}
func (*RetryInfo) Descriptor ¶
func (*RetryInfo) Descriptor() ([]byte, []int)
func (*RetryInfo) GetRetryDelay ¶
func (m *RetryInfo) GetRetryDelay() *google_protobuf.Duration
func (*RetryInfo) ProtoMessage ¶
func (*RetryInfo) ProtoMessage()
func (*RetryInfo) Reset ¶
func (m *RetryInfo) Reset()
func (*RetryInfo) String ¶
func (m *RetryInfo) String() string