rpc

package
Version: v1.4.1 Latest Latest
Warning

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

Go to latest
Published: Mar 10, 2021 License: Apache-2.0 Imports: 11 Imported by: 368

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")
)
View Source
var (
	ErrInvalidLengthStatus        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowStatus          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupStatus = fmt.Errorf("proto: unexpected end of group")
)
View Source
var Code_name = map[int32]string{
	0:  "OK",
	1:  "CANCELLED",
	2:  "UNKNOWN",
	3:  "INVALID_ARGUMENT",
	4:  "DEADLINE_EXCEEDED",
	5:  "NOT_FOUND",
	6:  "ALREADY_EXISTS",
	7:  "PERMISSION_DENIED",
	16: "UNAUTHENTICATED",
	8:  "RESOURCE_EXHAUSTED",
	9:  "FAILED_PRECONDITION",
	10: "ABORTED",
	11: "OUT_OF_RANGE",
	12: "UNIMPLEMENTED",
	13: "INTERNAL",
	14: "UNAVAILABLE",
	15: "DATA_LOSS",
}
View Source
var Code_value = map[string]int32{
	"OK":                  0,
	"CANCELLED":           1,
	"UNKNOWN":             2,
	"INVALID_ARGUMENT":    3,
	"DEADLINE_EXCEEDED":   4,
	"NOT_FOUND":           5,
	"ALREADY_EXISTS":      6,
	"PERMISSION_DENIED":   7,
	"UNAUTHENTICATED":     16,
	"RESOURCE_EXHAUSTED":  8,
	"FAILED_PRECONDITION": 9,
	"ABORTED":             10,
	"OUT_OF_RANGE":        11,
	"UNIMPLEMENTED":       12,
	"INTERNAL":            13,
	"UNAVAILABLE":         14,
	"DATA_LOSS":           15,
}

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 added in v1.3.0

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 added in v1.3.0

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 Code

type Code int32

The canonical error codes for gRPC APIs.

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

const (
	// Not an error; returned on success
	//
	// HTTP Mapping: 200 OK
	OK Code = 0
	// The operation was cancelled, typically by the caller.
	//
	// HTTP Mapping: 499 Client Closed Request
	CANCELLED Code = 1
	// Unknown error.  For example, this error may be returned when
	// a `Status` value received from another address space belongs to
	// an error space that is not known in this address space.  Also
	// errors raised by APIs that do not return enough error information
	// may be converted to this error.
	//
	// HTTP Mapping: 500 Internal Server Error
	UNKNOWN Code = 2
	// The client specified an invalid argument.  Note that this differs
	// from `FAILED_PRECONDITION`.  `INVALID_ARGUMENT` indicates arguments
	// that are problematic regardless of the state of the system
	// (e.g., a malformed file name).
	//
	// HTTP Mapping: 400 Bad Request
	INVALID_ARGUMENT Code = 3
	// The deadline expired before the operation could complete. For operations
	// that change the state of the system, this error may be returned
	// even if the operation has completed successfully.  For example, a
	// successful response from a server could have been delayed long
	// enough for the deadline to expire.
	//
	// HTTP Mapping: 504 Gateway Timeout
	DEADLINE_EXCEEDED Code = 4
	// Some requested entity (e.g., file or directory) was not found.
	//
	// Note to server developers: if a request is denied for an entire class
	// of users, such as gradual feature rollout or undocumented whitelist,
	// `NOT_FOUND` may be used. If a request is denied for some users within
	// a class of users, such as user-based access control, `PERMISSION_DENIED`
	// must be used.
	//
	// HTTP Mapping: 404 Not Found
	NOT_FOUND Code = 5
	// The entity that a client attempted to create (e.g., file or directory)
	// already exists.
	//
	// HTTP Mapping: 409 Conflict
	ALREADY_EXISTS Code = 6
	// The caller does not have permission to execute the specified
	// operation. `PERMISSION_DENIED` must not be used for rejections
	// caused by exhausting some resource (use `RESOURCE_EXHAUSTED`
	// instead for those errors). `PERMISSION_DENIED` must not be
	// used if the caller can not be identified (use `UNAUTHENTICATED`
	// instead for those errors). This error code does not imply the
	// request is valid or the requested entity exists or satisfies
	// other pre-conditions.
	//
	// HTTP Mapping: 403 Forbidden
	PERMISSION_DENIED Code = 7
	// The request does not have valid authentication credentials for the
	// operation.
	//
	// HTTP Mapping: 401 Unauthorized
	UNAUTHENTICATED Code = 16
	// Some resource has been exhausted, perhaps a per-user quota, or
	// perhaps the entire file system is out of space.
	//
	// HTTP Mapping: 429 Too Many Requests
	RESOURCE_EXHAUSTED Code = 8
	// The operation was rejected because the system is not in a state
	// required for the operation's execution.  For example, the directory
	// to be deleted is non-empty, an rmdir operation is applied to
	// a non-directory, etc.
	//
	// Service implementors can use the following guidelines to decide
	// between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:
	//  (a) Use `UNAVAILABLE` if the client can retry just the failing call.
	//  (b) Use `ABORTED` if the client should retry at a higher level
	//      (e.g., when a client-specified test-and-set fails, indicating the
	//      client should restart a read-modify-write sequence).
	//  (c) Use `FAILED_PRECONDITION` if the client should not retry until
	//      the system state has been explicitly fixed.  E.g., if an "rmdir"
	//      fails because the directory is non-empty, `FAILED_PRECONDITION`
	//      should be returned since the client should not retry unless
	//      the files are deleted from the directory.
	//
	// HTTP Mapping: 400 Bad Request
	FAILED_PRECONDITION Code = 9
	// The operation was aborted, typically due to a concurrency issue such as
	// a sequencer check failure or transaction abort.
	//
	// See the guidelines above for deciding between `FAILED_PRECONDITION`,
	// `ABORTED`, and `UNAVAILABLE`.
	//
	// HTTP Mapping: 409 Conflict
	ABORTED Code = 10
	// The operation was attempted past the valid range.  E.g., seeking or
	// reading past end-of-file.
	//
	// Unlike `INVALID_ARGUMENT`, this error indicates a problem that may
	// be fixed if the system state changes. For example, a 32-bit file
	// system will generate `INVALID_ARGUMENT` if asked to read at an
	// offset that is not in the range [0,2^32-1], but it will generate
	// `OUT_OF_RANGE` if asked to read from an offset past the current
	// file size.
	//
	// There is a fair bit of overlap between `FAILED_PRECONDITION` and
	// `OUT_OF_RANGE`.  We recommend using `OUT_OF_RANGE` (the more specific
	// error) when it applies so that callers who are iterating through
	// a space can easily look for an `OUT_OF_RANGE` error to detect when
	// they are done.
	//
	// HTTP Mapping: 400 Bad Request
	OUT_OF_RANGE Code = 11
	// The operation is not implemented or is not supported/enabled in this
	// service.
	//
	// HTTP Mapping: 501 Not Implemented
	UNIMPLEMENTED Code = 12
	// Internal errors.  This means that some invariants expected by the
	// underlying system have been broken.  This error code is reserved
	// for serious errors.
	//
	// HTTP Mapping: 500 Internal Server Error
	INTERNAL Code = 13
	// The service is currently unavailable.  This is most likely a
	// transient condition, which can be corrected by retrying with
	// a backoff. Note that it is not always safe to retry
	// non-idempotent operations.
	//
	// See the guidelines above for deciding between `FAILED_PRECONDITION`,
	// `ABORTED`, and `UNAVAILABLE`.
	//
	// HTTP Mapping: 503 Service Unavailable
	UNAVAILABLE Code = 14
	// Unrecoverable data loss or corruption.
	//
	// HTTP Mapping: 500 Internal Server Error
	DATA_LOSS Code = 15
)

func (Code) EnumDescriptor

func (Code) EnumDescriptor() ([]byte, []int)

func (Code) String

func (x Code) String() string

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 added in v1.3.0

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 ErrorInfo added in v1.3.3

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. 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 `` /* 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 NewPopulatedErrorInfo added in v1.3.3

func NewPopulatedErrorInfo(r randyErrorDetails, easy bool) *ErrorInfo

func (*ErrorInfo) Compare added in v1.3.3

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

func (*ErrorInfo) Descriptor added in v1.3.3

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

func (*ErrorInfo) Equal added in v1.3.3

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

func (*ErrorInfo) GetDomain added in v1.3.3

func (m *ErrorInfo) GetDomain() string

func (*ErrorInfo) GetMetadata added in v1.3.3

func (m *ErrorInfo) GetMetadata() map[string]string

func (*ErrorInfo) GetReason added in v1.4.0

func (m *ErrorInfo) GetReason() string

func (*ErrorInfo) GoString added in v1.3.3

func (this *ErrorInfo) GoString() string

func (*ErrorInfo) Marshal added in v1.3.3

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

func (*ErrorInfo) MarshalTo added in v1.3.3

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

func (*ErrorInfo) MarshalToSizedBuffer added in v1.3.3

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

func (*ErrorInfo) ProtoMessage added in v1.3.3

func (*ErrorInfo) ProtoMessage()

func (*ErrorInfo) Reset added in v1.3.3

func (m *ErrorInfo) Reset()

func (*ErrorInfo) Size added in v1.3.3

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

func (*ErrorInfo) String added in v1.3.3

func (this *ErrorInfo) String() string

func (*ErrorInfo) Unmarshal added in v1.3.3

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

func (*ErrorInfo) XXX_DiscardUnknown added in v1.3.3

func (m *ErrorInfo) XXX_DiscardUnknown()

func (*ErrorInfo) XXX_Marshal added in v1.3.3

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

func (*ErrorInfo) XXX_Merge added in v1.3.3

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

func (*ErrorInfo) XXX_MessageName added in v1.3.3

func (*ErrorInfo) XXX_MessageName() string

func (*ErrorInfo) XXX_Size added in v1.3.3

func (m *ErrorInfo) XXX_Size() int

func (*ErrorInfo) XXX_Unmarshal added in v1.3.3

func (m *ErrorInfo) 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 added in v1.3.0

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 added in v1.3.0

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 added in v1.3.0

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 added in v1.3.0

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 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 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 (*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 added in v1.3.0

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 RetryInfo 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 added in v1.3.0

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 added in v1.3.0

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 added in v1.3.0

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 added in v1.3.0

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 retries 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 added in v1.3.0

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

type Status

type Status struct {
	// The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
	Code int32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	// A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	// [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// A list of messages that carry the error details.  There is a common set of
	// message types for APIs to use.
	Details              []*types.Any `protobuf:"bytes,3,rep,name=details,proto3" json:"details,omitempty"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

func NewPopulatedStatus

func NewPopulatedStatus(r randyStatus, easy bool) *Status

func (*Status) Compare

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

func (*Status) Descriptor

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

func (*Status) Equal

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

func (*Status) GetCode

func (m *Status) GetCode() int32

func (*Status) GetDetails

func (m *Status) GetDetails() []*types.Any

func (*Status) GetMessage

func (m *Status) GetMessage() string

func (*Status) GoString

func (this *Status) GoString() string

func (*Status) Marshal

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

func (*Status) MarshalTo

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

func (*Status) MarshalToSizedBuffer added in v1.3.0

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

func (*Status) ProtoMessage

func (*Status) ProtoMessage()

func (*Status) Reset

func (m *Status) Reset()

func (*Status) Size

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

func (*Status) String

func (this *Status) String() string

func (*Status) Unmarshal

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

func (*Status) XXX_DiscardUnknown

func (m *Status) XXX_DiscardUnknown()

func (*Status) XXX_Marshal

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

func (*Status) XXX_Merge

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

func (*Status) XXX_MessageName

func (*Status) XXX_MessageName() string

func (*Status) XXX_Size

func (m *Status) XXX_Size() int

func (*Status) XXX_Unmarshal

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL