java.lang.Object
- io.github.cdklabs.projen.python.PoetryPyprojectOptions.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<PoetryPyprojectOptions>

Enclosing interface:: PoetryPyprojectOptions

@Stability(Experimental)
public static final class PoetryPyprojectOptions.Builder
extends Object
implements software.amazon.jsii.Builder<PoetryPyprojectOptions>

A builder for PoetryPyprojectOptions

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PoetryPyprojectOptions.Builder`	`authors(List<String> authors)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getAuthors()`
`PoetryPyprojectOptions`	`build()`	Builds the configured instance.
`PoetryPyprojectOptions.Builder`	`classifiers(List<String> classifiers)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getClassifiers()`
`PoetryPyprojectOptions.Builder`	`dependencies(Map<String,? extends Object> dependencies)`	Sets the value of `PoetryPyprojectOptions.getDependencies()`
`PoetryPyprojectOptions.Builder`	`description(String description)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getDescription()`
`PoetryPyprojectOptions.Builder`	`devDependencies(Map<String,? extends Object> devDependencies)`	Sets the value of `PoetryPyprojectOptions.getDevDependencies()`
`PoetryPyprojectOptions.Builder`	`documentation(String documentation)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getDocumentation()`
`PoetryPyprojectOptions.Builder`	`exclude(List<String> exclude)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getExclude()`
`PoetryPyprojectOptions.Builder`	`extras(Map<String,? extends List<String>> extras)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getExtras()`
`PoetryPyprojectOptions.Builder`	`homepage(String homepage)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getHomepage()`
`PoetryPyprojectOptions.Builder`	`include(List<String> include)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getInclude()`
`PoetryPyprojectOptions.Builder`	`keywords(List<String> keywords)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getKeywords()`
`PoetryPyprojectOptions.Builder`	`license(String license)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getLicense()`
`PoetryPyprojectOptions.Builder`	`maintainers(List<String> maintainers)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getMaintainers()`
`PoetryPyprojectOptions.Builder`	`name(String name)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getName()`
`PoetryPyprojectOptions.Builder`	`packages(List<? extends Object> packages)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getPackages()`
`PoetryPyprojectOptions.Builder`	`plugins(Object plugins)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getPlugins()`
`PoetryPyprojectOptions.Builder`	`readme(String readme)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getReadme()`
`PoetryPyprojectOptions.Builder`	`repository(String repository)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getRepository()`
`PoetryPyprojectOptions.Builder`	`scripts(Map<String,? extends Object> scripts)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getScripts()`
`PoetryPyprojectOptions.Builder`	`source(List<? extends Object> source)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getSource()`
`PoetryPyprojectOptions.Builder`	`urls(Map<String,String> urls)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getUrls()`
`PoetryPyprojectOptions.Builder`	`version(String version)`	Sets the value of `PoetryPyprojectOptionsWithoutDeps.getVersion()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - dependencies
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder dependencies(Map<String,? extends Object> dependencies)
```
    Sets the value of PoetryPyprojectOptions.getDependencies()
    
    Parameters:
    
    dependencies - A list of dependencies for the project. The python version for which your package is compatible is also required.
    
    Returns:
    
    this
  - devDependencies
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder devDependencies(Map<String,? extends Object> devDependencies)
```
    Sets the value of PoetryPyprojectOptions.getDevDependencies()
    
    Parameters:
    
    devDependencies - A list of development dependencies for the project.
    
    Returns:
    
    this
  - authors
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder authors(List<String> authors)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getAuthors()
    
    Parameters:
    
    authors - The authors of the package. Must be in the form "name "
    
    Returns:
    
    this
  - classifiers
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder classifiers(List<String> classifiers)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getClassifiers()
    
    Parameters:
    
    classifiers - A list of PyPI trove classifiers that describe the project.
    
    Returns:
    
    this
  - description
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder description(String description)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getDescription()
    
    Parameters:
    
    description - A short description of the package (required).
    
    Returns:
    
    this
  - documentation
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder documentation(String documentation)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getDocumentation()
    
    Parameters:
    
    documentation - A URL to the documentation of the project.
    
    Returns:
    
    this
  - exclude
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder exclude(List<String> exclude)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getExclude()
    
    Parameters:
    
    exclude - A list of patterns that will be excluded in the final package. If a VCS is being used for a package, the exclude field will be seeded with the VCS’ ignore settings (.gitignore for git for example).
    
    Returns:
    
    this
  - extras
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder extras(Map<String,? extends List<String>> extras)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getExtras()
    
    Parameters:
    
    extras - Package extras.
    
    Returns:
    
    this
  - homepage
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder homepage(String homepage)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getHomepage()
    
    Parameters:
    
    homepage - A URL to the website of the project.
    
    Returns:
    
    this
  - include
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder include(List<String> include)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getInclude()
    
    Parameters:
    
    include - A list of patterns that will be included in the final package.
    
    Returns:
    
    this
  - keywords
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder keywords(List<String> keywords)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getKeywords()
    
    Parameters:
    
    keywords - A list of keywords (max: 5) that the package is related to.
    
    Returns:
    
    this
  - license
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder license(String license)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getLicense()
    
    Parameters:
    
    license - License of this package as an SPDX identifier. If the project is proprietary and does not use a specific license, you can set this value as "Proprietary".
    
    Returns:
    
    this
  - maintainers
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder maintainers(List<String> maintainers)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getMaintainers()
    
    Parameters:
    
    maintainers - the maintainers of the package. Must be in the form "name "
    
    Returns:
    
    this
  - name
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder name(String name)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getName()
    
    Parameters:
    
    name - Name of the package (required).
    
    Returns:
    
    this
  - packages
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder packages(List<? extends Object> packages)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getPackages()
    
    Parameters:
    
    packages - A list of packages and modules to include in the final distribution.
    
    Returns:
    
    this
  - plugins
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder plugins(Object plugins)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getPlugins()
    
    Parameters:
    
    plugins - Plugins. Must be specified as a table.
    
    Returns:
    
    this
  - readme
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder readme(String readme)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getReadme()
    
    Parameters:
    
    readme - The name of the readme file of the package.
    
    Returns:
    
    this
  - repository
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder repository(String repository)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getRepository()
    
    Parameters:
    
    repository - A URL to the repository of the project.
    
    Returns:
    
    this
  - scripts
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder scripts(Map<String,? extends Object> scripts)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getScripts()
    
    Parameters:
    
    scripts - The scripts or executables that will be installed when installing the package.
    
    Returns:
    
    this
  - source
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder source(List<? extends Object> source)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getSource()
    
    Parameters:
    
    source - Source registries from which packages are retrieved.
    
    Returns:
    
    this
  - urls
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder urls(Map<String,String> urls)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getUrls()
    
    Parameters:
    
    urls - Project custom URLs, in addition to homepage, repository and documentation. E.g. "Bug Tracker"
    
    Returns:
    
    this
  - version
```
@Stability(Experimental)
public PoetryPyprojectOptions.Builder version(String version)
```
    Sets the value of PoetryPyprojectOptionsWithoutDeps.getVersion()
    
    Parameters:
    
    version - Version of the package (required).
    
    Returns:
    
    this
  - build
```
@Stability(Experimental)
public PoetryPyprojectOptions build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<PoetryPyprojectOptions>
    
    Returns:
    
    a new instance of PoetryPyprojectOptions
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class PoetryPyprojectOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

dependencies

devDependencies

authors

classifiers

description

documentation

exclude

extras

homepage

include

keywords

license

maintainers

name

packages

plugins

readme

repository

scripts

source

urls

version

build