get_item

Documentation

Overview

Support for the DynamoDB GetItem endpoint.

example use:

tests/get_item-livestest.go

Index

• Constants
• type Get
  • func NewGet() *Get
  • func (get *Get) EndpointReq() (string, int, error)
• type GetItem
  • func NewGetItem() *GetItem
  • func (get_item *GetItem) EndpointReq() (string, int, error)
• type Request
  • func (req *Request) EndpointReq() (string, int, error)
• type Response
  • func NewResponse() *Response
  • func (r Response) MarshalJSON() ([]byte, error)
  • func (resp *Response) ToResponseItemJSON() (*ResponseItemJSON, error)
• type ResponseItemJSON
  • func NewResponseItemJSON() *ResponseItemJSON
  • func (r ResponseItemJSON) MarshalJSON() ([]byte, error)

Constants

const (
	ENDPOINT_NAME      = "GetItem"
	JSON_ENDPOINT_NAME = ENDPOINT_NAME + "JSON"
	GETITEM_ENDPOINT   = aws_const.ENDPOINT_PREFIX + ENDPOINT_NAME
)

Types

type Get

type Get GetItem

Get is an alias for backwards compatibility

func NewGet

func NewGet() *Get

func (*Get) EndpointReq

func (get *Get) EndpointReq() (string, int, error)

type GetItem

type GetItem struct {
	AttributesToGet          attributestoget.AttributesToGet                   `json:",omitempty"`
	ConsistentRead           bool                                              // false is sane default
	ExpressionAttributeNames expressionattributenames.ExpressionAttributeNames `json:",omitempty"`
	Key                      item.Key
	ProjectionExpression     string `json:",omitempty"`
	ReturnConsumedCapacity   string `json:",omitempty"`
	TableName                string
}

func NewGetItem

func NewGetItem() *GetItem

func (*GetItem) EndpointReq

func (get_item *GetItem) EndpointReq() (string, int, error)

type Request

type Request GetItem

func (*Request) EndpointReq

func (req *Request) EndpointReq() (string, int, error)

type Response

type Response struct {
	Item             item.Item
	ConsumedCapacity *capacity.ConsumedCapacity `json:",omitempty"`
}

func NewResponse

func NewResponse() *Response

func (Response) MarshalJSON

func (r Response) MarshalJSON() ([]byte, error)

Some work required to omit empty ConsumedCapacity fields

func (*Response) ToResponseItemJSON

func (resp *Response) ToResponseItemJSON() (*ResponseItemJSON, error)

ToResponseItemJSON will try to convert the Response to a ResponseItemJSON, where the interface value for Item represents a structure that can be marshaled into basic JSON.

type ResponseItemJSON

type ResponseItemJSON struct {
	Item             interface{}
	ConsumedCapacity *capacity.ConsumedCapacity `json:",omitempty"`
}

ResponseItemJSON can be formed from a Response when the caller wishes to receive the Item as basic JSON.

func NewResponseItemJSON

func NewResponseItemJSON() *ResponseItemJSON

func (ResponseItemJSON) MarshalJSON

func (r ResponseItemJSON) MarshalJSON() ([]byte, error)

Some work required to omit empty ConsumedCapacity fields