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.Kubectl.

Summary

Print the supported API resources on the server.

Assembly

Cake.Kubectl.dll

Namespace

Cake.Kubectl

Base Types

ToolSettings
AutoToolSettings

graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Kubectl/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["KubectlApiResourcesSettings"] class Type type-node

Syntax

public sealed class KubectlApiResourcesSettings : AutoToolSettings

Examples

# Print the supported API resources kubectl api-resources # Print the supported API resources with more information kubectl api-resources -o wide # Print the supported API resources sorted by a column kubectl api-resources --sort-by=name # Print the supported namespaced resources kubectl api-resources --namespaced=true # Print the supported non-namespaced resources kubectl api-resources --namespaced=false # Print the supported API resources with a specific APIGroup kubectl api-resources --api-group=rbac.authorization.k8s.io

Attributes

Type	Description
NullableContextAttribute
NullableAttribute
CompilerGeneratedAttribute

Constructors

Name	Summary
KubectlApiResourcesSettings()

Properties

Name	Value	Summary
ApiGroup	string	--api-group Limit to resources in the specified API group.
Cached	Nullable<bool>	--cached Use the cached list of resources if available.
Categories	string	--categories Limit to resources that belong the the specified categories.
Namespaced	Nullable<bool>	--namespaced If false, non-namespaced resources will be returned, otherwise returning namespaced resources by default.
NoHeaders	Nullable<bool>	--no-headers When using the default or custom-column output format, don't print headers (default print headers).
Output	string	-o, --output Output format. One of: (wide, name).
SortBy	string	--sort-by If non-empty, sort list of resources using specified field. The field can be either 'name' or 'kind'.
Verbs	string	--verbs Limit to resources that support the specified verbs.

Extension Methods

Name	Value	Summary
Dump<KubectlApiResourcesSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<KubectlApiResourcesSettings>(KubectlApiResourcesSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<KubectlApiResourcesSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<KubectlApiResourcesSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<KubectlApiResourcesSettings>(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<KubectlApiResourcesSettings>(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