remoterepoapi

Documentation

Overview

Package remoterepoapi contains requests and responses for remote repository API.

Index

• type ApplyRetentionPolicyRequest
• type ApplyRetentionPolicyResponse
• type ManifestWithMetadata
• type Parameters
  • func (p *Parameters) GetHashFunction() string
  • func (p *Parameters) GetHmacSecret() []byte
• type PrefetchContentsRequest
• type PrefetchContentsResponse

Types

type ApplyRetentionPolicyRequest

type ApplyRetentionPolicyRequest struct {
	SourcePath   string `json:"sourcePath"`
	ReallyDelete bool   `json:"reallyDelete"`
}

ApplyRetentionPolicyRequest represents a request to apply retention policy to a given source path.

type ApplyRetentionPolicyResponse

type ApplyRetentionPolicyResponse struct {
	ManifestIDs []manifest.ID `json:"manifests"`
}

ApplyRetentionPolicyResponse represents a response to a request to apply retention policy.

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"`

	format.ObjectFormat
}

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 PrefetchContentsRequest

type PrefetchContentsRequest struct {
	ContentIDs []content.ID `json:"contents"`
	Hint       string       `json:"hint"`
}

PrefetchContentsRequest represents a request to prefetch contents.

type PrefetchContentsResponse

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

PrefetchContentsResponse represents a response from request to prefetch contents.