Documentation ¶
Index ¶
- type BadRequest
- func (*BadRequest) Descriptor() ([]byte, []int)
- func (m *BadRequest) GetFieldViolations() []*BadRequest_FieldViolation
- func (*BadRequest) ProtoMessage()
- func (m *BadRequest) Reset()
- func (m *BadRequest) String() string
- func (m *BadRequest) XXX_DiscardUnknown()
- func (m *BadRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *BadRequest) XXX_Merge(src proto.Message)
- func (m *BadRequest) XXX_Size() int
- func (m *BadRequest) XXX_Unmarshal(b []byte) error
- type BadRequest_FieldViolation
- func (*BadRequest_FieldViolation) Descriptor() ([]byte, []int)
- func (m *BadRequest_FieldViolation) GetDescription() string
- func (m *BadRequest_FieldViolation) GetField() string
- func (*BadRequest_FieldViolation) ProtoMessage()
- func (m *BadRequest_FieldViolation) Reset()
- func (m *BadRequest_FieldViolation) String() string
- func (m *BadRequest_FieldViolation) XXX_DiscardUnknown()
- func (m *BadRequest_FieldViolation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *BadRequest_FieldViolation) XXX_Merge(src proto.Message)
- func (m *BadRequest_FieldViolation) XXX_Size() int
- func (m *BadRequest_FieldViolation) XXX_Unmarshal(b []byte) error
- type DebugInfo
- func (*DebugInfo) Descriptor() ([]byte, []int)
- func (m *DebugInfo) GetDetail() string
- func (m *DebugInfo) GetStackEntries() []string
- func (*DebugInfo) ProtoMessage()
- func (m *DebugInfo) Reset()
- func (m *DebugInfo) String() string
- func (m *DebugInfo) XXX_DiscardUnknown()
- func (m *DebugInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *DebugInfo) XXX_Merge(src proto.Message)
- func (m *DebugInfo) XXX_Size() int
- func (m *DebugInfo) XXX_Unmarshal(b []byte) error
- type ErrorInfo
- func (*ErrorInfo) Descriptor() ([]byte, []int)
- func (m *ErrorInfo) GetDomain() string
- func (m *ErrorInfo) GetMetadata() map[string]string
- func (m *ErrorInfo) GetReason() string
- func (*ErrorInfo) ProtoMessage()
- func (m *ErrorInfo) Reset()
- func (m *ErrorInfo) String() string
- func (m *ErrorInfo) XXX_DiscardUnknown()
- func (m *ErrorInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ErrorInfo) XXX_Merge(src proto.Message)
- func (m *ErrorInfo) XXX_Size() int
- func (m *ErrorInfo) XXX_Unmarshal(b []byte) error
- type Help
- func (*Help) Descriptor() ([]byte, []int)
- func (m *Help) GetLinks() []*Help_Link
- func (*Help) ProtoMessage()
- func (m *Help) Reset()
- func (m *Help) String() string
- func (m *Help) XXX_DiscardUnknown()
- func (m *Help) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Help) XXX_Merge(src proto.Message)
- func (m *Help) XXX_Size() int
- func (m *Help) XXX_Unmarshal(b []byte) error
- type Help_Link
- func (*Help_Link) Descriptor() ([]byte, []int)
- func (m *Help_Link) GetDescription() string
- func (m *Help_Link) GetUrl() string
- func (*Help_Link) ProtoMessage()
- func (m *Help_Link) Reset()
- func (m *Help_Link) String() string
- func (m *Help_Link) XXX_DiscardUnknown()
- func (m *Help_Link) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Help_Link) XXX_Merge(src proto.Message)
- func (m *Help_Link) XXX_Size() int
- func (m *Help_Link) XXX_Unmarshal(b []byte) error
- type LocalizedMessage
- func (*LocalizedMessage) Descriptor() ([]byte, []int)
- func (m *LocalizedMessage) GetLocale() string
- func (m *LocalizedMessage) GetMessage() string
- func (*LocalizedMessage) ProtoMessage()
- func (m *LocalizedMessage) Reset()
- func (m *LocalizedMessage) String() string
- func (m *LocalizedMessage) XXX_DiscardUnknown()
- func (m *LocalizedMessage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *LocalizedMessage) XXX_Merge(src proto.Message)
- func (m *LocalizedMessage) XXX_Size() int
- func (m *LocalizedMessage) XXX_Unmarshal(b []byte) error
- type PreconditionFailure
- func (*PreconditionFailure) Descriptor() ([]byte, []int)
- func (m *PreconditionFailure) GetViolations() []*PreconditionFailure_Violation
- func (*PreconditionFailure) ProtoMessage()
- func (m *PreconditionFailure) Reset()
- func (m *PreconditionFailure) String() string
- func (m *PreconditionFailure) XXX_DiscardUnknown()
- func (m *PreconditionFailure) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *PreconditionFailure) XXX_Merge(src proto.Message)
- func (m *PreconditionFailure) XXX_Size() int
- func (m *PreconditionFailure) XXX_Unmarshal(b []byte) error
- type PreconditionFailure_Violation
- func (*PreconditionFailure_Violation) Descriptor() ([]byte, []int)
- func (m *PreconditionFailure_Violation) GetDescription() string
- func (m *PreconditionFailure_Violation) GetSubject() string
- func (m *PreconditionFailure_Violation) GetType() string
- func (*PreconditionFailure_Violation) ProtoMessage()
- func (m *PreconditionFailure_Violation) Reset()
- func (m *PreconditionFailure_Violation) String() string
- func (m *PreconditionFailure_Violation) XXX_DiscardUnknown()
- func (m *PreconditionFailure_Violation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *PreconditionFailure_Violation) XXX_Merge(src proto.Message)
- func (m *PreconditionFailure_Violation) XXX_Size() int
- func (m *PreconditionFailure_Violation) XXX_Unmarshal(b []byte) error
- type QuotaFailure
- func (*QuotaFailure) Descriptor() ([]byte, []int)
- func (m *QuotaFailure) GetViolations() []*QuotaFailure_Violation
- func (*QuotaFailure) ProtoMessage()
- func (m *QuotaFailure) Reset()
- func (m *QuotaFailure) String() string
- func (m *QuotaFailure) XXX_DiscardUnknown()
- func (m *QuotaFailure) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *QuotaFailure) XXX_Merge(src proto.Message)
- func (m *QuotaFailure) XXX_Size() int
- func (m *QuotaFailure) XXX_Unmarshal(b []byte) error
- type QuotaFailure_Violation
- func (*QuotaFailure_Violation) Descriptor() ([]byte, []int)
- func (m *QuotaFailure_Violation) GetDescription() string
- func (m *QuotaFailure_Violation) GetSubject() string
- func (*QuotaFailure_Violation) ProtoMessage()
- func (m *QuotaFailure_Violation) Reset()
- func (m *QuotaFailure_Violation) String() string
- func (m *QuotaFailure_Violation) XXX_DiscardUnknown()
- func (m *QuotaFailure_Violation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *QuotaFailure_Violation) XXX_Merge(src proto.Message)
- func (m *QuotaFailure_Violation) XXX_Size() int
- func (m *QuotaFailure_Violation) XXX_Unmarshal(b []byte) error
- type RequestInfo
- func (*RequestInfo) Descriptor() ([]byte, []int)
- func (m *RequestInfo) GetRequestId() string
- func (m *RequestInfo) GetServingData() string
- func (*RequestInfo) ProtoMessage()
- func (m *RequestInfo) Reset()
- func (m *RequestInfo) String() string
- func (m *RequestInfo) XXX_DiscardUnknown()
- func (m *RequestInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RequestInfo) XXX_Merge(src proto.Message)
- func (m *RequestInfo) XXX_Size() int
- func (m *RequestInfo) XXX_Unmarshal(b []byte) error
- type ResourceInfo
- func (*ResourceInfo) Descriptor() ([]byte, []int)
- func (m *ResourceInfo) GetDescription() string
- func (m *ResourceInfo) GetOwner() string
- func (m *ResourceInfo) GetResourceName() string
- func (m *ResourceInfo) GetResourceType() string
- func (*ResourceInfo) ProtoMessage()
- func (m *ResourceInfo) Reset()
- func (m *ResourceInfo) String() string
- func (m *ResourceInfo) XXX_DiscardUnknown()
- func (m *ResourceInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ResourceInfo) XXX_Merge(src proto.Message)
- func (m *ResourceInfo) XXX_Size() int
- func (m *ResourceInfo) XXX_Unmarshal(b []byte) error
- type RetryInfo
- func (*RetryInfo) Descriptor() ([]byte, []int)
- func (m *RetryInfo) GetRetryDelay() *duration.Duration
- func (*RetryInfo) ProtoMessage()
- func (m *RetryInfo) Reset()
- func (m *RetryInfo) String() string
- func (m *RetryInfo) XXX_DiscardUnknown()
- func (m *RetryInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RetryInfo) XXX_Merge(src proto.Message)
- func (m *RetryInfo) XXX_Size() int
- func (m *RetryInfo) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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 (*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
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_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 (*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
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_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 (*DebugInfo) Descriptor ¶
func (*DebugInfo) GetStackEntries ¶
func (*DebugInfo) ProtoMessage ¶
func (*DebugInfo) ProtoMessage()
func (*DebugInfo) XXX_DiscardUnknown ¶
func (m *DebugInfo) XXX_DiscardUnknown()
func (*DebugInfo) XXX_Marshal ¶
func (*DebugInfo) XXX_Unmarshal ¶
type ErrorInfo ¶
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-Z0-9_]+/. Reason string `protobuf:"bytes,1,opt,name=reason,proto3" json:"reason,omitempty"` // The logical grouping to which the "reason" belongs. Often "domain" will // contain the registered service name of the tool or product that is the // source of the error. Example: "pubsub.googleapis.com". If the error is // common across many APIs, the first segment of the example above will be // omitted. The value will be, "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 `` /* 157-byte string literal not displayed */ XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
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" } }
func (*ErrorInfo) Descriptor ¶
func (*ErrorInfo) GetMetadata ¶
func (*ErrorInfo) ProtoMessage ¶
func (*ErrorInfo) ProtoMessage()
func (*ErrorInfo) XXX_DiscardUnknown ¶
func (m *ErrorInfo) XXX_DiscardUnknown()
func (*ErrorInfo) XXX_Marshal ¶
func (*ErrorInfo) XXX_Unmarshal ¶
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 (*Help) Descriptor ¶
func (*Help) ProtoMessage ¶
func (*Help) ProtoMessage()
func (*Help) XXX_DiscardUnknown ¶
func (m *Help) XXX_DiscardUnknown()
func (*Help) XXX_Unmarshal ¶
type Help_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"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Describes a URL link.
func (*Help_Link) Descriptor ¶
func (*Help_Link) GetDescription ¶
func (*Help_Link) ProtoMessage ¶
func (*Help_Link) ProtoMessage()
func (*Help_Link) XXX_DiscardUnknown ¶
func (m *Help_Link) XXX_DiscardUnknown()
func (*Help_Link) XXX_Marshal ¶
func (*Help_Link) XXX_Unmarshal ¶
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 (*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
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_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 (*PreconditionFailure) Descriptor ¶
func (*PreconditionFailure) Descriptor() ([]byte, []int)
func (*PreconditionFailure) GetViolations ¶
func (m *PreconditionFailure) GetViolations() []*PreconditionFailure_Violation
func (*PreconditionFailure) ProtoMessage ¶
func (*PreconditionFailure) ProtoMessage()
func (*PreconditionFailure) Reset ¶
func (m *PreconditionFailure) Reset()
func (*PreconditionFailure) String ¶
func (m *PreconditionFailure) String() string
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_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 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"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
A message type used to describe a single precondition failure.
func (*PreconditionFailure_Violation) Descriptor ¶
func (*PreconditionFailure_Violation) Descriptor() ([]byte, []int)
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) ProtoMessage ¶
func (*PreconditionFailure_Violation) ProtoMessage()
func (*PreconditionFailure_Violation) Reset ¶
func (m *PreconditionFailure_Violation) Reset()
func (*PreconditionFailure_Violation) String ¶
func (m *PreconditionFailure_Violation) String() string
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_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 RetryInfo and Help types for other details about handling a quota failure.
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
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_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 (*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
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_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 (*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
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_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 (*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
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_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 *duration.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 retries have been reached or a maximum retry delay cap has been reached.
func (*RetryInfo) Descriptor ¶
func (*RetryInfo) GetRetryDelay ¶
func (*RetryInfo) ProtoMessage ¶
func (*RetryInfo) ProtoMessage()
func (*RetryInfo) XXX_DiscardUnknown ¶
func (m *RetryInfo) XXX_DiscardUnknown()