package errdetails

Import Path
	google.golang.org/genproto/googleapis/rpc/errdetails (on go.dev)

Dependency Relation
	imports 6 packages, and imported by one package

Involved Source Files

	      error_details.pb.go
Package-Level Type Names (total 14, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type BadRequest (struct)
		Describes violations in a client request. This error type focuses on the
		syntactic aspects of the request.

		Fields (total 4, in which 1 are exported)
			FieldViolations []*BadRequest_FieldViolation
				Describes all violations in a client request.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 6, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use BadRequest.ProtoReflect.Descriptor instead.

			(*T) GetFieldViolations() []*BadRequest_FieldViolation
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer

	 type BadRequest_FieldViolation (struct)
		A message type used to describe a single bad request field.

		Fields (total 5, in which 2 are exported)
			Description string
				A description of why the request element is bad.

			Field string
				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.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 7, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use BadRequest_FieldViolation.ProtoReflect.Descriptor instead.

			(*T) GetDescription() string
			(*T) GetField() string
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least one exported)
			func (*BadRequest).GetFieldViolations() []*BadRequest_FieldViolation

	 type DebugInfo (struct)
		Describes additional debugging info.

		Fields (total 5, in which 2 are exported)
			Detail string
				Additional debugging information provided by the server.

			StackEntries []string
				The stack trace entries indicating where the error occurred.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 7, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use DebugInfo.ProtoReflect.Descriptor instead.

			(*T) GetDetail() string
			(*T) GetStackEntries() []string
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer

	 type ErrorInfo (struct)
		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"
		      }
		    }

		Fields (total 6, in which 3 are exported)
			Domain string
				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".

			Metadata map[string]string
				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.

			Reason string
				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_]+/.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 8, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use ErrorInfo.ProtoReflect.Descriptor instead.

			(*T) GetDomain() string
			(*T) GetMetadata() map[string]string
			(*T) GetReason() string
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer

	 type Help (struct)
		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.

		Fields (total 4, in which 1 are exported)
			Links []*Help_Link
				URL(s) pointing to additional information on handling the current error.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 6, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use Help.ProtoReflect.Descriptor instead.

			(*T) GetLinks() []*Help_Link
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer

	 type Help_Link (struct)
		Describes a URL link.

		Fields (total 5, in which 2 are exported)
			Description string
				Describes what the link offers.

			Url string
				The URL of the link.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 7, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use Help_Link.ProtoReflect.Descriptor instead.

			(*T) GetDescription() string
			(*T) GetUrl() string
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least one exported)
			func (*Help).GetLinks() []*Help_Link

	 type LocalizedMessage (struct)
		Provides a localized error message that is safe to return to the user
		which can be attached to an RPC error.

		Fields (total 5, in which 2 are exported)
			Locale string
				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"

			Message string
				The localized error message in the above locale.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 7, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use LocalizedMessage.ProtoReflect.Descriptor instead.

			(*T) GetLocale() string
			(*T) GetMessage() string
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer

	 type PreconditionFailure (struct)
		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.

		Fields (total 4, in which 1 are exported)
			Violations []*PreconditionFailure_Violation
				Describes all precondition violations.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 6, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use PreconditionFailure.ProtoReflect.Descriptor instead.

			(*T) GetViolations() []*PreconditionFailure_Violation
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer

	 type PreconditionFailure_Violation (struct)
		A message type used to describe a single precondition failure.

		Fields (total 6, in which 3 are exported)
			Description string
				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".

			Subject string
				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.

			Type string
				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".

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 8, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use PreconditionFailure_Violation.ProtoReflect.Descriptor instead.

			(*T) GetDescription() string
			(*T) GetSubject() string
			(*T) GetType() string
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least one exported)
			func (*PreconditionFailure).GetViolations() []*PreconditionFailure_Violation

	 type QuotaFailure (struct)
		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.

		Fields (total 4, in which 1 are exported)
			Violations []*QuotaFailure_Violation
				Describes all quota violations.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 6, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use QuotaFailure.ProtoReflect.Descriptor instead.

			(*T) GetViolations() []*QuotaFailure_Violation
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer

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

		Fields (total 5, in which 2 are exported)
			Description string
				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".

			Subject string
				The subject on which the quota check failed.
				For example, "clientip:<ip address of client>" or "project:<Google
				developer project id>".

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 7, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use QuotaFailure_Violation.ProtoReflect.Descriptor instead.

			(*T) GetDescription() string
			(*T) GetSubject() string
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least one exported)
			func (*QuotaFailure).GetViolations() []*QuotaFailure_Violation

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

		Fields (total 5, in which 2 are exported)
			RequestId string
				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.

			ServingData string
				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.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 7, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use RequestInfo.ProtoReflect.Descriptor instead.

			(*T) GetRequestId() string
			(*T) GetServingData() string
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer

	 type ResourceInfo (struct)
		Describes the resource that is being accessed.

		Fields (total 7, in which 4 are exported)
			Description string
				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.

			Owner string
				The owner of the resource (optional).
				For example, "user:<owner email>" or "project:<Google developer project
				id>".

			ResourceName string
				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].

			ResourceType string
				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".

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 9, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use ResourceInfo.ProtoReflect.Descriptor instead.

			(*T) GetDescription() string
			(*T) GetOwner() string
			(*T) GetResourceName() string
			(*T) GetResourceType() string
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer

	 type RetryInfo (struct)
		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.

		Fields (total 4, in which 1 are exported)
			RetryDelay *durationpb.Duration
				Clients should wait at least this long between retrying the same request.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 6, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use RetryInfo.ProtoReflect.Descriptor instead.

			(*T) GetRetryDelay() *durationpb.Duration
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer


Package-Level Functions (total 3, none are exported)

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func file_google_rpc_error_details_proto_init()
	 func file_google_rpc_error_details_proto_rawDescGZIP() []byte
	 func init()
Package-Level Variables (total 7, in which 1 are exported)

	  var File_google_rpc_error_details_proto protoreflect.FileDescriptor
	/* 6 unexporteds ... *//* 6 unexporteds: */
	  var file_google_rpc_error_details_proto_depIdxs []int32
	  var file_google_rpc_error_details_proto_goTypes []interface{}
	  var file_google_rpc_error_details_proto_msgTypes []impl.MessageInfo
	  var file_google_rpc_error_details_proto_rawDesc []byte
	  var file_google_rpc_error_details_proto_rawDescData []byte
	  var file_google_rpc_error_details_proto_rawDescOnce sync.Once

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.