Package software.aws.awsprototypingsdk.openapigateway

Interface OpenApiGatewayProjectOptions

All Superinterfaces:

CommonApiProjectOptions, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

OpenApiGatewayJavaProjectOptions, OpenApiGatewayPythonProjectOptions, OpenApiGatewayTsProjectOptions

All Known Implementing Classes:

OpenApiGatewayJavaProjectOptions.Jsii$Proxy, OpenApiGatewayProjectOptions.Jsii$Proxy, OpenApiGatewayPythonProjectOptions.Jsii$Proxy, OpenApiGatewayTsProjectOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-01T04:12:24.851Z")
@Stability(Experimental)
public interface OpenApiGatewayProjectOptions
extends software.amazon.jsii.JsiiSerializable, CommonApiProjectOptions

(experimental) Options common to all open api gateway projects.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	OpenApiGatewayProjectOptions.Builder	A builder for OpenApiGatewayProjectOptions
static class	OpenApiGatewayProjectOptions.Jsii$Proxy	An implementation for OpenApiGatewayProjectOptions

Method Summary

Modifier and Type	Method	Description
static OpenApiGatewayProjectOptions.Builder	builder()
default String	getSpecFile()	(experimental) The path to the OpenAPI specification file, relative to the project source directory (srcdir).

Methods inherited from interface software.aws.awsprototypingsdk.openapigateway.CommonApiProjectOptions

getApiSrcDir, getClientLanguages, getDocumentationFormats, getForceGenerateCodeAndDocs, getGeneratedCodeDir, getJavaClientOptions, getParsedSpecFileName, getPythonClientOptions, getTypescriptClientOptions

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSpecFile

@Stability(Experimental)
@Nullable
default String getSpecFile()

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

Default: "spec/spec.yaml"

builder

@Stability(Experimental)
static OpenApiGatewayProjectOptions.Builder builder()

Returns:

a OpenApiGatewayProjectOptions.Builder of OpenApiGatewayProjectOptions