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
Display events
Prints a table of the most important information about events. You can request events for a namespace, for all namespace, or filtered to only those pertaining to a specified resource.
- 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["KubectlEventsSettings"]
class Type type-node
Syntax
public sealed class KubectlEventsSettings : AutoToolSettingsExamples
# List recent events in the default namespace.
kubectl events
# List recent events in all namespaces.
kubectl events --all-namespaces
# List recent events for the specified pod, then wait for more events and list them as they arrive.
kubectl events --for pod/web-pod-13je7 --watch
# List recent events in given format. Supported ones, apart from default, are json and yaml.
kubectl events -oyaml
# List recent only events in given event types
kubectl events --types=Warning,Normal
Attributes
| Type | Description |
|---|---|
| Nullable |
|
| NullableAttribute | |
| Compiler |
Constructors
| Name | Summary |
|---|---|
| Kubectl |
Properties
| Name | Value | Summary |
|---|---|---|
| AllNamespaces | Nullable |
-A, --all-namespaces
If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
|
| Allow |
Nullable |
--allow-missing-template-keys
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.
|
| ChunkSize | Nullable |
--chunk-size
Return large lists in chunks rather than all at once. Pass 0 to disable. This flag is beta and may change in the future.
|
| For | string |
--for
Filter events to only those pertaining to the specified resource.
|
| NoHeaders | Nullable |
--no-headers
When using the default output format, don't print headers.
|
| Output | string |
-o, --output
Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
|
| ShowManagedFields | Nullable |
--show-managed-fields
If true, keep the managedFields when printing objects in JSON or YAML format.
|
| Template | string |
--template
Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
| Types | string |
--types
Output only events of given types.
|
| Watch | Nullable |
-w, --watch
After listing the requested events, watch for more events.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|