AutoRestRunner Class

Summary

Wrapper around Azure AutoRest functionality to generate client libraries for RESTful API services
Assembly
Cake.AutoRest.dll
Namespace
Cake.AutoRest
Base Types
graph BT Type-->Base0["Tool<AutoRestSettings>"] Type["AutoRestRunner"] class Type type-node

Syntax

public class AutoRestRunner : Tool<AutoRestSettings>

Constructors

Name Summary
AutoRestRunner(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator, ICakeLog) Initializes a new instance of the AutoRestRunner class

Methods

Name Value Summary
Generate(FilePath, Action<AutoRestSettings>) DirectoryPath
Invokes AutoRest to create a client model for the provided API spec, optionally using the provided settings.
Generate(FilePath, AutoRestSettings) DirectoryPath
Invokes AutoRest to create a client model for the provided API spec, using the provided settings
GetToolExecutableNames() IEnumerable<string>
Gets the possible executable names for the tool
GetToolName() string
Gets the tool name

Extension Methods

Name Value Summary
Dump<AutoRestRunner>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AutoRestRunner>(AutoRestRunner[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AutoRestRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<AutoRestRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<AutoRestRunner>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<AutoRestRunner>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin