package
2.33.0
Repository: https://github.com/fluxninja/aperture-go.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author

# Functions

FlowStatusString retrieves an enum value from the enum constants string name.
FlowStatusStrings returns a slice of all String values of the enum.
FlowStatusValues returns all values of the enum.
NewClient returns a new Client that can be used to perform Check calls.

# Constants

Error indicate error on flow execution.
LookupStatusHit indicates that the cache lookup was a hit.
LookupStatusMiss indicates that the cache lookup was a miss.
OK indicates successful flow execution.
OperationStatusError indicates that the cache operation was unsuccessful.
OperationStatusSuccess indicates that the cache operation was successful.

# Variables

ErrKeyMissingFromGlobalCacheResponse is returned when the global cache response does not contain the key.
ErrResultCacheKeyNotSet is returned when empty result cache key is provided by the caller during start flow.
ErrResultCacheResponseNil is returned when the result cache response is nil.

# Structs

CacheEntry describes the properties of cache entry.
EndResponse is the response returned by the End method of the Flow interface.
FlowParams is a struct that contains parameters for StartFlow call.
MiddlewareParams is the interface for the middleware params.
Options that the user can pass to Aperture in order to receive a new Client.

# Interfaces

Client is the interface that is provided to the user upon which they can perform Check calls for their service and eventually shut down in case of error.
Flow is the interface that is returned to the user every time a CheckHTTP call through ApertureClient is made.
HTTPFlow is the interface that is returned to the user every time a CheckHTTP call through ApertureClient is made.
KeyDeleteResponse is the interface to read the response from a delete cached value operation.
KeyLookupResponse is the interface to read the response from a get cached value operation.
KeyUpsertResponse is the interface to read the response from a set cached value operation.

# Type aliases

FlowStatus represents status of flow execution.
LookupStatus is the status of a cache lookup, either HIT or MISS.
OperationStatus is the status of a cache operation, either SUCCESS or ERROR.