artifactstore

package
v0.2.20 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 5, 2026 License: MPL-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type API added in v0.2.13 

type API struct {
	// contains filtered or unexported fields
}

API provides the transport-independent Artifact Store API.

The caller owns the lifecycle of the supplied Components.

func Open added in v0.2.20 

func Open(
	ctx context.Context,
	config OpenConfig,
) (*API, error)

Open creates one complete Artifact Store.

The returned API owns the Store lifecycle and must be closed by its application composition owner.

func (*API) AdoptArtifact added in v0.2.20 

func (a *API) AdoptArtifact(
	ctx context.Context,
	request artifact.AdoptRequest,
) (artifact.Artifact, error)

func (*API) AttachCollectionSource added in v0.2.20 

func (a *API) AttachCollectionSource(
	ctx context.Context,
	ref collection.CollectionRef,
	expectedCollectionRevision uint64,
	draft collection.AttachmentDraft,
) (collection.Collection, collection.Attachment, error)

func (*API) CanonicalizeExpected added in v0.2.20 

func (a *API) CanonicalizeExpected(
	ctx context.Context,
	expected providerapi.SchemaKey,
	raw []byte,
) (providerapi.ParsedDocument, error)

func (*API) Close added in v0.2.14 

func (a *API) Close() error

func (*API) CommitTopologyHydration added in v0.2.20 

func (a *API) CommitTopologyHydration(
	ctx context.Context,
	desired topology.Hydration,
) error

func (*API) CreateArtifactRoot added in v0.2.13 

func (a *API) CreateArtifactRoot(
	ctx context.Context,
	request *CreateArtifactRootRequest,
) (*CreateArtifactRootResponse, error)

func (*API) CreateArtifactSource added in v0.2.13 

func (a *API) CreateArtifactSource(
	ctx context.Context,
	request *CreateArtifactSourceRequest,
) (*CreateArtifactSourceResponse, error)

func (*API) CreateCollection added in v0.2.20 

func (a *API) CreateCollection(
	ctx context.Context,
	rootID basespec.RootID,
	draft collection.Draft,
	attachments []collection.AttachmentDraft,
) (collection.Collection, []collection.Attachment, error)

func (*API) CreateSource added in v0.2.20 

func (a *API) CreateSource(
	ctx context.Context,
	rootID basespec.RootID,
	draft source.Draft,
) (source.Summary, error)

func (*API) CreateSourceWithStatus added in v0.2.20 

func (a *API) CreateSourceWithStatus(
	ctx context.Context,
	rootID basespec.RootID,
	draft source.Draft,
) (source.Summary, bool, error)

func (*API) CurrentCollectionCatalog added in v0.2.20 

func (a *API) CurrentCollectionCatalog(
	ctx context.Context,
	ref collection.CollectionRef,
) (catalog.Snapshot, error)

func (*API) DetachCollectionSource added in v0.2.20 

func (a *API) DetachCollectionSource(
	ctx context.Context,
	ref collection.CollectionRef,
	sourceID basespec.SourceID,
	expectedCollectionRevision uint64,
	expectedAttachmentRevision uint64,
) (collection.Collection, error)

func (*API) DiscardSource added in v0.2.20 

func (a *API) DiscardSource(
	ctx context.Context,
	rootID basespec.RootID,
	sourceID basespec.SourceID,
	expectedRevision uint64,
) error

func (*API) EnsureProtectedTopology added in v0.2.20 

func (a *API) EnsureProtectedTopology(
	ctx context.Context,
	declaration topology.Declaration,
) (topology.Installed, error)

func (*API) GetArtifact added in v0.2.20 

func (a *API) GetArtifact(
	ctx context.Context,
	ref artifact.ArtifactRef,
) (artifact.Artifact, error)

func (*API) GetArtifactRoot added in v0.2.13 

func (a *API) GetArtifactRoot(
	ctx context.Context,
	request *GetArtifactRootRequest,
) (*GetArtifactRootResponse, error)

func (*API) GetArtifactSource added in v0.2.13 

func (a *API) GetArtifactSource(
	ctx context.Context,
	request *GetArtifactSourceRequest,
) (*GetArtifactSourceResponse, error)

func (*API) GetCollection added in v0.2.20 

func (a *API) GetCollection(
	ctx context.Context,
	ref collection.CollectionRef,
) (collection.Collection, error)

func (*API) GetCollectionAttachment added in v0.2.20 

func (a *API) GetCollectionAttachment(
	ctx context.Context,
	ref collection.CollectionRef,
	sourceID basespec.SourceID,
) (collection.Attachment, error)

func (*API) GetRetiredCollection added in v0.2.20 

func (a *API) GetRetiredCollection(
	ctx context.Context,
	ref collection.CollectionRef,
) (collection.Collection, error)

func (*API) GetSource added in v0.2.20 

func (a *API) GetSource(
	ctx context.Context,
	rootID basespec.RootID,
	sourceID basespec.SourceID,
) (source.Summary, error)

func (*API) InspectCollectionCatalog added in v0.2.20 

func (a *API) InspectCollectionCatalog(
	ctx context.Context,
	ref collection.CollectionRef,
) (refresh.CatalogInspection, error)

func (*API) IsProtectedRoot added in v0.2.20 

func (a *API) IsProtectedRoot(rootID basespec.RootID) bool

func (*API) ListArtifactRoots added in v0.2.13 

func (a *API) ListArtifactRoots(
	ctx context.Context,
	_ *ListArtifactRootsRequest,
) (*ListArtifactRootsResponse, error)

func (*API) ListArtifactSourceKinds added in v0.2.13 

func (a *API) ListArtifactSourceKinds(
	ctx context.Context,
	_ *ListArtifactSourceKindsRequest,
) (*ListArtifactSourceKindsResponse, error)

func (*API) ListArtifactSources added in v0.2.13 

func (a *API) ListArtifactSources(
	ctx context.Context,
	request *ListArtifactSourcesRequest,
) (*ListArtifactSourcesResponse, error)

func (*API) ListCollectionArtifacts added in v0.2.20 

func (a *API) ListCollectionArtifacts(
	ctx context.Context,
	ref collection.CollectionRef,
) ([]artifact.Artifact, error)

func (*API) ListCollectionAttachments added in v0.2.20 

func (a *API) ListCollectionAttachments(
	ctx context.Context,
	ref collection.CollectionRef,
) ([]collection.Attachment, error)

func (*API) ListCollectionSuppressions added in v0.2.20 

func (a *API) ListCollectionSuppressions(
	ctx context.Context,
	ref collection.CollectionRef,
) ([]artifact.Suppression, error)

func (*API) ListCollections added in v0.2.20 

func (a *API) ListCollections(
	ctx context.Context,
	rootID basespec.RootID,
) ([]collection.Collection, error)

func (*API) PinArtifact added in v0.2.20 

func (a *API) PinArtifact(
	ctx context.Context,
	request artifact.PinRequest,
) (artifact.Artifact, error)

func (*API) PrepareTopologyHydrations added in v0.2.20 

func (a *API) PrepareTopologyHydrations(
	ctx context.Context,
	desired []topology.Hydration,
) (map[string]bool, error)

func (*API) PublishManagedArtifact added in v0.2.20 

func (a *API) PublishManagedArtifact(
	ctx context.Context,
	request managedartifact.PublishRequest,
) (managedartifact.PublishResult, error)

func (*API) PublishManagedCollection added in v0.2.20 

func (a *API) PublishManagedCollection(
	ctx context.Context,
	request managedartifact.PublishCollectionRequest,
) (managedartifact.PublishCollectionResult, error)

func (*API) PurgeAndSuppressArtifact added in v0.2.20 

func (a *API) PurgeAndSuppressArtifact(
	ctx context.Context,
	ref artifact.ArtifactRef,
	expectedRevision uint64,
) error

func (*API) PurgeArtifact added in v0.2.13 

func (a *API) PurgeArtifact(
	ctx context.Context,
	ref artifact.ArtifactRef,
	expectedRevision uint64,
) error

func (*API) PurgeArtifactRoot added in v0.2.13 

func (a *API) PurgeArtifactRoot(
	ctx context.Context,
	request *PurgeArtifactRootRequest,
) (*PurgeArtifactRootResponse, error)

func (*API) PurgeArtifactSource added in v0.2.13 

func (a *API) PurgeArtifactSource(
	ctx context.Context,
	request *PurgeArtifactSourceRequest,
) (*PurgeArtifactSourceResponse, error)

func (*API) PurgeCollection added in v0.2.20 

func (a *API) PurgeCollection(
	ctx context.Context,
	ref collection.CollectionRef,
	expectedRevision uint64,
) error

func (*API) ReadCollectionEntry added in v0.2.20 

func (a *API) ReadCollectionEntry(
	ctx context.Context,
	ref collection.CollectionRef,
	sourceID basespec.SourceID,
	locator basespec.Locator,
	maximumBytes int64,
) (artifactAPI.VerifiedEntry, error)

func (*API) RefreshCollection added in v0.2.20 

func (a *API) RefreshCollection(
	ctx context.Context,
	ref collection.CollectionRef,
) (refresh.Result, error)

func (*API) RemoveManagedArtifact added in v0.2.20 

func (a *API) RemoveManagedArtifact(
	ctx context.Context,
	request managedartifact.RemoveRequest,
) error

func (*API) ReplaceCollectionAttachment added in v0.2.20 

func (a *API) ReplaceCollectionAttachment(
	ctx context.Context,
	ref collection.CollectionRef,
	replacement collection.AttachmentReplacement,
) (collection.Collection, collection.Attachment, error)

func (*API) RequirePrivilegedInstaller added in v0.2.20 

func (a *API) RequirePrivilegedInstaller(ctx context.Context) error

func (*API) ResolveArtifact added in v0.2.20 

func (a *API) ResolveArtifact(
	ctx context.Context,
	ref artifact.ArtifactRef,
	options artifactAPI.ResolveOptions,
) (artifactAPI.ResolvedArtifact, error)

func (*API) ResolveSourceLocalPath added in v0.2.20 

func (a *API) ResolveSourceLocalPath(
	ctx context.Context,
	rootID basespec.RootID,
	sourceID basespec.SourceID,
	locator basespec.Locator,
) (string, error)

func (*API) ResolveVerifiedLocalPath added in v0.2.20 

func (a *API) ResolveVerifiedLocalPath(
	ctx context.Context,
	resolved artifactAPI.ResolvedArtifact,
	localLocator basespec.Locator,
) (string, error)

func (*API) RetireArtifactRoot added in v0.2.13 

func (a *API) RetireArtifactRoot(
	ctx context.Context,
	request *RetireArtifactRootRequest,
) (*RetireArtifactRootResponse, error)

func (*API) RetireArtifactSource added in v0.2.13 

func (a *API) RetireArtifactSource(
	ctx context.Context,
	request *RetireArtifactSourceRequest,
) (*RetireArtifactSourceResponse, error)

func (*API) RetireCollection added in v0.2.20 

func (a *API) RetireCollection(
	ctx context.Context,
	ref collection.CollectionRef,
	expectedRevision uint64,
) (collection.Collection, error)

func (*API) SetArtifactEnabled added in v0.2.20 

func (a *API) SetArtifactEnabled(
	ctx context.Context,
	ref artifact.ArtifactRef,
	expectedRevision uint64,
	enabled bool,
) (artifact.Artifact, error)

func (*API) SetArtifactName added in v0.2.20 

func (a *API) SetArtifactName(
	ctx context.Context,
	ref artifact.ArtifactRef,
	expectedRevision uint64,
	name string,
) (artifact.Artifact, error)

func (*API) SupportsLocalPath added in v0.2.20 

func (a *API) SupportsLocalPath(kind basespec.SourceKind) bool

func (*API) SuppressBinding added in v0.2.20 

func (a *API) SuppressBinding(
	ctx context.Context,
	request artifact.SuppressRequest,
) (artifact.Suppression, error)

func (*API) UnadoptArtifact added in v0.2.20 

func (a *API) UnadoptArtifact(
	ctx context.Context,
	ref artifact.ArtifactRef,
	expectedRevision uint64,
	suppress bool,
) error

func (*API) UnsuppressBinding added in v0.2.20 

func (a *API) UnsuppressBinding(
	ctx context.Context,
	ref collection.CollectionRef,
	binding artifact.SourceBinding,
	expectedRevision uint64,
) error

func (*API) UpdateArtifactData added in v0.2.20 

func (a *API) UpdateArtifactData(
	ctx context.Context,
	ref artifact.ArtifactRef,
	expectedRevision uint64,
	data json.RawMessage,
) (artifact.Artifact, error)

func (*API) UpdateArtifactRoot added in v0.2.13 

func (a *API) UpdateArtifactRoot(
	ctx context.Context,
	request *UpdateArtifactRootRequest,
) (*UpdateArtifactRootResponse, error)

func (*API) UpdateArtifactSource added in v0.2.13 

func (a *API) UpdateArtifactSource(
	ctx context.Context,
	request *UpdateArtifactSourceRequest,
) (*UpdateArtifactSourceResponse, error)

func (*API) UpdateCollection added in v0.2.20 

func (a *API) UpdateCollection(
	ctx context.Context,
	ref collection.CollectionRef,
	update collection.Update,
) (collection.Collection, error)

func (*API) UpdateCollectionAttachment added in v0.2.20 

func (a *API) UpdateCollectionAttachment(
	ctx context.Context,
	ref collection.CollectionRef,
	sourceID basespec.SourceID,
	update collection.AttachmentUpdate,
) (collection.Collection, collection.Attachment, error)

type ArtifactSourceDraft added in v0.2.13 

type ArtifactSourceDraft struct {
	ID          basespec.SourceID   `json:"id"          required:"true"`
	StorageKey  basespec.StorageKey `json:"storageKey"  required:"true"`
	Kind        basespec.SourceKind `json:"kind"        required:"true"`
	DisplayName string              `json:"displayName" required:"true"`
	Enabled     bool                `json:"enabled"`
	Config      json.RawMessage     `json:"config"`
}

ArtifactSourceDraft is write-only. Source configuration can contain local filesystem paths or provider credentials and is not returned by the API.

type CreateArtifactRootRequest added in v0.2.13 

type CreateArtifactRootRequest struct {
	Body *root.RootDraft
}

type CreateArtifactRootResponse added in v0.2.13 

type CreateArtifactRootResponse struct {
	Body *root.Root
}

type CreateArtifactSourceRequest added in v0.2.13 

type CreateArtifactSourceRequest struct {
	RootID basespec.RootID `path:"rootID" required:"true"`
	Body   *ArtifactSourceDraft
}

type CreateArtifactSourceResponse added in v0.2.13 

type CreateArtifactSourceResponse struct {
	Body *source.Summary
}

type GetArtifactRootRequest added in v0.2.13 

type GetArtifactRootRequest struct {
	RootID basespec.RootID `path:"rootID" required:"true"`
}

type GetArtifactRootResponse added in v0.2.13 

type GetArtifactRootResponse struct {
	Body *root.Root
}

type GetArtifactSourceRequest added in v0.2.13 

type GetArtifactSourceRequest struct {
	RootID   basespec.RootID   `path:"rootID"   required:"true"`
	SourceID basespec.SourceID `path:"sourceID" required:"true"`
}

type GetArtifactSourceResponse added in v0.2.13 

type GetArtifactSourceResponse struct {
	Body *source.Summary
}

type ListArtifactRootsRequest added in v0.2.13 

type ListArtifactRootsRequest struct{}

type ListArtifactRootsResponse added in v0.2.13 

type ListArtifactRootsResponse struct {
	Body *ListArtifactRootsResponseBody
}

type ListArtifactRootsResponseBody added in v0.2.13 

type ListArtifactRootsResponseBody struct {
	Roots []root.Root `json:"roots"`
}

type ListArtifactSourceKindsRequest added in v0.2.13 

type ListArtifactSourceKindsRequest struct{}

type ListArtifactSourceKindsResponse added in v0.2.13 

type ListArtifactSourceKindsResponse struct {
	Body *ListArtifactSourceKindsResponseBody
}

type ListArtifactSourceKindsResponseBody added in v0.2.13 

type ListArtifactSourceKindsResponseBody struct {
	Kinds []basespec.SourceKind `json:"kinds"`
}

type ListArtifactSourcesRequest added in v0.2.13 

type ListArtifactSourcesRequest struct {
	RootID basespec.RootID `path:"rootID" required:"true"`
}

type ListArtifactSourcesResponse added in v0.2.13 

type ListArtifactSourcesResponse struct {
	Body *ListArtifactSourcesResponseBody
}

type ListArtifactSourcesResponseBody added in v0.2.13 

type ListArtifactSourcesResponseBody struct {
	Sources []source.Summary `json:"sources"`
}

type OpenConfig added in v0.2.20 

type OpenConfig struct {
	BaseDirectory string

	ArtifactProviders []providerapi.Provider

	ProtectedRoots []basespec.RootID
	RetainedRoots  []basespec.RootID
}

OpenConfig contains the application-composition inputs required to open one Artifact Store.

Store implementation dependencies, source snapshots, source adapters, metadata repositories, SQLite handles, clocks, and automatic Artifact ID providers remain private to Artifact Store.

type PurgeArtifactRootRequest added in v0.2.13 

type PurgeArtifactRootRequest struct {
	RootID           basespec.RootID `path:"rootID" required:"true"`
	ExpectedRevision uint64          `              required:"true" json:"expectedRevision"`
}

type PurgeArtifactRootResponse added in v0.2.13 

type PurgeArtifactRootResponse struct {
	RootID basespec.RootID `json:"rootID"`
}

type PurgeArtifactSourceRequest added in v0.2.13 

type PurgeArtifactSourceRequest struct {
	RootID           basespec.RootID   `path:"rootID"   required:"true"`
	SourceID         basespec.SourceID `path:"sourceID" required:"true"`
	ExpectedRevision uint64            `                required:"true" json:"expectedRevision"`
}

type PurgeArtifactSourceResponse added in v0.2.13 

type PurgeArtifactSourceResponse struct {
	RootID   basespec.RootID   `json:"rootID"`
	SourceID basespec.SourceID `json:"sourceID"`
}

type RetireArtifactRootRequest added in v0.2.13 

type RetireArtifactRootRequest struct {
	RootID           basespec.RootID `path:"rootID" required:"true"`
	ExpectedRevision uint64          `              required:"true" json:"expectedRevision"`
}

type RetireArtifactRootResponse added in v0.2.13 

type RetireArtifactRootResponse struct {
	Body *root.Root
}

type RetireArtifactSourceRequest added in v0.2.13 

type RetireArtifactSourceRequest struct {
	RootID           basespec.RootID   `path:"rootID"   required:"true"`
	SourceID         basespec.SourceID `path:"sourceID" required:"true"`
	ExpectedRevision uint64            `                required:"true" json:"expectedRevision"`
}

type RetireArtifactSourceResponse added in v0.2.13 

type RetireArtifactSourceResponse struct {
	Body *source.Summary
}

type UpdateArtifactRootRequest added in v0.2.13 

type UpdateArtifactRootRequest struct {
	RootID basespec.RootID `path:"rootID" required:"true"`
	Body   *root.RootUpdate
}

type UpdateArtifactRootResponse added in v0.2.13 

type UpdateArtifactRootResponse struct {
	Body *root.Root
}

type UpdateArtifactSourceRequest added in v0.2.13 

type UpdateArtifactSourceRequest struct {
	RootID   basespec.RootID   `path:"rootID"   required:"true"`
	SourceID basespec.SourceID `path:"sourceID" required:"true"`
	Body     *UpdateArtifactSourceRequestBody
}

type UpdateArtifactSourceRequestBody added in v0.2.13 

type UpdateArtifactSourceRequestBody struct {
	ExpectedRevision uint64          `json:"expectedRevision" required:"true"`
	DisplayName      string          `json:"displayName"      required:"true"`
	Enabled          bool            `json:"enabled"`
	Config           json.RawMessage `json:"config,omitempty"`
}

type UpdateArtifactSourceResponse added in v0.2.13 

type UpdateArtifactSourceResponse struct {
	Body *source.Summary
}

Source Files

View all Source files

Directories

Path Synopsis
internal
artifact
artifactid
catalog
collection
discovery
managedartifact
mapstoreio
providerregistry
refresh
resource
root
shareable
source
source/embedded
source/fsdir
source/managed
sqlite
system
Package providerapi defines Artifact Store's stable inbound provider contracts.
 Package providerapi defines Artifact Store's stable inbound provider contracts.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.