Class OpenApiGatewayPythonProject.Builder
- java.lang.Object
-
- software.aws.awsprototypingsdk.openapigateway.OpenApiGatewayPythonProject.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<OpenApiGatewayPythonProject>
- Enclosing class:
- OpenApiGatewayPythonProject
@Stability(Deprecated) @Deprecated public static final class OpenApiGatewayPythonProject.Builder extends Object implements software.amazon.jsii.Builder<OpenApiGatewayPythonProject>
Deprecated.(deprecated) A fluent builder forOpenApiGatewayPythonProject.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OpenApiGatewayPythonProject.BuilderapiSrcDir(String apiSrcDir)Deprecated.(experimental) The directory in which the api generated code will reside, relative to the project srcdir.OpenApiGatewayPythonProject.BuilderauthorEmail(String authorEmail)Deprecated.(experimental) Author's e-mail.OpenApiGatewayPythonProject.BuilderauthorName(String authorName)Deprecated.(experimental) Author's name.OpenApiGatewayPythonProject.BuilderautoApproveOptions(io.github.cdklabs.projen.github.AutoApproveOptions autoApproveOptions)Deprecated.(experimental) Enable and configure the 'auto approve' workflow.OpenApiGatewayPythonProject.BuilderautoMerge(Boolean autoMerge)Deprecated.(experimental) Enable automatic merging on GitHub.OpenApiGatewayPythonProject.BuilderautoMergeOptions(io.github.cdklabs.projen.github.AutoMergeOptions autoMergeOptions)Deprecated.(experimental) Configure options for automatic merging on GitHub.OpenApiGatewayPythonProjectbuild()Deprecated.OpenApiGatewayPythonProject.Builderclassifiers(List<String> classifiers)Deprecated.(experimental) A list of PyPI trove classifiers that describe the project.OpenApiGatewayPythonProject.BuilderclientLanguages(List<? extends ClientLanguage> clientLanguages)Deprecated.(experimental) The list of languages for which clients will be generated.OpenApiGatewayPythonProject.Builderclobber(Boolean clobber)Deprecated.(experimental) Add aclobbertask which resets the repo to origin.OpenApiGatewayPythonProject.BuildercommitGenerated(Boolean commitGenerated)Deprecated.(experimental) Whether to commit the managed files by default.static OpenApiGatewayPythonProject.Buildercreate()Deprecated.OpenApiGatewayPythonProject.Builderdeps(List<String> deps)Deprecated.(experimental) List of runtime dependencies for this project.OpenApiGatewayPythonProject.Builderdescription(String description)Deprecated.(experimental) A short description of the package.OpenApiGatewayPythonProject.BuilderdevContainer(Boolean devContainer)Deprecated.(experimental) Add a VSCode development environment (used for GitHub Codespaces).OpenApiGatewayPythonProject.BuilderdevDeps(List<String> devDeps)Deprecated.(experimental) List of dev dependencies for this project.OpenApiGatewayPythonProject.BuilderdocumentationFormats(List<? extends DocumentationFormat> documentationFormats)Deprecated.(experimental) Formats to generate documentation in.OpenApiGatewayPythonProject.BuilderforceGenerateCodeAndDocs(Boolean forceGenerateCodeAndDocs)Deprecated.(experimental) Force to generate code and docs even if there were no changes in spec.OpenApiGatewayPythonProject.BuildergeneratedCodeDir(String generatedCodeDir)Deprecated.(experimental) The directory in which generated client code will be generated, relative to the outdir of this project.OpenApiGatewayPythonProject.Buildergithub(Boolean github)Deprecated.(experimental) Enable GitHub integration.OpenApiGatewayPythonProject.BuildergithubOptions(io.github.cdklabs.projen.github.GitHubOptions githubOptions)Deprecated.(experimental) Options for GitHub integration.OpenApiGatewayPythonProject.BuildergitIgnoreOptions(io.github.cdklabs.projen.IgnoreFileOptions gitIgnoreOptions)Deprecated.(experimental) Configuration options for .gitignore file.OpenApiGatewayPythonProject.BuildergitOptions(io.github.cdklabs.projen.GitOptions gitOptions)Deprecated.(experimental) Configuration options for git.OpenApiGatewayPythonProject.Buildergitpod(Boolean gitpod)Deprecated.(experimental) Add a Gitpod development environment.OpenApiGatewayPythonProject.Builderhomepage(String homepage)Deprecated.(experimental) A URL to the website of the project.OpenApiGatewayPythonProject.BuilderjavaClientOptions(io.github.cdklabs.projen.java.JavaProjectOptions javaClientOptions)Deprecated.(experimental) Options for the generated java client (if specified in clientLanguages).OpenApiGatewayPythonProject.Builderlicense(String license)Deprecated.(experimental) License of this package as an SPDX identifier.OpenApiGatewayPythonProject.Builderlogging(io.github.cdklabs.projen.LoggerOptions logging)Deprecated.(experimental) Configure logging options such as verbosity.OpenApiGatewayPythonProject.Buildermergify(Boolean mergify)Deprecated.usegithubOptions.mergifyinsteadOpenApiGatewayPythonProject.BuildermergifyOptions(io.github.cdklabs.projen.github.MergifyOptions mergifyOptions)Deprecated.usegithubOptions.mergifyOptionsinsteadOpenApiGatewayPythonProject.BuildermoduleName(String moduleName)Deprecated.(experimental) Name of the python package as used in imports and filenames.OpenApiGatewayPythonProject.Buildername(String name)Deprecated.(experimental) This is the name of your project.OpenApiGatewayPythonProject.Builderoutdir(String outdir)Deprecated.(experimental) The root directory of the project.OpenApiGatewayPythonProject.BuilderpackageName(String packageName)Deprecated.(experimental) Package name.OpenApiGatewayPythonProject.Builderparent(io.github.cdklabs.projen.Project parent)Deprecated.(experimental) The parent project, if this project is part of a bigger project.OpenApiGatewayPythonProject.BuilderparsedSpecFileName(String parsedSpecFileName)Deprecated.(experimental) The name of the output parsed OpenAPI specification file.OpenApiGatewayPythonProject.Builderpip(Boolean pip)Deprecated.(experimental) Use pip with a requirements.txt file to track project dependencies.OpenApiGatewayPythonProject.Builderpoetry(Boolean poetry)Deprecated.(experimental) Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.OpenApiGatewayPythonProject.BuilderpoetryOptions(io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps poetryOptions)Deprecated.(experimental) Additional options to set for poetry if using poetry.OpenApiGatewayPythonProject.BuilderprojectType(io.github.cdklabs.projen.ProjectType projectType)Deprecated.no longer supported at the base project levelOpenApiGatewayPythonProject.BuilderprojenCommand(String projenCommand)Deprecated.(experimental) The shell command to use in order to run the projen CLI.OpenApiGatewayPythonProject.BuilderprojenCredentials(io.github.cdklabs.projen.github.GithubCredentials projenCredentials)Deprecated.(experimental) Choose a method of providing GitHub API access for projen workflows.OpenApiGatewayPythonProject.BuilderprojenrcJs(Boolean projenrcJs)Deprecated.(experimental) Use projenrc in javascript.OpenApiGatewayPythonProject.BuilderprojenrcJson(Boolean projenrcJson)Deprecated.(experimental) Generate (once) .projenrc.json (in JSON).OpenApiGatewayPythonProject.BuilderprojenrcJsonOptions(io.github.cdklabs.projen.ProjenrcJsonOptions projenrcJsonOptions)Deprecated.(experimental) Options for .projenrc.json.OpenApiGatewayPythonProject.BuilderprojenrcJsOptions(io.github.cdklabs.projen.javascript.ProjenrcOptions projenrcJsOptions)Deprecated.(experimental) Options related to projenrc in JavaScript.OpenApiGatewayPythonProject.BuilderprojenrcPython(Boolean projenrcPython)Deprecated.(experimental) Use projenrc in Python.OpenApiGatewayPythonProject.BuilderprojenrcPythonOptions(io.github.cdklabs.projen.python.ProjenrcOptions projenrcPythonOptions)Deprecated.(experimental) Options related to projenrc in python.OpenApiGatewayPythonProject.BuilderprojenrcTs(Boolean projenrcTs)Deprecated.(experimental) Use projenrc in TypeScript.OpenApiGatewayPythonProject.BuilderprojenrcTsOptions(io.github.cdklabs.projen.typescript.ProjenrcTsOptions projenrcTsOptions)Deprecated.(experimental) Options related to projenrc in TypeScript.OpenApiGatewayPythonProject.BuilderprojenTokenSecret(String projenTokenSecret)Deprecated.useprojenCredentialsOpenApiGatewayPythonProject.Builderpytest(Boolean pytest)Deprecated.(experimental) Include pytest tests.OpenApiGatewayPythonProject.BuilderpytestOptions(io.github.cdklabs.projen.python.PytestOptions pytestOptions)Deprecated.(experimental) pytest options.OpenApiGatewayPythonProject.BuilderpythonClientOptions(io.github.cdklabs.projen.python.PythonProjectOptions pythonClientOptions)Deprecated.(experimental) Options for the generated python client (if specified in clientLanguages).OpenApiGatewayPythonProject.BuilderpythonExec(String pythonExec)Deprecated.(experimental) Path to the python executable to use.OpenApiGatewayPythonProject.Builderreadme(io.github.cdklabs.projen.SampleReadmeProps readme)Deprecated.(experimental) The README setup.OpenApiGatewayPythonProject.Builderrenovatebot(Boolean renovatebot)Deprecated.(experimental) Use renovatebot to handle dependency upgrades.OpenApiGatewayPythonProject.BuilderrenovatebotOptions(io.github.cdklabs.projen.RenovatebotOptions renovatebotOptions)Deprecated.(experimental) Options for renovatebot.OpenApiGatewayPythonProject.Buildersample(Boolean sample)Deprecated.(experimental) Include sample code and test if the relevant directories don't exist.OpenApiGatewayPythonProject.BuildersetupConfig(Map<String,? extends Object> setupConfig)Deprecated.(experimental) Additional fields to pass in the setup() function if using setuptools.OpenApiGatewayPythonProject.Buildersetuptools(Boolean setuptools)Deprecated.(experimental) Use setuptools with a setup.py script for packaging and publishing.OpenApiGatewayPythonProject.BuilderspecFile(String specFile)Deprecated.(experimental) The path to the OpenAPI specification file, relative to the project source directory (srcdir).OpenApiGatewayPythonProject.Builderstale(Boolean stale)Deprecated.(experimental) Auto-close of stale issues and pull request.OpenApiGatewayPythonProject.BuilderstaleOptions(io.github.cdklabs.projen.github.StaleOptions staleOptions)Deprecated.(experimental) Auto-close stale issues and pull requests.OpenApiGatewayPythonProject.BuildertypescriptClientOptions(io.github.cdklabs.projen.typescript.TypeScriptProjectOptions typescriptClientOptions)Deprecated.(experimental) Options for the generated typescript client.OpenApiGatewayPythonProject.Buildervenv(Boolean venv)Deprecated.(experimental) Use venv to manage a virtual environment for installing dependencies inside.OpenApiGatewayPythonProject.BuildervenvOptions(io.github.cdklabs.projen.python.VenvOptions venvOptions)Deprecated.(experimental) Venv options.OpenApiGatewayPythonProject.Builderversion(String version)Deprecated.(experimental) Version of the package.OpenApiGatewayPythonProject.Buildervscode(Boolean vscode)Deprecated.(experimental) Enable VSCode integration.
-
-
-
Method Detail
-
create
@Stability(Deprecated) @Deprecated public static OpenApiGatewayPythonProject.Builder create()
Deprecated.- Returns:
- a new instance of
OpenApiGatewayPythonProject.Builder.
-
name
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder name(String name)
Deprecated.(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 OpenApiGatewayPythonProject.Builder commitGenerated(Boolean commitGenerated)
Deprecated.(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
-
gitIgnoreOptions
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder gitIgnoreOptions(io.github.cdklabs.projen.IgnoreFileOptions gitIgnoreOptions)
Deprecated.(experimental) Configuration options for .gitignore file.- Parameters:
gitIgnoreOptions- Configuration options for .gitignore file. This parameter is required.- Returns:
this
-
gitOptions
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder gitOptions(io.github.cdklabs.projen.GitOptions gitOptions)
Deprecated.(experimental) Configuration options for git.- Parameters:
gitOptions- Configuration options for git. This parameter is required.- Returns:
this
-
logging
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder logging(io.github.cdklabs.projen.LoggerOptions logging)
Deprecated.(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 OpenApiGatewayPythonProject.Builder outdir(String outdir)
Deprecated.(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 OpenApiGatewayPythonProject.Builder parent(io.github.cdklabs.projen.Project parent)
Deprecated.(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 OpenApiGatewayPythonProject.Builder projenCommand(String projenCommand)
Deprecated.(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 OpenApiGatewayPythonProject.Builder projenrcJson(Boolean projenrcJson)
Deprecated.(experimental) Generate (once) .projenrc.json (in JSON). Set tofalsein order to disable .projenrc.json generation.Default: false
- Parameters:
projenrcJson- Generate (once) .projenrc.json (in JSON). Set tofalsein order to disable .projenrc.json generation. This parameter is required.- Returns:
this
-
projenrcJsonOptions
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder projenrcJsonOptions(io.github.cdklabs.projen.ProjenrcJsonOptions projenrcJsonOptions)
Deprecated.(experimental) Options for .projenrc.json.Default: - default options
- Parameters:
projenrcJsonOptions- Options for .projenrc.json. This parameter is required.- Returns:
this
-
renovatebot
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder renovatebot(Boolean renovatebot)
Deprecated.(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 OpenApiGatewayPythonProject.Builder renovatebotOptions(io.github.cdklabs.projen.RenovatebotOptions renovatebotOptions)
Deprecated.(experimental) Options for renovatebot.Default: - default options
- Parameters:
renovatebotOptions- Options for renovatebot. This parameter is required.- Returns:
this
-
autoApproveOptions
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder autoApproveOptions(io.github.cdklabs.projen.github.AutoApproveOptions autoApproveOptions)
Deprecated.(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 OpenApiGatewayPythonProject.Builder autoMerge(Boolean autoMerge)
Deprecated.(experimental) Enable automatic merging on GitHub.Has no effect if
github.mergifyis set to false.Default: true
- Parameters:
autoMerge- Enable automatic merging on GitHub. This parameter is required.- Returns:
this
-
autoMergeOptions
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder autoMergeOptions(io.github.cdklabs.projen.github.AutoMergeOptions autoMergeOptions)
Deprecated.(experimental) Configure options for automatic merging on GitHub.Has no effect if
github.mergifyorautoMergeis 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 OpenApiGatewayPythonProject.Builder clobber(Boolean clobber)
Deprecated.(experimental) Add aclobbertask which resets the repo to origin.Default: - true, but false for subprojects
- Parameters:
clobber- Add aclobbertask which resets the repo to origin. This parameter is required.- Returns:
this
-
devContainer
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder devContainer(Boolean devContainer)
Deprecated.(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 OpenApiGatewayPythonProject.Builder github(Boolean github)
Deprecated.(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 OpenApiGatewayPythonProject.Builder githubOptions(io.github.cdklabs.projen.github.GitHubOptions githubOptions)
Deprecated.(experimental) Options for GitHub integration.Default: - see GitHubOptions
- Parameters:
githubOptions- Options for GitHub integration. This parameter is required.- Returns:
this
-
gitpod
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder gitpod(Boolean gitpod)
Deprecated.(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 OpenApiGatewayPythonProject.Builder mergify(Boolean mergify)
Deprecated.usegithubOptions.mergifyinstead(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 OpenApiGatewayPythonProject.Builder mergifyOptions(io.github.cdklabs.projen.github.MergifyOptions mergifyOptions)
Deprecated.usegithubOptions.mergifyOptionsinstead(deprecated) Options for mergify.Default: - default options
- Parameters:
mergifyOptions- Options for mergify. This parameter is required.- Returns:
this
-
projectType
@Stability(Deprecated) @Deprecated public OpenApiGatewayPythonProject.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 OpenApiGatewayPythonProject.Builder projenCredentials(io.github.cdklabs.projen.github.GithubCredentials projenCredentials)
Deprecated.(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 OpenApiGatewayPythonProject.Builder projenTokenSecret(String projenTokenSecret)
Deprecated.useprojenCredentials(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,workflowsandpackagesscope.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 OpenApiGatewayPythonProject.Builder readme(io.github.cdklabs.projen.SampleReadmeProps readme)
Deprecated.(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 OpenApiGatewayPythonProject.Builder stale(Boolean stale)
Deprecated.(experimental) Auto-close of stale issues and pull request.See
staleOptionsfor options.Default: false
- Parameters:
stale- Auto-close of stale issues and pull request. This parameter is required.- Returns:
this
-
staleOptions
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder staleOptions(io.github.cdklabs.projen.github.StaleOptions staleOptions)
Deprecated.(experimental) Auto-close stale issues and pull requests.To disable set
staletofalse.Default: - see defaults in `StaleOptions`
- Parameters:
staleOptions- Auto-close stale issues and pull requests. This parameter is required.- Returns:
this
-
vscode
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder vscode(Boolean vscode)
Deprecated.(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
-
authorEmail
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder authorEmail(String authorEmail)
Deprecated.(experimental) Author's e-mail.Default: $GIT_USER_EMAIL
- Parameters:
authorEmail- Author's e-mail. This parameter is required.- Returns:
this
-
authorName
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder authorName(String authorName)
Deprecated.(experimental) Author's name.Default: $GIT_USER_NAME
- Parameters:
authorName- Author's name. This parameter is required.- Returns:
this
-
version
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder version(String version)
Deprecated.(experimental) Version of the package.Default: "0.1.0"
- Parameters:
version- Version of the package. This parameter is required.- Returns:
this
-
classifiers
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder classifiers(List<String> classifiers)
Deprecated.(experimental) A list of PyPI trove classifiers that describe the project.- Parameters:
classifiers- A list of PyPI trove classifiers that describe the project. This parameter is required.- Returns:
this- See Also:
- https://pypi.org/classifiers/
-
description
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder description(String description)
Deprecated.(experimental) A short description of the package.- Parameters:
description- A short description of the package. This parameter is required.- Returns:
this
-
homepage
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder homepage(String homepage)
Deprecated.(experimental) A URL to the website of the project.- Parameters:
homepage- A URL to the website of the project. This parameter is required.- Returns:
this
-
license
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder license(String license)
Deprecated.(experimental) License of this package as an SPDX identifier.- Parameters:
license- License of this package as an SPDX identifier. This parameter is required.- Returns:
this
-
packageName
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder packageName(String packageName)
Deprecated.(experimental) Package name.- Parameters:
packageName- Package name. This parameter is required.- Returns:
this
-
poetryOptions
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder poetryOptions(io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps poetryOptions)
Deprecated.(experimental) Additional options to set for poetry if using poetry.- Parameters:
poetryOptions- Additional options to set for poetry if using poetry. This parameter is required.- Returns:
this
-
setupConfig
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder setupConfig(Map<String,? extends Object> setupConfig)
Deprecated.(experimental) Additional fields to pass in the setup() function if using setuptools.- Parameters:
setupConfig- Additional fields to pass in the setup() function if using setuptools. This parameter is required.- Returns:
this
-
moduleName
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder moduleName(String moduleName)
Deprecated.(experimental) Name of the python package as used in imports and filenames.Must only consist of alphanumeric characters and underscores.
Default: $PYTHON_MODULE_NAME
- Parameters:
moduleName- Name of the python package as used in imports and filenames. This parameter is required.- Returns:
this
-
deps
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder deps(List<String> deps)
Deprecated.(experimental) List of runtime dependencies for this project.Dependencies use the format:
<module>@<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
-
devDeps
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder devDeps(List<String> devDeps)
Deprecated.(experimental) List of dev dependencies for this project.Dependencies use the format:
<module>@<semver>Additional dependencies can be added via
project.addDevDependency().Default: []
- Parameters:
devDeps- List of dev dependencies for this project. This parameter is required.- Returns:
this
-
pip
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder pip(Boolean pip)
Deprecated.(experimental) Use pip with a requirements.txt file to track project dependencies.Default: - true, unless poetry is true, then false
- Parameters:
pip- Use pip with a requirements.txt file to track project dependencies. This parameter is required.- Returns:
this
-
poetry
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder poetry(Boolean poetry)
Deprecated.(experimental) Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.This feature is incompatible with pip, setuptools, or venv. If you set this option to
true, then pip, setuptools, and venv must be set tofalse.Default: false
- Parameters:
poetry- Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. This parameter is required.- Returns:
this
-
projenrcJs
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder projenrcJs(Boolean projenrcJs)
Deprecated.(experimental) Use projenrc in javascript.This will install
projenas a JavaScript dependency and add asynthtask which will run.projenrc.js.Default: false
- Parameters:
projenrcJs- Use projenrc in javascript. This parameter is required.- Returns:
this
-
projenrcJsOptions
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder projenrcJsOptions(io.github.cdklabs.projen.javascript.ProjenrcOptions projenrcJsOptions)
Deprecated.(experimental) Options related to projenrc in JavaScript.Default: - default options
- Parameters:
projenrcJsOptions- Options related to projenrc in JavaScript. This parameter is required.- Returns:
this
-
projenrcPython
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder projenrcPython(Boolean projenrcPython)
Deprecated.(experimental) Use projenrc in Python.This will install
projenas a Python dependency and add asynthtask which will run.projenrc.py.Default: true
- Parameters:
projenrcPython- Use projenrc in Python. This parameter is required.- Returns:
this
-
projenrcPythonOptions
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder projenrcPythonOptions(io.github.cdklabs.projen.python.ProjenrcOptions projenrcPythonOptions)
Deprecated.(experimental) Options related to projenrc in python.Default: - default options
- Parameters:
projenrcPythonOptions- Options related to projenrc in python. This parameter is required.- Returns:
this
-
projenrcTs
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder projenrcTs(Boolean projenrcTs)
Deprecated.(experimental) Use projenrc in TypeScript.This will create a tsconfig file (default:
tsconfig.projen.json) and usets-nodein the default task to parse the project source files.Default: false
- Parameters:
projenrcTs- Use projenrc in TypeScript. This parameter is required.- Returns:
this
-
projenrcTsOptions
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder projenrcTsOptions(io.github.cdklabs.projen.typescript.ProjenrcTsOptions projenrcTsOptions)
Deprecated.(experimental) Options related to projenrc in TypeScript.Default: - default options
- Parameters:
projenrcTsOptions- Options related to projenrc in TypeScript. This parameter is required.- Returns:
this
-
pytest
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder pytest(Boolean pytest)
Deprecated.(experimental) Include pytest tests.Default: true
- Parameters:
pytest- Include pytest tests. This parameter is required.- Returns:
this
-
pytestOptions
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder pytestOptions(io.github.cdklabs.projen.python.PytestOptions pytestOptions)
Deprecated.(experimental) pytest options.Default: - defaults
- Parameters:
pytestOptions- pytest options. This parameter is required.- Returns:
this
-
pythonExec
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder pythonExec(String pythonExec)
Deprecated.(experimental) Path to the python executable to use.Default: "python"
- Parameters:
pythonExec- Path to the python executable to use. This parameter is required.- Returns:
this
-
sample
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder sample(Boolean sample)
Deprecated.(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
-
setuptools
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder setuptools(Boolean setuptools)
Deprecated.(experimental) Use setuptools with a setup.py script for packaging and publishing.Default: - true, unless poetry is true, then false
- Parameters:
setuptools- Use setuptools with a setup.py script for packaging and publishing. This parameter is required.- Returns:
this
-
venv
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder venv(Boolean venv)
Deprecated.(experimental) Use venv to manage a virtual environment for installing dependencies inside.Default: - true, unless poetry is true, then false
- Parameters:
venv- Use venv to manage a virtual environment for installing dependencies inside. This parameter is required.- Returns:
this
-
venvOptions
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder venvOptions(io.github.cdklabs.projen.python.VenvOptions venvOptions)
Deprecated.(experimental) Venv options.Default: - defaults
- Parameters:
venvOptions- Venv options. This parameter is required.- Returns:
this
-
clientLanguages
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder clientLanguages(List<? extends ClientLanguage> clientLanguages)
Deprecated.(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 OpenApiGatewayPythonProject.Builder apiSrcDir(String apiSrcDir)
Deprecated.(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 OpenApiGatewayPythonProject.Builder documentationFormats(List<? extends DocumentationFormat> documentationFormats)
Deprecated.(experimental) Formats to generate documentation in.- Parameters:
documentationFormats- Formats to generate documentation in. This parameter is required.- Returns:
this
-
forceGenerateCodeAndDocs
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder forceGenerateCodeAndDocs(Boolean forceGenerateCodeAndDocs)
Deprecated.(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 OpenApiGatewayPythonProject.Builder generatedCodeDir(String generatedCodeDir)
Deprecated.(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 OpenApiGatewayPythonProject.Builder javaClientOptions(io.github.cdklabs.projen.java.JavaProjectOptions javaClientOptions)
Deprecated.(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 OpenApiGatewayPythonProject.Builder parsedSpecFileName(String parsedSpecFileName)
Deprecated.(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 OpenApiGatewayPythonProject.Builder pythonClientOptions(io.github.cdklabs.projen.python.PythonProjectOptions pythonClientOptions)
Deprecated.(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 OpenApiGatewayPythonProject.Builder typescriptClientOptions(io.github.cdklabs.projen.typescript.TypeScriptProjectOptions typescriptClientOptions)
Deprecated.(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
-
specFile
@Stability(Experimental) public OpenApiGatewayPythonProject.Builder specFile(String specFile)
Deprecated.(experimental) The path to the OpenAPI specification file, relative to the project source directory (srcdir).Default: "spec/spec.yaml"
- Parameters:
specFile- The path to the OpenAPI specification file, relative to the project source directory (srcdir). This parameter is required.- Returns:
this
-
build
@Stability(Deprecated) @Deprecated public OpenApiGatewayPythonProject build()
Deprecated.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<OpenApiGatewayPythonProject>- Returns:
- a newly built instance of
OpenApiGatewayPythonProject.
-
-