Package software.aws.awsprototypingsdk.openapigateway

Interface SmithyBuildOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SmithyCommon

All Known Implementing Classes:

SmithyBuildOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-15T09:33:12.957Z")
@Stability(Experimental)
public interface SmithyBuildOptions
extends software.amazon.jsii.JsiiSerializable, SmithyCommon

(experimental) Options for the smithy build files.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SmithyBuildOptions.Builder	builder()
default Boolean	getIgnoreMissingPlugins()	(experimental) If a plugin can't be found, Smithy will by default fail the build.
default SmithyMavenConfiguration	getMaven()	(experimental) Maven configuration for the Smithy build project, used to specify dependencies and repositories in the build.gradle and smithy-build.json files.
default Map<String,SmithyProjection>	getProjections()	(experimental) Map of projections name to projection configurations https://awslabs.github.io/smithy/2.0/guides/building-models/build-config.html#projections.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getImports, getPlugins

Method Detail

getIgnoreMissingPlugins

@Stability(Experimental)
@Nullable
default Boolean getIgnoreMissingPlugins()

(experimental) If a plugin can't be found, Smithy will by default fail the build.

This setting can be set to true to allow the build to progress even if a plugin can't be found on the classpath.

Default: - no ignoreMissingPlugins set in the smithy-build.json file

getMaven

@Stability(Experimental)
@Nullable
default SmithyMavenConfiguration getMaven()

(experimental) Maven configuration for the Smithy build project, used to specify dependencies and repositories in the build.gradle and smithy-build.json files.

Default: the default configuration required for Smithy to OpenAPI conversion

getProjections

@Stability(Experimental)
@Nullable
default Map<String,SmithyProjection> getProjections()

(experimental) Map of projections name to projection configurations https://awslabs.github.io/smithy/2.0/guides/building-models/build-config.html#projections.

Default: - no projections

builder

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

Returns:

a SmithyBuildOptions.Builder of SmithyBuildOptions