Package software.aws.awsprototypingsdk.openapigateway

Class SmithyApiGatewayProjectOptions.Builder

java.lang.Object

software.aws.awsprototypingsdk.openapigateway.SmithyApiGatewayProjectOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SmithyApiGatewayProjectOptions>

Enclosing interface:

SmithyApiGatewayProjectOptions

@Stability(Experimental)
public static final class SmithyApiGatewayProjectOptions.Builder
extends Object
implements software.amazon.jsii.Builder<SmithyApiGatewayProjectOptions>

A builder for SmithyApiGatewayProjectOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SmithyApiGatewayProjectOptions.Builder	apiSrcDir(String apiSrcDir)	Sets the value of CommonApiProjectOptions.getApiSrcDir()
SmithyApiGatewayProjectOptions	build()	Builds the configured instance.
SmithyApiGatewayProjectOptions.Builder	clientLanguages(List<? extends ClientLanguage> clientLanguages)	Sets the value of CommonApiProjectOptions.getClientLanguages()
SmithyApiGatewayProjectOptions.Builder	documentationFormats(List<? extends DocumentationFormat> documentationFormats)	Sets the value of CommonApiProjectOptions.getDocumentationFormats()
SmithyApiGatewayProjectOptions.Builder	forceGenerateCodeAndDocs(Boolean forceGenerateCodeAndDocs)	Sets the value of CommonApiProjectOptions.getForceGenerateCodeAndDocs()
SmithyApiGatewayProjectOptions.Builder	generatedCodeDir(String generatedCodeDir)	Sets the value of CommonApiProjectOptions.getGeneratedCodeDir()
SmithyApiGatewayProjectOptions.Builder	gradleWrapperPath(String gradleWrapperPath)	Sets the value of SmithyApiGatewayProjectOptions.getGradleWrapperPath()
SmithyApiGatewayProjectOptions.Builder	ignoreSmithyBuildOutput(Boolean ignoreSmithyBuildOutput)	Sets the value of SmithyApiGatewayProjectOptions.getIgnoreSmithyBuildOutput()
SmithyApiGatewayProjectOptions.Builder	javaClientOptions(io.github.cdklabs.projen.java.JavaProjectOptions javaClientOptions)	Sets the value of CommonApiProjectOptions.getJavaClientOptions()
SmithyApiGatewayProjectOptions.Builder	modelDir(String modelDir)	Sets the value of SmithyApiGatewayProjectOptions.getModelDir()
SmithyApiGatewayProjectOptions.Builder	parsedSpecFileName(String parsedSpecFileName)	Sets the value of CommonApiProjectOptions.getParsedSpecFileName()
SmithyApiGatewayProjectOptions.Builder	pythonClientOptions(io.github.cdklabs.projen.python.PythonProjectOptions pythonClientOptions)	Sets the value of CommonApiProjectOptions.getPythonClientOptions()
SmithyApiGatewayProjectOptions.Builder	serviceName(SmithyServiceName serviceName)	Sets the value of SmithyApiGatewayProjectOptions.getServiceName()
SmithyApiGatewayProjectOptions.Builder	smithyBuildOptions(SmithyBuildOptions smithyBuildOptions)	Sets the value of SmithyApiGatewayProjectOptions.getSmithyBuildOptions()
SmithyApiGatewayProjectOptions.Builder	typescriptClientOptions(io.github.cdklabs.projen.typescript.TypeScriptProjectOptions typescriptClientOptions)	Sets the value of CommonApiProjectOptions.getTypescriptClientOptions()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

serviceName

@Stability(Experimental)
public SmithyApiGatewayProjectOptions.Builder serviceName(SmithyServiceName serviceName)

Sets the value of SmithyApiGatewayProjectOptions.getServiceName()

Parameters:

serviceName - The name of the Smithy service from your model which will be targeted for deployment and client generation. This parameter is required. On initial project synthesis this service name will be written to the sample "hello world" model. If you change this value after initial synthesis you will need to manually update your Smithy models to match, unless you delete the "model" directory. Likewise, if you change the namespace or service name in your Smithy models you will need to update this value to ensure your service can be found.

Returns:

this

gradleWrapperPath

@Stability(Experimental)
public SmithyApiGatewayProjectOptions.Builder gradleWrapperPath(String gradleWrapperPath)

Sets the value of SmithyApiGatewayProjectOptions.getGradleWrapperPath()

Parameters:

gradleWrapperPath - Path to a directory containing a custom gradle wrapper (gradlew) to use instead of the one provided by the PDK, relative to the project outdir. Use this if you would like to own and check in the gradle wrapper instead of using the provided one.

Returns:

this

ignoreSmithyBuildOutput

@Stability(Experimental)
public SmithyApiGatewayProjectOptions.Builder ignoreSmithyBuildOutput(Boolean ignoreSmithyBuildOutput)

Sets the value of SmithyApiGatewayProjectOptions.getIgnoreSmithyBuildOutput()

Parameters:

ignoreSmithyBuildOutput - Set to false if you would like to check in your smithy build output or have more fine-grained control over what is checked in, eg if you add other projections to the smithy-build.json file.

Returns:

this

modelDir

@Stability(Experimental)
public SmithyApiGatewayProjectOptions.Builder modelDir(String modelDir)

Sets the value of SmithyApiGatewayProjectOptions.getModelDir()

Parameters:

modelDir - The path to the Smithy model directory, relative to the project source directory (srcdir).

Returns:

this

smithyBuildOptions

@Stability(Experimental)
public SmithyApiGatewayProjectOptions.Builder smithyBuildOptions(SmithyBuildOptions smithyBuildOptions)

Sets the value of SmithyApiGatewayProjectOptions.getSmithyBuildOptions()

Parameters:

smithyBuildOptions - Any additional properties you'd like to add your smithy-build.json. The smithy-build.json will automatically include the "openapi" plugin, but you can add extra configuration for that via this option if you like.

Returns:

this

clientLanguages

@Stability(Experimental)
public SmithyApiGatewayProjectOptions.Builder clientLanguages(List<? extends ClientLanguage> clientLanguages)

Sets the value of CommonApiProjectOptions.getClientLanguages()

Parameters:

clientLanguages - The list of languages for which clients will be generated. This parameter is required. A typescript client will always be generated.

Returns:

this

apiSrcDir

@Stability(Experimental)
public SmithyApiGatewayProjectOptions.Builder apiSrcDir(String apiSrcDir)

Sets the value of CommonApiProjectOptions.getApiSrcDir()

Parameters:

apiSrcDir - The directory in which the api generated code will reside, relative to the project srcdir.

Returns:

this

documentationFormats

@Stability(Experimental)
public SmithyApiGatewayProjectOptions.Builder documentationFormats(List<? extends DocumentationFormat> documentationFormats)

Sets the value of CommonApiProjectOptions.getDocumentationFormats()

Parameters:

documentationFormats - Formats to generate documentation in.

Returns:

this

forceGenerateCodeAndDocs

@Stability(Experimental)
public SmithyApiGatewayProjectOptions.Builder forceGenerateCodeAndDocs(Boolean forceGenerateCodeAndDocs)

Sets the value of CommonApiProjectOptions.getForceGenerateCodeAndDocs()

Parameters:

forceGenerateCodeAndDocs - Force to generate code and docs even if there were no changes in spec.

Returns:

this

generatedCodeDir

@Stability(Experimental)
public SmithyApiGatewayProjectOptions.Builder generatedCodeDir(String generatedCodeDir)

Sets the value of CommonApiProjectOptions.getGeneratedCodeDir()

Parameters:

generatedCodeDir - The directory in which generated client code will be generated, relative to the outdir of this project.

Returns:

this

javaClientOptions

@Stability(Experimental)
public SmithyApiGatewayProjectOptions.Builder javaClientOptions(io.github.cdklabs.projen.java.JavaProjectOptions javaClientOptions)

Sets the value of CommonApiProjectOptions.getJavaClientOptions()

Parameters:

javaClientOptions - Options for the generated java client (if specified in clientLanguages). These override the default inferred options.

Returns:

this

parsedSpecFileName

@Stability(Experimental)
public SmithyApiGatewayProjectOptions.Builder parsedSpecFileName(String parsedSpecFileName)

Sets the value of CommonApiProjectOptions.getParsedSpecFileName()

Parameters:

parsedSpecFileName - The name of the output parsed OpenAPI specification file. Must end with .json.

Returns:

this

pythonClientOptions

@Stability(Experimental)
public SmithyApiGatewayProjectOptions.Builder pythonClientOptions(io.github.cdklabs.projen.python.PythonProjectOptions pythonClientOptions)

Sets the value of CommonApiProjectOptions.getPythonClientOptions()

Parameters:

pythonClientOptions - Options for the generated python client (if specified in clientLanguages). These override the default inferred options.

Returns:

this

typescriptClientOptions

@Stability(Experimental)
public SmithyApiGatewayProjectOptions.Builder typescriptClientOptions(io.github.cdklabs.projen.typescript.TypeScriptProjectOptions typescriptClientOptions)

Sets the value of CommonApiProjectOptions.getTypescriptClientOptions()

Parameters:

typescriptClientOptions - Options for the generated typescript client. These override the default inferred options.

Returns:

this

build

@Stability(Experimental)
public SmithyApiGatewayProjectOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<SmithyApiGatewayProjectOptions>

Returns:

a new instance of SmithyApiGatewayProjectOptions

Throws:

NullPointerException - if any required attribute was not provided