storage

Documentation

Overview

Package storage implements the Storage domain.

Index

• func NewClient(conn *rpcc.Conn) *domainClient
• type CacheStorageContentUpdatedClient
• type CacheStorageContentUpdatedReply
• type CacheStorageListUpdatedClient
• type CacheStorageListUpdatedReply
• type ClearDataForOriginArgs
  • func NewClearDataForOriginArgs(origin string, storageTypes string) *ClearDataForOriginArgs
• type GetUsageAndQuotaArgs
  • func NewGetUsageAndQuotaArgs(origin string) *GetUsageAndQuotaArgs
• type GetUsageAndQuotaReply
• type TrackCacheStorageForOriginArgs
  • func NewTrackCacheStorageForOriginArgs(origin string) *TrackCacheStorageForOriginArgs
• type Type
  • func (e Type) String() string
  • func (e Type) Valid() bool
• type UntrackCacheStorageForOriginArgs
  • func NewUntrackCacheStorageForOriginArgs(origin string) *UntrackCacheStorageForOriginArgs
• type UsageForType

Functions

func NewClient

func NewClient(conn *rpcc.Conn) *domainClient

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

Types

type CacheStorageContentUpdatedClient

type CacheStorageContentUpdatedClient interface {
	// Recv calls RecvMsg on rpcc.Stream, blocks until the event is
	// triggered, context canceled or connection closed.
	Recv() (*CacheStorageContentUpdatedReply, error)
	rpcc.Stream
}

CacheStorageContentUpdatedClient is a client for CacheStorageContentUpdated events. A cache's contents have been modified.

type CacheStorageContentUpdatedReply

type CacheStorageContentUpdatedReply struct {
	Origin    string `json:"origin"`    // Origin to update.
	CacheName string `json:"cacheName"` // Name of cache in origin.
}

CacheStorageContentUpdatedReply is the reply for CacheStorageContentUpdated events.

type CacheStorageListUpdatedClient

type CacheStorageListUpdatedClient interface {
	// Recv calls RecvMsg on rpcc.Stream, blocks until the event is
	// triggered, context canceled or connection closed.
	Recv() (*CacheStorageListUpdatedReply, error)
	rpcc.Stream
}

CacheStorageListUpdatedClient is a client for CacheStorageListUpdated events. A cache has been added/deleted.

type CacheStorageListUpdatedReply

type CacheStorageListUpdatedReply struct {
	Origin string `json:"origin"` // Origin to update.
}

CacheStorageListUpdatedReply is the reply for CacheStorageListUpdated events.

type ClearDataForOriginArgs

type ClearDataForOriginArgs struct {
	Origin       string `json:"origin"`       // Security origin.
	StorageTypes string `json:"storageTypes"` // Comma separated origin names.
}

ClearDataForOriginArgs represents the arguments for ClearDataForOrigin in the Storage domain.

func NewClearDataForOriginArgs

func NewClearDataForOriginArgs(origin string, storageTypes string) *ClearDataForOriginArgs

NewClearDataForOriginArgs initializes ClearDataForOriginArgs with the required arguments.

type GetUsageAndQuotaArgs

type GetUsageAndQuotaArgs struct {
	Origin string `json:"origin"` // Security origin.
}

GetUsageAndQuotaArgs represents the arguments for GetUsageAndQuota in the Storage domain.

func NewGetUsageAndQuotaArgs

func NewGetUsageAndQuotaArgs(origin string) *GetUsageAndQuotaArgs

NewGetUsageAndQuotaArgs initializes GetUsageAndQuotaArgs with the required arguments.

type GetUsageAndQuotaReply

type GetUsageAndQuotaReply struct {
	Usage          float64        `json:"usage"`          // Storage usage (bytes).
	Quota          float64        `json:"quota"`          // Storage quota (bytes).
	UsageBreakdown []UsageForType `json:"usageBreakdown"` // Storage usage per type (bytes).
}

GetUsageAndQuotaReply represents the return values for GetUsageAndQuota in the Storage domain.

type TrackCacheStorageForOriginArgs

type TrackCacheStorageForOriginArgs struct {
	Origin string `json:"origin"` // Security origin.
}

TrackCacheStorageForOriginArgs represents the arguments for TrackCacheStorageForOrigin in the Storage domain.

func NewTrackCacheStorageForOriginArgs

func NewTrackCacheStorageForOriginArgs(origin string) *TrackCacheStorageForOriginArgs

NewTrackCacheStorageForOriginArgs initializes TrackCacheStorageForOriginArgs with the required arguments.

type Type

type Type string

Type Enum of possible storage types.

const (
	TypeNotSet         Type = ""
	TypeAppcache       Type = "appcache"
	TypeCookies        Type = "cookies"
	TypeFileSystems    Type = "file_systems"
	TypeIndexeddb      Type = "indexeddb"
	TypeLocalStorage   Type = "local_storage"
	TypeShaderCache    Type = "shader_cache"
	TypeWebsql         Type = "websql"
	TypeServiceWorkers Type = "service_workers"
	TypeCacheStorage   Type = "cache_storage"
	TypeAll            Type = "all"
	TypeOther          Type = "other"
)

Type as enums.

func (Type) String

func (e Type) String() string

func (Type) Valid

func (e Type) Valid() bool

type UntrackCacheStorageForOriginArgs

type UntrackCacheStorageForOriginArgs struct {
	Origin string `json:"origin"` // Security origin.
}

UntrackCacheStorageForOriginArgs represents the arguments for UntrackCacheStorageForOrigin in the Storage domain.

func NewUntrackCacheStorageForOriginArgs

func NewUntrackCacheStorageForOriginArgs(origin string) *UntrackCacheStorageForOriginArgs

NewUntrackCacheStorageForOriginArgs initializes UntrackCacheStorageForOriginArgs with the required arguments.

type UsageForType

type UsageForType struct {
	StorageType Type    `json:"storageType"` // Name of storage type.
	Usage       float64 `json:"usage"`       // Storage usage (bytes).
}

UsageForType Usage for a storage type.