<!-- Code generated by gomarkdoc. DO NOT EDIT -->

```go
import "github.com/Azure/iot-operations-sdks/go/services/statestore/errors"
```

## Index

- [Variables](<#variables>)
- [type Argument](<#Argument>)
  - [func \(e Argument\) Error\(\) string](<#Argument.Error>)
  - [func \(Argument\) Unwrap\(\) error](<#Argument.Unwrap>)
- [type Payload](<#Payload>)
  - [func \(e Payload\) Error\(\) string](<#Payload.Error>)
  - [func \(Payload\) Unwrap\(\) error](<#Payload.Unwrap>)
- [type Service](<#Service>)
  - [func \(e Service\) Error\(\) string](<#Service.Error>)
  - [func \(Service\) Unwrap\(\) error](<#Service.Unwrap>)


## Variables

<a name="ErrService"></a>

```go
var (
    ErrService  = errors.New("service error")
    ErrPayload  = errors.New("malformed payload")
    ErrArgument = errors.New("invalid argument")
)
```

<a name="Argument"></a>
## type [Argument](<https://github.com/Azure/iot-operations-sdks/blob/main/go/services/statestore/errors/errors.go#L19-L22>)

Argument errors indicate an invalid argument.

```go
type Argument struct {
    Name  string
    Value any
}
```

<a name="Argument.Error"></a>
### func \(Argument\) [Error](<https://github.com/Azure/iot-operations-sdks/blob/main/go/services/statestore/errors/errors.go#L65>)

```go
func (e Argument) Error() string
```



<a name="Argument.Unwrap"></a>
### func \(Argument\) [Unwrap](<https://github.com/Azure/iot-operations-sdks/blob/main/go/services/statestore/errors/errors.go#L69>)

```go
func (Argument) Unwrap() error
```



<a name="Payload"></a>
## type [Payload](<https://github.com/Azure/iot-operations-sdks/blob/main/go/services/statestore/errors/errors.go#L16>)

Payload errors indicate a malformed or unexpected payload returned from the state store.

```go
type Payload string
```

<a name="Payload.Error"></a>
### func \(Payload\) [Error](<https://github.com/Azure/iot-operations-sdks/blob/main/go/services/statestore/errors/errors.go#L57>)

```go
func (e Payload) Error() string
```



<a name="Payload.Unwrap"></a>
### func \(Payload\) [Unwrap](<https://github.com/Azure/iot-operations-sdks/blob/main/go/services/statestore/errors/errors.go#L61>)

```go
func (Payload) Unwrap() error
```



<a name="Service"></a>
## type [Service](<https://github.com/Azure/iot-operations-sdks/blob/main/go/services/statestore/errors/errors.go#L12>)

Service errors indicate an error returned from the state store.

```go
type Service string
```

<a name="TimestampSkew"></a>The following are well\-known error strings returned from the state store.

```go
const (
    TimestampSkew            Service = "the request timestamp is too far in the future; ensure that the client and broker system clocks are synchronized"
    MissingFencingToken      Service = "a fencing token is required for this request"
    FencingTokenSkew         Service = "the request fencing token timestamp is too far in the future; ensure that the client and broker system clocks are synchronized"
    FencingTokenLowerVersion Service = "the request fencing token is a lower version than the fencing token protecting the resource"
    QuotaExceeded            Service = "the quota has been exceeded"
    SyntaxError              Service = "syntax error"
    NotAuthorized            Service = "not authorized"
    UnknownCommand           Service = "unknown command"
    WrongNumberOfArguments   Service = "wrong number of arguments"
    TimestampMissing         Service = "missing timestamp"
    TimestampMalformed       Service = "malformed timestamp"
    KeyLengthZero            Service = "the key length is zero"
)
```

<a name="Service.Error"></a>
### func \(Service\) [Error](<https://github.com/Azure/iot-operations-sdks/blob/main/go/services/statestore/errors/errors.go#L49>)

```go
func (e Service) Error() string
```



<a name="Service.Unwrap"></a>
### func \(Service\) [Unwrap](<https://github.com/Azure/iot-operations-sdks/blob/main/go/services/statestore/errors/errors.go#L53>)

```go
func (Service) Unwrap() error
```



Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
