AutoRestSettings Class

This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.AutoRest.

Summary

Settings to control the AutoRest generation process.

Assembly

Cake.AutoRest.dll

Namespace

Base Types

ToolSettings

graph BT Type-->Base0["ToolSettings"] Type["AutoRestSettings"] class Type type-node

Syntax

public class AutoRestSettings : ToolSettings

Remarks

Supports either standard object syntax or a fluent interface using extension methods.

Constructors

Name	Summary
AutoRestSettings()	Create a new instances of the `AutoRestSettings` class.
AutoRestSettings(FilePath)	Create a new instances of the `AutoRestSettings` class.

Properties

Name	Value	Summary
AddCredentials	bool	If true, the generated client includes a ServiceClientCredentials property and constructor parameter. Authentication behaviors are implemented by extending the ServiceClientCredentials type
ClientName	string	Name to use for the generated client type.
Generator	CodeGenerator	The code generator (see `CodeGenerator`) language.
GeneratorSettings	IGeneratorSettings	Any generator-specific settings.
HeaderComment	string	Text to include as a header comment in generated files.
Modeler	string	The Modeler to use on the input.
Namespace	string	The namespace to use for generated code
OutputDirectory	DirectoryPath	The location for generated files.
OutputFileName	string	If set, will cause generated code to be output to a single file.
PayloadFlattenThreshold	Nullable<int>	The maximum number of properties in the request body to be represented as method arguments.
Verbose	bool	If set, will output verbose diagnostic messages.

Extension Methods

Name	Value	Summary
AddCredentials(bool)	AutoRestSettings	Enables the inclusion of a ServiceClientCredentials property and constructor parameter in generated code From AutoRestSettingsExtensions Requires the Cake.AutoRest addin
AddHeaderComment(string)	AutoRestSettings	Sets the generated code header comment From AutoRestSettingsExtensions Requires the Cake.AutoRest addin
Dump<AutoRestSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<AutoRestSettings>(AutoRestSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<AutoRestSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<AutoRestSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
OutputToDirectory(DirectoryPath)	AutoRestSettings	Sets the output directory for generated code From AutoRestSettingsExtensions Requires the Cake.AutoRest addin
OutputToFile(FilePath)	AutoRestSettings	Will cause generated code to be output to the specified single file. Not supported by all code generators. From AutoRestSettingsExtensions Requires the Cake.AutoRest addin
ThrowIfNull<AutoRestSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<AutoRestSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin
UseClientName(string)	AutoRestSettings	Sets the client name to use in generated code From AutoRestSettingsExtensions Requires the Cake.AutoRest addin
UseFlattenThreshold(int)	AutoRestSettings	Sets the property flattening threshold (see `AutoRestSettings`) From AutoRestSettingsExtensions Requires the Cake.AutoRest addin
UseNamespace(string)	AutoRestSettings	Sets the client namespace From AutoRestSettingsExtensions Requires the Cake.AutoRest addin
WithGenerator(CodeGenerator, IGeneratorSettings)	AutoRestSettings	Sets the Generator used by AutoRest From AutoRestSettingsExtensions Requires the Cake.AutoRest addin
WithModeler(string)	AutoRestSettings	Sets the modeler used by AutoRest From AutoRestSettingsExtensions Requires the Cake.AutoRest addin
WithVerboseOutput()	AutoRestSettings	Enables verbose/diagnostic messages From AutoRestSettingsExtensions Requires the Cake.AutoRest addin