com.google.cloud.tools.jib.gradle.extension

Interface JibGradlePluginExtension<T>

All Superinterfaces:

com.google.cloud.tools.jib.plugins.extension.JibPluginExtension

public interface JibGradlePluginExtension<T>
extends com.google.cloud.tools.jib.plugins.extension.JibPluginExtension

Jib Gradle plugin extension API.

If a class implementing the interface is visible on the classpath of the Jib Gradle plugin and the plugin is configured to load the extension class, the Jib plugin extension framework calls the interface method of the class.

Method Summary

Modifier and Type	Method and Description
com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan	extendContainerBuildPlan(com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan buildPlan, java.util.Map<java.lang.String,java.lang.String> properties, java.util.Optional<T> extraConfig, GradleData gradleData, com.google.cloud.tools.jib.plugins.extension.ExtensionLogger logger) Extends the build plan prepared by the Jib Gradle plugin.
java.util.Optional<java.lang.Class<T>>	getExtraConfigType() The type of an custom configuration defined by this extension.

Method Detail

getExtraConfigType

java.util.Optional<java.lang.Class<T>> getExtraConfigType()

The type of an custom configuration defined by this extension. The configuration object is mapped from pluginExtensions.pluginExtension.configuration. Often, it is sufficient to leverage pluginExtensions.pluginExtension.properties and the extension may not wish to define a custom configuration; in that case, use Void for <T> and have this method return Optional#empty(). (Don't return Optional.of(Void.class).)

Returns:

type of an extension-specific custom configuration; Optional.empty() if no need to define custom configuration

extendContainerBuildPlan

com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan extendContainerBuildPlan(com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan buildPlan,
                                                                                     java.util.Map<java.lang.String,java.lang.String> properties,
                                                                                     java.util.Optional<T> extraConfig,
                                                                                     GradleData gradleData,
                                                                                     com.google.cloud.tools.jib.plugins.extension.ExtensionLogger logger)
                                                                              throws com.google.cloud.tools.jib.plugins.extension.JibPluginExtensionException

Extends the build plan prepared by the Jib Gradle plugin.

Parameters:

buildPlan - original build plan prepared by the Jib Gradle plugin

properties - custom properties configured for the plugin extension

extraConfig - extension-specific custom configuration mapped from jib.pluginExtensions.pluginExtension.configuration of type type <T>. Optional.empty() when getExtraConfigType() returns Optional.empty() or pluginExtension.configuration is not specified by the extension user.

gradleData - GradleData providing Gradle-specific data and properties

logger - logger for writing log messages

Returns:

updated build plan

Throws:

com.google.cloud.tools.jib.plugins.extension.JibPluginExtensionException - if an error occurs while running the plugin extension