Package software.aws.awsprototypingsdk.openapigateway

Class SmithyApiGatewayProjectOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, CommonApiProjectOptions, SmithyApiGatewayProjectOptions

Enclosing interface:

SmithyApiGatewayProjectOptions

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

An implementation for SmithyApiGatewayProjectOptions

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.SmithyApiGatewayProjectOptions

SmithyApiGatewayProjectOptions.Builder, SmithyApiGatewayProjectOptions.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(SmithyApiGatewayProjectOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the SmithyApiGatewayProjectOptions.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.
String	getGradleWrapperPath()	(experimental) 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.
Boolean	getIgnoreSmithyBuildOutput()	(experimental) 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.
io.github.cdklabs.projen.java.JavaProjectOptions	getJavaClientOptions()	(experimental) Options for the generated java client (if specified in clientLanguages).
String	getModelDir()	(experimental) The path to the Smithy model directory, relative to the project source directory (srcdir).
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).
SmithyServiceName	getServiceName()	(experimental) The name of the Smithy service from your model which will be targeted for deployment and client generation.
SmithyBuildOptions	getSmithyBuildOptions()	(experimental) Any additional properties you'd like to add your smithy-build.json.
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(SmithyApiGatewayProjectOptions.Builder builder)

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

Method Detail

getServiceName

public final SmithyServiceName getServiceName()

Description copied from interface: SmithyApiGatewayProjectOptions

(experimental) The name of the Smithy service from your model which will be targeted for deployment and client generation.

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.

Default: "example.hello#Hello"

Specified by:

getServiceName in interface SmithyApiGatewayProjectOptions

getGradleWrapperPath

public final String getGradleWrapperPath()

Description copied from interface: SmithyApiGatewayProjectOptions

(experimental) 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.

Specified by:

getGradleWrapperPath in interface SmithyApiGatewayProjectOptions

getIgnoreSmithyBuildOutput

public final Boolean getIgnoreSmithyBuildOutput()

Description copied from interface: SmithyApiGatewayProjectOptions

(experimental) 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.

Default: true

Specified by:

getIgnoreSmithyBuildOutput in interface SmithyApiGatewayProjectOptions

getModelDir

public final String getModelDir()

Description copied from interface: SmithyApiGatewayProjectOptions

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

Default: "model"

Specified by:

getModelDir in interface SmithyApiGatewayProjectOptions

getSmithyBuildOptions

public final SmithyBuildOptions getSmithyBuildOptions()

Description copied from interface: SmithyApiGatewayProjectOptions

(experimental) 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.

Specified by:

getSmithyBuildOptions in interface SmithyApiGatewayProjectOptions

See Also:

https://awslabs.github.io/smithy/2.0/guides/converting-to-openapi.html#openapi-configuration-settings

getClientLanguages

public final List<ClientLanguage> getClientLanguages()

Description copied from interface: CommonApiProjectOptions

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

A typescript client will always be generated.

Specified by:

getClientLanguages in interface CommonApiProjectOptions

getApiSrcDir

public final String getApiSrcDir()

Description copied from interface: CommonApiProjectOptions

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

Specified by:

getApiSrcDir in interface CommonApiProjectOptions

getDocumentationFormats

public final List<DocumentationFormat> getDocumentationFormats()

Description copied from interface: CommonApiProjectOptions

(experimental) Formats to generate documentation in.

Specified by:

getDocumentationFormats in interface CommonApiProjectOptions

getForceGenerateCodeAndDocs

public final Boolean getForceGenerateCodeAndDocs()

Description copied from interface: CommonApiProjectOptions

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

Default: "false"

Specified by:

getForceGenerateCodeAndDocs in interface CommonApiProjectOptions

getGeneratedCodeDir

public final String getGeneratedCodeDir()

Description copied from interface: CommonApiProjectOptions

(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 CommonApiProjectOptions

getJavaClientOptions

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

Description copied from interface: CommonApiProjectOptions

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

These override the default inferred options.

Specified by:

getJavaClientOptions in interface CommonApiProjectOptions

getParsedSpecFileName

public final String getParsedSpecFileName()

Description copied from interface: CommonApiProjectOptions

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

Must end with .json.

Default: ".parsed-spec.json"

Specified by:

getParsedSpecFileName in interface CommonApiProjectOptions

getPythonClientOptions

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

Description copied from interface: CommonApiProjectOptions

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

These override the default inferred options.

Specified by:

getPythonClientOptions in interface CommonApiProjectOptions

getTypescriptClientOptions

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

Description copied from interface: CommonApiProjectOptions

(experimental) Options for the generated typescript client.

These override the default inferred options.

Specified by:

getTypescriptClientOptions in interface CommonApiProjectOptions

$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