Package software.aws.awsprototypingsdk.openapigateway

Class CommonApiProjectOptions.Builder

java.lang.Object

software.aws.awsprototypingsdk.openapigateway.CommonApiProjectOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CommonApiProjectOptions>

Enclosing interface:

CommonApiProjectOptions

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

A builder for CommonApiProjectOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

clientLanguages

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CommonApiProjectOptions

Throws:

NullPointerException - if any required attribute was not provided