Package org.cdk8s.plus25.k8s

Class CustomResourceDefinitionNames.Builder

java.lang.Object

org.cdk8s.plus25.k8s.CustomResourceDefinitionNames.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CustomResourceDefinitionNames>

Enclosing interface:

CustomResourceDefinitionNames

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

A builder for CustomResourceDefinitionNames

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CustomResourceDefinitionNames	build()	Builds the configured instance.
CustomResourceDefinitionNames.Builder	categories(List<String> categories)	Sets the value of CustomResourceDefinitionNames.getCategories()
CustomResourceDefinitionNames.Builder	kind(String kind)	Sets the value of CustomResourceDefinitionNames.getKind()
CustomResourceDefinitionNames.Builder	listKind(String listKind)	Sets the value of CustomResourceDefinitionNames.getListKind()
CustomResourceDefinitionNames.Builder	plural(String plural)	Sets the value of CustomResourceDefinitionNames.getPlural()
CustomResourceDefinitionNames.Builder	shortNames(List<String> shortNames)	Sets the value of CustomResourceDefinitionNames.getShortNames()
CustomResourceDefinitionNames.Builder	singular(String singular)	Sets the value of CustomResourceDefinitionNames.getSingular()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

kind

@Stability(Stable)
public CustomResourceDefinitionNames.Builder kind(String kind)

Sets the value of CustomResourceDefinitionNames.getKind()

Parameters:

kind - kind is the serialized kind of the resource. This parameter is required. It is normally CamelCase and singular. Custom resource instances will use this value as the kind attribute in API calls.

Returns:

this

plural

@Stability(Stable)
public CustomResourceDefinitionNames.Builder plural(String plural)

Sets the value of CustomResourceDefinitionNames.getPlural()

Parameters:

plural - plural is the plural name of the resource to serve. This parameter is required. The custom resources are served under /apis/<group>/<version>/.../<plural>. Must match the name of the CustomResourceDefinition (in the form <names.plural>.<group>). Must be all lowercase.

Returns:

this

categories

@Stability(Stable)
public CustomResourceDefinitionNames.Builder categories(List<String> categories)

Sets the value of CustomResourceDefinitionNames.getCategories()

Parameters:

categories - categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like kubectl get all.

Returns:

this

listKind

@Stability(Stable)
public CustomResourceDefinitionNames.Builder listKind(String listKind)

Sets the value of CustomResourceDefinitionNames.getListKind()

Parameters:

listKind - listKind is the serialized kind of the list for this resource. Defaults to "kindList".

Returns:

this

shortNames

@Stability(Stable)
public CustomResourceDefinitionNames.Builder shortNames(List<String> shortNames)

Sets the value of CustomResourceDefinitionNames.getShortNames()

Parameters:

shortNames - shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like kubectl get <shortname>. It must be all lowercase.

Returns:

this

singular

@Stability(Stable)
public CustomResourceDefinitionNames.Builder singular(String singular)

Sets the value of CustomResourceDefinitionNames.getSingular()

Parameters:

singular - singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind.

Returns:

this

build

@Stability(Stable)
public CustomResourceDefinitionNames build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CustomResourceDefinitionNames

Throws:

NullPointerException - if any required attribute was not provided