Class GoogleCloudFunction

java.lang.Object

io.micronaut.starter.feature.function.AbstractFunctionFeature

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

io.micronaut.starter.feature.function.gcp.GoogleCloudFunction

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.http.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class GoogleCloudFunction
extends AbstractGoogleCloudFunction

A feature for supporting Google Cloud Function.

Since:

2.0.0

Author:

graemerocher

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
GoogleCloudFunction(ShadePlugin shadePlugin, JacksonDatabindFeature jacksonDatabindFeature)

Method Summary

Modifier and Type	Method	Description
protected void	addDependencies(GeneratorContext generatorContext)
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(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
protected String	getBuildCommand(BuildTool buildTool)
String	getDescription()
String	getMicronautDocumentation()
@NonNull String	getName()	The name of the feature.
protected String	getRunCommand(BuildTool buildTool)
String	getTitle()
com.fizzed.rocker.RockerModel	groovyJUnitTemplate(Project project)
boolean	isVisible()	Some features should not be visible to the user because they are a common parent of other selectable features, or they should always be applied, or any other reason.
com.fizzed.rocker.RockerModel	javaJUnitTemplate(Project project)
protected com.fizzed.rocker.RockerModel	koTestTemplate(Project project)
com.fizzed.rocker.RockerModel	kotlinJUnitTemplate(Project project)
com.fizzed.rocker.RockerModel	spockTemplate(Project project)

Methods inherited from class AbstractGoogleCloudFunction

processSelectedFeatures

Methods inherited from class AbstractFunctionFeature

applyFunction, applyTestTemplate, getTestSuffix, groovyControllerTemplate, javaControllerTemplate, kotlinControllerTemplate, readmeTemplate

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

Methods inherited from interface FunctionFeature

getCategory, supports

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

GoogleCloudFunction

public 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

getTitle

public String getTitle()

Returns:

The title of the feature

getDescription

public String getDescription()

isVisible

public boolean isVisible()

Description copied from interface: Feature

Some features should not be visible to the user because they are a common parent of other selectable features, or they should always be applied, or any other reason.

Returns:

True if the feature should able to be selected by the user

javaJUnitTemplate

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

Specified by:

javaJUnitTemplate in class AbstractFunctionFeature

kotlinJUnitTemplate

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

Specified by:

kotlinJUnitTemplate in class AbstractFunctionFeature

groovyJUnitTemplate

public 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

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(ApplicationType, 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. This method can be implemented to modify the generated project. The feature can add templates by executing GeneratorContext.addTemplate(String, io.micronaut.starter.template.Template), modify configuration by modifying GeneratorContext.getConfiguration() or GeneratorContext.getBootstrapConfiguration(), or modify build properties through GeneratorContext.getBuildProperties().

Specified by:

apply in interface Feature

Overrides:

apply in class AbstractGoogleCloudFunction

Parameters:

generatorContext - THe generator context

addDependencies

protected void addDependencies(GeneratorContext generatorContext)

getRunCommand

protected String getRunCommand(BuildTool buildTool)

Specified by:

getRunCommand in class AbstractFunctionFeature

getBuildCommand

protected String getBuildCommand(BuildTool buildTool)

Specified by:

getBuildCommand in class AbstractFunctionFeature

getMicronautDocumentation

public String getMicronautDocumentation()

Returns:

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