Documentation
¶
Overview ¶
Package types catalogs github.com/moby/moby/api/types/image for wrapping by containerkit.
Code generated by go run ./tools/gencatalog; DO NOT EDIT.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image
Each identifier keeps the exact upstream type name. Domain isolation lives in the import path (internal/engine/image/types), not in renamed aliases.
Index ¶
- type AttestationProperties
- type AttestationStatement
- type BuildIdentity
- type DeleteResponse
- type DiskUsage
- type HistoryResponseItem
- type Identity
- type ImageProperties
- type InspectResponse
- type KnownSignerIdentity
- type ManifestKind
- type ManifestSummary
- type Metadata
- type PruneReport
- type PullIdentity
- type RootFS
- type SignatureIdentity
- type SignatureTimestamp
- type SignatureTimestampType
- type SignatureType
- type SignerIdentity
- type Summary
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AttestationProperties ¶
type AttestationProperties = image.AttestationProperties
AttestationProperties wraps image.AttestationProperties.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#AttestationProperties GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/manifest.go Kind: struct Usecase: wrap the Engine API type AttestationProperties from image.
type AttestationStatement ¶
type AttestationStatement = image.AttestationStatement
AttestationStatement wraps image.AttestationStatement.
AttestationStatement is a single in-toto statement attached to an image.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#AttestationStatement GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/attestation.go Kind: struct References: encoding/json.RawMessage, github.com/opencontainers/image-spec/specs-go/v1.Descriptor Usecase: wrap the Engine API type AttestationStatement from image.
type BuildIdentity ¶
type BuildIdentity = image.BuildIdentity
BuildIdentity wraps image.BuildIdentity.
BuildIdentity contains build reference information if image was created via build.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#BuildIdentity GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/build_identity.go Kind: struct References: time.Time Usecase: wrap the Engine API type BuildIdentity from image.
type DeleteResponse ¶
type DeleteResponse = image.DeleteResponse
DeleteResponse wraps image.DeleteResponse.
DeleteResponse delete response ¶
swagger:model DeleteResponse
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#DeleteResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/delete_response.go Kind: struct Usecase: wrap the Engine API type DeleteResponse from image.
type DiskUsage ¶
DiskUsage wraps image.DiskUsage.
DiskUsage represents system data usage for image resources.
swagger:model DiskUsage
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#DiskUsage GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/disk_usage.go Kind: struct Usecase: wrap the Engine API type DiskUsage from image.
type HistoryResponseItem ¶
type HistoryResponseItem = image.HistoryResponseItem
HistoryResponseItem wraps image.HistoryResponseItem.
HistoryResponseItem HistoryResponseItem ¶
individual image layer information in response to ImageHistory operation
swagger:model HistoryResponseItem
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#HistoryResponseItem GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/history_response_item.go Kind: struct Usecase: wrap the Engine API type HistoryResponseItem from image.
type Identity ¶
Identity wraps image.Identity.
Identity holds information about the identity and origin of the image. This is trusted information verified by the daemon and cannot be modified by tagging an image to a different name.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#Identity GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/identity.go Kind: struct Usecase: wrap the Engine API type Identity from image.
type ImageProperties ¶
type ImageProperties = image.ImageProperties
ImageProperties wraps image.ImageProperties.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#ImageProperties GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/manifest.go Kind: struct References: github.com/opencontainers/image-spec/specs-go/v1.Platform Usecase: wrap the Engine API type ImageProperties from image.
type InspectResponse ¶
type InspectResponse = image.InspectResponse
InspectResponse wraps image.InspectResponse.
InspectResponse contains response of Engine API: GET "/images/{name:.*}/json"
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#InspectResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/image_inspect.go Kind: struct References: github.com/moby/docker-image-spec/specs-go/v1.DockerOCIImageConfig, github.com/moby/moby/api/types/storage.DriverData, github.com/opencontainers/image-spec/specs-go/v1.Descriptor Usecase: wrap the Engine API type InspectResponse from image.
type KnownSignerIdentity ¶
type KnownSignerIdentity = image.KnownSignerIdentity
KnownSignerIdentity wraps image.KnownSignerIdentity.
KnownSignerIdentity is an identifier for a special signer identity that is known to the implementation.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#KnownSignerIdentity GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/image_inspect.go Kind: named:string Underlying: string Usecase: wrap the Engine API type KnownSignerIdentity from image.
type ManifestKind ¶
type ManifestKind = image.ManifestKind
ManifestKind wraps image.ManifestKind.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#ManifestKind GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/manifest.go Kind: named:string Underlying: string Usecase: wrap the Engine API type ManifestKind from image.
type ManifestSummary ¶
type ManifestSummary = image.ManifestSummary
ManifestSummary wraps image.ManifestSummary.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#ManifestSummary GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/manifest.go Kind: struct References: github.com/opencontainers/image-spec/specs-go/v1.Descriptor Usecase: wrap the Engine API type ManifestSummary from image.
type Metadata ¶
Metadata wraps image.Metadata.
Metadata contains engine-local data about the image.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#Metadata GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/image.go Kind: struct References: time.Time Usecase: wrap the Engine API type Metadata from image.
type PruneReport ¶
type PruneReport = image.PruneReport
PruneReport wraps image.PruneReport.
PruneReport contains the response for Engine API: POST "/images/prune"
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#PruneReport GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/image.go Kind: struct Usecase: wrap the Engine API type PruneReport from image.
type PullIdentity ¶
type PullIdentity = image.PullIdentity
PullIdentity wraps image.PullIdentity.
PullIdentity contains remote location information if image was created via pull. If image was pulled via mirror, this contains the original repository location.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#PullIdentity GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/pull_identity.go Kind: struct Usecase: wrap the Engine API type PullIdentity from image.
type RootFS ¶
RootFS wraps image.RootFS.
RootFS returns Image's RootFS description including the layer IDs.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#RootFS GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/image_inspect.go Kind: struct Usecase: wrap the Engine API type RootFS from image.
type SignatureIdentity ¶
type SignatureIdentity = image.SignatureIdentity
SignatureIdentity wraps image.SignatureIdentity.
SignatureIdentity contains the properties of verified signatures for the image.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#SignatureIdentity GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/signature_identity.go Kind: struct Usecase: wrap the Engine API type SignatureIdentity from image.
type SignatureTimestamp ¶
type SignatureTimestamp = image.SignatureTimestamp
SignatureTimestamp wraps image.SignatureTimestamp.
SignatureTimestamp contains information about a verified signed timestamp for an image signature.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#SignatureTimestamp GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/signature_timestamp.go Kind: struct References: time.Time Usecase: wrap the Engine API type SignatureTimestamp from image.
type SignatureTimestampType ¶
type SignatureTimestampType = image.SignatureTimestampType
SignatureTimestampType wraps image.SignatureTimestampType.
SignatureTimestampType is the type of timestamp used in the signature.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#SignatureTimestampType GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/image_inspect.go Kind: named:string Underlying: string Usecase: wrap the Engine API type SignatureTimestampType from image.
type SignatureType ¶
type SignatureType = image.SignatureType
SignatureType wraps image.SignatureType.
SignatureType is the type of signature format.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#SignatureType GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/image_inspect.go Kind: named:string Underlying: string Usecase: wrap the Engine API type SignatureType from image.
type SignerIdentity ¶
type SignerIdentity = image.SignerIdentity
SignerIdentity wraps image.SignerIdentity.
SignerIdentity contains information about the signer certificate used to sign the image. This is certificate.Summary with deprecated fields removed and keys in Moby uppercase style.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#SignerIdentity GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/signer_identity.go Kind: struct Usecase: wrap the Engine API type SignerIdentity from image.
type Summary ¶
Summary wraps image.Summary.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/image#Summary GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/image/summary.go Kind: struct References: github.com/opencontainers/image-spec/specs-go/v1.Descriptor Usecase: wrap the Engine API type Summary from image.