Class SmithyApiGatewayPythonProjectOptions.Jsii$Proxy
- java.lang.Object
-
- software.amazon.jsii.JsiiObject
-
- software.aws.awsprototypingsdk.openapigateway.SmithyApiGatewayPythonProjectOptions.Jsii$Proxy
-
- All Implemented Interfaces:
io.github.cdklabs.projen.github.GitHubProjectOptions,io.github.cdklabs.projen.ProjectOptions,io.github.cdklabs.projen.python.PythonPackagingOptions,io.github.cdklabs.projen.python.PythonProjectOptions,software.amazon.jsii.JsiiSerializable,CommonApiProjectOptions,SmithyApiGatewayProjectOptions,SmithyApiGatewayPythonProjectOptions
- Enclosing interface:
- SmithyApiGatewayPythonProjectOptions
@Stability(Experimental) @Internal public static final class SmithyApiGatewayPythonProjectOptions.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements SmithyApiGatewayPythonProjectOptions
An implementation forSmithyApiGatewayPythonProjectOptions
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Nested classes/interfaces inherited from interface software.aws.awsprototypingsdk.openapigateway.SmithyApiGatewayPythonProjectOptions
SmithyApiGatewayPythonProjectOptions.Builder, SmithyApiGatewayPythonProjectOptions.Jsii$Proxy
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)Constructor that initializes the object based on values retrieved from the JsiiObject.protectedJsii$Proxy(SmithyApiGatewayPythonProjectOptions.Builder builder)Constructor that initializes the object based on literal property values passed by theSmithyApiGatewayPythonProjectOptions.Builder.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.fasterxml.jackson.databind.JsonNode$jsii$toJson()booleanequals(Object o)StringgetApiSrcDir()(experimental) The directory in which the api generated code will reside, relative to the project srcdir.StringgetAuthorEmail()StringgetAuthorName()io.github.cdklabs.projen.github.AutoApproveOptionsgetAutoApproveOptions()BooleangetAutoMerge()io.github.cdklabs.projen.github.AutoMergeOptionsgetAutoMergeOptions()List<String>getClassifiers()List<ClientLanguage>getClientLanguages()(experimental) The list of languages for which clients will be generated.BooleangetClobber()BooleangetCommitGenerated()List<String>getDeps()StringgetDescription()BooleangetDevContainer()List<String>getDevDeps()List<DocumentationFormat>getDocumentationFormats()(experimental) Formats to generate documentation in.BooleangetForceGenerateCodeAndDocs()(experimental) Force to generate code and docs even if there were no changes in spec.StringgetGeneratedCodeDir()(experimental) The directory in which generated client code will be generated, relative to the outdir of this project.BooleangetGithub()io.github.cdklabs.projen.github.GitHubOptionsgetGithubOptions()BooleangetGitpod()StringgetGradleWrapperPath()(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.StringgetHomepage()BooleangetIgnoreSmithyBuildOutput()(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.io.github.cdklabs.projen.java.JavaProjectOptionsgetJavaClientOptions()(experimental) Options for the generated java client (if specified in clientLanguages).StringgetLicense()io.github.cdklabs.projen.LoggerOptionsgetLogging()BooleangetMergify()io.github.cdklabs.projen.github.MergifyOptionsgetMergifyOptions()StringgetModelDir()(experimental) The path to the Smithy model directory, relative to the project source directory (srcdir).StringgetModuleName()StringgetName()StringgetOutdir()StringgetPackageName()io.github.cdklabs.projen.ProjectgetParent()StringgetParsedSpecFileName()(experimental) The name of the output parsed OpenAPI specification file.BooleangetPip()BooleangetPoetry()io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDepsgetPoetryOptions()io.github.cdklabs.projen.ProjectTypegetProjectType()StringgetProjenCommand()io.github.cdklabs.projen.github.GithubCredentialsgetProjenCredentials()BooleangetProjenrcJs()BooleangetProjenrcJson()io.github.cdklabs.projen.ProjenrcOptionsgetProjenrcJsonOptions()io.github.cdklabs.projen.javascript.ProjenrcOptionsgetProjenrcJsOptions()BooleangetProjenrcPython()io.github.cdklabs.projen.python.ProjenrcOptionsgetProjenrcPythonOptions()StringgetProjenTokenSecret()BooleangetPytest()io.github.cdklabs.projen.python.PytestOptionsgetPytestOptions()io.github.cdklabs.projen.python.PythonProjectOptionsgetPythonClientOptions()(experimental) Options for the generated python client (if specified in clientLanguages).io.github.cdklabs.projen.SampleReadmePropsgetReadme()BooleangetRenovatebot()io.github.cdklabs.projen.RenovatebotOptionsgetRenovatebotOptions()BooleangetSample()SmithyServiceNamegetServiceName()(experimental) The name of the Smithy service from your model which will be targeted for deployment and client generation.Map<String,Object>getSetupConfig()BooleangetSetuptools()SmithyBuildOptionsgetSmithyBuildOptions()(experimental) Any additional properties you'd like to add your smithy-build.json.BooleangetStale()io.github.cdklabs.projen.github.StaleOptionsgetStaleOptions()io.github.cdklabs.projen.typescript.TypeScriptProjectOptionsgetTypescriptClientOptions()(experimental) Options for the generated typescript client.BooleangetVenv()io.github.cdklabs.projen.python.VenvOptionsgetVenvOptions()StringgetVersion()BooleangetVscode()inthashCode()
-
-
-
Constructor Detail
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
protected Jsii$Proxy(SmithyApiGatewayPythonProjectOptions.Builder builder)
Constructor that initializes the object based on literal property values passed by theSmithyApiGatewayPythonProjectOptions.Builder.
-
-
Method Detail
-
getModuleName
public final String getModuleName()
- Specified by:
getModuleNamein interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getDeps
public final List<String> getDeps()
- Specified by:
getDepsin interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getDevDeps
public final List<String> getDevDeps()
- Specified by:
getDevDepsin interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getPip
public final Boolean getPip()
- Specified by:
getPipin interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getPoetry
public final Boolean getPoetry()
- Specified by:
getPoetryin interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getProjenrcJs
public final Boolean getProjenrcJs()
- Specified by:
getProjenrcJsin interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getProjenrcJsOptions
public final io.github.cdklabs.projen.javascript.ProjenrcOptions getProjenrcJsOptions()
- Specified by:
getProjenrcJsOptionsin interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getProjenrcPython
public final Boolean getProjenrcPython()
- Specified by:
getProjenrcPythonin interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getProjenrcPythonOptions
public final io.github.cdklabs.projen.python.ProjenrcOptions getProjenrcPythonOptions()
- Specified by:
getProjenrcPythonOptionsin interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getPytest
public final Boolean getPytest()
- Specified by:
getPytestin interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getPytestOptions
public final io.github.cdklabs.projen.python.PytestOptions getPytestOptions()
- Specified by:
getPytestOptionsin interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getSample
public final Boolean getSample()
- Specified by:
getSamplein interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getSetuptools
public final Boolean getSetuptools()
- Specified by:
getSetuptoolsin interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getVenv
public final Boolean getVenv()
- Specified by:
getVenvin interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getVenvOptions
public final io.github.cdklabs.projen.python.VenvOptions getVenvOptions()
- Specified by:
getVenvOptionsin interfaceio.github.cdklabs.projen.python.PythonProjectOptions
-
getAutoApproveOptions
public final io.github.cdklabs.projen.github.AutoApproveOptions getAutoApproveOptions()
- Specified by:
getAutoApproveOptionsin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getAutoMerge
public final Boolean getAutoMerge()
- Specified by:
getAutoMergein interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getAutoMergeOptions
public final io.github.cdklabs.projen.github.AutoMergeOptions getAutoMergeOptions()
- Specified by:
getAutoMergeOptionsin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getClobber
public final Boolean getClobber()
- Specified by:
getClobberin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getDevContainer
public final Boolean getDevContainer()
- Specified by:
getDevContainerin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getGithub
public final Boolean getGithub()
- Specified by:
getGithubin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getGithubOptions
public final io.github.cdklabs.projen.github.GitHubOptions getGithubOptions()
- Specified by:
getGithubOptionsin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getGitpod
public final Boolean getGitpod()
- Specified by:
getGitpodin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getMergify
public final Boolean getMergify()
- Specified by:
getMergifyin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getMergifyOptions
public final io.github.cdklabs.projen.github.MergifyOptions getMergifyOptions()
- Specified by:
getMergifyOptionsin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getProjectType
public final io.github.cdklabs.projen.ProjectType getProjectType()
- Specified by:
getProjectTypein interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getProjenCredentials
public final io.github.cdklabs.projen.github.GithubCredentials getProjenCredentials()
- Specified by:
getProjenCredentialsin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getProjenTokenSecret
public final String getProjenTokenSecret()
- Specified by:
getProjenTokenSecretin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getReadme
public final io.github.cdklabs.projen.SampleReadmeProps getReadme()
- Specified by:
getReadmein interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getStale
public final Boolean getStale()
- Specified by:
getStalein interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getStaleOptions
public final io.github.cdklabs.projen.github.StaleOptions getStaleOptions()
- Specified by:
getStaleOptionsin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getVscode
public final Boolean getVscode()
- Specified by:
getVscodein interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getName
public final String getName()
- Specified by:
getNamein interfaceio.github.cdklabs.projen.ProjectOptions
-
getCommitGenerated
public final Boolean getCommitGenerated()
- Specified by:
getCommitGeneratedin interfaceio.github.cdklabs.projen.ProjectOptions
-
getLogging
public final io.github.cdklabs.projen.LoggerOptions getLogging()
- Specified by:
getLoggingin interfaceio.github.cdklabs.projen.ProjectOptions
-
getOutdir
public final String getOutdir()
- Specified by:
getOutdirin interfaceio.github.cdklabs.projen.ProjectOptions
-
getParent
public final io.github.cdklabs.projen.Project getParent()
- Specified by:
getParentin interfaceio.github.cdklabs.projen.ProjectOptions
-
getProjenCommand
public final String getProjenCommand()
- Specified by:
getProjenCommandin interfaceio.github.cdklabs.projen.ProjectOptions
-
getProjenrcJson
public final Boolean getProjenrcJson()
- Specified by:
getProjenrcJsonin interfaceio.github.cdklabs.projen.ProjectOptions
-
getProjenrcJsonOptions
public final io.github.cdklabs.projen.ProjenrcOptions getProjenrcJsonOptions()
- Specified by:
getProjenrcJsonOptionsin interfaceio.github.cdklabs.projen.ProjectOptions
-
getRenovatebot
public final Boolean getRenovatebot()
- Specified by:
getRenovatebotin interfaceio.github.cdklabs.projen.ProjectOptions
-
getRenovatebotOptions
public final io.github.cdklabs.projen.RenovatebotOptions getRenovatebotOptions()
- Specified by:
getRenovatebotOptionsin interfaceio.github.cdklabs.projen.ProjectOptions
-
getAuthorEmail
public final String getAuthorEmail()
- Specified by:
getAuthorEmailin interfaceio.github.cdklabs.projen.python.PythonPackagingOptions
-
getAuthorName
public final String getAuthorName()
- Specified by:
getAuthorNamein interfaceio.github.cdklabs.projen.python.PythonPackagingOptions
-
getVersion
public final String getVersion()
- Specified by:
getVersionin interfaceio.github.cdklabs.projen.python.PythonPackagingOptions
-
getClassifiers
public final List<String> getClassifiers()
- Specified by:
getClassifiersin interfaceio.github.cdklabs.projen.python.PythonPackagingOptions
-
getDescription
public final String getDescription()
- Specified by:
getDescriptionin interfaceio.github.cdklabs.projen.python.PythonPackagingOptions
-
getHomepage
public final String getHomepage()
- Specified by:
getHomepagein interfaceio.github.cdklabs.projen.python.PythonPackagingOptions
-
getLicense
public final String getLicense()
- Specified by:
getLicensein interfaceio.github.cdklabs.projen.python.PythonPackagingOptions
-
getPackageName
public final String getPackageName()
- Specified by:
getPackageNamein interfaceio.github.cdklabs.projen.python.PythonPackagingOptions
-
getPoetryOptions
public final io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps getPoetryOptions()
- Specified by:
getPoetryOptionsin interfaceio.github.cdklabs.projen.python.PythonPackagingOptions
-
getSetupConfig
public final Map<String,Object> getSetupConfig()
- Specified by:
getSetupConfigin interfaceio.github.cdklabs.projen.python.PythonPackagingOptions
-
getServiceName
public final SmithyServiceName getServiceName()
Description copied from interface:SmithyApiGatewayProjectOptions(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"
- Specified by:
getServiceNamein interfaceSmithyApiGatewayProjectOptions
-
getGradleWrapperPath
public final String getGradleWrapperPath()
Description copied from interface:SmithyApiGatewayProjectOptions(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.
- Specified by:
getGradleWrapperPathin interfaceSmithyApiGatewayProjectOptions
-
getIgnoreSmithyBuildOutput
public final Boolean getIgnoreSmithyBuildOutput()
Description copied from interface:SmithyApiGatewayProjectOptions(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
- Specified by:
getIgnoreSmithyBuildOutputin interfaceSmithyApiGatewayProjectOptions
-
getModelDir
public final String getModelDir()
Description copied from interface:SmithyApiGatewayProjectOptions(experimental) The path to the Smithy model directory, relative to the project source directory (srcdir).Default: "model"
- Specified by:
getModelDirin interfaceSmithyApiGatewayProjectOptions
-
getSmithyBuildOptions
public final SmithyBuildOptions getSmithyBuildOptions()
Description copied from interface:SmithyApiGatewayProjectOptions(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.- Specified by:
getSmithyBuildOptionsin interfaceSmithyApiGatewayProjectOptions- See Also:
- https://awslabs.github.io/smithy/2.0/guides/converting-to-openapi.html#openapi-configuration-settings
-
getClientLanguages
public final List<ClientLanguage> getClientLanguages()
Description copied from interface:CommonApiProjectOptions(experimental) The list of languages for which clients will be generated.A typescript client will always be generated.
- Specified by:
getClientLanguagesin interfaceCommonApiProjectOptions
-
getApiSrcDir
public final String getApiSrcDir()
Description copied from interface:CommonApiProjectOptions(experimental) The directory in which the api generated code will reside, relative to the project srcdir.- Specified by:
getApiSrcDirin interfaceCommonApiProjectOptions
-
getDocumentationFormats
public final List<DocumentationFormat> getDocumentationFormats()
Description copied from interface:CommonApiProjectOptions(experimental) Formats to generate documentation in.- Specified by:
getDocumentationFormatsin interfaceCommonApiProjectOptions
-
getForceGenerateCodeAndDocs
public final Boolean getForceGenerateCodeAndDocs()
Description copied from interface:CommonApiProjectOptions(experimental) Force to generate code and docs even if there were no changes in spec.Default: "false"
- Specified by:
getForceGenerateCodeAndDocsin interfaceCommonApiProjectOptions
-
getGeneratedCodeDir
public final String getGeneratedCodeDir()
Description copied from interface:CommonApiProjectOptions(experimental) The directory in which generated client code will be generated, relative to the outdir of this project.Default: "generated"
- Specified by:
getGeneratedCodeDirin interfaceCommonApiProjectOptions
-
getJavaClientOptions
public final io.github.cdklabs.projen.java.JavaProjectOptions getJavaClientOptions()
Description copied from interface:CommonApiProjectOptions(experimental) Options for the generated java client (if specified in clientLanguages).These override the default inferred options.
- Specified by:
getJavaClientOptionsin interfaceCommonApiProjectOptions
-
getParsedSpecFileName
public final String getParsedSpecFileName()
Description copied from interface:CommonApiProjectOptions(experimental) The name of the output parsed OpenAPI specification file.Must end with .json.
Default: ".parsed-spec.json"
- Specified by:
getParsedSpecFileNamein interfaceCommonApiProjectOptions
-
getPythonClientOptions
public final io.github.cdklabs.projen.python.PythonProjectOptions getPythonClientOptions()
Description copied from interface:CommonApiProjectOptions(experimental) Options for the generated python client (if specified in clientLanguages).These override the default inferred options.
- Specified by:
getPythonClientOptionsin interfaceCommonApiProjectOptions
-
getTypescriptClientOptions
public final io.github.cdklabs.projen.typescript.TypeScriptProjectOptions getTypescriptClientOptions()
Description copied from interface:CommonApiProjectOptions(experimental) Options for the generated typescript client.These override the default inferred options.
- Specified by:
getTypescriptClientOptionsin interfaceCommonApiProjectOptions
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
-