KubectlRolloutStatusSettings Class

Summary

Show the status of the rollout. By default 'rollout status' will watch the status of the latest rollout until it's done. If you don't want to wait for the rollout to finish then you can use --watch=false. Note that if a new rollout starts in-between, then 'rollout status' will continue watching the latest revision. If you want to pin to a specific revision and abort if it is rolled over by another revision, use --revision=N where N is the revision you need to watch for.
Assembly
Cake.Kubectl.dll
Namespace
Cake.Kubectl
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Kubectl/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["KubectlRolloutStatusSettings"] class Type type-node

Syntax

public sealed class KubectlRolloutStatusSettings : AutoToolSettings

Examples

# Watch the rollout status of a deployment kubectl rollout status deployment/nginx

Attributes

Type Description
CompilerGeneratedAttribute

Constructors

Properties

Name Value Summary
Filename string
-f, --filename Filename, directory, or URL to files identifying the resource to get from a server.
Kustomize string
-k, --kustomize Process the kustomization directory. This flag can't be used together with -f or -R.
Recursive Nullable<bool>
-R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
Revision string
--revision Pin to a specific revision for showing its status. Defaults to 0 (last revision).
Timeout string
--timeout The length of time to wait before ending watch, zero means never. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h).
Watch Nullable<bool>
-w, --watch Watch the status of the rollout until it's done.

Extension Methods

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