remoterepoapi

Documentation

Overview

Package remoterepoapi contains requests and responses for remote repository API.

Index

• type ManifestWithMetadata
• type Parameters
  • func (p *Parameters) GetHashFunction() string
  • func (p *Parameters) GetHmacSecret() []byte
• type PrefetchObjectsRequest
• type PrefetchObjectsResponse

Types

type ManifestWithMetadata

type ManifestWithMetadata struct {
	Payload  json.RawMessage         `json:"payload"`
	Metadata *manifest.EntryMetadata `json:"metadata"`
}

ManifestWithMetadata represents manifest payload and metadata.

type Parameters

type Parameters struct {
	HashFunction               string `json:"hash"`
	HMACSecret                 []byte `json:"hmacSecret"`
	SupportsContentCompression bool   `json:"supportsContentCompression"`

	object.Format
}

Parameters encapsulates all parameters for repository. returned by /api/v1/repo/parameters.

func (*Parameters) GetHashFunction

func (p *Parameters) GetHashFunction() string

GetHashFunction returns the name of the hash function for remote repository.

func (*Parameters) GetHmacSecret

func (p *Parameters) GetHmacSecret() []byte

GetHmacSecret returns the HMAC secret for the remote repository.

type PrefetchObjectsRequest

type PrefetchObjectsRequest struct {
	ObjectIDs []object.ID `json:"objects"`
}

PrefetchObjectsRequest represents a request to prefetch objects.

type PrefetchObjectsResponse

type PrefetchObjectsResponse struct {
	ContentIDs []content.ID `json:"contents"`
}

PrefetchObjectsResponse represents a request from request prefetch objects.