etcd: go.etcd.io/etcd/etcdserver/api/v3rpc/rpctypes Index | Files

package rpctypes

import "go.etcd.io/etcd/etcdserver/api/v3rpc/rpctypes"

Package rpctypes has types and values shared by the etcd server and client for v3 RPC interaction.

Index

Package Files

doc.go error.go md.go metadatafields.go

Variables

var (
    ErrGRPCEmptyKey      = status.New(codes.InvalidArgument, "etcdserver: key is not provided").Err()
    ErrGRPCKeyNotFound   = status.New(codes.InvalidArgument, "etcdserver: key not found").Err()
    ErrGRPCValueProvided = status.New(codes.InvalidArgument, "etcdserver: value is provided").Err()
    ErrGRPCLeaseProvided = status.New(codes.InvalidArgument, "etcdserver: lease is provided").Err()
    ErrGRPCTooManyOps    = status.New(codes.InvalidArgument, "etcdserver: too many operations in txn request").Err()
    ErrGRPCDuplicateKey  = status.New(codes.InvalidArgument, "etcdserver: duplicate key given in txn request").Err()
    ErrGRPCCompacted     = status.New(codes.OutOfRange, "etcdserver: mvcc: required revision has been compacted").Err()
    ErrGRPCFutureRev     = status.New(codes.OutOfRange, "etcdserver: mvcc: required revision is a future revision").Err()
    ErrGRPCNoSpace       = status.New(codes.ResourceExhausted, "etcdserver: mvcc: database space exceeded").Err()

    ErrGRPCLeaseNotFound    = status.New(codes.NotFound, "etcdserver: requested lease not found").Err()
    ErrGRPCLeaseExist       = status.New(codes.FailedPrecondition, "etcdserver: lease already exists").Err()
    ErrGRPCLeaseTTLTooLarge = status.New(codes.OutOfRange, "etcdserver: too large lease TTL").Err()

    ErrGRPCMemberExist            = status.New(codes.FailedPrecondition, "etcdserver: member ID already exist").Err()
    ErrGRPCPeerURLExist           = status.New(codes.FailedPrecondition, "etcdserver: Peer URLs already exists").Err()
    ErrGRPCMemberNotEnoughStarted = status.New(codes.FailedPrecondition, "etcdserver: re-configuration failed due to not enough started members").Err()
    ErrGRPCMemberBadURLs          = status.New(codes.InvalidArgument, "etcdserver: given member URLs are invalid").Err()
    ErrGRPCMemberNotFound         = status.New(codes.NotFound, "etcdserver: member not found").Err()

    ErrGRPCRequestTooLarge        = status.New(codes.InvalidArgument, "etcdserver: request is too large").Err()
    ErrGRPCRequestTooManyRequests = status.New(codes.ResourceExhausted, "etcdserver: too many requests").Err()

    ErrGRPCRootUserNotExist     = status.New(codes.FailedPrecondition, "etcdserver: root user does not exist").Err()
    ErrGRPCRootRoleNotExist     = status.New(codes.FailedPrecondition, "etcdserver: root user does not have root role").Err()
    ErrGRPCUserAlreadyExist     = status.New(codes.FailedPrecondition, "etcdserver: user name already exists").Err()
    ErrGRPCUserEmpty            = status.New(codes.InvalidArgument, "etcdserver: user name is empty").Err()
    ErrGRPCUserNotFound         = status.New(codes.FailedPrecondition, "etcdserver: user name not found").Err()
    ErrGRPCRoleAlreadyExist     = status.New(codes.FailedPrecondition, "etcdserver: role name already exists").Err()
    ErrGRPCRoleNotFound         = status.New(codes.FailedPrecondition, "etcdserver: role name not found").Err()
    ErrGRPCAuthFailed           = status.New(codes.InvalidArgument, "etcdserver: authentication failed, invalid user ID or password").Err()
    ErrGRPCPermissionDenied     = status.New(codes.PermissionDenied, "etcdserver: permission denied").Err()
    ErrGRPCRoleNotGranted       = status.New(codes.FailedPrecondition, "etcdserver: role is not granted to the user").Err()
    ErrGRPCPermissionNotGranted = status.New(codes.FailedPrecondition, "etcdserver: permission is not granted to the role").Err()
    ErrGRPCAuthNotEnabled       = status.New(codes.FailedPrecondition, "etcdserver: authentication is not enabled").Err()
    ErrGRPCInvalidAuthToken     = status.New(codes.Unauthenticated, "etcdserver: invalid auth token").Err()
    ErrGRPCInvalidAuthMgmt      = status.New(codes.InvalidArgument, "etcdserver: invalid auth management").Err()

    ErrGRPCNoLeader                   = status.New(codes.Unavailable, "etcdserver: no leader").Err()
    ErrGRPCNotLeader                  = status.New(codes.FailedPrecondition, "etcdserver: not leader").Err()
    ErrGRPCLeaderChanged              = status.New(codes.Unavailable, "etcdserver: leader changed").Err()
    ErrGRPCNotCapable                 = status.New(codes.Unavailable, "etcdserver: not capable").Err()
    ErrGRPCStopped                    = status.New(codes.Unavailable, "etcdserver: server stopped").Err()
    ErrGRPCTimeout                    = status.New(codes.Unavailable, "etcdserver: request timed out").Err()
    ErrGRPCTimeoutDueToLeaderFail     = status.New(codes.Unavailable, "etcdserver: request timed out, possibly due to previous leader failure").Err()
    ErrGRPCTimeoutDueToConnectionLost = status.New(codes.Unavailable, "etcdserver: request timed out, possibly due to connection lost").Err()
    ErrGRPCUnhealthy                  = status.New(codes.Unavailable, "etcdserver: unhealthy cluster").Err()
    ErrGRPCCorrupt                    = status.New(codes.DataLoss, "etcdserver: corrupt cluster").Err()
)

server-side error

var (
    ErrEmptyKey      = Error(ErrGRPCEmptyKey)
    ErrKeyNotFound   = Error(ErrGRPCKeyNotFound)
    ErrValueProvided = Error(ErrGRPCValueProvided)
    ErrLeaseProvided = Error(ErrGRPCLeaseProvided)
    ErrTooManyOps    = Error(ErrGRPCTooManyOps)
    ErrDuplicateKey  = Error(ErrGRPCDuplicateKey)
    ErrCompacted     = Error(ErrGRPCCompacted)
    ErrFutureRev     = Error(ErrGRPCFutureRev)
    ErrNoSpace       = Error(ErrGRPCNoSpace)

    ErrLeaseNotFound    = Error(ErrGRPCLeaseNotFound)
    ErrLeaseExist       = Error(ErrGRPCLeaseExist)
    ErrLeaseTTLTooLarge = Error(ErrGRPCLeaseTTLTooLarge)

    ErrMemberExist            = Error(ErrGRPCMemberExist)
    ErrPeerURLExist           = Error(ErrGRPCPeerURLExist)
    ErrMemberNotEnoughStarted = Error(ErrGRPCMemberNotEnoughStarted)
    ErrMemberBadURLs          = Error(ErrGRPCMemberBadURLs)
    ErrMemberNotFound         = Error(ErrGRPCMemberNotFound)

    ErrRequestTooLarge = Error(ErrGRPCRequestTooLarge)
    ErrTooManyRequests = Error(ErrGRPCRequestTooManyRequests)

    ErrRootUserNotExist     = Error(ErrGRPCRootUserNotExist)
    ErrRootRoleNotExist     = Error(ErrGRPCRootRoleNotExist)
    ErrUserAlreadyExist     = Error(ErrGRPCUserAlreadyExist)
    ErrUserEmpty            = Error(ErrGRPCUserEmpty)
    ErrUserNotFound         = Error(ErrGRPCUserNotFound)
    ErrRoleAlreadyExist     = Error(ErrGRPCRoleAlreadyExist)
    ErrRoleNotFound         = Error(ErrGRPCRoleNotFound)
    ErrAuthFailed           = Error(ErrGRPCAuthFailed)
    ErrPermissionDenied     = Error(ErrGRPCPermissionDenied)
    ErrRoleNotGranted       = Error(ErrGRPCRoleNotGranted)
    ErrPermissionNotGranted = Error(ErrGRPCPermissionNotGranted)
    ErrAuthNotEnabled       = Error(ErrGRPCAuthNotEnabled)
    ErrInvalidAuthToken     = Error(ErrGRPCInvalidAuthToken)
    ErrInvalidAuthMgmt      = Error(ErrGRPCInvalidAuthMgmt)

    ErrNoLeader                   = Error(ErrGRPCNoLeader)
    ErrNotLeader                  = Error(ErrGRPCNotLeader)
    ErrLeaderChanged              = Error(ErrGRPCLeaderChanged)
    ErrNotCapable                 = Error(ErrGRPCNotCapable)
    ErrStopped                    = Error(ErrGRPCStopped)
    ErrTimeout                    = Error(ErrGRPCTimeout)
    ErrTimeoutDueToLeaderFail     = Error(ErrGRPCTimeoutDueToLeaderFail)
    ErrTimeoutDueToConnectionLost = Error(ErrGRPCTimeoutDueToConnectionLost)
    ErrUnhealthy                  = Error(ErrGRPCUnhealthy)
    ErrCorrupt                    = Error(ErrGRPCCorrupt)
)

client-side error

var (
    MetadataRequireLeaderKey = "hasleader"
    MetadataHasLeader        = "true"
)
var (
    TokenFieldNameGRPC    = "token"
    TokenFieldNameSwagger = "authorization"
)

func Error Uses

func Error(err error) error

func ErrorDesc Uses

func ErrorDesc(err error) string

type EtcdError Uses

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

EtcdError defines gRPC server errors. (https://github.com/grpc/grpc-go/blob/master/rpc_util.go#L319-L323)

func (EtcdError) Code Uses

func (e EtcdError) Code() codes.Code

Code returns grpc/codes.Code. TODO: define clientv3/codes.Code.

func (EtcdError) Error Uses

func (e EtcdError) Error() string

Package rpctypes imports 2 packages (graph) and is imported by 72 packages. Updated 2018-09-25. Refresh now. Tools for package owners.