Package software.aws.awsprototypingsdk.openapigateway

Class OpenApiGatewayProjectOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.aws.awsprototypingsdk.openapigateway.OpenApiGatewayProjectOptions.Jsii$Proxy

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, OpenApiGatewayProjectOptions

Enclosing interface:

OpenApiGatewayProjectOptions

@Stability(Experimental)
@Internal
public static final class OpenApiGatewayProjectOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements OpenApiGatewayProjectOptions

An implementation for OpenApiGatewayProjectOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.aws.awsprototypingsdk.openapigateway.OpenApiGatewayProjectOptions

OpenApiGatewayProjectOptions.Builder, OpenApiGatewayProjectOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.
protected	Jsii$Proxy(OpenApiGatewayProjectOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the OpenApiGatewayProjectOptions.Builder.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getApiSrcDir()	(experimental) The directory in which the api generated code will reside, relative to the project srcdir.
List<ClientLanguage>	getClientLanguages()	(experimental) The list of languages for which clients will be generated.
List<DocumentationFormat>	getDocumentationFormats()	(experimental) Formats to generate documentation in.
Boolean	getForceGenerateCodeAndDocs()	(experimental) Force to generate code and docs even if there were no changes in spec.
String	getGeneratedCodeDir()	(experimental) The directory in which generated client code will be generated, relative to the outdir of this project.
io.github.cdklabs.projen.java.JavaProjectOptions	getJavaClientOptions()	(experimental) Options for the generated java client (if specified in clientLanguages).
String	getParsedSpecFileName()	(experimental) The name of the output parsed OpenAPI specification file.
io.github.cdklabs.projen.python.PythonProjectOptions	getPythonClientOptions()	(experimental) Options for the generated python client (if specified in clientLanguages).
String	getSpecFile()	(experimental) The path to the OpenAPI specification file, relative to the project source directory (srcdir).
io.github.cdklabs.projen.typescript.TypeScriptProjectOptions	getTypescriptClientOptions()	(experimental) Options for the generated typescript client.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(OpenApiGatewayProjectOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the OpenApiGatewayProjectOptions.Builder.

Method Detail

getClientLanguages

public final List<ClientLanguage> getClientLanguages()

Description copied from interface: OpenApiGatewayProjectOptions

(experimental) The list of languages for which clients will be generated.

A typescript client will always be generated.

Specified by:

getClientLanguages in interface OpenApiGatewayProjectOptions

getApiSrcDir

public final String getApiSrcDir()

Description copied from interface: OpenApiGatewayProjectOptions

(experimental) The directory in which the api generated code will reside, relative to the project srcdir.

Specified by:

getApiSrcDir in interface OpenApiGatewayProjectOptions

getDocumentationFormats

public final List<DocumentationFormat> getDocumentationFormats()

Description copied from interface: OpenApiGatewayProjectOptions

(experimental) Formats to generate documentation in.

Specified by:

getDocumentationFormats in interface OpenApiGatewayProjectOptions

getForceGenerateCodeAndDocs

public final Boolean getForceGenerateCodeAndDocs()

Description copied from interface: OpenApiGatewayProjectOptions

(experimental) Force to generate code and docs even if there were no changes in spec.

Default: "false"

Specified by:

getForceGenerateCodeAndDocs in interface OpenApiGatewayProjectOptions

getGeneratedCodeDir

public final String getGeneratedCodeDir()

Description copied from interface: OpenApiGatewayProjectOptions

(experimental) The directory in which generated client code will be generated, relative to the outdir of this project.

Default: "generated"

Specified by:

getGeneratedCodeDir in interface OpenApiGatewayProjectOptions

getJavaClientOptions

public final io.github.cdklabs.projen.java.JavaProjectOptions getJavaClientOptions()

Description copied from interface: OpenApiGatewayProjectOptions

(experimental) Options for the generated java client (if specified in clientLanguages).

These override the default inferred options.

Specified by:

getJavaClientOptions in interface OpenApiGatewayProjectOptions

getParsedSpecFileName

public final String getParsedSpecFileName()

Description copied from interface: OpenApiGatewayProjectOptions

(experimental) The name of the output parsed OpenAPI specification file.

Must end with .json.

Default: ".parsed-spec.json"

Specified by:

getParsedSpecFileName in interface OpenApiGatewayProjectOptions

getPythonClientOptions

public final io.github.cdklabs.projen.python.PythonProjectOptions getPythonClientOptions()

Description copied from interface: OpenApiGatewayProjectOptions

(experimental) Options for the generated python client (if specified in clientLanguages).

These override the default inferred options.

Specified by:

getPythonClientOptions in interface OpenApiGatewayProjectOptions

getSpecFile

public final String getSpecFile()

Description copied from interface: OpenApiGatewayProjectOptions

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

Default: "spec/spec.yaml"

Specified by:

getSpecFile in interface OpenApiGatewayProjectOptions

getTypescriptClientOptions

public final io.github.cdklabs.projen.typescript.TypeScriptProjectOptions getTypescriptClientOptions()

Description copied from interface: OpenApiGatewayProjectOptions

(experimental) Options for the generated typescript client.

These override the default inferred options.

Specified by:

getTypescriptClientOptions in interface OpenApiGatewayProjectOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object