Package io.micronaut.starter.feature.function.gcp

Class GoogleCloudRawFunction

java.lang.Object

io.micronaut.starter.feature.function.AbstractFunctionFeature

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

io.micronaut.starter.feature.function.gcp.GoogleCloudRawFunction

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

Feature that adds support for deploying raw functions to Google Cloud Functions in a Micronaut project.

Provides integration with Google Cloud's Functions Framework and sets up the necessary templates, dependencies, and configuration for function-based applications.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from class io.micronaut.starter.feature.function.gcp.AbstractGoogleCloudFunction

GCP_FUNCTIONS_FRAMEWORK_API

Fields inherited from interface io.micronaut.starter.feature.MicronautRuntimeFeature

PROPERTY_MICRONAUT_RUNTIME

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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 void	applyTestTemplate(GeneratorContext generatorContext, Project project, String name)	Applies the test templates to the module.
protected String	getBuildCommand(BuildTool buildTool)
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)
void	processSelectedFeatures(FeatureContext featureContext)	If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set).
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)

Methods inherited from class io.micronaut.starter.feature.function.AbstractFunctionFeature

applyFunction, getTestSuffix, groovyControllerTemplate, javaControllerTemplate, kotlinControllerTemplate

Methods inherited from class java.lang.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 io.micronaut.projectgen.core.feature.Feature

getOrder, getThirdPartyDocumentation, isCommunity, isPreview, isVisible

Methods inherited from interface io.micronaut.starter.feature.function.FunctionFeature

getCategory, supports

Methods inherited from interface io.micronaut.starter.feature.function.gcp.GcpCloudFeature

getCloud

Methods inherited from interface io.micronaut.starter.feature.function.gcp.GcpMicronautRuntimeFeature

resolveMicronautRuntime

Methods inherited from interface io.micronaut.starter.feature.MicronautRuntimeFeature

addMicronautRuntimeBuildProperty

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

GoogleCloudRawFunction

public GoogleCloudRawFunction(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

public 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

processSelectedFeatures

public void processSelectedFeatures(FeatureContext featureContext)

Description copied from interface: Feature

If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set). This method can be implemented to allow features to modify the list of features that will apply to the project. The methods FeatureContext.addFeature(Feature) and FeatureContext.exclude(FeaturePredicate) are the primary ways to add and remove features from the context. FeatureContext.isPresent(Class) can be used to determine the existence of other features in order to make decisions.

Specified by:

processSelectedFeatures in interface Feature

Overrides:

processSelectedFeatures in class AbstractGoogleCloudFunction

Parameters:

featureContext - The feature context

applyTestTemplate

protected void applyTestTemplate(GeneratorContext generatorContext,
 Project project,
 String name)

Description copied from class: AbstractFunctionFeature

Applies the test templates to the module. Subclasses may override to customize the test generation logic.

Overrides:

applyTestTemplate in class AbstractFunctionFeature

Parameters:

generatorContext - the generator context

project - the project

name - the name of the test class

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