rpc

package
v0.0.3 Latest Latest
Warning

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

 Go to latest Published: Oct 22, 2024 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

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",
	}
	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,
	}
)

Enum value maps for Code.

View Source 
var File_google_rpc_code_proto protoreflect.FileDescriptor
View Source 
var File_google_rpc_error_details_proto protoreflect.FileDescriptor
View Source 
var File_google_rpc_status_proto protoreflect.FileDescriptor

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"`
	// contains filtered or unexported fields
}

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

func (*BadRequest) CloneMessageVT 

func (m *BadRequest) CloneMessageVT() proto.Message

func (*BadRequest) CloneVT 

func (m *BadRequest) CloneVT() *BadRequest

func (*BadRequest) Descriptor deprecated 

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

Deprecated: Use BadRequest.ProtoReflect.Descriptor instead.

func (*BadRequest) EqualMessageVT 

func (this *BadRequest) EqualMessageVT(thatMsg proto.Message) bool

func (*BadRequest) EqualVT 

func (this *BadRequest) EqualVT(that *BadRequest) bool

func (*BadRequest) GetFieldViolations 

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

func (*BadRequest) MarshalToSizedBufferVT 

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

func (*BadRequest) MarshalToVT 

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

func (*BadRequest) MarshalVT 

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

func (*BadRequest) ProtoMessage 

func (*BadRequest) ProtoMessage()

func (*BadRequest) ProtoReflect 

func (x *BadRequest) ProtoReflect() protoreflect.Message

func (*BadRequest) Reset 

func (x *BadRequest) Reset()

func (*BadRequest) SizeVT 

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

func (*BadRequest) String 

func (x *BadRequest) String() string

func (*BadRequest) UnmarshalVT 

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

func (*BadRequest) Validate 

func (m *BadRequest) Validate() error

Validate checks the field values on BadRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*BadRequest) ValidateAll 

func (m *BadRequest) ValidateAll() error

ValidateAll checks the field values on BadRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in BadRequestMultiError, or nil if none found.

type BadRequestMultiError 

type BadRequestMultiError []error

BadRequestMultiError is an error wrapping multiple validation errors returned by BadRequest.ValidateAll() if the designated constraints aren't met.

func (BadRequestMultiError) AllErrors 

func (m BadRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (BadRequestMultiError) Error 

func (m BadRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type BadRequestValidationError 

type BadRequestValidationError struct {
	// contains filtered or unexported fields
}

BadRequestValidationError is the validation error returned by BadRequest.Validate if the designated constraints aren't met.

func (BadRequestValidationError) Cause 

func (e BadRequestValidationError) Cause() error

Cause function returns cause value.

func (BadRequestValidationError) Error 

func (e BadRequestValidationError) Error() string

Error satisfies the builtin error interface

func (BadRequestValidationError) ErrorName 

func (e BadRequestValidationError) ErrorName() string

ErrorName returns error name.

func (BadRequestValidationError) Field 

func (e BadRequestValidationError) Field() string

Field function returns field value.

func (BadRequestValidationError) Key 

func (e BadRequestValidationError) Key() bool

Key function returns key value.

func (BadRequestValidationError) Reason 

func (e BadRequestValidationError) Reason() string

Reason function returns reason value.

type BadRequest_FieldViolation 

type BadRequest_FieldViolation struct {

	// A path that leads to a field in the request body. The value will be a
	// sequence of dot-separated identifiers that identify a protocol buffer
	// field.
	//
	// Consider the following:
	//
	//	message CreateContactRequest {
	//	  message EmailAddress {
	//	    enum Type {
	//	      TYPE_UNSPECIFIED = 0;
	//	      HOME = 1;
	//	      WORK = 2;
	//	    }
	//
	//	    optional string email = 1;
	//	    repeated EmailType type = 2;
	//	  }
	//
	//	  string full_name = 1;
	//	  repeated EmailAddress email_addresses = 2;
	//	}
	//
	// In this example, in proto `field` could take one of the following values:
	//
	//   - `full_name` for a violation in the `full_name` value
	//   - `email_addresses[1].email` for a violation in the `email` field of the
	//     first `email_addresses` message
	//   - `email_addresses[3].type[2]` for a violation in the second `type`
	//     value in the third `email_addresses` message.
	//
	// In JSON, the same values are represented as:
	//
	//   - `fullName` for a violation in the `fullName` value
	//   - `emailAddresses[1].email` for a violation in the `email` field of the
	//     first `emailAddresses` message
	//   - `emailAddresses[3].type[2]` for a violation in the second `type`
	//     value in the third `emailAddresses` message.
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// A description of why the request element is bad.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

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

func (*BadRequest_FieldViolation) CloneMessageVT 

func (m *BadRequest_FieldViolation) CloneMessageVT() proto.Message

func (*BadRequest_FieldViolation) CloneVT 

func (m *BadRequest_FieldViolation) CloneVT() *BadRequest_FieldViolation

func (*BadRequest_FieldViolation) Descriptor deprecated 

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

Deprecated: Use BadRequest_FieldViolation.ProtoReflect.Descriptor instead.

func (*BadRequest_FieldViolation) EqualMessageVT 

func (this *BadRequest_FieldViolation) EqualMessageVT(thatMsg proto.Message) bool

func (*BadRequest_FieldViolation) EqualVT 

func (this *BadRequest_FieldViolation) EqualVT(that *BadRequest_FieldViolation) bool

func (*BadRequest_FieldViolation) GetDescription 

func (x *BadRequest_FieldViolation) GetDescription() string

func (*BadRequest_FieldViolation) GetField 

func (x *BadRequest_FieldViolation) GetField() string

func (*BadRequest_FieldViolation) MarshalToSizedBufferVT 

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

func (*BadRequest_FieldViolation) MarshalToVT 

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

func (*BadRequest_FieldViolation) MarshalVT 

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

func (*BadRequest_FieldViolation) ProtoMessage 

func (*BadRequest_FieldViolation) ProtoMessage()

func (*BadRequest_FieldViolation) ProtoReflect 

func (x *BadRequest_FieldViolation) ProtoReflect() protoreflect.Message

func (*BadRequest_FieldViolation) Reset 

func (x *BadRequest_FieldViolation) Reset()

func (*BadRequest_FieldViolation) SizeVT 

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

func (*BadRequest_FieldViolation) String 

func (x *BadRequest_FieldViolation) String() string

func (*BadRequest_FieldViolation) UnmarshalVT 

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

func (*BadRequest_FieldViolation) Validate 

func (m *BadRequest_FieldViolation) Validate() error

Validate checks the field values on BadRequest_FieldViolation with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*BadRequest_FieldViolation) ValidateAll 

func (m *BadRequest_FieldViolation) ValidateAll() error

ValidateAll checks the field values on BadRequest_FieldViolation with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in BadRequest_FieldViolationMultiError, or nil if none found.

type BadRequest_FieldViolationMultiError 

type BadRequest_FieldViolationMultiError []error

BadRequest_FieldViolationMultiError is an error wrapping multiple validation errors returned by BadRequest_FieldViolation.ValidateAll() if the designated constraints aren't met.

func (BadRequest_FieldViolationMultiError) AllErrors 

func (m BadRequest_FieldViolationMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (BadRequest_FieldViolationMultiError) Error 

func (m BadRequest_FieldViolationMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type BadRequest_FieldViolationValidationError 

type BadRequest_FieldViolationValidationError struct {
	// contains filtered or unexported fields
}

BadRequest_FieldViolationValidationError is the validation error returned by BadRequest_FieldViolation.Validate if the designated constraints aren't met.

func (BadRequest_FieldViolationValidationError) Cause 

func (e BadRequest_FieldViolationValidationError) Cause() error

Cause function returns cause value.

func (BadRequest_FieldViolationValidationError) Error 

func (e BadRequest_FieldViolationValidationError) Error() string

Error satisfies the builtin error interface

func (BadRequest_FieldViolationValidationError) ErrorName 

func (e BadRequest_FieldViolationValidationError) ErrorName() string

ErrorName returns error name.

func (BadRequest_FieldViolationValidationError) Field 

func (e BadRequest_FieldViolationValidationError) Field() string

Field function returns field value.

func (BadRequest_FieldViolationValidationError) Key 

func (e BadRequest_FieldViolationValidationError) Key() bool

Key function returns key value.

func (BadRequest_FieldViolationValidationError) Reason 

func (e BadRequest_FieldViolationValidationError) Reason() string

Reason function returns reason value.

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
	Code_OK Code = 0
	// The operation was cancelled, typically by the caller.
	//
	// HTTP Mapping: 499 Client Closed Request
	Code_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
	Code_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
	Code_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
	Code_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 allowlist,
	// `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
	Code_NOT_FOUND Code = 5
	// The entity that a client attempted to create (e.g., file or directory)
	// already exists.
	//
	// HTTP Mapping: 409 Conflict
	Code_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
	Code_PERMISSION_DENIED Code = 7
	// The request does not have valid authentication credentials for the
	// operation.
	//
	// HTTP Mapping: 401 Unauthorized
	Code_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
	Code_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. For
	//	    example, 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. For example, 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
	Code_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
	Code_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
	Code_OUT_OF_RANGE Code = 11
	// The operation is not implemented or is not supported/enabled in this
	// service.
	//
	// HTTP Mapping: 501 Not Implemented
	Code_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
	Code_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
	Code_UNAVAILABLE Code = 14
	// Unrecoverable data loss or corruption.
	//
	// HTTP Mapping: 500 Internal Server Error
	Code_DATA_LOSS Code = 15
)

func (Code) Descriptor 

func (Code) Descriptor() protoreflect.EnumDescriptor

func (Code) Enum 

func (x Code) Enum() *Code

func (Code) EnumDescriptor deprecated 

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

Deprecated: Use Code.Descriptor instead.

func (Code) Number 

func (x Code) Number() protoreflect.EnumNumber

func (Code) String 

func (x Code) String() string

func (Code) Type 

func (Code) Type() protoreflect.EnumType

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"`
	// contains filtered or unexported fields
}

Describes additional debugging info.

func (*DebugInfo) CloneMessageVT 

func (m *DebugInfo) CloneMessageVT() proto.Message

func (*DebugInfo) CloneVT 

func (m *DebugInfo) CloneVT() *DebugInfo

func (*DebugInfo) Descriptor deprecated 

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

Deprecated: Use DebugInfo.ProtoReflect.Descriptor instead.

func (*DebugInfo) EqualMessageVT 

func (this *DebugInfo) EqualMessageVT(thatMsg proto.Message) bool

func (*DebugInfo) EqualVT 

func (this *DebugInfo) EqualVT(that *DebugInfo) bool

func (*DebugInfo) GetDetail 

func (x *DebugInfo) GetDetail() string

func (*DebugInfo) GetStackEntries 

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

func (*DebugInfo) MarshalToSizedBufferVT 

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

func (*DebugInfo) MarshalToVT 

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

func (*DebugInfo) MarshalVT 

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

func (*DebugInfo) ProtoMessage 

func (*DebugInfo) ProtoMessage()

func (*DebugInfo) ProtoReflect 

func (x *DebugInfo) ProtoReflect() protoreflect.Message

func (*DebugInfo) Reset 

func (x *DebugInfo) Reset()

func (*DebugInfo) SizeVT 

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

func (*DebugInfo) String 

func (x *DebugInfo) String() string

func (*DebugInfo) UnmarshalVT 

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

func (*DebugInfo) Validate 

func (m *DebugInfo) Validate() error

Validate checks the field values on DebugInfo with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*DebugInfo) ValidateAll 

func (m *DebugInfo) ValidateAll() error

ValidateAll checks the field values on DebugInfo with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DebugInfoMultiError, or nil if none found.

type DebugInfoMultiError 

type DebugInfoMultiError []error

DebugInfoMultiError is an error wrapping multiple validation errors returned by DebugInfo.ValidateAll() if the designated constraints aren't met.

func (DebugInfoMultiError) AllErrors 

func (m DebugInfoMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DebugInfoMultiError) Error 

func (m DebugInfoMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type DebugInfoValidationError 

type DebugInfoValidationError struct {
	// contains filtered or unexported fields
}

DebugInfoValidationError is the validation error returned by DebugInfo.Validate if the designated constraints aren't met.

func (DebugInfoValidationError) Cause 

func (e DebugInfoValidationError) Cause() error

Cause function returns cause value.

func (DebugInfoValidationError) Error 

func (e DebugInfoValidationError) Error() string

Error satisfies the builtin error interface

func (DebugInfoValidationError) ErrorName 

func (e DebugInfoValidationError) ErrorName() string

ErrorName returns error name.

func (DebugInfoValidationError) Field 

func (e DebugInfoValidationError) Field() string

Field function returns field value.

func (DebugInfoValidationError) Key 

func (e DebugInfoValidationError) Key() bool

Key function returns key value.

func (DebugInfoValidationError) Reason 

func (e DebugInfoValidationError) Reason() string

Reason function returns reason value.

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
	// regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents
	// UPPER_SNAKE_CASE.
	Reason string `protobuf:"bytes,1,opt,name=reason,proto3" json:"reason,omitempty"`
	// The logical grouping to which the "reason" belongs. The error domain
	// is typically the registered service name of the tool or product that
	// generates the error. Example: "pubsub.googleapis.com". If the error is
	// generated by some common infrastructure, the error domain must be a
	// globally unique value that identifies the infrastructure. For Google API
	// infrastructure, the error domain is "googleapis.com".
	Domain string `protobuf:"bytes,2,opt,name=domain,proto3" json:"domain,omitempty"`
	// Additional structured details about this error.
	//
	// Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in
	// length. When identifying the current value of an exceeded limit, the units
	// should be contained in the key, not the value.  For example, rather than
	// {"instanceLimit": "100/request"}, should be returned as,
	// {"instanceLimitPerRequest": "100"}, if the client exceeds the number of
	// instances that can be created in a single (batch) request.
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (m *ErrorInfo) CloneMessageVT() proto.Message

func (*ErrorInfo) CloneVT 

func (m *ErrorInfo) CloneVT() *ErrorInfo

func (*ErrorInfo) Descriptor deprecated 

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

Deprecated: Use ErrorInfo.ProtoReflect.Descriptor instead.

func (*ErrorInfo) EqualMessageVT 

func (this *ErrorInfo) EqualMessageVT(thatMsg proto.Message) bool

func (*ErrorInfo) EqualVT 

func (this *ErrorInfo) EqualVT(that *ErrorInfo) bool

func (*ErrorInfo) GetDomain 

func (x *ErrorInfo) GetDomain() string

func (*ErrorInfo) GetMetadata 

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

func (*ErrorInfo) GetReason 

func (x *ErrorInfo) GetReason() string

func (*ErrorInfo) MarshalToSizedBufferVT 

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

func (*ErrorInfo) MarshalToVT 

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

func (*ErrorInfo) MarshalVT 

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

func (*ErrorInfo) ProtoMessage 

func (*ErrorInfo) ProtoMessage()

func (*ErrorInfo) ProtoReflect 

func (x *ErrorInfo) ProtoReflect() protoreflect.Message

func (*ErrorInfo) Reset 

func (x *ErrorInfo) Reset()

func (*ErrorInfo) SizeVT 

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

func (*ErrorInfo) String 

func (x *ErrorInfo) String() string

func (*ErrorInfo) UnmarshalVT 

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

func (*ErrorInfo) Validate 

func (m *ErrorInfo) Validate() error

Validate checks the field values on ErrorInfo with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ErrorInfo) ValidateAll 

func (m *ErrorInfo) ValidateAll() error

ValidateAll checks the field values on ErrorInfo with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ErrorInfoMultiError, or nil if none found.

type ErrorInfoMultiError 

type ErrorInfoMultiError []error

ErrorInfoMultiError is an error wrapping multiple validation errors returned by ErrorInfo.ValidateAll() if the designated constraints aren't met.

func (ErrorInfoMultiError) AllErrors 

func (m ErrorInfoMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ErrorInfoMultiError) Error 

func (m ErrorInfoMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ErrorInfoValidationError 

type ErrorInfoValidationError struct {
	// contains filtered or unexported fields
}

ErrorInfoValidationError is the validation error returned by ErrorInfo.Validate if the designated constraints aren't met.

func (ErrorInfoValidationError) Cause 

func (e ErrorInfoValidationError) Cause() error

Cause function returns cause value.

func (ErrorInfoValidationError) Error 

func (e ErrorInfoValidationError) Error() string

Error satisfies the builtin error interface

func (ErrorInfoValidationError) ErrorName 

func (e ErrorInfoValidationError) ErrorName() string

ErrorName returns error name.

func (ErrorInfoValidationError) Field 

func (e ErrorInfoValidationError) Field() string

Field function returns field value.

func (ErrorInfoValidationError) Key 

func (e ErrorInfoValidationError) Key() bool

Key function returns key value.

func (ErrorInfoValidationError) Reason 

func (e ErrorInfoValidationError) Reason() string

Reason function returns reason value.

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"`
	// contains filtered or unexported fields
}

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

func (m *Help) CloneMessageVT() proto.Message

func (*Help) CloneVT 

func (m *Help) CloneVT() *Help

func (*Help) Descriptor deprecated 

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

Deprecated: Use Help.ProtoReflect.Descriptor instead.

func (*Help) EqualMessageVT 

func (this *Help) EqualMessageVT(thatMsg proto.Message) bool

func (*Help) EqualVT 

func (this *Help) EqualVT(that *Help) bool
func (x *Help) GetLinks() []*Help_Link

func (*Help) MarshalToSizedBufferVT 

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

func (*Help) MarshalToVT 

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

func (*Help) MarshalVT 

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

func (*Help) ProtoMessage 

func (*Help) ProtoMessage()

func (*Help) ProtoReflect 

func (x *Help) ProtoReflect() protoreflect.Message

func (*Help) Reset 

func (x *Help) Reset()

func (*Help) SizeVT 

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

func (*Help) String 

func (x *Help) String() string

func (*Help) UnmarshalVT 

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

func (*Help) Validate 

func (m *Help) Validate() error

Validate checks the field values on Help with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Help) ValidateAll 

func (m *Help) ValidateAll() error

ValidateAll checks the field values on Help with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in HelpMultiError, or nil if none found.

type HelpMultiError 

type HelpMultiError []error

HelpMultiError is an error wrapping multiple validation errors returned by Help.ValidateAll() if the designated constraints aren't met.

func (HelpMultiError) AllErrors 

func (m HelpMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HelpMultiError) Error 

func (m HelpMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type HelpValidationError 

type HelpValidationError struct {
	// contains filtered or unexported fields
}

HelpValidationError is the validation error returned by Help.Validate if the designated constraints aren't met.

func (HelpValidationError) Cause 

func (e HelpValidationError) Cause() error

Cause function returns cause value.

func (HelpValidationError) Error 

func (e HelpValidationError) Error() string

Error satisfies the builtin error interface

func (HelpValidationError) ErrorName 

func (e HelpValidationError) ErrorName() string

ErrorName returns error name.

func (HelpValidationError) Field 

func (e HelpValidationError) Field() string

Field function returns field value.

func (HelpValidationError) Key 

func (e HelpValidationError) Key() bool

Key function returns key value.

func (HelpValidationError) Reason 

func (e HelpValidationError) Reason() string

Reason function returns reason value. 

type Help_Link struct {

	// Describes what the link offers.
	Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	// The URL of the link.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

Describes a URL link.

func (*Help_Link) CloneMessageVT 

func (m *Help_Link) CloneMessageVT() proto.Message

func (*Help_Link) CloneVT 

func (m *Help_Link) CloneVT() *Help_Link

func (*Help_Link) Descriptor deprecated 

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

Deprecated: Use Help_Link.ProtoReflect.Descriptor instead.

func (*Help_Link) EqualMessageVT 

func (this *Help_Link) EqualMessageVT(thatMsg proto.Message) bool

func (*Help_Link) EqualVT 

func (this *Help_Link) EqualVT(that *Help_Link) bool

func (*Help_Link) GetDescription 

func (x *Help_Link) GetDescription() string

func (*Help_Link) GetUrl 

func (x *Help_Link) GetUrl() string

func (*Help_Link) MarshalToSizedBufferVT 

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

func (*Help_Link) MarshalToVT 

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

func (*Help_Link) MarshalVT 

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

func (*Help_Link) ProtoMessage 

func (*Help_Link) ProtoMessage()

func (*Help_Link) ProtoReflect 

func (x *Help_Link) ProtoReflect() protoreflect.Message

func (*Help_Link) Reset 

func (x *Help_Link) Reset()

func (*Help_Link) SizeVT 

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

func (*Help_Link) String 

func (x *Help_Link) String() string

func (*Help_Link) UnmarshalVT 

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

func (*Help_Link) Validate 

func (m *Help_Link) Validate() error

Validate checks the field values on Help_Link with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Help_Link) ValidateAll 

func (m *Help_Link) ValidateAll() error

ValidateAll checks the field values on Help_Link with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in Help_LinkMultiError, or nil if none found.

type Help_LinkMultiError 

type Help_LinkMultiError []error

Help_LinkMultiError is an error wrapping multiple validation errors returned by Help_Link.ValidateAll() if the designated constraints aren't met.

func (Help_LinkMultiError) AllErrors 

func (m Help_LinkMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (Help_LinkMultiError) Error 

func (m Help_LinkMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type Help_LinkValidationError 

type Help_LinkValidationError struct {
	// contains filtered or unexported fields
}

Help_LinkValidationError is the validation error returned by Help_Link.Validate if the designated constraints aren't met.

func (Help_LinkValidationError) Cause 

func (e Help_LinkValidationError) Cause() error

Cause function returns cause value.

func (Help_LinkValidationError) Error 

func (e Help_LinkValidationError) Error() string

Error satisfies the builtin error interface

func (Help_LinkValidationError) ErrorName 

func (e Help_LinkValidationError) ErrorName() string

ErrorName returns error name.

func (Help_LinkValidationError) Field 

func (e Help_LinkValidationError) Field() string

Field function returns field value.

func (Help_LinkValidationError) Key 

func (e Help_LinkValidationError) Key() bool

Key function returns key value.

func (Help_LinkValidationError) Reason 

func (e Help_LinkValidationError) Reason() string

Reason function returns reason value.

type LocalizedMessage 

type LocalizedMessage struct {

	// The locale used following the specification defined at
	// https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
	// Examples are: "en-US", "fr-CH", "es-MX"
	Locale string `protobuf:"bytes,1,opt,name=locale,proto3" json:"locale,omitempty"`
	// The localized error message in the above locale.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

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

func (*LocalizedMessage) CloneMessageVT 

func (m *LocalizedMessage) CloneMessageVT() proto.Message

func (*LocalizedMessage) CloneVT 

func (m *LocalizedMessage) CloneVT() *LocalizedMessage

func (*LocalizedMessage) Descriptor deprecated 

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

Deprecated: Use LocalizedMessage.ProtoReflect.Descriptor instead.

func (*LocalizedMessage) EqualMessageVT 

func (this *LocalizedMessage) EqualMessageVT(thatMsg proto.Message) bool

func (*LocalizedMessage) EqualVT 

func (this *LocalizedMessage) EqualVT(that *LocalizedMessage) bool

func (*LocalizedMessage) GetLocale 

func (x *LocalizedMessage) GetLocale() string

func (*LocalizedMessage) GetMessage 

func (x *LocalizedMessage) GetMessage() string

func (*LocalizedMessage) MarshalToSizedBufferVT 

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

func (*LocalizedMessage) MarshalToVT 

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

func (*LocalizedMessage) MarshalVT 

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

func (*LocalizedMessage) ProtoMessage 

func (*LocalizedMessage) ProtoMessage()

func (*LocalizedMessage) ProtoReflect 

func (x *LocalizedMessage) ProtoReflect() protoreflect.Message

func (*LocalizedMessage) Reset 

func (x *LocalizedMessage) Reset()

func (*LocalizedMessage) SizeVT 

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

func (*LocalizedMessage) String 

func (x *LocalizedMessage) String() string

func (*LocalizedMessage) UnmarshalVT 

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

func (*LocalizedMessage) Validate 

func (m *LocalizedMessage) Validate() error

Validate checks the field values on LocalizedMessage with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*LocalizedMessage) ValidateAll 

func (m *LocalizedMessage) ValidateAll() error

ValidateAll checks the field values on LocalizedMessage with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in LocalizedMessageMultiError, or nil if none found.

type LocalizedMessageMultiError 

type LocalizedMessageMultiError []error

LocalizedMessageMultiError is an error wrapping multiple validation errors returned by LocalizedMessage.ValidateAll() if the designated constraints aren't met.

func (LocalizedMessageMultiError) AllErrors 

func (m LocalizedMessageMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (LocalizedMessageMultiError) Error 

func (m LocalizedMessageMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type LocalizedMessageValidationError 

type LocalizedMessageValidationError struct {
	// contains filtered or unexported fields
}

LocalizedMessageValidationError is the validation error returned by LocalizedMessage.Validate if the designated constraints aren't met.

func (LocalizedMessageValidationError) Cause 

func (e LocalizedMessageValidationError) Cause() error

Cause function returns cause value.

func (LocalizedMessageValidationError) Error 

func (e LocalizedMessageValidationError) Error() string

Error satisfies the builtin error interface

func (LocalizedMessageValidationError) ErrorName 

func (e LocalizedMessageValidationError) ErrorName() string

ErrorName returns error name.

func (LocalizedMessageValidationError) Field 

func (e LocalizedMessageValidationError) Field() string

Field function returns field value.

func (LocalizedMessageValidationError) Key 

func (e LocalizedMessageValidationError) Key() bool

Key function returns key value.

func (LocalizedMessageValidationError) Reason 

func (e LocalizedMessageValidationError) Reason() string

Reason function returns reason value.

type PreconditionFailure 

type PreconditionFailure struct {

	// Describes all precondition violations.
	Violations []*PreconditionFailure_Violation `protobuf:"bytes,1,rep,name=violations,proto3" json:"violations,omitempty"`
	// contains filtered or unexported fields
}

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

func (m *PreconditionFailure) CloneMessageVT() proto.Message

func (*PreconditionFailure) CloneVT 

func (m *PreconditionFailure) CloneVT() *PreconditionFailure

func (*PreconditionFailure) Descriptor deprecated 

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

Deprecated: Use PreconditionFailure.ProtoReflect.Descriptor instead.

func (*PreconditionFailure) EqualMessageVT 

func (this *PreconditionFailure) EqualMessageVT(thatMsg proto.Message) bool

func (*PreconditionFailure) EqualVT 

func (this *PreconditionFailure) EqualVT(that *PreconditionFailure) bool

func (*PreconditionFailure) GetViolations 

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

func (*PreconditionFailure) MarshalToSizedBufferVT 

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

func (*PreconditionFailure) MarshalToVT 

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

func (*PreconditionFailure) MarshalVT 

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

func (*PreconditionFailure) ProtoMessage 

func (*PreconditionFailure) ProtoMessage()

func (*PreconditionFailure) ProtoReflect 

func (x *PreconditionFailure) ProtoReflect() protoreflect.Message

func (*PreconditionFailure) Reset 

func (x *PreconditionFailure) Reset()

func (*PreconditionFailure) SizeVT 

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

func (*PreconditionFailure) String 

func (x *PreconditionFailure) String() string

func (*PreconditionFailure) UnmarshalVT 

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

func (*PreconditionFailure) Validate 

func (m *PreconditionFailure) Validate() error

Validate checks the field values on PreconditionFailure with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*PreconditionFailure) ValidateAll 

func (m *PreconditionFailure) ValidateAll() error

ValidateAll checks the field values on PreconditionFailure with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PreconditionFailureMultiError, or nil if none found.

type PreconditionFailureMultiError 

type PreconditionFailureMultiError []error

PreconditionFailureMultiError is an error wrapping multiple validation errors returned by PreconditionFailure.ValidateAll() if the designated constraints aren't met.

func (PreconditionFailureMultiError) AllErrors 

func (m PreconditionFailureMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PreconditionFailureMultiError) Error 

func (m PreconditionFailureMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type PreconditionFailureValidationError 

type PreconditionFailureValidationError struct {
	// contains filtered or unexported fields
}

PreconditionFailureValidationError is the validation error returned by PreconditionFailure.Validate if the designated constraints aren't met.

func (PreconditionFailureValidationError) Cause 

func (e PreconditionFailureValidationError) Cause() error

Cause function returns cause value.

func (PreconditionFailureValidationError) Error 

func (e PreconditionFailureValidationError) Error() string

Error satisfies the builtin error interface

func (PreconditionFailureValidationError) ErrorName 

func (e PreconditionFailureValidationError) ErrorName() string

ErrorName returns error name.

func (PreconditionFailureValidationError) Field 

func (e PreconditionFailureValidationError) Field() string

Field function returns field value.

func (PreconditionFailureValidationError) Key 

func (e PreconditionFailureValidationError) Key() bool

Key function returns key value.

func (PreconditionFailureValidationError) Reason 

func (e PreconditionFailureValidationError) Reason() string

Reason function returns reason value.

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"`
	// contains filtered or unexported fields
}

A message type used to describe a single precondition failure.

func (*PreconditionFailure_Violation) CloneMessageVT 

func (m *PreconditionFailure_Violation) CloneMessageVT() proto.Message

func (*PreconditionFailure_Violation) CloneVT 

func (m *PreconditionFailure_Violation) CloneVT() *PreconditionFailure_Violation

func (*PreconditionFailure_Violation) Descriptor deprecated 

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

Deprecated: Use PreconditionFailure_Violation.ProtoReflect.Descriptor instead.

func (*PreconditionFailure_Violation) EqualMessageVT 

func (this *PreconditionFailure_Violation) EqualMessageVT(thatMsg proto.Message) bool

func (*PreconditionFailure_Violation) EqualVT 

func (this *PreconditionFailure_Violation) EqualVT(that *PreconditionFailure_Violation) bool

func (*PreconditionFailure_Violation) GetDescription 

func (x *PreconditionFailure_Violation) GetDescription() string

func (*PreconditionFailure_Violation) GetSubject 

func (x *PreconditionFailure_Violation) GetSubject() string

func (*PreconditionFailure_Violation) GetType 

func (x *PreconditionFailure_Violation) GetType() string

func (*PreconditionFailure_Violation) MarshalToSizedBufferVT 

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

func (*PreconditionFailure_Violation) MarshalToVT 

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

func (*PreconditionFailure_Violation) MarshalVT 

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

func (*PreconditionFailure_Violation) ProtoMessage 

func (*PreconditionFailure_Violation) ProtoMessage()

func (*PreconditionFailure_Violation) ProtoReflect 

func (x *PreconditionFailure_Violation) ProtoReflect() protoreflect.Message

func (*PreconditionFailure_Violation) Reset 

func (x *PreconditionFailure_Violation) Reset()

func (*PreconditionFailure_Violation) SizeVT 

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

func (*PreconditionFailure_Violation) String 

func (x *PreconditionFailure_Violation) String() string

func (*PreconditionFailure_Violation) UnmarshalVT 

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

func (*PreconditionFailure_Violation) Validate 

func (m *PreconditionFailure_Violation) Validate() error

Validate checks the field values on PreconditionFailure_Violation with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*PreconditionFailure_Violation) ValidateAll 

func (m *PreconditionFailure_Violation) ValidateAll() error

ValidateAll checks the field values on PreconditionFailure_Violation with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PreconditionFailure_ViolationMultiError, or nil if none found.

type PreconditionFailure_ViolationMultiError 

type PreconditionFailure_ViolationMultiError []error

PreconditionFailure_ViolationMultiError is an error wrapping multiple validation errors returned by PreconditionFailure_Violation.ValidateAll() if the designated constraints aren't met.

func (PreconditionFailure_ViolationMultiError) AllErrors 

func (m PreconditionFailure_ViolationMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PreconditionFailure_ViolationMultiError) Error 

func (m PreconditionFailure_ViolationMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type PreconditionFailure_ViolationValidationError 

type PreconditionFailure_ViolationValidationError struct {
	// contains filtered or unexported fields
}

PreconditionFailure_ViolationValidationError is the validation error returned by PreconditionFailure_Violation.Validate if the designated constraints aren't met.

func (PreconditionFailure_ViolationValidationError) Cause 

func (e PreconditionFailure_ViolationValidationError) Cause() error

Cause function returns cause value.

func (PreconditionFailure_ViolationValidationError) Error 

func (e PreconditionFailure_ViolationValidationError) Error() string

Error satisfies the builtin error interface

func (PreconditionFailure_ViolationValidationError) ErrorName 

func (e PreconditionFailure_ViolationValidationError) ErrorName() string

ErrorName returns error name.

func (PreconditionFailure_ViolationValidationError) Field 

func (e PreconditionFailure_ViolationValidationError) Field() string

Field function returns field value.

func (PreconditionFailure_ViolationValidationError) Key 

func (e PreconditionFailure_ViolationValidationError) Key() bool

Key function returns key value.

func (PreconditionFailure_ViolationValidationError) Reason 

func (e PreconditionFailure_ViolationValidationError) Reason() string

Reason function returns reason value.

type QuotaFailure 

type QuotaFailure struct {

	// Describes all quota violations.
	Violations []*QuotaFailure_Violation `protobuf:"bytes,1,rep,name=violations,proto3" json:"violations,omitempty"`
	// contains filtered or unexported fields
}

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

func (m *QuotaFailure) CloneMessageVT() proto.Message

func (*QuotaFailure) CloneVT 

func (m *QuotaFailure) CloneVT() *QuotaFailure

func (*QuotaFailure) Descriptor deprecated 

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

Deprecated: Use QuotaFailure.ProtoReflect.Descriptor instead.

func (*QuotaFailure) EqualMessageVT 

func (this *QuotaFailure) EqualMessageVT(thatMsg proto.Message) bool

func (*QuotaFailure) EqualVT 

func (this *QuotaFailure) EqualVT(that *QuotaFailure) bool

func (*QuotaFailure) GetViolations 

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

func (*QuotaFailure) MarshalToSizedBufferVT 

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

func (*QuotaFailure) MarshalToVT 

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

func (*QuotaFailure) MarshalVT 

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

func (*QuotaFailure) ProtoMessage 

func (*QuotaFailure) ProtoMessage()

func (*QuotaFailure) ProtoReflect 

func (x *QuotaFailure) ProtoReflect() protoreflect.Message

func (*QuotaFailure) Reset 

func (x *QuotaFailure) Reset()

func (*QuotaFailure) SizeVT 

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

func (*QuotaFailure) String 

func (x *QuotaFailure) String() string

func (*QuotaFailure) UnmarshalVT 

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

func (*QuotaFailure) Validate 

func (m *QuotaFailure) Validate() error

Validate checks the field values on QuotaFailure with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*QuotaFailure) ValidateAll 

func (m *QuotaFailure) ValidateAll() error

ValidateAll checks the field values on QuotaFailure with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in QuotaFailureMultiError, or nil if none found.

type QuotaFailureMultiError 

type QuotaFailureMultiError []error

QuotaFailureMultiError is an error wrapping multiple validation errors returned by QuotaFailure.ValidateAll() if the designated constraints aren't met.

func (QuotaFailureMultiError) AllErrors 

func (m QuotaFailureMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (QuotaFailureMultiError) Error 

func (m QuotaFailureMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type QuotaFailureValidationError 

type QuotaFailureValidationError struct {
	// contains filtered or unexported fields
}

QuotaFailureValidationError is the validation error returned by QuotaFailure.Validate if the designated constraints aren't met.

func (QuotaFailureValidationError) Cause 

func (e QuotaFailureValidationError) Cause() error

Cause function returns cause value.

func (QuotaFailureValidationError) Error 

func (e QuotaFailureValidationError) Error() string

Error satisfies the builtin error interface

func (QuotaFailureValidationError) ErrorName 

func (e QuotaFailureValidationError) ErrorName() string

ErrorName returns error name.

func (QuotaFailureValidationError) Field 

func (e QuotaFailureValidationError) Field() string

Field function returns field value.

func (QuotaFailureValidationError) Key 

func (e QuotaFailureValidationError) Key() bool

Key function returns key value.

func (QuotaFailureValidationError) Reason 

func (e QuotaFailureValidationError) Reason() string

Reason function returns reason value.

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"`
	// contains filtered or unexported fields
}

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

func (m *QuotaFailure_Violation) CloneMessageVT() proto.Message

func (*QuotaFailure_Violation) CloneVT 

func (m *QuotaFailure_Violation) CloneVT() *QuotaFailure_Violation

func (*QuotaFailure_Violation) Descriptor deprecated 

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

Deprecated: Use QuotaFailure_Violation.ProtoReflect.Descriptor instead.

func (*QuotaFailure_Violation) EqualMessageVT 

func (this *QuotaFailure_Violation) EqualMessageVT(thatMsg proto.Message) bool

func (*QuotaFailure_Violation) EqualVT 

func (this *QuotaFailure_Violation) EqualVT(that *QuotaFailure_Violation) bool

func (*QuotaFailure_Violation) GetDescription 

func (x *QuotaFailure_Violation) GetDescription() string

func (*QuotaFailure_Violation) GetSubject 

func (x *QuotaFailure_Violation) GetSubject() string

func (*QuotaFailure_Violation) MarshalToSizedBufferVT 

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

func (*QuotaFailure_Violation) MarshalToVT 

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

func (*QuotaFailure_Violation) MarshalVT 

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

func (*QuotaFailure_Violation) ProtoMessage 

func (*QuotaFailure_Violation) ProtoMessage()

func (*QuotaFailure_Violation) ProtoReflect 

func (x *QuotaFailure_Violation) ProtoReflect() protoreflect.Message

func (*QuotaFailure_Violation) Reset 

func (x *QuotaFailure_Violation) Reset()

func (*QuotaFailure_Violation) SizeVT 

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

func (*QuotaFailure_Violation) String 

func (x *QuotaFailure_Violation) String() string

func (*QuotaFailure_Violation) UnmarshalVT 

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

func (*QuotaFailure_Violation) Validate 

func (m *QuotaFailure_Violation) Validate() error

Validate checks the field values on QuotaFailure_Violation with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*QuotaFailure_Violation) ValidateAll 

func (m *QuotaFailure_Violation) ValidateAll() error

ValidateAll checks the field values on QuotaFailure_Violation with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in QuotaFailure_ViolationMultiError, or nil if none found.

type QuotaFailure_ViolationMultiError 

type QuotaFailure_ViolationMultiError []error

QuotaFailure_ViolationMultiError is an error wrapping multiple validation errors returned by QuotaFailure_Violation.ValidateAll() if the designated constraints aren't met.

func (QuotaFailure_ViolationMultiError) AllErrors 

func (m QuotaFailure_ViolationMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (QuotaFailure_ViolationMultiError) Error 

func (m QuotaFailure_ViolationMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type QuotaFailure_ViolationValidationError 

type QuotaFailure_ViolationValidationError struct {
	// contains filtered or unexported fields
}

QuotaFailure_ViolationValidationError is the validation error returned by QuotaFailure_Violation.Validate if the designated constraints aren't met.

func (QuotaFailure_ViolationValidationError) Cause 

func (e QuotaFailure_ViolationValidationError) Cause() error

Cause function returns cause value.

func (QuotaFailure_ViolationValidationError) Error 

func (e QuotaFailure_ViolationValidationError) Error() string

Error satisfies the builtin error interface

func (QuotaFailure_ViolationValidationError) ErrorName 

func (e QuotaFailure_ViolationValidationError) ErrorName() string

ErrorName returns error name.

func (QuotaFailure_ViolationValidationError) Field 

func (e QuotaFailure_ViolationValidationError) Field() string

Field function returns field value.

func (QuotaFailure_ViolationValidationError) Key 

func (e QuotaFailure_ViolationValidationError) Key() bool

Key function returns key value.

func (QuotaFailure_ViolationValidationError) Reason 

func (e QuotaFailure_ViolationValidationError) Reason() string

Reason function returns reason value.

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"`
	// contains filtered or unexported fields
}

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

func (*RequestInfo) CloneMessageVT 

func (m *RequestInfo) CloneMessageVT() proto.Message

func (*RequestInfo) CloneVT 

func (m *RequestInfo) CloneVT() *RequestInfo

func (*RequestInfo) Descriptor deprecated 

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

Deprecated: Use RequestInfo.ProtoReflect.Descriptor instead.

func (*RequestInfo) EqualMessageVT 

func (this *RequestInfo) EqualMessageVT(thatMsg proto.Message) bool

func (*RequestInfo) EqualVT 

func (this *RequestInfo) EqualVT(that *RequestInfo) bool

func (*RequestInfo) GetRequestId 

func (x *RequestInfo) GetRequestId() string

func (*RequestInfo) GetServingData 

func (x *RequestInfo) GetServingData() string

func (*RequestInfo) MarshalToSizedBufferVT 

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

func (*RequestInfo) MarshalToVT 

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

func (*RequestInfo) MarshalVT 

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

func (*RequestInfo) ProtoMessage 

func (*RequestInfo) ProtoMessage()

func (*RequestInfo) ProtoReflect 

func (x *RequestInfo) ProtoReflect() protoreflect.Message

func (*RequestInfo) Reset 

func (x *RequestInfo) Reset()

func (*RequestInfo) SizeVT 

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

func (*RequestInfo) String 

func (x *RequestInfo) String() string

func (*RequestInfo) UnmarshalVT 

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

func (*RequestInfo) Validate 

func (m *RequestInfo) Validate() error

Validate checks the field values on RequestInfo with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RequestInfo) ValidateAll 

func (m *RequestInfo) ValidateAll() error

ValidateAll checks the field values on RequestInfo with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RequestInfoMultiError, or nil if none found.

type RequestInfoMultiError 

type RequestInfoMultiError []error

RequestInfoMultiError is an error wrapping multiple validation errors returned by RequestInfo.ValidateAll() if the designated constraints aren't met.

func (RequestInfoMultiError) AllErrors 

func (m RequestInfoMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RequestInfoMultiError) Error 

func (m RequestInfoMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RequestInfoValidationError 

type RequestInfoValidationError struct {
	// contains filtered or unexported fields
}

RequestInfoValidationError is the validation error returned by RequestInfo.Validate if the designated constraints aren't met.

func (RequestInfoValidationError) Cause 

func (e RequestInfoValidationError) Cause() error

Cause function returns cause value.

func (RequestInfoValidationError) Error 

func (e RequestInfoValidationError) Error() string

Error satisfies the builtin error interface

func (RequestInfoValidationError) ErrorName 

func (e RequestInfoValidationError) ErrorName() string

ErrorName returns error name.

func (RequestInfoValidationError) Field 

func (e RequestInfoValidationError) Field() string

Field function returns field value.

func (RequestInfoValidationError) Key 

func (e RequestInfoValidationError) Key() bool

Key function returns key value.

func (RequestInfoValidationError) Reason 

func (e RequestInfoValidationError) Reason() string

Reason function returns reason value.

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"`
	// contains filtered or unexported fields
}

Describes the resource that is being accessed.

func (*ResourceInfo) CloneMessageVT 

func (m *ResourceInfo) CloneMessageVT() proto.Message

func (*ResourceInfo) CloneVT 

func (m *ResourceInfo) CloneVT() *ResourceInfo

func (*ResourceInfo) Descriptor deprecated 

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

Deprecated: Use ResourceInfo.ProtoReflect.Descriptor instead.

func (*ResourceInfo) EqualMessageVT 

func (this *ResourceInfo) EqualMessageVT(thatMsg proto.Message) bool

func (*ResourceInfo) EqualVT 

func (this *ResourceInfo) EqualVT(that *ResourceInfo) bool

func (*ResourceInfo) GetDescription 

func (x *ResourceInfo) GetDescription() string

func (*ResourceInfo) GetOwner 

func (x *ResourceInfo) GetOwner() string

func (*ResourceInfo) GetResourceName 

func (x *ResourceInfo) GetResourceName() string

func (*ResourceInfo) GetResourceType 

func (x *ResourceInfo) GetResourceType() string

func (*ResourceInfo) MarshalToSizedBufferVT 

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

func (*ResourceInfo) MarshalToVT 

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

func (*ResourceInfo) MarshalVT 

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

func (*ResourceInfo) ProtoMessage 

func (*ResourceInfo) ProtoMessage()

func (*ResourceInfo) ProtoReflect 

func (x *ResourceInfo) ProtoReflect() protoreflect.Message

func (*ResourceInfo) Reset 

func (x *ResourceInfo) Reset()

func (*ResourceInfo) SizeVT 

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

func (*ResourceInfo) String 

func (x *ResourceInfo) String() string

func (*ResourceInfo) UnmarshalVT 

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

func (*ResourceInfo) Validate 

func (m *ResourceInfo) Validate() error

Validate checks the field values on ResourceInfo with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ResourceInfo) ValidateAll 

func (m *ResourceInfo) ValidateAll() error

ValidateAll checks the field values on ResourceInfo with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ResourceInfoMultiError, or nil if none found.

type ResourceInfoMultiError 

type ResourceInfoMultiError []error

ResourceInfoMultiError is an error wrapping multiple validation errors returned by ResourceInfo.ValidateAll() if the designated constraints aren't met.

func (ResourceInfoMultiError) AllErrors 

func (m ResourceInfoMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ResourceInfoMultiError) Error 

func (m ResourceInfoMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ResourceInfoValidationError 

type ResourceInfoValidationError struct {
	// contains filtered or unexported fields
}

ResourceInfoValidationError is the validation error returned by ResourceInfo.Validate if the designated constraints aren't met.

func (ResourceInfoValidationError) Cause 

func (e ResourceInfoValidationError) Cause() error

Cause function returns cause value.

func (ResourceInfoValidationError) Error 

func (e ResourceInfoValidationError) Error() string

Error satisfies the builtin error interface

func (ResourceInfoValidationError) ErrorName 

func (e ResourceInfoValidationError) ErrorName() string

ErrorName returns error name.

func (ResourceInfoValidationError) Field 

func (e ResourceInfoValidationError) Field() string

Field function returns field value.

func (ResourceInfoValidationError) Key 

func (e ResourceInfoValidationError) Key() bool

Key function returns key value.

func (ResourceInfoValidationError) Reason 

func (e ResourceInfoValidationError) Reason() string

Reason function returns reason value.

type RetryInfo 

type RetryInfo struct {

	// Clients should wait at least this long between retrying the same request.
	RetryDelay *durationpb.Duration `protobuf:"bytes,1,opt,name=retry_delay,json=retryDelay,proto3" json:"retry_delay,omitempty"`
	// contains filtered or unexported fields
}

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

func (m *RetryInfo) CloneMessageVT() proto.Message

func (*RetryInfo) CloneVT 

func (m *RetryInfo) CloneVT() *RetryInfo

func (*RetryInfo) Descriptor deprecated 

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

Deprecated: Use RetryInfo.ProtoReflect.Descriptor instead.

func (*RetryInfo) EqualMessageVT 

func (this *RetryInfo) EqualMessageVT(thatMsg proto.Message) bool

func (*RetryInfo) EqualVT 

func (this *RetryInfo) EqualVT(that *RetryInfo) bool

func (*RetryInfo) GetRetryDelay 

func (x *RetryInfo) GetRetryDelay() *durationpb.Duration

func (*RetryInfo) MarshalToSizedBufferVT 

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

func (*RetryInfo) MarshalToVT 

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

func (*RetryInfo) MarshalVT 

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

func (*RetryInfo) ProtoMessage 

func (*RetryInfo) ProtoMessage()

func (*RetryInfo) ProtoReflect 

func (x *RetryInfo) ProtoReflect() protoreflect.Message

func (*RetryInfo) Reset 

func (x *RetryInfo) Reset()

func (*RetryInfo) SizeVT 

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

func (*RetryInfo) String 

func (x *RetryInfo) String() string

func (*RetryInfo) UnmarshalVT 

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

func (*RetryInfo) Validate 

func (m *RetryInfo) Validate() error

Validate checks the field values on RetryInfo with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RetryInfo) ValidateAll 

func (m *RetryInfo) ValidateAll() error

ValidateAll checks the field values on RetryInfo with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RetryInfoMultiError, or nil if none found.

type RetryInfoMultiError 

type RetryInfoMultiError []error

RetryInfoMultiError is an error wrapping multiple validation errors returned by RetryInfo.ValidateAll() if the designated constraints aren't met.

func (RetryInfoMultiError) AllErrors 

func (m RetryInfoMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RetryInfoMultiError) Error 

func (m RetryInfoMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RetryInfoValidationError 

type RetryInfoValidationError struct {
	// contains filtered or unexported fields
}

RetryInfoValidationError is the validation error returned by RetryInfo.Validate if the designated constraints aren't met.

func (RetryInfoValidationError) Cause 

func (e RetryInfoValidationError) Cause() error

Cause function returns cause value.

func (RetryInfoValidationError) Error 

func (e RetryInfoValidationError) Error() string

Error satisfies the builtin error interface

func (RetryInfoValidationError) ErrorName 

func (e RetryInfoValidationError) ErrorName() string

ErrorName returns error name.

func (RetryInfoValidationError) Field 

func (e RetryInfoValidationError) Field() string

Field function returns field value.

func (RetryInfoValidationError) Key 

func (e RetryInfoValidationError) Key() bool

Key function returns key value.

func (RetryInfoValidationError) Reason 

func (e RetryInfoValidationError) Reason() string

Reason function returns reason value.

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 []*anypb.Any `protobuf:"bytes,3,rep,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

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 (*Status) CloneMessageVT 

func (m *Status) CloneMessageVT() proto.Message

func (*Status) CloneVT 

func (m *Status) CloneVT() *Status

func (*Status) Descriptor deprecated 

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

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) EqualMessageVT 

func (this *Status) EqualMessageVT(thatMsg proto.Message) bool

func (*Status) EqualVT 

func (this *Status) EqualVT(that *Status) bool

func (*Status) GetCode 

func (x *Status) GetCode() int32

func (*Status) GetDetails 

func (x *Status) GetDetails() []*anypb.Any

func (*Status) GetMessage 

func (x *Status) GetMessage() string

func (*Status) MarshalToSizedBufferVT 

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

func (*Status) MarshalToVT 

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

func (*Status) MarshalVT 

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

func (*Status) ProtoMessage 

func (*Status) ProtoMessage()

func (*Status) ProtoReflect 

func (x *Status) ProtoReflect() protoreflect.Message

func (*Status) Reset 

func (x *Status) Reset()

func (*Status) SizeVT 

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

func (*Status) String 

func (x *Status) String() string

func (*Status) UnmarshalVT 

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

func (*Status) Validate 

func (m *Status) Validate() error

Validate checks the field values on Status with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Status) ValidateAll 

func (m *Status) ValidateAll() error

ValidateAll checks the field values on Status with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in StatusMultiError, or nil if none found.

type StatusMultiError 

type StatusMultiError []error

StatusMultiError is an error wrapping multiple validation errors returned by Status.ValidateAll() if the designated constraints aren't met.

func (StatusMultiError) AllErrors 

func (m StatusMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (StatusMultiError) Error 

func (m StatusMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type StatusValidationError 

type StatusValidationError struct {
	// contains filtered or unexported fields
}

StatusValidationError is the validation error returned by Status.Validate if the designated constraints aren't met.

func (StatusValidationError) Cause 

func (e StatusValidationError) Cause() error

Cause function returns cause value.

func (StatusValidationError) Error 

func (e StatusValidationError) Error() string

Error satisfies the builtin error interface

func (StatusValidationError) ErrorName 

func (e StatusValidationError) ErrorName() string

ErrorName returns error name.

func (StatusValidationError) Field 

func (e StatusValidationError) Field() string

Field function returns field value.

func (StatusValidationError) Key 

func (e StatusValidationError) Key() bool

Key function returns key value.

func (StatusValidationError) Reason 

func (e StatusValidationError) Reason() string

Reason function returns reason value.

Source Files

View all Source files

Directories

Path Synopsis

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.