Package org.cdk8s.plus25.k8s

Class RbdVolumeSource.Builder

java.lang.Object

org.cdk8s.plus25.k8s.RbdVolumeSource.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<RbdVolumeSource>

Enclosing interface:

RbdVolumeSource

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

A builder for RbdVolumeSource

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RbdVolumeSource	build()	Builds the configured instance.
RbdVolumeSource.Builder	fsType(String fsType)	Sets the value of RbdVolumeSource.getFsType()
RbdVolumeSource.Builder	image(String image)	Sets the value of RbdVolumeSource.getImage()
RbdVolumeSource.Builder	keyring(String keyring)	Sets the value of RbdVolumeSource.getKeyring()
RbdVolumeSource.Builder	monitors(List<String> monitors)	Sets the value of RbdVolumeSource.getMonitors()
RbdVolumeSource.Builder	pool(String pool)	Sets the value of RbdVolumeSource.getPool()
RbdVolumeSource.Builder	readOnly(Boolean readOnly)	Sets the value of RbdVolumeSource.getReadOnly()
RbdVolumeSource.Builder	secretRef(LocalObjectReference secretRef)	Sets the value of RbdVolumeSource.getSecretRef()
RbdVolumeSource.Builder	user(String user)	Sets the value of RbdVolumeSource.getUser()

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

image

@Stability(Stable)
public RbdVolumeSource.Builder image(String image)

Sets the value of RbdVolumeSource.getImage()

Parameters:

image - image is the rados image name. This parameter is required. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Returns:

this

monitors

@Stability(Stable)
public RbdVolumeSource.Builder monitors(List<String> monitors)

Sets the value of RbdVolumeSource.getMonitors()

Parameters:

monitors - monitors is a collection of Ceph monitors. This parameter is required. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Returns:

this

fsType

@Stability(Stable)
public RbdVolumeSource.Builder fsType(String fsType)

Sets the value of RbdVolumeSource.getFsType()

Parameters:

fsType - fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd

Returns:

this

keyring

@Stability(Stable)
public RbdVolumeSource.Builder keyring(String keyring)

Sets the value of RbdVolumeSource.getKeyring()

Parameters:

keyring - keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Returns:

this

pool

@Stability(Stable)
public RbdVolumeSource.Builder pool(String pool)

Sets the value of RbdVolumeSource.getPool()

Parameters:

pool - pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Returns:

this

readOnly

@Stability(Stable)
public RbdVolumeSource.Builder readOnly(Boolean readOnly)

Sets the value of RbdVolumeSource.getReadOnly()

Parameters:

readOnly - readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Returns:

this

secretRef

@Stability(Stable)
public RbdVolumeSource.Builder secretRef(LocalObjectReference secretRef)

Sets the value of RbdVolumeSource.getSecretRef()

Parameters:

secretRef - secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Returns:

this

user

@Stability(Stable)
public RbdVolumeSource.Builder user(String user)

Sets the value of RbdVolumeSource.getUser()

Parameters:

user - user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Returns:

this

build

@Stability(Stable)
public RbdVolumeSource build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of RbdVolumeSource

Throws:

NullPointerException - if any required attribute was not provided