Skip to content

[V] UnbrandedSdkEmitterOptions

const UnbrandedSdkEmitterOptions: object;
NameTypeDefault value
api-versionobject-
api-version.api-versionobject-
api-version.api-version.description"Use this flag if you would like to generate the sdk only for a specific version. Default value is the latest version. Also accepts values `latest` and `all`.""Use this flag if you would like to generate the sdk only for a specific version. Default value is the latest version. Also accepts values `latest` and `all`."
api-version.api-version.nullabletruetrue
api-version.api-version.type"string""string"
generate-convenience-methodsobject-
generate-convenience-methods.generate-convenience-methodsobject-
generate-convenience-methods.generate-convenience-methods.description"When set to `true`, the emitter will generate convenience methods for each service operation if `@convenientAPI` is not set for an operation. Default value is `true`.""When set to `true`, the emitter will generate convenience methods for each service operation if `@convenientAPI` is not set for an operation. Default value is `true`."
generate-convenience-methods.generate-convenience-methods.nullabletruetrue
generate-convenience-methods.generate-convenience-methods.type"boolean""boolean"
generate-protocol-methodsobject-
generate-protocol-methods.generate-protocol-methodsobject-
generate-protocol-methods.generate-protocol-methods.description"When set to `true`, the emitter will generate low-level protocol methods for each service operation if `@protocolAPI` is not set for an operation. Default value is `true`.""When set to `true`, the emitter will generate low-level protocol methods for each service operation if `@protocolAPI` is not set for an operation. Default value is `true`."
generate-protocol-methods.generate-protocol-methods.nullabletruetrue
generate-protocol-methods.generate-protocol-methods.type"boolean""boolean"
licenseobject-
license.licenseobject-
license.license.additionalPropertiesfalsefalse
license.license.description"License information for the generated client code.""License information for the generated client code."
license.license.nullabletruetrue
license.license.propertiesobject-
license.license.properties.companyobject-
license.license.properties.company.description"License company name. It will be used in copyright sentences.""License company name. It will be used in copyright sentences."
license.license.properties.company.nullabletruetrue
license.license.properties.company.type"string""string"
license.license.properties.descriptionobject-
license.license.properties.description.description"License description. The full license text.""License description. The full license text."
license.license.properties.description.nullabletruetrue
license.license.properties.description.type"string""string"
license.license.properties.headerobject-
license.license.properties.header.description"License header. It will be used in the header comment of generated client code.""License header. It will be used in the header comment of generated client code."
license.license.properties.header.nullabletruetrue
license.license.properties.header.type"string""string"
license.license.properties.linkobject-
license.license.properties.link.description"License link.""License link."
license.license.properties.link.nullabletruetrue
license.license.properties.link.type"string""string"
license.license.properties.nameobject-
license.license.properties.name.description"License name. The config is required. Predefined license are: MIT License, Apache License 2.0, BSD 3-Clause License, MPL 2.0, GPL-3.0, LGPL-3.0. For other license, you need to configure all the other license config manually.""License name. The config is required. Predefined license are: MIT License, Apache License 2.0, BSD 3-Clause License, MPL 2.0, GPL-3.0, LGPL-3.0. For other license, you need to configure all the other license config manually."
license.license.properties.name.nullablefalsefalse
license.license.properties.name.type"string""string"
license.license.requiredreadonly ["name"]-
license.license.type"object""object"