Safe Haskell	None
Language	GHC2021

Ecluse.Runtime.Maintenance.CodeArtifact.Read.Internal

Contents

The calls that only observe
Where an observation was made
What one observation preserves
One listing page

Description

The observation evidence and the page projections behind Ecluse.Runtime.Maintenance.CodeArtifact.Read, which documents the read-only half and re-exports the curated surface. Importing this module opts out of that stability promise, the convention text and bytestring use, so production code imports the public one.

Synopsis

data ReadPlane = ReadPlane {
- rpListPackages :: ListPackages -> IO (Either StoreFault ListPackagesResponse)
- rpListVersions :: ListPackageVersions -> IO (Either StoreFault ListPackageVersionsResponse)
- rpDescribeRepository :: DescribeRepository -> IO (Either StoreFault DescribeRepositoryResponse)
- rpDescribeUpstream :: DescribeRepository -> IO (Either UpstreamSafety DescribeRepositoryResponse)
- rpListTags :: ListTagsForResource -> IO (Either StoreFault ListTagsForResourceResponse)
}
data RepositoryIdentity = RepositoryIdentity {
- ridDomainOwner :: Text
- ridRegion :: Text
- ridDomain :: Text
- ridRepository :: Text
- ridEcosystem :: Ecosystem
}
identityOfStore :: CodeArtifactStore -> RepositoryIdentity
data VersionObservation = VersionObservation {
- obsIdentity :: RepositoryIdentity
- obsPackage :: PackageName
- obsVersion :: Version
- obsStatus :: PackageVersionStatus
- obsPresence :: VersionPresence
- obsRevision :: Maybe Text
- obsOrigin :: Maybe VersionOrigin
}
data VersionOrigin = VersionOrigin {
- vorType :: Maybe PackageVersionOriginType
- vorEntryRepository :: Maybe Text
- vorEntryConnection :: Maybe Text
}
observationsOfPage :: RepositoryIdentity -> PackageName -> [PackageVersionSummary] -> [VersionObservation]
versionsOfPage :: RepositoryIdentity -> PackageName -> [PackageVersionSummary] -> [StoredVersion]
storedOfObservation :: VersionObservation -> StoredVersion

The calls that only observe

data ReadPlane Source #

The CodeArtifact calls that observe an inventory, held apart from every call that changes it.

Constructors

ReadPlane

Fields

rpListPackages :: ListPackages -> IO (Either StoreFault ListPackagesResponse)
rpListVersions :: ListPackageVersions -> IO (Either StoreFault ListPackageVersionsResponse)
rpDescribeRepository :: DescribeRepository -> IO (Either StoreFault DescribeRepositoryResponse)
rpDescribeUpstream :: DescribeRepository -> IO (Either UpstreamSafety DescribeRepositoryResponse)
The same call as rpDescribeRepository, under the probe's own reading of a refusal: an identity that may not ask answers unsafe rather than faulting.
rpListTags :: ListTagsForResource -> IO (Either StoreFault ListTagsForResourceResponse)

Where an observation was made

data RepositoryIdentity Source #

The exact repository an observation was made in. The region is the store's own, which is also the one the leaf binds its amazonka environment to.

Constructors

RepositoryIdentity
Fields ridDomainOwner :: Text The 12-digit account number that owns the domain. ridRegion :: Text ridDomain :: Text ridRepository :: Text ridEcosystem :: Ecosystem

Instances

Instances details

Show RepositoryIdentity Source #
Instance details Defined in Ecluse.Runtime.Maintenance.CodeArtifact.Read.Internal Methods showsPrec :: Int -> RepositoryIdentity -> ShowS # show :: RepositoryIdentity -> String # showList :: [RepositoryIdentity] -> ShowS #
Eq RepositoryIdentity Source #
Instance details Defined in Ecluse.Runtime.Maintenance.CodeArtifact.Read.Internal Methods (==) :: RepositoryIdentity -> RepositoryIdentity -> Bool # (/=) :: RepositoryIdentity -> RepositoryIdentity -> Bool #

identityOfStore :: CodeArtifactStore -> RepositoryIdentity Source #

The repository a store's coordinates name.

What one observation preserves

data VersionObservation Source #

One version the store reported holding, with the evidence a later decision reads. Two observations of the same version in different repositories stay two observations.

Constructors

VersionObservation

Fields

obsIdentity :: RepositoryIdentity
obsPackage :: PackageName
obsVersion :: Version
obsStatus :: PackageVersionStatus
CodeArtifact's own status, kept beside the projection so an unexpected one survives.
obsPresence :: VersionPresence
obsRevision :: Maybe Text
The store's revision of this version, Nothing where it reported none.
obsOrigin :: Maybe VersionOrigin
Nothing where the store reported no origin at all.

Instances

Instances details

Show VersionObservation Source #
Instance details Defined in Ecluse.Runtime.Maintenance.CodeArtifact.Read.Internal Methods showsPrec :: Int -> VersionObservation -> ShowS # show :: VersionObservation -> String # showList :: [VersionObservation] -> ShowS #
Eq VersionObservation Source #
Instance details Defined in Ecluse.Runtime.Maintenance.CodeArtifact.Read.Internal Methods (==) :: VersionObservation -> VersionObservation -> Bool # (/=) :: VersionObservation -> VersionObservation -> Bool #

data VersionOrigin Source #

How a version entered the domain, as the store reported it. Each field stays optional, because one the store omitted is not one it denied.

Constructors

VersionOrigin
Fields vorType :: Maybe PackageVersionOriginType CodeArtifact's own token, verbatim, so a token this build does not know survives. vorEntryRepository :: Maybe Text The repository the version was first published to, where the store named one. vorEntryConnection :: Maybe Text The external connection the version was ingested through, where the store named one.

Instances

Instances details

Show VersionOrigin Source #
Instance details Defined in Ecluse.Runtime.Maintenance.CodeArtifact.Read.Internal Methods showsPrec :: Int -> VersionOrigin -> ShowS # show :: VersionOrigin -> String # showList :: [VersionOrigin] -> ShowS #
Eq VersionOrigin Source #
Instance details Defined in Ecluse.Runtime.Maintenance.CodeArtifact.Read.Internal Methods (==) :: VersionOrigin -> VersionOrigin -> Bool # (/=) :: VersionOrigin -> VersionOrigin -> Bool #

One listing page

observationsOfPage :: RepositoryIdentity -> PackageName -> [PackageVersionSummary] -> [VersionObservation] Source #

The observations in one listing page, one per entry and never merged by version.

versionsOfPage :: RepositoryIdentity -> PackageName -> [PackageVersionSummary] -> [StoredVersion] Source #

The versions in one listing page, projected to what the sweep reads.

storedOfObservation :: VersionObservation -> StoredVersion Source #

The sweep's view of one observation: which version, and whether the store still serves it.