Package io.fabric8.openshift.api.model

Class Image

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<ImageBuilder>, io.fabric8.kubernetes.api.model.HasMetadata, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class Image
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<ImageBuilder>, io.fabric8.kubernetes.api.model.HasMetadata
    Image is an immutable representation of a container image and its metadata at a point in time. Images are named by taking a hash of their contents (metadata and content) and any change in format, content, or metadata results in a new name. The images resource is primarily for use by cluster administrators and integrations like the cluster image registry - end users, instead, access images via the imagestreamtags or imagestreamimages resources. While image metadata is stored in the API, any integration that implements the container image registry API must provide its own storage for the raw manifest data, image config, and layer contents.


    Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

    See Also:
    Serialized Form

    • Method Detail

      • getApiVersion

        public String getApiVersion()
        APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
        Specified by:
        getApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setApiVersion

        public void setApiVersion​(String apiVersion)
        APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
        Specified by:
        setApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata

      • getDockerImageConfig

        public String getDockerImageConfig()
        dockerImageConfig is a JSON blob that the runtime uses to set up the container. This is a part of manifest schema v2. Will not be set when the image represents a manifest list.

      • setDockerImageConfig

        public void setDockerImageConfig​(String dockerImageConfig)
        dockerImageConfig is a JSON blob that the runtime uses to set up the container. This is a part of manifest schema v2. Will not be set when the image represents a manifest list.

      • getDockerImageLayers

        public List<ImageLayer> getDockerImageLayers()
        dockerImageLayers represents the layers in the image. May not be set if the image does not define that data or if the image represents a manifest list.

      • setDockerImageLayers

        public void setDockerImageLayers​(List<ImageLayer> dockerImageLayers)
        dockerImageLayers represents the layers in the image. May not be set if the image does not define that data or if the image represents a manifest list.

      • getDockerImageManifest

        public String getDockerImageManifest()
        dockerImageManifest is the raw JSON of the manifest

      • setDockerImageManifest

        public void setDockerImageManifest​(String dockerImageManifest)
        dockerImageManifest is the raw JSON of the manifest

      • getDockerImageManifestMediaType

        public String getDockerImageManifestMediaType()
        dockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.

      • setDockerImageManifestMediaType

        public void setDockerImageManifestMediaType​(String dockerImageManifestMediaType)
        dockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.

      • getDockerImageManifests

        public List<ImageManifest> getDockerImageManifests()
        dockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified.

      • setDockerImageManifests

        public void setDockerImageManifests​(List<ImageManifest> dockerImageManifests)
        dockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified.

      • getDockerImageMetadata

        public Object getDockerImageMetadata()
        Image is an immutable representation of a container image and its metadata at a point in time. Images are named by taking a hash of their contents (metadata and content) and any change in format, content, or metadata results in a new name. The images resource is primarily for use by cluster administrators and integrations like the cluster image registry - end users, instead, access images via the imagestreamtags or imagestreamimages resources. While image metadata is stored in the API, any integration that implements the container image registry API must provide its own storage for the raw manifest data, image config, and layer contents.


        Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

      • setDockerImageMetadata

        public void setDockerImageMetadata​(Object dockerImageMetadata)
        Image is an immutable representation of a container image and its metadata at a point in time. Images are named by taking a hash of their contents (metadata and content) and any change in format, content, or metadata results in a new name. The images resource is primarily for use by cluster administrators and integrations like the cluster image registry - end users, instead, access images via the imagestreamtags or imagestreamimages resources. While image metadata is stored in the API, any integration that implements the container image registry API must provide its own storage for the raw manifest data, image config, and layer contents.


        Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

      • getDockerImageMetadataVersion

        public String getDockerImageMetadataVersion()
        dockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0"

      • setDockerImageMetadataVersion

        public void setDockerImageMetadataVersion​(String dockerImageMetadataVersion)
        dockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0"

      • getDockerImageReference

        public String getDockerImageReference()
        dockerImageReference is the string that can be used to pull this image.

      • setDockerImageReference

        public void setDockerImageReference​(String dockerImageReference)
        dockerImageReference is the string that can be used to pull this image.

      • getDockerImageSignatures

        public List<String> getDockerImageSignatures()
        dockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.

      • setDockerImageSignatures

        public void setDockerImageSignatures​(List<String> dockerImageSignatures)
        dockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.

      • getKind

        public String getKind()
        Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
        Specified by:
        getKind in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setKind

        public void setKind​(String kind)
        Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

      • getMetadata

        public io.fabric8.kubernetes.api.model.ObjectMeta getMetadata()
        Image is an immutable representation of a container image and its metadata at a point in time. Images are named by taking a hash of their contents (metadata and content) and any change in format, content, or metadata results in a new name. The images resource is primarily for use by cluster administrators and integrations like the cluster image registry - end users, instead, access images via the imagestreamtags or imagestreamimages resources. While image metadata is stored in the API, any integration that implements the container image registry API must provide its own storage for the raw manifest data, image config, and layer contents.


        Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

        Specified by:
        getMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setMetadata

        public void setMetadata​(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
        Image is an immutable representation of a container image and its metadata at a point in time. Images are named by taking a hash of their contents (metadata and content) and any change in format, content, or metadata results in a new name. The images resource is primarily for use by cluster administrators and integrations like the cluster image registry - end users, instead, access images via the imagestreamtags or imagestreamimages resources. While image metadata is stored in the API, any integration that implements the container image registry API must provide its own storage for the raw manifest data, image config, and layer contents.


        Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

        Specified by:
        setMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

      • getSignatures

        public List<ImageSignature> getSignatures()
        signatures holds all signatures of the image.

      • setSignatures

        public void setSignatures​(List<ImageSignature> signatures)
        signatures holds all signatures of the image.

      • edit

        public ImageBuilder edit()
        Specified by:
        edit in interface io.fabric8.kubernetes.api.builder.Editable<ImageBuilder>

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)