v0.0.0-...-fe161b3 Latest Latest

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

Go to latest
Published: Nov 12, 2020 License: Apache-2.0 Imports: 13 Imported by: 0




This section is empty.


This section is empty.


This section is empty.


type HandlerList

type HandlerList struct {
	// contains filtered or unexported fields

A HandlerList manages zero or more handlers in a list.

func (*HandlerList) Clear

func (l *HandlerList) Clear()

Clear clears the handler list.

func (*HandlerList) Len

func (l *HandlerList) Len() int

Len returns the number of handlers in the list.

func (*HandlerList) PushBack

func (l *HandlerList) PushBack(f func(*Request))

PushBack pushes handler f to the back of the handler list.

func (*HandlerList) PushBackNamed

func (l *HandlerList) PushBackNamed(n NamedHandler)

PushBackNamed pushes named handler f to the back of the handler list.

func (*HandlerList) PushFront

func (l *HandlerList) PushFront(f func(*Request))

PushFront pushes handler f to the front of the handler list.

func (*HandlerList) PushFrontNamed

func (l *HandlerList) PushFrontNamed(n NamedHandler)

PushFrontNamed pushes named handler f to the front of the handler list.

func (*HandlerList) Remove

func (l *HandlerList) Remove(n NamedHandler)

Remove removes a NamedHandler n

func (*HandlerList) Run

func (l *HandlerList) Run(r *Request)

Run executes all handlers in the list with a given request object.

type Handlers

type Handlers struct {
	Validate         HandlerList
	Build            HandlerList
	Sign             HandlerList
	Send             HandlerList
	ValidateResponse HandlerList
	Unmarshal        HandlerList
	UnmarshalMeta    HandlerList
	UnmarshalError   HandlerList
	Retry            HandlerList
	AfterRetry       HandlerList

A Handlers provides a collection of request handlers for various stages of handling requests.

func (*Handlers) Clear

func (h *Handlers) Clear()

Clear removes callback functions for all handlers

func (*Handlers) Copy

func (h *Handlers) Copy() Handlers

Copy returns of this handler's lists.

type NamedHandler

type NamedHandler struct {
	Name string
	Fn   func(*Request)

A NamedHandler is a struct that contains a name and function callback.

type Operation

type Operation struct {
	Name       string
	HTTPMethod string
	HTTPPath   string

An Operation is the service API operation to be made.

type Paginator

type Paginator struct {
	InputTokens     []string
	OutputTokens    []string
	LimitToken      string
	TruncationToken string

Paginator keeps track of pagination configuration for an API operation.

type Request

type Request struct {
	Config     aws.Config
	ClientInfo metadata.ClientInfo
	Handlers   Handlers

	Time         time.Time
	ExpireTime   time.Duration
	Operation    *Operation
	HTTPRequest  *http.Request
	HTTPResponse *http.Response
	Body         io.ReadSeeker
	BodyStart    int64 // offset from beginning of Body that the request body starts
	Params       interface{}
	Error        error
	Data         interface{}
	RequestID    string
	RetryCount   int
	Retryable    *bool
	RetryDelay   time.Duration
	// contains filtered or unexported fields

A Request is the service request to be made.

func New

func New(cfg aws.Config, clientInfo metadata.ClientInfo, handlers Handlers,
	retryer Retryer, operation *Operation, params interface{}, data interface{}) *Request

New returns a new Request pointer for the service API operation and parameters.

Params is any value of input parameters to be the request payload. Data is pointer value to an object which the request's response payload will be deserialized to.

func (*Request) Build

func (r *Request) Build() error

Build will build the request's object so it can be signed and sent to the service. Build will also validate all the request's parameters. Anny additional build Handlers set on this request will be run in the order they were set.

The request will only be built once. Multiple calls to build will have no effect.

If any Validate or Build errors occur the build will stop and the error which occurred will be returned.

func (*Request) DataFilled

func (r *Request) DataFilled() bool

DataFilled returns true if the request's data for response deserialization target has been set and is a valid. False is returned if data is not set, or is invalid.

func (*Request) EachPage

func (r *Request) EachPage(fn func(data interface{}, isLastPage bool) (shouldContinue bool)) error

EachPage iterates over each page of a paginated request object. The fn parameter should be a function with the following sample signature:

func(page *T, lastPage bool) bool {
    return true // return false to stop iterating

Where "T" is the structure type matching the output structure of the given operation. For example, a request object generated by DynamoDB.ListTablesRequest() would expect to see dynamodb.ListTablesOutput as the structure "T". The lastPage value represents whether the page is the last page of data or not. The return value of this function should return true to keep iterating or false to stop.

func (*Request) HasNextPage

func (r *Request) HasNextPage() bool

HasNextPage returns true if this request has more pages of data available.

func (*Request) IsErrorExpired

func (r *Request) IsErrorExpired() bool

IsErrorExpired returns whether the error code is a credential expiry error. Returns false if the request has no Error set.

func (*Request) IsErrorRetryable

func (r *Request) IsErrorRetryable() bool

IsErrorRetryable returns whether the error is retryable, based on its Code. Returns false if the request has no Error set.

func (*Request) NextPage

func (r *Request) NextPage() *Request

NextPage returns a new Request that can be executed to return the next page of result data. Call .Send() on this request to execute it.

func (*Request) ParamsFilled

func (r *Request) ParamsFilled() bool

ParamsFilled returns if the request's parameters have been populated and the parameters are valid. False is returned if no parameters are provided or invalid.

func (*Request) Presign

func (r *Request) Presign(expireTime time.Duration) (string, error)

Presign returns the request's signed URL. Error will be returned if the signing fails.

func (*Request) Send

func (r *Request) Send() error

Send will send the request returning error if errors are encountered.

Send will sign the request prior to sending. All Send Handlers will be executed in the order they were set.

func (*Request) SetBufferBody

func (r *Request) SetBufferBody(buf []byte)

SetBufferBody will set the request's body bytes that will be sent to the service API.

func (*Request) SetReaderBody

func (r *Request) SetReaderBody(reader io.ReadSeeker)

SetReaderBody will set the request's body reader.

func (*Request) SetStringBody

func (r *Request) SetStringBody(s string)

SetStringBody sets the body of the request to be backed by a string.

func (*Request) Sign

func (r *Request) Sign() error

Sign will sign the request retuning error if errors are encountered.

Send will build the request prior to signing. All Sign Handlers will be executed in the order they were set.

func (*Request) WillRetry

func (r *Request) WillRetry() bool

WillRetry returns if the request's can be retried.

type Retryer

type Retryer interface {
	RetryRules(*Request) time.Duration
	ShouldRetry(*Request) bool
	MaxRetries() int

Retryer is an interface to control retry logic for a given service. The default implementation used by most services is the service.DefaultRetryer structure, which contains basic retry logic using exponential backoff.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL