Package software.aws.awsprototypingsdk.openapigateway

Class SmithyApiGatewayJavaProject.Builder

    • Method Detail

      • name

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder name​(String name)
        (experimental) This is the name of your project.

        Default: $BASEDIR

        Parameters:
        name - This is the name of your project. This parameter is required.
        Returns:
        this

      • commitGenerated

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder commitGenerated​(Boolean commitGenerated)
        (experimental) Whether to commit the managed files by default.

        Default: true

        Parameters:
        commitGenerated - Whether to commit the managed files by default. This parameter is required.
        Returns:
        this

      • logging

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder logging​(io.github.cdklabs.projen.LoggerOptions logging)
        (experimental) Configure logging options such as verbosity.

        Default: {}

        Parameters:
        logging - Configure logging options such as verbosity. This parameter is required.
        Returns:
        this

      • outdir

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder outdir​(String outdir)
        (experimental) The root directory of the project.

        Relative to this directory, all files are synthesized.

        If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects.

        Default: "."

        Parameters:
        outdir - The root directory of the project. This parameter is required.
        Returns:
        this

      • parent

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder parent​(io.github.cdklabs.projen.Project parent)
        (experimental) The parent project, if this project is part of a bigger project.

        Parameters:
        parent - The parent project, if this project is part of a bigger project. This parameter is required.
        Returns:
        this

      • projenCommand

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder projenCommand​(String projenCommand)
        (experimental) The shell command to use in order to run the projen CLI.

        Can be used to customize in special environments.

        Default: "npx projen"

        Parameters:
        projenCommand - The shell command to use in order to run the projen CLI. This parameter is required.
        Returns:
        this

      • projenrcJson

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder projenrcJson​(Boolean projenrcJson)
        (experimental) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.

        Default: false

        Parameters:
        projenrcJson - Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. This parameter is required.
        Returns:
        this

      • projenrcJsonOptions

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder projenrcJsonOptions​(io.github.cdklabs.projen.ProjenrcOptions projenrcJsonOptions)
        (experimental) Options for .projenrc.json.

        Default: - default options

        Parameters:
        projenrcJsonOptions - Options for .projenrc.json. This parameter is required.
        Returns:
        this

      • renovatebot

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder renovatebot​(Boolean renovatebot)
        (experimental) Use renovatebot to handle dependency upgrades.

        Default: false

        Parameters:
        renovatebot - Use renovatebot to handle dependency upgrades. This parameter is required.
        Returns:
        this

      • renovatebotOptions

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder renovatebotOptions​(io.github.cdklabs.projen.RenovatebotOptions renovatebotOptions)
        (experimental) Options for renovatebot.

        Default: - default options

        Parameters:
        renovatebotOptions - Options for renovatebot. This parameter is required.
        Returns:
        this

      • autoApproveOptions

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder autoApproveOptions​(io.github.cdklabs.projen.github.AutoApproveOptions autoApproveOptions)
        (experimental) Enable and configure the 'auto approve' workflow.

        Default: - auto approve is disabled

        Parameters:
        autoApproveOptions - Enable and configure the 'auto approve' workflow. This parameter is required.
        Returns:
        this

      • autoMerge

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder autoMerge​(Boolean autoMerge)
        (experimental) Enable automatic merging on GitHub.

        Has no effect if github.mergify is set to false.

        Default: true

        Parameters:
        autoMerge - Enable automatic merging on GitHub. This parameter is required.
        Returns:
        this

      • autoMergeOptions

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder autoMergeOptions​(io.github.cdklabs.projen.github.AutoMergeOptions autoMergeOptions)
        (experimental) Configure options for automatic merging on GitHub.

        Has no effect if github.mergify or autoMerge is set to false.

        Default: - see defaults in `AutoMergeOptions`

        Parameters:
        autoMergeOptions - Configure options for automatic merging on GitHub. This parameter is required.
        Returns:
        this

      • clobber

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder clobber​(Boolean clobber)
        (experimental) Add a `clobber` task which resets the repo to origin.

        Default: true

        Parameters:
        clobber - Add a `clobber` task which resets the repo to origin. This parameter is required.
        Returns:
        this

      • devContainer

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder devContainer​(Boolean devContainer)
        (experimental) Add a VSCode development environment (used for GitHub Codespaces).

        Default: false

        Parameters:
        devContainer - Add a VSCode development environment (used for GitHub Codespaces). This parameter is required.
        Returns:
        this

      • github

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder github​(Boolean github)
        (experimental) Enable GitHub integration.

        Enabled by default for root projects. Disabled for non-root projects.

        Default: true

        Parameters:
        github - Enable GitHub integration. This parameter is required.
        Returns:
        this

      • githubOptions

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder githubOptions​(io.github.cdklabs.projen.github.GitHubOptions githubOptions)
        (experimental) Options for GitHub integration.

        Default: - see GitHubOptions

        Parameters:
        githubOptions - Options for GitHub integration. This parameter is required.
        Returns:
        this

      • gitpod

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder gitpod​(Boolean gitpod)
        (experimental) Add a Gitpod development environment.

        Default: false

        Parameters:
        gitpod - Add a Gitpod development environment. This parameter is required.
        Returns:
        this

      • mergify

        @Stability(Deprecated)
@Deprecated
public SmithyApiGatewayJavaProject.Builder mergify​(Boolean mergify)
        Deprecated.
        use `githubOptions.mergify` instead
        (deprecated) Whether mergify should be enabled on this repository or not.

        Default: true

        Parameters:
        mergify - Whether mergify should be enabled on this repository or not. This parameter is required.
        Returns:
        this

      • mergifyOptions

        @Stability(Deprecated)
@Deprecated
public SmithyApiGatewayJavaProject.Builder mergifyOptions​(io.github.cdklabs.projen.github.MergifyOptions mergifyOptions)
        Deprecated.
        use `githubOptions.mergifyOptions` instead
        (deprecated) Options for mergify.

        Default: - default options

        Parameters:
        mergifyOptions - Options for mergify. This parameter is required.
        Returns:
        this

      • projectType

        @Stability(Deprecated)
@Deprecated
public SmithyApiGatewayJavaProject.Builder projectType​(io.github.cdklabs.projen.ProjectType projectType)
        Deprecated.
        no longer supported at the base project level
        (deprecated) Which type of project this is (library/app).

        Default: ProjectType.UNKNOWN

        Parameters:
        projectType - Which type of project this is (library/app). This parameter is required.
        Returns:
        this

      • projenCredentials

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder projenCredentials​(io.github.cdklabs.projen.github.GithubCredentials projenCredentials)
        (experimental) Choose a method of providing GitHub API access for projen workflows.

        Default: - use a personal access token named PROJEN_GITHUB_TOKEN

        Parameters:
        projenCredentials - Choose a method of providing GitHub API access for projen workflows. This parameter is required.
        Returns:
        this

      • projenTokenSecret

        @Stability(Deprecated)
@Deprecated
public SmithyApiGatewayJavaProject.Builder projenTokenSecret​(String projenTokenSecret)
        Deprecated.
        use `projenCredentials`
        (deprecated) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.

        This token needs to have the repo, workflows and packages scope.

        Default: "PROJEN_GITHUB_TOKEN"

        Parameters:
        projenTokenSecret - The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This parameter is required.
        Returns:
        this

      • readme

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder readme​(io.github.cdklabs.projen.SampleReadmeProps readme)
        (experimental) The README setup.

        Default: - { filename: 'README.md', contents: '# replace this' }

        Example: 

         "{ filename: 'readme.md', contents: '# title' }"

        Parameters:
        readme - The README setup. This parameter is required.
        Returns:
        this

      • stale

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder stale​(Boolean stale)
        (experimental) Auto-close of stale issues and pull request.

        See staleOptions for options.

        Default: false

        Parameters:
        stale - Auto-close of stale issues and pull request. This parameter is required.
        Returns:
        this

      • staleOptions

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder staleOptions​(io.github.cdklabs.projen.github.StaleOptions staleOptions)
        (experimental) Auto-close stale issues and pull requests.

        To disable set stale to false.

        Default: - see defaults in `StaleOptions`

        Parameters:
        staleOptions - Auto-close stale issues and pull requests. This parameter is required.
        Returns:
        this

      • vscode

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder vscode​(Boolean vscode)
        (experimental) Enable VSCode integration.

        Enabled by default for root projects. Disabled for non-root projects.

        Default: true

        Parameters:
        vscode - Enable VSCode integration. This parameter is required.
        Returns:
        this

      • artifactId

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder artifactId​(String artifactId)
        (experimental) The artifactId is generally the name that the project is known by.

        Although the groupId is important, people within the group will rarely mention the groupId in discussion (they are often all be the same ID, such as the MojoHaus project groupId: org.codehaus.mojo). It, along with the groupId, creates a key that separates this project from every other project in the world (at least, it should :) ). Along with the groupId, the artifactId fully defines the artifact's living quarters within the repository. In the case of the above project, my-project lives in $M2_REPO/org/codehaus/mojo/my-project.

        Default: "my-app"

        Parameters:
        artifactId - The artifactId is generally the name that the project is known by. This parameter is required.
        Returns:
        this

      • groupId

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder groupId​(String groupId)
        (experimental) This is generally unique amongst an organization or a project.

        For example, all core Maven artifacts do (well, should) live under the groupId org.apache.maven. Group ID's do not necessarily use the dot notation, for example, the junit project. Note that the dot-notated groupId does not have to correspond to the package structure that the project contains. It is, however, a good practice to follow. When stored within a repository, the group acts much like the Java packaging structure does in an operating system. The dots are replaced by OS specific directory separators (such as '/' in Unix) which becomes a relative directory structure from the base repository. In the example given, the org.codehaus.mojo group lives within the directory $M2_REPO/org/codehaus/mojo.

        Default: "org.acme"

        Parameters:
        groupId - This is generally unique amongst an organization or a project. This parameter is required.
        Returns:
        this

      • version

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder version​(String version)
        (experimental) This is the last piece of the naming puzzle.

        groupId:artifactId denotes a single project but they cannot delineate which incarnation of that project we are talking about. Do we want the junit:junit of 2018 (version 4.12), or of 2007 (version 3.8.2)? In short: code changes, those changes should be versioned, and this element keeps those versions in line. It is also used within an artifact's repository to separate versions from each other. my-project version 1.0 files live in the directory structure $M2_REPO/org/codehaus/mojo/my-project/1.0.

        Default: "0.1.0"

        Parameters:
        version - This is the last piece of the naming puzzle. This parameter is required.
        Returns:
        this

      • description

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder description​(String description)
        (experimental) Description of a project is always good.

        Although this should not replace formal documentation, a quick comment to any readers of the POM is always helpful.

        Default: undefined

        Parameters:
        description - Description of a project is always good. This parameter is required.
        Returns:
        this

      • packaging

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder packaging​(String packaging)
        (experimental) Project packaging format.

        Default: "jar"

        Parameters:
        packaging - Project packaging format. This parameter is required.
        Returns:
        this

      • url

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder url​(String url)
        (experimental) The URL, like the name, is not required.

        This is a nice gesture for projects users, however, so that they know where the project lives.

        Default: undefined

        Parameters:
        url - The URL, like the name, is not required. This parameter is required.
        Returns:
        this

      • compileOptions

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder compileOptions​(io.github.cdklabs.projen.java.MavenCompileOptions compileOptions)
        (experimental) Compile options.

        Default: - defaults

        Parameters:
        compileOptions - Compile options. This parameter is required.
        Returns:
        this

      • deps

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder deps​(List<String> deps)
        (experimental) List of runtime dependencies for this project.

        Dependencies use the format: <groupId>/<artifactId>@<semver>

        Additional dependencies can be added via project.addDependency().

        Default: []

        Parameters:
        deps - List of runtime dependencies for this project. This parameter is required.
        Returns:
        this

      • distdir

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder distdir​(String distdir)
        (experimental) Final artifact output directory.

        Default: "dist/java"

        Parameters:
        distdir - Final artifact output directory. This parameter is required.
        Returns:
        this

      • junit

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder junit​(Boolean junit)
        (experimental) Include junit tests.

        Default: true

        Parameters:
        junit - Include junit tests. This parameter is required.
        Returns:
        this

      • junitOptions

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder junitOptions​(io.github.cdklabs.projen.java.JunitOptions junitOptions)
        (experimental) junit options.

        Default: - defaults

        Parameters:
        junitOptions - junit options. This parameter is required.
        Returns:
        this

      • packagingOptions

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder packagingOptions​(io.github.cdklabs.projen.java.MavenPackagingOptions packagingOptions)
        (experimental) Packaging options.

        Default: - defaults

        Parameters:
        packagingOptions - Packaging options. This parameter is required.
        Returns:
        this

      • projenrcJava

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder projenrcJava​(Boolean projenrcJava)
        (experimental) Use projenrc in java.

        This will install projen as a java dependency and will add a synth task which will compile & execute main() from src/main/java/projenrc.java.

        Default: true

        Parameters:
        projenrcJava - Use projenrc in java. This parameter is required.
        Returns:
        this

      • projenrcJavaOptions

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder projenrcJavaOptions​(io.github.cdklabs.projen.java.ProjenrcOptions projenrcJavaOptions)
        (experimental) Options related to projenrc in java.

        Default: - default options

        Parameters:
        projenrcJavaOptions - Options related to projenrc in java. This parameter is required.
        Returns:
        this

      • testDeps

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder testDeps​(List<String> testDeps)
        (experimental) List of test dependencies for this project.

        Dependencies use the format: <groupId>/<artifactId>@<semver>

        Additional dependencies can be added via project.addTestDependency().

        Default: []

        Parameters:
        testDeps - List of test dependencies for this project. This parameter is required.
        Returns:
        this

      • sample

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder sample​(Boolean sample)
        (experimental) Include sample code and test if the relevant directories don't exist.

        Default: true

        Parameters:
        sample - Include sample code and test if the relevant directories don't exist. This parameter is required.
        Returns:
        this

      • sampleJavaPackage

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder sampleJavaPackage​(String sampleJavaPackage)
        (experimental) The java package to use for the code sample.

        Default: "org.acme"

        Parameters:
        sampleJavaPackage - The java package to use for the code sample. This parameter is required.
        Returns:
        this

      • clientLanguages

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder clientLanguages​(List<? extends ClientLanguage> clientLanguages)
        (experimental) The list of languages for which clients will be generated.

        A typescript client will always be generated.

        Parameters:
        clientLanguages - The list of languages for which clients will be generated. This parameter is required.
        Returns:
        this

      • apiSrcDir

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder apiSrcDir​(String apiSrcDir)
        (experimental) The directory in which the api generated code will reside, relative to the project srcdir.

        Parameters:
        apiSrcDir - The directory in which the api generated code will reside, relative to the project srcdir. This parameter is required.
        Returns:
        this

      • documentationFormats

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder documentationFormats​(List<? extends DocumentationFormat> documentationFormats)
        (experimental) Formats to generate documentation in.

        Parameters:
        documentationFormats - Formats to generate documentation in. This parameter is required.
        Returns:
        this

      • forceGenerateCodeAndDocs

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder forceGenerateCodeAndDocs​(Boolean forceGenerateCodeAndDocs)
        (experimental) Force to generate code and docs even if there were no changes in spec.

        Default: "false"

        Parameters:
        forceGenerateCodeAndDocs - Force to generate code and docs even if there were no changes in spec. This parameter is required.
        Returns:
        this

      • generatedCodeDir

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder generatedCodeDir​(String generatedCodeDir)
        (experimental) The directory in which generated client code will be generated, relative to the outdir of this project.

        Default: "generated"

        Parameters:
        generatedCodeDir - The directory in which generated client code will be generated, relative to the outdir of this project. This parameter is required.
        Returns:
        this

      • javaClientOptions

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder javaClientOptions​(io.github.cdklabs.projen.java.JavaProjectOptions javaClientOptions)
        (experimental) Options for the generated java client (if specified in clientLanguages).

        These override the default inferred options.

        Parameters:
        javaClientOptions - Options for the generated java client (if specified in clientLanguages). This parameter is required.
        Returns:
        this

      • parsedSpecFileName

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder parsedSpecFileName​(String parsedSpecFileName)
        (experimental) The name of the output parsed OpenAPI specification file.

        Must end with .json.

        Default: ".parsed-spec.json"

        Parameters:
        parsedSpecFileName - The name of the output parsed OpenAPI specification file. This parameter is required.
        Returns:
        this

      • pythonClientOptions

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder pythonClientOptions​(io.github.cdklabs.projen.python.PythonProjectOptions pythonClientOptions)
        (experimental) Options for the generated python client (if specified in clientLanguages).

        These override the default inferred options.

        Parameters:
        pythonClientOptions - Options for the generated python client (if specified in clientLanguages). This parameter is required.
        Returns:
        this

      • typescriptClientOptions

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder typescriptClientOptions​(io.github.cdklabs.projen.typescript.TypeScriptProjectOptions typescriptClientOptions)
        (experimental) Options for the generated typescript client.

        These override the default inferred options.

        Parameters:
        typescriptClientOptions - Options for the generated typescript client. This parameter is required.
        Returns:
        this

      • serviceName

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder serviceName​(SmithyServiceName serviceName)
        (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"

        Parameters:
        serviceName - The name of the Smithy service from your model which will be targeted for deployment and client generation. This parameter is required.
        Returns:
        this

      • gradleWrapperPath

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder gradleWrapperPath​(String gradleWrapperPath)
        (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.

        Parameters:
        gradleWrapperPath - 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. This parameter is required.
        Returns:
        this

      • ignoreSmithyBuildOutput

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder ignoreSmithyBuildOutput​(Boolean ignoreSmithyBuildOutput)
        (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

        Parameters:
        ignoreSmithyBuildOutput - 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. This parameter is required.
        Returns:
        this

      • modelDir

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder modelDir​(String modelDir)
        (experimental) The path to the Smithy model directory, relative to the project source directory (srcdir).

        Default: "model"

        Parameters:
        modelDir - The path to the Smithy model directory, relative to the project source directory (srcdir). This parameter is required.
        Returns:
        this

      • smithyBuildOptions

        @Stability(Experimental)
public SmithyApiGatewayJavaProject.Builder smithyBuildOptions​(SmithyBuildOptions smithyBuildOptions)
        (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.

        Parameters:
        smithyBuildOptions - 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. This parameter is required.
        Returns:
        this
        See Also:
        https://awslabs.github.io/smithy/2.0/guides/converting-to-openapi.html#openapi-configuration-settings