Package org.cdk8s.plus24.k8s

Interface CustomResourceColumnDefinition

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomResourceColumnDefinition.Jsii$Proxy

@Generated(value="jsii-pacmak/1.79.0 (build b22f628)",
           date="2023-03-31T02:28:41.756Z")
@Stability(Stable)
public interface CustomResourceColumnDefinition
extends software.amazon.jsii.JsiiSerializable

CustomResourceColumnDefinition specifies a column for server side printing.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CustomResourceColumnDefinition.Builder	A builder for CustomResourceColumnDefinition
static class	CustomResourceColumnDefinition.Jsii$Proxy	An implementation for CustomResourceColumnDefinition

Method Summary

Modifier and Type	Method	Description
static CustomResourceColumnDefinition.Builder	builder()
default String	getDescription()	description is a human readable description of this column.
default String	getFormat()	format is an optional OpenAPI type definition for this column.
String	getJsonPath()	jsonPath is a simple JSON path (i.e.
String	getName()	name is a human readable name for the column.
default Number	getPriority()	priority is an integer defining the relative importance of this column compared to others.
String	getType()	type is an OpenAPI type definition for this column.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getJsonPath

@Stability(Stable)
@NotNull
String getJsonPath()

jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column.

getName

@Stability(Stable)
@NotNull
String getName()

name is a human readable name for the column.

getType

@Stability(Stable)
@NotNull
String getType()

type is an OpenAPI type definition for this column.

See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

description is a human readable description of this column.

getFormat

@Stability(Stable)
@Nullable
default String getFormat()

format is an optional OpenAPI type definition for this column.

The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.

getPriority

@Stability(Stable)
@Nullable
default Number getPriority()

priority is an integer defining the relative importance of this column compared to others.

Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0.

builder

@Stability(Stable)
static CustomResourceColumnDefinition.Builder builder()

Returns:

a CustomResourceColumnDefinition.Builder of CustomResourceColumnDefinition