Interface StatusCause

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    StatusCause.Jsii$Proxy

    @Generated(value="jsii-pacmak/1.79.0 (build b22f628)",
               date="2023-03-31T02:28:42.055Z")
    @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.
    • 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.