Class Image

java.lang.Object
org.springframework.boot.maven.Image
public class Image extends Object
Image configuration options.
Since:
2.3.0
Author:
Phillip Webb, Scott Frederick, Jeroen Meijer, Rafael Ceccone, Julian Liebig

  • Constructor Details

    • Image

      public Image()

  • Method Details

    • getName

      public @Nullable String getName()
      The name of the created image.
      Returns:
      the image name

    • getBuilder

      public @Nullable String getBuilder()
      The name of the builder image to use to create the image.
      Returns:
      the builder image name

    • getTrustBuilder

      public @Nullable Boolean getTrustBuilder()
      If the builder should be treated as trusted.
      Returns:
      true if the builder should be treated as trusted

    • getRunImage

      public @Nullable String getRunImage()
      The name of the run image to use to create the image.
      Returns:
      the builder image name

    • getEnv

      public @Nullable Map<String,String> getEnv()
      Environment properties that should be passed to the builder.
      Returns:
      the environment properties

    • getCleanCache

      public @Nullable Boolean getCleanCache()
      If the cache should be cleaned before building.
      Returns:
      true if the cache should be cleaned

    • isVerboseLogging

      public boolean isVerboseLogging()
      If verbose logging is required.
      Returns:
      true for verbose logging

    • getPullPolicy

      public @Nullable org.springframework.boot.buildpack.platform.build.PullPolicy getPullPolicy()
      If images should be pulled from a remote repository during image build.
      Returns:
      the pull policy

    • getPublish

      public @Nullable Boolean getPublish()
      If the built image should be pushed to a registry.
      Returns:
      true if the image should be published

    • getNetwork

      public @Nullable String getNetwork()
      Returns the network the build container will connect to.
      Returns:
      the network

    • setNetwork

      public void setNetwork(@Nullable String network)

    • getCreatedDate

      public @Nullable String getCreatedDate()
      Returns the created date for the image.
      Returns:
      the created date

    • setCreatedDate

      public void setCreatedDate(@Nullable String createdDate)

    • getApplicationDirectory

      public @Nullable String getApplicationDirectory()
      Returns the application content directory for the image.
      Returns:
      the application directory

    • setApplicationDirectory

      public void setApplicationDirectory(@Nullable String applicationDirectory)

    • getImagePlatform

      public @Nullable String getImagePlatform()
      Returns the platform (os/architecture/variant) that will be used for all pulled images. When null, the system will choose a platform based on the host operating system and architecture.
      Returns:
      the image platform

    • setImagePlatform

      public void setImagePlatform(@Nullable String imagePlatform)