Package org.cdk8s.plus25.k8s
Interface StatusCause
-
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
StatusCause.Jsii$Proxy
@Generated(value="jsii-pacmak/1.88.0 (build eaabd08)", date="2023-09-11T06:17:58.823Z") @Stability(Stable) public interface StatusCause extends software.amazon.jsii.JsiiSerializable
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classStatusCause.BuilderA builder forStatusCausestatic classStatusCause.Jsii$ProxyAn implementation forStatusCause
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static StatusCause.Builderbuilder()default StringgetField()The field of the resource that has caused this error, as named by its JSON serialization.default StringgetMessage()A human-readable description of the cause of the error.default StringgetReason()A machine-readable description of the cause of the error.
-
-
-
Method Detail
-
getField
@Stability(Stable) @Nullable default String getField()
The field of the resource that has caused this error, as named by its JSON serialization.May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
-
getMessage
@Stability(Stable) @Nullable default String getMessage()
A human-readable description of the cause of the error.This field may be presented as-is to a reader.
-
getReason
@Stability(Stable) @Nullable default String getReason()
A machine-readable description of the cause of the error.If this value is empty there is no information available.
-
builder
@Stability(Stable) static StatusCause.Builder builder()
- Returns:
- a
StatusCause.BuilderofStatusCause
-
-