DotNetAliases.

DotNetWorkloadSearch(ICakeContext, string, DotNetWorkloadSearchSettings) Method

Summary

Lists available workloads by specifying all or part of the workload ID.
Namespace
Cake.Common.Tools.DotNet
Containing Type
DotNetAliases

Syntax

[CakeMethodAlias]
[CakeAliasCategory("Workload")]
[CakeNamespaceImport("Cake.Common.Tools.DotNet.Workload.Search")]
public static IEnumerable<DotNetWorkload> DotNetWorkloadSearch(this ICakeContext context, string searchString, DotNetWorkloadSearchSettings settings)

Examples

 var settings = new DotNetWorkloadSearchSettings
 {
     Verbosity = Detailed
 };

 var workloads = DotNetWorkloadSearch("maui", settings);

 foreach (var workload in workloads)
 {
      Information($"Id: {workload.Id}, Description: {workload.Description}");
 }

Attributes

Type Description
CakeMethodAliasAttribute An attribute used to mark script method aliases.
CakeAliasCategoryAttribute An attribute used for documentation of alias methods/properties.
CakeNamespaceImportAttribute An attribute used to hint Cake about additional namespaces that need to be imported for an alias to work. This attribute can mark an extension method, the extension method class, or the assembly to provide a global set of imports.

Parameters

Name Type Description
context ICakeContext The context.
searchString string The workload ID to search for, or part of it.
settings DotNetWorkloadSearchSettings The settings.

Return Value

Type Description
IEnumerable<DotNetWorkload> The list of available workloads.