Class GoogleCloudEventsFunction

java.lang.Object

io.micronaut.starter.feature.function.AbstractFunctionFeature

io.micronaut.starter.feature.function.gcp.AbstractGoogleCloudFunction

io.micronaut.starter.feature.function.gcp.GoogleCloudEventsFunction

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, CloudFeature, FunctionFeature, GcpCloudFeature, GcpMicronautRuntimeFeature, MicronautRuntimeFeature

@Requires(property="micronaut.starter.feature.google.cloud.function.cloudevents.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class GoogleCloudEventsFunction
extends AbstractGoogleCloudFunction

A feature for supporting Google CloudEvents Function.

Since:

3.9.0

Author:

Guillermo Calvo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from class AbstractGoogleCloudFunction

GCP_FUNCTIONS_FRAMEWORK_API

Fields inherited from interface MicronautRuntimeFeature

PROPERTY_MICRONAUT_RUNTIME

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
GoogleCloudEventsFunction(GoogleCloudFunction googleCloudFunction, ShadePlugin shadePlugin, JacksonDatabindFeature jacksonDatabindFeature)

Method Summary

Modifier and Type	Method	Description
protected void	addDependencies(ModuleContext module)	Adds the necessary dependencies for Google CloudEvents Function to the given ModuleContext.
void	apply(GeneratorContext generatorContext)	If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
protected String	getBuildCommand(BuildTool buildTool)
@NonNull String	getDescription()
String	getFrameworkDocumentation(GeneratorContext generatorContext)
@NonNull String	getName()	The name of the feature.
protected String	getRunCommand(BuildTool buildTool)
String	getTitle()
protected com.fizzed.rocker.RockerModel	groovyJUnitTemplate(Project project)
protected com.fizzed.rocker.RockerModel	javaJUnitTemplate(Project project)
protected com.fizzed.rocker.RockerModel	koTestTemplate(Project project)
protected com.fizzed.rocker.RockerModel	kotlinJUnitTemplate(Project project)
protected Optional<com.fizzed.rocker.RockerModel>	readmeTemplate(GeneratorContext generatorContext, Project project, BuildTool buildTool)	Returns the README template for this function feature, if any.
com.fizzed.rocker.RockerModel	spockTemplate(Project project)
boolean	supports(Options options)	This method must be implemented to ensure it is only selectable for the desired application types.

Methods inherited from class AbstractGoogleCloudFunction

processSelectedFeatures

Methods inherited from class AbstractFunctionFeature

applyFunction, applyTestTemplate, getTestSuffix, groovyControllerTemplate, javaControllerTemplate, kotlinControllerTemplate

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.core.naming.Described

getDescription

Methods inherited from interface Feature

getOrder, getThirdPartyDocumentation, isCommunity, isPreview, isVisible

Methods inherited from interface FunctionFeature

getCategory

Methods inherited from interface GcpCloudFeature

getCloud

Methods inherited from interface GcpMicronautRuntimeFeature

resolveMicronautRuntime

Methods inherited from interface MicronautRuntimeFeature

addMicronautRuntimeBuildProperty

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

GoogleCloudEventsFunction

public GoogleCloudEventsFunction(GoogleCloudFunction googleCloudFunction,
 ShadePlugin shadePlugin,
 JacksonDatabindFeature jacksonDatabindFeature)

Method Details

getName

@NonNull
public @NonNull String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Returns:

the name of the feature

apply

public void apply(GeneratorContext generatorContext)

Description copied from interface: Feature

If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature). At this point the feature list is set and cannot change.

Specified by:

apply in interface Feature

Overrides:

apply in class AbstractGoogleCloudFunction

Parameters:

generatorContext - THe generator context

getTitle

public String getTitle()

Returns:

The title of the feature

getDescription

@NonNull
public @NonNull String getDescription()

readmeTemplate

protected Optional<com.fizzed.rocker.RockerModel> readmeTemplate(GeneratorContext generatorContext,
 Project project,
 BuildTool buildTool)

Description copied from class: AbstractFunctionFeature

Returns the README template for this function feature, if any. Subclasses may override to provide custom documentation.

Overrides:

readmeTemplate in class AbstractFunctionFeature

Parameters:

generatorContext - the generator context

project - the project

buildTool - the build tool used

Returns:

an optional Rocker model for the README

supports

public boolean supports(Options options)

Description copied from interface: Feature

This method must be implemented to ensure it is only selectable for the desired application types. This method is not used for determining if a default feature should be applied.

Parameters:

options - Options

Returns:

True if the feature can be selected by the user

getRunCommand

protected String getRunCommand(BuildTool buildTool)

Specified by:

getRunCommand in class AbstractFunctionFeature

getBuildCommand

protected String getBuildCommand(BuildTool buildTool)

Specified by:

getBuildCommand in class AbstractFunctionFeature

javaJUnitTemplate

protected com.fizzed.rocker.RockerModel javaJUnitTemplate(Project project)

Specified by:

javaJUnitTemplate in class AbstractFunctionFeature

kotlinJUnitTemplate

protected com.fizzed.rocker.RockerModel kotlinJUnitTemplate(Project project)

Specified by:

kotlinJUnitTemplate in class AbstractFunctionFeature

groovyJUnitTemplate

protected com.fizzed.rocker.RockerModel groovyJUnitTemplate(Project project)

Specified by:

groovyJUnitTemplate in class AbstractFunctionFeature

koTestTemplate

protected com.fizzed.rocker.RockerModel koTestTemplate(Project project)

Specified by:

koTestTemplate in class AbstractFunctionFeature

spockTemplate

public com.fizzed.rocker.RockerModel spockTemplate(Project project)

Specified by:

spockTemplate in class AbstractFunctionFeature

getFrameworkDocumentation

public String getFrameworkDocumentation(GeneratorContext generatorContext)

Parameters:

generatorContext - Generator Context

Returns:

Returns a link to Framework documentation about the feature. eg. https://micronaut-projects.github.io/micronaut-cache/latest/guide/index.html#hazelcast

addDependencies

protected void addDependencies(ModuleContext module)

Adds the necessary dependencies for Google CloudEvents Function to the given ModuleContext.

Parameters:

module - the ModuleContext to which the dependencies should be added