errdetails

package
v1.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 11, 2020 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidLengthErrorDetails        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowErrorDetails          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupErrorDetails = fmt.Errorf("proto: unexpected end of group")
)

Functions

This section is empty.

Types

type BadRequest 

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"`
	XXX_NoUnkeyedLiteral struct{}                     `json:"-"`
	XXX_unrecognized     []byte                       `json:"-"`
	XXX_sizecache        int32                        `json:"-"`
}

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

func NewPopulatedBadRequest 

func NewPopulatedBadRequest(r randyErrorDetails, easy bool) *BadRequest

func (*BadRequest) Compare 

func (this *BadRequest) Compare(that interface{}) int

func (*BadRequest) Descriptor 

func (*BadRequest) Descriptor() ([]byte, []int)

func (*BadRequest) Equal 

func (this *BadRequest) Equal(that interface{}) bool

func (*BadRequest) GetFieldViolations 

func (m *BadRequest) GetFieldViolations() []*BadRequest_FieldViolation

func (*BadRequest) GoString 

func (this *BadRequest) GoString() string

func (*BadRequest) Marshal 

func (m *BadRequest) Marshal() (dAtA []byte, err error)

func (*BadRequest) MarshalTo 

func (m *BadRequest) MarshalTo(dAtA []byte) (int, error)

func (*BadRequest) MarshalToSizedBuffer 

func (m *BadRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*BadRequest) ProtoMessage 

func (*BadRequest) ProtoMessage()

func (*BadRequest) Reset 

func (m *BadRequest) Reset()

func (*BadRequest) Size 

func (m *BadRequest) Size() (n int)

func (*BadRequest) String 

func (this *BadRequest) String() string

func (*BadRequest) Unmarshal 

func (m *BadRequest) Unmarshal(dAtA []byte) error

func (*BadRequest) XXX_DiscardUnknown 

func (m *BadRequest) XXX_DiscardUnknown()

func (*BadRequest) XXX_Marshal 

func (m *BadRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BadRequest) XXX_Merge 

func (m *BadRequest) XXX_Merge(src proto.Message)

func (*BadRequest) XXX_MessageName 

func (*BadRequest) XXX_MessageName() string

func (*BadRequest) XXX_Size 

func (m *BadRequest) XXX_Size() int

func (*BadRequest) XXX_Unmarshal 

func (m *BadRequest) XXX_Unmarshal(b []byte) error

type BadRequest_FieldViolation 

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,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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A message type used to describe a single bad request field.

func NewPopulatedBadRequest_FieldViolation 

func NewPopulatedBadRequest_FieldViolation(r randyErrorDetails, easy bool) *BadRequest_FieldViolation

func (*BadRequest_FieldViolation) Compare 

func (this *BadRequest_FieldViolation) Compare(that interface{}) int

func (*BadRequest_FieldViolation) Descriptor 

func (*BadRequest_FieldViolation) Descriptor() ([]byte, []int)

func (*BadRequest_FieldViolation) Equal 

func (this *BadRequest_FieldViolation) Equal(that interface{}) bool

func (*BadRequest_FieldViolation) GetDescription 

func (m *BadRequest_FieldViolation) GetDescription() string

func (*BadRequest_FieldViolation) GetField 

func (m *BadRequest_FieldViolation) GetField() string

func (*BadRequest_FieldViolation) GoString 

func (this *BadRequest_FieldViolation) GoString() string

func (*BadRequest_FieldViolation) Marshal 

func (m *BadRequest_FieldViolation) Marshal() (dAtA []byte, err error)

func (*BadRequest_FieldViolation) MarshalTo 

func (m *BadRequest_FieldViolation) MarshalTo(dAtA []byte) (int, error)

func (*BadRequest_FieldViolation) MarshalToSizedBuffer 

func (m *BadRequest_FieldViolation) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*BadRequest_FieldViolation) ProtoMessage 

func (*BadRequest_FieldViolation) ProtoMessage()

func (*BadRequest_FieldViolation) Reset 

func (m *BadRequest_FieldViolation) Reset()

func (*BadRequest_FieldViolation) Size 

func (m *BadRequest_FieldViolation) Size() (n int)

func (*BadRequest_FieldViolation) String 

func (this *BadRequest_FieldViolation) String() string

func (*BadRequest_FieldViolation) Unmarshal 

func (m *BadRequest_FieldViolation) Unmarshal(dAtA []byte) error

func (*BadRequest_FieldViolation) XXX_DiscardUnknown 

func (m *BadRequest_FieldViolation) XXX_DiscardUnknown()

func (*BadRequest_FieldViolation) XXX_Marshal 

func (m *BadRequest_FieldViolation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BadRequest_FieldViolation) XXX_Merge 

func (m *BadRequest_FieldViolation) XXX_Merge(src proto.Message)

func (*BadRequest_FieldViolation) XXX_MessageName 

func (*BadRequest_FieldViolation) XXX_MessageName() string

func (*BadRequest_FieldViolation) XXX_Size 

func (m *BadRequest_FieldViolation) XXX_Size() int

func (*BadRequest_FieldViolation) XXX_Unmarshal 

func (m *BadRequest_FieldViolation) XXX_Unmarshal(b []byte) error

type DebugInfo 

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Describes additional debugging info.

func NewPopulatedDebugInfo 

func NewPopulatedDebugInfo(r randyErrorDetails, easy bool) *DebugInfo

func (*DebugInfo) Compare 

func (this *DebugInfo) Compare(that interface{}) int

func (*DebugInfo) Descriptor 

func (*DebugInfo) Descriptor() ([]byte, []int)

func (*DebugInfo) Equal 

func (this *DebugInfo) Equal(that interface{}) bool

func (*DebugInfo) GetDetail 

func (m *DebugInfo) GetDetail() string

func (*DebugInfo) GetStackEntries 

func (m *DebugInfo) GetStackEntries() []string

func (*DebugInfo) GoString 

func (this *DebugInfo) GoString() string

func (*DebugInfo) Marshal 

func (m *DebugInfo) Marshal() (dAtA []byte, err error)

func (*DebugInfo) MarshalTo 

func (m *DebugInfo) MarshalTo(dAtA []byte) (int, error)

func (*DebugInfo) MarshalToSizedBuffer 

func (m *DebugInfo) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DebugInfo) ProtoMessage 

func (*DebugInfo) ProtoMessage()

func (*DebugInfo) Reset 

func (m *DebugInfo) Reset()

func (*DebugInfo) Size 

func (m *DebugInfo) Size() (n int)

func (*DebugInfo) String 

func (this *DebugInfo) String() string

func (*DebugInfo) Unmarshal 

func (m *DebugInfo) Unmarshal(dAtA []byte) error

func (*DebugInfo) XXX_DiscardUnknown 

func (m *DebugInfo) XXX_DiscardUnknown()

func (*DebugInfo) XXX_Marshal 

func (m *DebugInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DebugInfo) XXX_Merge 

func (m *DebugInfo) XXX_Merge(src proto.Message)

func (*DebugInfo) XXX_MessageName 

func (*DebugInfo) XXX_MessageName() string

func (*DebugInfo) XXX_Size 

func (m *DebugInfo) XXX_Size() int

func (*DebugInfo) XXX_Unmarshal 

func (m *DebugInfo) XXX_Unmarshal(b []byte) error

type Help 

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"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

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.

func NewPopulatedHelp 

func NewPopulatedHelp(r randyErrorDetails, easy bool) *Help

func (*Help) Compare 

func (this *Help) Compare(that interface{}) int

func (*Help) Descriptor 

func (*Help) Descriptor() ([]byte, []int)

func (*Help) Equal 

func (this *Help) Equal(that interface{}) bool
func (m *Help) GetLinks() []*Help_Link

func (*Help) GoString 

func (this *Help) GoString() string

func (*Help) Marshal 

func (m *Help) Marshal() (dAtA []byte, err error)

func (*Help) MarshalTo 

func (m *Help) MarshalTo(dAtA []byte) (int, error)

func (*Help) MarshalToSizedBuffer 

func (m *Help) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Help) ProtoMessage 

func (*Help) ProtoMessage()

func (*Help) Reset 

func (m *Help) Reset()

func (*Help) Size 

func (m *Help) Size() (n int)

func (*Help) String 

func (this *Help) String() string

func (*Help) Unmarshal 

func (m *Help) Unmarshal(dAtA []byte) error

func (*Help) XXX_DiscardUnknown 

func (m *Help) XXX_DiscardUnknown()

func (*Help) XXX_Marshal 

func (m *Help) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Help) XXX_Merge 

func (m *Help) XXX_Merge(src proto.Message)

func (*Help) XXX_MessageName 

func (*Help) XXX_MessageName() string

func (*Help) XXX_Size 

func (m *Help) XXX_Size() int

func (*Help) XXX_Unmarshal 

func (m *Help) XXX_Unmarshal(b []byte) error
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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Describes a URL link. 

func NewPopulatedHelp_Link(r randyErrorDetails, easy bool) *Help_Link

func (*Help_Link) Compare 

func (this *Help_Link) Compare(that interface{}) int

func (*Help_Link) Descriptor 

func (*Help_Link) Descriptor() ([]byte, []int)

func (*Help_Link) Equal 

func (this *Help_Link) Equal(that interface{}) bool

func (*Help_Link) GetDescription 

func (m *Help_Link) GetDescription() string

func (*Help_Link) GetUrl 

func (m *Help_Link) GetUrl() string

func (*Help_Link) GoString 

func (this *Help_Link) GoString() string

func (*Help_Link) Marshal 

func (m *Help_Link) Marshal() (dAtA []byte, err error)

func (*Help_Link) MarshalTo 

func (m *Help_Link) MarshalTo(dAtA []byte) (int, error)

func (*Help_Link) MarshalToSizedBuffer 

func (m *Help_Link) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Help_Link) ProtoMessage 

func (*Help_Link) ProtoMessage()

func (*Help_Link) Reset 

func (m *Help_Link) Reset()

func (*Help_Link) Size 

func (m *Help_Link) Size() (n int)

func (*Help_Link) String 

func (this *Help_Link) String() string

func (*Help_Link) Unmarshal 

func (m *Help_Link) Unmarshal(dAtA []byte) error

func (*Help_Link) XXX_DiscardUnknown 

func (m *Help_Link) XXX_DiscardUnknown()

func (*Help_Link) XXX_Marshal 

func (m *Help_Link) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Help_Link) XXX_Merge 

func (m *Help_Link) XXX_Merge(src proto.Message)

func (*Help_Link) XXX_MessageName 

func (*Help_Link) XXX_MessageName() string

func (*Help_Link) XXX_Size 

func (m *Help_Link) XXX_Size() int

func (*Help_Link) XXX_Unmarshal 

func (m *Help_Link) XXX_Unmarshal(b []byte) error

type LocalizedMessage 

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,proto3" json:"locale,omitempty"`
	// The localized error message in the above locale.
	Message              string   `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func NewPopulatedLocalizedMessage 

func NewPopulatedLocalizedMessage(r randyErrorDetails, easy bool) *LocalizedMessage

func (*LocalizedMessage) Compare 

func (this *LocalizedMessage) Compare(that interface{}) int

func (*LocalizedMessage) Descriptor 

func (*LocalizedMessage) Descriptor() ([]byte, []int)

func (*LocalizedMessage) Equal 

func (this *LocalizedMessage) Equal(that interface{}) bool

func (*LocalizedMessage) GetLocale 

func (m *LocalizedMessage) GetLocale() string

func (*LocalizedMessage) GetMessage 

func (m *LocalizedMessage) GetMessage() string

func (*LocalizedMessage) GoString 

func (this *LocalizedMessage) GoString() string

func (*LocalizedMessage) Marshal 

func (m *LocalizedMessage) Marshal() (dAtA []byte, err error)

func (*LocalizedMessage) MarshalTo 

func (m *LocalizedMessage) MarshalTo(dAtA []byte) (int, error)

func (*LocalizedMessage) MarshalToSizedBuffer 

func (m *LocalizedMessage) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*LocalizedMessage) ProtoMessage 

func (*LocalizedMessage) ProtoMessage()

func (*LocalizedMessage) Reset 

func (m *LocalizedMessage) Reset()

func (*LocalizedMessage) Size 

func (m *LocalizedMessage) Size() (n int)

func (*LocalizedMessage) String 

func (this *LocalizedMessage) String() string

func (*LocalizedMessage) Unmarshal 

func (m *LocalizedMessage) Unmarshal(dAtA []byte) error

func (*LocalizedMessage) XXX_DiscardUnknown 

func (m *LocalizedMessage) XXX_DiscardUnknown()

func (*LocalizedMessage) XXX_Marshal 

func (m *LocalizedMessage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*LocalizedMessage) XXX_Merge 

func (m *LocalizedMessage) XXX_Merge(src proto.Message)

func (*LocalizedMessage) XXX_MessageName 

func (*LocalizedMessage) XXX_MessageName() string

func (*LocalizedMessage) XXX_Size 

func (m *LocalizedMessage) XXX_Size() int

func (*LocalizedMessage) XXX_Unmarshal 

func (m *LocalizedMessage) XXX_Unmarshal(b []byte) error

type PreconditionFailure 

type PreconditionFailure struct {
	// Describes all precondition violations.
	Violations           []*PreconditionFailure_Violation `protobuf:"bytes,1,rep,name=violations,proto3" json:"violations,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                         `json:"-"`
	XXX_unrecognized     []byte                           `json:"-"`
	XXX_sizecache        int32                            `json:"-"`
}

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.

func NewPopulatedPreconditionFailure 

func NewPopulatedPreconditionFailure(r randyErrorDetails, easy bool) *PreconditionFailure

func (*PreconditionFailure) Compare 

func (this *PreconditionFailure) Compare(that interface{}) int

func (*PreconditionFailure) Descriptor 

func (*PreconditionFailure) Descriptor() ([]byte, []int)

func (*PreconditionFailure) Equal 

func (this *PreconditionFailure) Equal(that interface{}) bool

func (*PreconditionFailure) GetViolations 

func (m *PreconditionFailure) GetViolations() []*PreconditionFailure_Violation

func (*PreconditionFailure) GoString 

func (this *PreconditionFailure) GoString() string

func (*PreconditionFailure) Marshal 

func (m *PreconditionFailure) Marshal() (dAtA []byte, err error)

func (*PreconditionFailure) MarshalTo 

func (m *PreconditionFailure) MarshalTo(dAtA []byte) (int, error)

func (*PreconditionFailure) MarshalToSizedBuffer 

func (m *PreconditionFailure) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*PreconditionFailure) ProtoMessage 

func (*PreconditionFailure) ProtoMessage()

func (*PreconditionFailure) Reset 

func (m *PreconditionFailure) Reset()

func (*PreconditionFailure) Size 

func (m *PreconditionFailure) Size() (n int)

func (*PreconditionFailure) String 

func (this *PreconditionFailure) String() string

func (*PreconditionFailure) Unmarshal 

func (m *PreconditionFailure) Unmarshal(dAtA []byte) error

func (*PreconditionFailure) XXX_DiscardUnknown 

func (m *PreconditionFailure) XXX_DiscardUnknown()

func (*PreconditionFailure) XXX_Marshal 

func (m *PreconditionFailure) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PreconditionFailure) XXX_Merge 

func (m *PreconditionFailure) XXX_Merge(src proto.Message)

func (*PreconditionFailure) XXX_MessageName 

func (*PreconditionFailure) XXX_MessageName() string

func (*PreconditionFailure) XXX_Size 

func (m *PreconditionFailure) XXX_Size() int

func (*PreconditionFailure) XXX_Unmarshal 

func (m *PreconditionFailure) XXX_Unmarshal(b []byte) error

type PreconditionFailure_Violation 

type PreconditionFailure_Violation struct {
	// The type of PreconditionFailure. We recommend using a service-specific
	// enum type to define the supported precondition violation types. 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A message type used to describe a single precondition failure.

func NewPopulatedPreconditionFailure_Violation 

func NewPopulatedPreconditionFailure_Violation(r randyErrorDetails, easy bool) *PreconditionFailure_Violation

func (*PreconditionFailure_Violation) Compare 

func (this *PreconditionFailure_Violation) Compare(that interface{}) int

func (*PreconditionFailure_Violation) Descriptor 

func (*PreconditionFailure_Violation) Descriptor() ([]byte, []int)

func (*PreconditionFailure_Violation) Equal 

func (this *PreconditionFailure_Violation) Equal(that interface{}) bool

func (*PreconditionFailure_Violation) GetDescription 

func (m *PreconditionFailure_Violation) GetDescription() string

func (*PreconditionFailure_Violation) GetSubject 

func (m *PreconditionFailure_Violation) GetSubject() string

func (*PreconditionFailure_Violation) GetType 

func (m *PreconditionFailure_Violation) GetType() string

func (*PreconditionFailure_Violation) GoString 

func (this *PreconditionFailure_Violation) GoString() string

func (*PreconditionFailure_Violation) Marshal 

func (m *PreconditionFailure_Violation) Marshal() (dAtA []byte, err error)

func (*PreconditionFailure_Violation) MarshalTo 

func (m *PreconditionFailure_Violation) MarshalTo(dAtA []byte) (int, error)

func (*PreconditionFailure_Violation) MarshalToSizedBuffer 

func (m *PreconditionFailure_Violation) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*PreconditionFailure_Violation) ProtoMessage 

func (*PreconditionFailure_Violation) ProtoMessage()

func (*PreconditionFailure_Violation) Reset 

func (m *PreconditionFailure_Violation) Reset()

func (*PreconditionFailure_Violation) Size 

func (m *PreconditionFailure_Violation) Size() (n int)

func (*PreconditionFailure_Violation) String 

func (this *PreconditionFailure_Violation) String() string

func (*PreconditionFailure_Violation) Unmarshal 

func (m *PreconditionFailure_Violation) Unmarshal(dAtA []byte) error

func (*PreconditionFailure_Violation) XXX_DiscardUnknown 

func (m *PreconditionFailure_Violation) XXX_DiscardUnknown()

func (*PreconditionFailure_Violation) XXX_Marshal 

func (m *PreconditionFailure_Violation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PreconditionFailure_Violation) XXX_Merge 

func (m *PreconditionFailure_Violation) XXX_Merge(src proto.Message)

func (*PreconditionFailure_Violation) XXX_MessageName 

func (*PreconditionFailure_Violation) XXX_MessageName() string

func (*PreconditionFailure_Violation) XXX_Size 

func (m *PreconditionFailure_Violation) XXX_Size() int

func (*PreconditionFailure_Violation) XXX_Unmarshal 

func (m *PreconditionFailure_Violation) XXX_Unmarshal(b []byte) error

type QuotaFailure 

type QuotaFailure struct {
	// Describes all quota violations.
	Violations           []*QuotaFailure_Violation `protobuf:"bytes,1,rep,name=violations,proto3" json:"violations,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                  `json:"-"`
	XXX_unrecognized     []byte                    `json:"-"`
	XXX_sizecache        int32                     `json:"-"`
}

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.

func NewPopulatedQuotaFailure 

func NewPopulatedQuotaFailure(r randyErrorDetails, easy bool) *QuotaFailure

func (*QuotaFailure) Compare 

func (this *QuotaFailure) Compare(that interface{}) int

func (*QuotaFailure) Descriptor 

func (*QuotaFailure) Descriptor() ([]byte, []int)

func (*QuotaFailure) Equal 

func (this *QuotaFailure) Equal(that interface{}) bool

func (*QuotaFailure) GetViolations 

func (m *QuotaFailure) GetViolations() []*QuotaFailure_Violation

func (*QuotaFailure) GoString 

func (this *QuotaFailure) GoString() string

func (*QuotaFailure) Marshal 

func (m *QuotaFailure) Marshal() (dAtA []byte, err error)

func (*QuotaFailure) MarshalTo 

func (m *QuotaFailure) MarshalTo(dAtA []byte) (int, error)

func (*QuotaFailure) MarshalToSizedBuffer 

func (m *QuotaFailure) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QuotaFailure) ProtoMessage 

func (*QuotaFailure) ProtoMessage()

func (*QuotaFailure) Reset 

func (m *QuotaFailure) Reset()

func (*QuotaFailure) Size 

func (m *QuotaFailure) Size() (n int)

func (*QuotaFailure) String 

func (this *QuotaFailure) String() string

func (*QuotaFailure) Unmarshal 

func (m *QuotaFailure) Unmarshal(dAtA []byte) error

func (*QuotaFailure) XXX_DiscardUnknown 

func (m *QuotaFailure) XXX_DiscardUnknown()

func (*QuotaFailure) XXX_Marshal 

func (m *QuotaFailure) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QuotaFailure) XXX_Merge 

func (m *QuotaFailure) XXX_Merge(src proto.Message)

func (*QuotaFailure) XXX_MessageName 

func (*QuotaFailure) XXX_MessageName() string

func (*QuotaFailure) XXX_Size 

func (m *QuotaFailure) XXX_Size() int

func (*QuotaFailure) XXX_Unmarshal 

func (m *QuotaFailure) XXX_Unmarshal(b []byte) error

type QuotaFailure_Violation 

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.

func NewPopulatedQuotaFailure_Violation 

func NewPopulatedQuotaFailure_Violation(r randyErrorDetails, easy bool) *QuotaFailure_Violation

func (*QuotaFailure_Violation) Compare 

func (this *QuotaFailure_Violation) Compare(that interface{}) int

func (*QuotaFailure_Violation) Descriptor 

func (*QuotaFailure_Violation) Descriptor() ([]byte, []int)

func (*QuotaFailure_Violation) Equal 

func (this *QuotaFailure_Violation) Equal(that interface{}) bool

func (*QuotaFailure_Violation) GetDescription 

func (m *QuotaFailure_Violation) GetDescription() string

func (*QuotaFailure_Violation) GetSubject 

func (m *QuotaFailure_Violation) GetSubject() string

func (*QuotaFailure_Violation) GoString 

func (this *QuotaFailure_Violation) GoString() string

func (*QuotaFailure_Violation) Marshal 

func (m *QuotaFailure_Violation) Marshal() (dAtA []byte, err error)

func (*QuotaFailure_Violation) MarshalTo 

func (m *QuotaFailure_Violation) MarshalTo(dAtA []byte) (int, error)

func (*QuotaFailure_Violation) MarshalToSizedBuffer 

func (m *QuotaFailure_Violation) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QuotaFailure_Violation) ProtoMessage 

func (*QuotaFailure_Violation) ProtoMessage()

func (*QuotaFailure_Violation) Reset 

func (m *QuotaFailure_Violation) Reset()

func (*QuotaFailure_Violation) Size 

func (m *QuotaFailure_Violation) Size() (n int)

func (*QuotaFailure_Violation) String 

func (this *QuotaFailure_Violation) String() string

func (*QuotaFailure_Violation) Unmarshal 

func (m *QuotaFailure_Violation) Unmarshal(dAtA []byte) error

func (*QuotaFailure_Violation) XXX_DiscardUnknown 

func (m *QuotaFailure_Violation) XXX_DiscardUnknown()

func (*QuotaFailure_Violation) XXX_Marshal 

func (m *QuotaFailure_Violation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QuotaFailure_Violation) XXX_Merge 

func (m *QuotaFailure_Violation) XXX_Merge(src proto.Message)

func (*QuotaFailure_Violation) XXX_MessageName 

func (*QuotaFailure_Violation) XXX_MessageName() string

func (*QuotaFailure_Violation) XXX_Size 

func (m *QuotaFailure_Violation) XXX_Size() int

func (*QuotaFailure_Violation) XXX_Unmarshal 

func (m *QuotaFailure_Violation) XXX_Unmarshal(b []byte) error

type RequestInfo 

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func NewPopulatedRequestInfo 

func NewPopulatedRequestInfo(r randyErrorDetails, easy bool) *RequestInfo

func (*RequestInfo) Compare 

func (this *RequestInfo) Compare(that interface{}) int

func (*RequestInfo) Descriptor 

func (*RequestInfo) Descriptor() ([]byte, []int)

func (*RequestInfo) Equal 

func (this *RequestInfo) Equal(that interface{}) bool

func (*RequestInfo) GetRequestId 

func (m *RequestInfo) GetRequestId() string

func (*RequestInfo) GetServingData 

func (m *RequestInfo) GetServingData() string

func (*RequestInfo) GoString 

func (this *RequestInfo) GoString() string

func (*RequestInfo) Marshal 

func (m *RequestInfo) Marshal() (dAtA []byte, err error)

func (*RequestInfo) MarshalTo 

func (m *RequestInfo) MarshalTo(dAtA []byte) (int, error)

func (*RequestInfo) MarshalToSizedBuffer 

func (m *RequestInfo) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*RequestInfo) ProtoMessage 

func (*RequestInfo) ProtoMessage()

func (*RequestInfo) Reset 

func (m *RequestInfo) Reset()

func (*RequestInfo) Size 

func (m *RequestInfo) Size() (n int)

func (*RequestInfo) String 

func (this *RequestInfo) String() string

func (*RequestInfo) Unmarshal 

func (m *RequestInfo) Unmarshal(dAtA []byte) error

func (*RequestInfo) XXX_DiscardUnknown 

func (m *RequestInfo) XXX_DiscardUnknown()

func (*RequestInfo) XXX_Marshal 

func (m *RequestInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RequestInfo) XXX_Merge 

func (m *RequestInfo) XXX_Merge(src proto.Message)

func (*RequestInfo) XXX_MessageName 

func (*RequestInfo) XXX_MessageName() string

func (*RequestInfo) XXX_Size 

func (m *RequestInfo) XXX_Size() int

func (*RequestInfo) XXX_Unmarshal 

func (m *RequestInfo) XXX_Unmarshal(b []byte) error

type ResourceInfo 

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Describes the resource that is being accessed.

func NewPopulatedResourceInfo 

func NewPopulatedResourceInfo(r randyErrorDetails, easy bool) *ResourceInfo

func (*ResourceInfo) Compare 

func (this *ResourceInfo) Compare(that interface{}) int

func (*ResourceInfo) Descriptor 

func (*ResourceInfo) Descriptor() ([]byte, []int)

func (*ResourceInfo) Equal 

func (this *ResourceInfo) Equal(that interface{}) bool

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) GoString 

func (this *ResourceInfo) GoString() string

func (*ResourceInfo) Marshal 

func (m *ResourceInfo) Marshal() (dAtA []byte, err error)

func (*ResourceInfo) MarshalTo 

func (m *ResourceInfo) MarshalTo(dAtA []byte) (int, error)

func (*ResourceInfo) MarshalToSizedBuffer 

func (m *ResourceInfo) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ResourceInfo) ProtoMessage 

func (*ResourceInfo) ProtoMessage()

func (*ResourceInfo) Reset 

func (m *ResourceInfo) Reset()

func (*ResourceInfo) Size 

func (m *ResourceInfo) Size() (n int)

func (*ResourceInfo) String 

func (this *ResourceInfo) String() string

func (*ResourceInfo) Unmarshal 

func (m *ResourceInfo) Unmarshal(dAtA []byte) error

func (*ResourceInfo) XXX_DiscardUnknown 

func (m *ResourceInfo) XXX_DiscardUnknown()

func (*ResourceInfo) XXX_Marshal 

func (m *ResourceInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ResourceInfo) XXX_Merge 

func (m *ResourceInfo) XXX_Merge(src proto.Message)

func (*ResourceInfo) XXX_MessageName 

func (*ResourceInfo) XXX_MessageName() string

func (*ResourceInfo) XXX_Size 

func (m *ResourceInfo) XXX_Size() int

func (*ResourceInfo) XXX_Unmarshal 

func (m *ResourceInfo) XXX_Unmarshal(b []byte) error

type RetryInfo 

type RetryInfo struct {
	// Clients should wait at least this long between retrying the same request.
	RetryDelay           *types.Duration `protobuf:"bytes,1,opt,name=retry_delay,json=retryDelay,proto3" json:"retry_delay,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

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.

func NewPopulatedRetryInfo 

func NewPopulatedRetryInfo(r randyErrorDetails, easy bool) *RetryInfo

func (*RetryInfo) Compare 

func (this *RetryInfo) Compare(that interface{}) int

func (*RetryInfo) Descriptor 

func (*RetryInfo) Descriptor() ([]byte, []int)

func (*RetryInfo) Equal 

func (this *RetryInfo) Equal(that interface{}) bool

func (*RetryInfo) GetRetryDelay 

func (m *RetryInfo) GetRetryDelay() *types.Duration

func (*RetryInfo) GoString 

func (this *RetryInfo) GoString() string

func (*RetryInfo) Marshal 

func (m *RetryInfo) Marshal() (dAtA []byte, err error)

func (*RetryInfo) MarshalTo 

func (m *RetryInfo) MarshalTo(dAtA []byte) (int, error)

func (*RetryInfo) MarshalToSizedBuffer 

func (m *RetryInfo) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*RetryInfo) ProtoMessage 

func (*RetryInfo) ProtoMessage()

func (*RetryInfo) Reset 

func (m *RetryInfo) Reset()

func (*RetryInfo) Size 

func (m *RetryInfo) Size() (n int)

func (*RetryInfo) String 

func (this *RetryInfo) String() string

func (*RetryInfo) Unmarshal 

func (m *RetryInfo) Unmarshal(dAtA []byte) error

func (*RetryInfo) XXX_DiscardUnknown 

func (m *RetryInfo) XXX_DiscardUnknown()

func (*RetryInfo) XXX_Marshal 

func (m *RetryInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RetryInfo) XXX_Merge 

func (m *RetryInfo) XXX_Merge(src proto.Message)

func (*RetryInfo) XXX_MessageName 

func (*RetryInfo) XXX_MessageName() string

func (*RetryInfo) XXX_Size 

func (m *RetryInfo) XXX_Size() int

func (*RetryInfo) XXX_Unmarshal 

func (m *RetryInfo) XXX_Unmarshal(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.