Package software.aws.awsprototypingsdk.openapigateway

Class OpenApiGatewayProjectOptions.Builder

java.lang.Object

software.aws.awsprototypingsdk.openapigateway.OpenApiGatewayProjectOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<OpenApiGatewayProjectOptions>

Enclosing interface:

OpenApiGatewayProjectOptions

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

A builder for OpenApiGatewayProjectOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenApiGatewayProjectOptions.Builder	apiSrcDir(String apiSrcDir)	Sets the value of CommonApiProjectOptions.getApiSrcDir()
OpenApiGatewayProjectOptions	build()	Builds the configured instance.
OpenApiGatewayProjectOptions.Builder	clientLanguages(List<? extends ClientLanguage> clientLanguages)	Sets the value of CommonApiProjectOptions.getClientLanguages()
OpenApiGatewayProjectOptions.Builder	documentationFormats(List<? extends DocumentationFormat> documentationFormats)	Sets the value of CommonApiProjectOptions.getDocumentationFormats()
OpenApiGatewayProjectOptions.Builder	forceGenerateCodeAndDocs(Boolean forceGenerateCodeAndDocs)	Sets the value of CommonApiProjectOptions.getForceGenerateCodeAndDocs()
OpenApiGatewayProjectOptions.Builder	generatedCodeDir(String generatedCodeDir)	Sets the value of CommonApiProjectOptions.getGeneratedCodeDir()
OpenApiGatewayProjectOptions.Builder	javaClientOptions(io.github.cdklabs.projen.java.JavaProjectOptions javaClientOptions)	Sets the value of CommonApiProjectOptions.getJavaClientOptions()
OpenApiGatewayProjectOptions.Builder	parsedSpecFileName(String parsedSpecFileName)	Sets the value of CommonApiProjectOptions.getParsedSpecFileName()
OpenApiGatewayProjectOptions.Builder	pythonClientOptions(io.github.cdklabs.projen.python.PythonProjectOptions pythonClientOptions)	Sets the value of CommonApiProjectOptions.getPythonClientOptions()
OpenApiGatewayProjectOptions.Builder	specFile(String specFile)	Sets the value of OpenApiGatewayProjectOptions.getSpecFile()
OpenApiGatewayProjectOptions.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

specFile

@Stability(Experimental)
public OpenApiGatewayProjectOptions.Builder specFile(String specFile)

Sets the value of OpenApiGatewayProjectOptions.getSpecFile()

Parameters:

specFile - The path to the OpenAPI specification file, relative to the project source directory (srcdir).

Returns:

this

clientLanguages

@Stability(Experimental)
public OpenApiGatewayProjectOptions.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 OpenApiGatewayProjectOptions.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 OpenApiGatewayProjectOptions.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 OpenApiGatewayProjectOptions.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 OpenApiGatewayProjectOptions.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 OpenApiGatewayProjectOptions.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 OpenApiGatewayProjectOptions.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 OpenApiGatewayProjectOptions.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 OpenApiGatewayProjectOptions.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 OpenApiGatewayProjectOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of OpenApiGatewayProjectOptions

Throws:

NullPointerException - if any required attribute was not provided