Package org.cdk8s.plus24.k8s

Class KubeStatus.Builder

java.lang.Object

org.cdk8s.plus24.k8s.KubeStatus.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<KubeStatus>

Enclosing class:

KubeStatus

@Stability(Stable)
public static final class KubeStatus.Builder
extends Object
implements software.amazon.jsii.Builder<KubeStatus>

A fluent builder for KubeStatus.

Method Summary

Modifier and Type	Method	Description
KubeStatus	build()
KubeStatus.Builder	code(Number code)	Suggested HTTP return code for this status, 0 if not set.
static KubeStatus.Builder	create(software.constructs.Construct scope, String id)
KubeStatus.Builder	details(StatusDetails details)	Extended data associated with the reason.
KubeStatus.Builder	message(String message)	A human-readable description of the status of this operation.
KubeStatus.Builder	metadata(ListMeta metadata)	Standard list metadata.
KubeStatus.Builder	reason(String reason)	A machine-readable description of why this operation is in the "Failure" status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(Stable)
public static KubeStatus.Builder create(software.constructs.Construct scope,
                                        String id)

Parameters:

scope - the scope in which to define this object. This parameter is required.

id - a scope-local name for the object. This parameter is required.

Returns:

a new instance of KubeStatus.Builder.

code

@Stability(Stable)
public KubeStatus.Builder code(Number code)

Suggested HTTP return code for this status, 0 if not set.

Parameters:

code - Suggested HTTP return code for this status, 0 if not set. This parameter is required.

Returns:

this

details

@Stability(Stable)
public KubeStatus.Builder details(StatusDetails details)

Extended data associated with the reason.

Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

Parameters:

details - Extended data associated with the reason. This parameter is required.

Returns:

this

message

@Stability(Stable)
public KubeStatus.Builder message(String message)

A human-readable description of the status of this operation.

Parameters:

message - A human-readable description of the status of this operation. This parameter is required.

Returns:

this

metadata

@Stability(Stable)
public KubeStatus.Builder metadata(ListMeta metadata)

Standard list metadata.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Parameters:

metadata - Standard list metadata. This parameter is required.

Returns:

this

reason

@Stability(Stable)
public KubeStatus.Builder reason(String reason)

A machine-readable description of why this operation is in the "Failure" status.

If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

Parameters:

reason - A machine-readable description of why this operation is in the "Failure" status. This parameter is required.

Returns:

this

build

@Stability(Stable)
public KubeStatus build()

Specified by:

build in interface software.amazon.jsii.Builder<KubeStatus>