cachestorage

Documentation

Overview

Package cachestorage implements the CacheStorage domain.

Index

• func NewClient(conn *rpcc.Conn) *domainClient
• type Cache
• type CacheID
• type CachedResponse
• type CachedResponseType
  • func (e CachedResponseType) String() string
  • func (e CachedResponseType) Valid() bool
• type DataEntry
• type DeleteCacheArgs
  • func NewDeleteCacheArgs(cacheID CacheID) *DeleteCacheArgs
• type DeleteEntryArgs
  • func NewDeleteEntryArgs(cacheID CacheID, request string) *DeleteEntryArgs
• type Header
• type RequestCacheNamesArgs
  • func NewRequestCacheNamesArgs(securityOrigin string) *RequestCacheNamesArgs
• type RequestCacheNamesReply
• type RequestCachedResponseArgs
  • func NewRequestCachedResponseArgs(cacheID CacheID, requestURL string, requestHeaders []Header) *RequestCachedResponseArgs
• type RequestCachedResponseReply
• type RequestEntriesArgs
  • func NewRequestEntriesArgs(cacheID CacheID) *RequestEntriesArgs
  • func (a *RequestEntriesArgs) SetPageSize(pageSize int) *RequestEntriesArgs
  • func (a *RequestEntriesArgs) SetPathFilter(pathFilter string) *RequestEntriesArgs
  • func (a *RequestEntriesArgs) SetSkipCount(skipCount int) *RequestEntriesArgs
• type RequestEntriesReply

Functions

func NewClient

func NewClient(conn *rpcc.Conn) *domainClient

NewClient returns a client for the CacheStorage domain with the connection set to conn.

Types

type Cache

type Cache struct {
	CacheID        CacheID `json:"cacheId"`        // An opaque unique id of the cache.
	SecurityOrigin string  `json:"securityOrigin"` // Security origin of the cache.
	CacheName      string  `json:"cacheName"`      // The name of the cache.
}

Cache Cache identifier.

type CacheID

type CacheID string

CacheID Unique identifier of the Cache object.

type CachedResponse

type CachedResponse struct {
	Body []byte `json:"body"` // Entry content, base64-encoded. (Encoded as a base64 string when passed over JSON)
}

CachedResponse Cached response

type CachedResponseType

type CachedResponseType string

CachedResponseType type of HTTP response cached

const (
	CachedResponseTypeNotSet         CachedResponseType = ""
	CachedResponseTypeBasic          CachedResponseType = "basic"
	CachedResponseTypeCORS           CachedResponseType = "cors"
	CachedResponseTypeDefault        CachedResponseType = "default"
	CachedResponseTypeError          CachedResponseType = "error"
	CachedResponseTypeOpaqueResponse CachedResponseType = "opaqueResponse"
	CachedResponseTypeOpaqueRedirect CachedResponseType = "opaqueRedirect"
)

CachedResponseType as enums.

func (CachedResponseType) String

func (e CachedResponseType) String() string

func (CachedResponseType) Valid

func (e CachedResponseType) Valid() bool

type DataEntry

type DataEntry struct {
	RequestURL         string             `json:"requestURL"`         // Request URL.
	RequestMethod      string             `json:"requestMethod"`      // Request method.
	RequestHeaders     []Header           `json:"requestHeaders"`     // Request headers
	ResponseTime       float64            `json:"responseTime"`       // Number of seconds since epoch.
	ResponseStatus     int                `json:"responseStatus"`     // HTTP response status code.
	ResponseStatusText string             `json:"responseStatusText"` // HTTP response status text.
	ResponseType       CachedResponseType `json:"responseType"`       // HTTP response type
	ResponseHeaders    []Header           `json:"responseHeaders"`    // Response headers
}

DataEntry Data entry.

type DeleteCacheArgs

type DeleteCacheArgs struct {
	CacheID CacheID `json:"cacheId"` // Id of cache for deletion.
}

DeleteCacheArgs represents the arguments for DeleteCache in the CacheStorage domain.

func NewDeleteCacheArgs

func NewDeleteCacheArgs(cacheID CacheID) *DeleteCacheArgs

NewDeleteCacheArgs initializes DeleteCacheArgs with the required arguments.

type DeleteEntryArgs

type DeleteEntryArgs struct {
	CacheID CacheID `json:"cacheId"` // Id of cache where the entry will be deleted.
	Request string  `json:"request"` // URL spec of the request.
}

DeleteEntryArgs represents the arguments for DeleteEntry in the CacheStorage domain.

func NewDeleteEntryArgs

func NewDeleteEntryArgs(cacheID CacheID, request string) *DeleteEntryArgs

NewDeleteEntryArgs initializes DeleteEntryArgs with the required arguments.

type Header

type Header struct {
	Name  string `json:"name"`  // No description.
	Value string `json:"value"` // No description.
}

Header

type RequestCacheNamesArgs

type RequestCacheNamesArgs struct {
	SecurityOrigin string `json:"securityOrigin"` // Security origin.
}

RequestCacheNamesArgs represents the arguments for RequestCacheNames in the CacheStorage domain.

func NewRequestCacheNamesArgs

func NewRequestCacheNamesArgs(securityOrigin string) *RequestCacheNamesArgs

NewRequestCacheNamesArgs initializes RequestCacheNamesArgs with the required arguments.

type RequestCacheNamesReply

type RequestCacheNamesReply struct {
	Caches []Cache `json:"caches"` // Caches for the security origin.
}

RequestCacheNamesReply represents the return values for RequestCacheNames in the CacheStorage domain.

type RequestCachedResponseArgs

type RequestCachedResponseArgs struct {
	CacheID        CacheID  `json:"cacheId"`        // Id of cache that contains the entry.
	RequestURL     string   `json:"requestURL"`     // URL spec of the request.
	RequestHeaders []Header `json:"requestHeaders"` // headers of the request.
}

RequestCachedResponseArgs represents the arguments for RequestCachedResponse in the CacheStorage domain.

func NewRequestCachedResponseArgs

func NewRequestCachedResponseArgs(cacheID CacheID, requestURL string, requestHeaders []Header) *RequestCachedResponseArgs

NewRequestCachedResponseArgs initializes RequestCachedResponseArgs with the required arguments.

type RequestCachedResponseReply

type RequestCachedResponseReply struct {
	Response CachedResponse `json:"response"` // Response read from the cache.
}

RequestCachedResponseReply represents the return values for RequestCachedResponse in the CacheStorage domain.

type RequestEntriesArgs

type RequestEntriesArgs struct {
	CacheID    CacheID `json:"cacheId"`              // ID of cache to get entries from.
	SkipCount  *int    `json:"skipCount,omitempty"`  // Number of records to skip.
	PageSize   *int    `json:"pageSize,omitempty"`   // Number of records to fetch.
	PathFilter *string `json:"pathFilter,omitempty"` // If present, only return the entries containing this substring in the path
}

RequestEntriesArgs represents the arguments for RequestEntries in the CacheStorage domain.

func NewRequestEntriesArgs

func NewRequestEntriesArgs(cacheID CacheID) *RequestEntriesArgs

NewRequestEntriesArgs initializes RequestEntriesArgs with the required arguments.

func (*RequestEntriesArgs) SetPageSize

func (a *RequestEntriesArgs) SetPageSize(pageSize int) *RequestEntriesArgs

SetPageSize sets the PageSize optional argument. Number of records to fetch.

func (*RequestEntriesArgs) SetPathFilter

func (a *RequestEntriesArgs) SetPathFilter(pathFilter string) *RequestEntriesArgs

SetPathFilter sets the PathFilter optional argument. If present, only return the entries containing this substring in the path

func (*RequestEntriesArgs) SetSkipCount

func (a *RequestEntriesArgs) SetSkipCount(skipCount int) *RequestEntriesArgs

SetSkipCount sets the SkipCount optional argument. Number of records to skip.

type RequestEntriesReply

type RequestEntriesReply struct {
	CacheDataEntries []DataEntry `json:"cacheDataEntries"` // Array of object store data entries.
	ReturnCount      float64     `json:"returnCount"`      // Count of returned entries from this storage. If pathFilter is empty, it is the count of all entries from this storage.
}

RequestEntriesReply represents the return values for RequestEntries in the CacheStorage domain.