Package io.fabric8.kubernetes.api.model.resource.v1alpha3

Class DeviceRequestAllocationResult

java.lang.Object

io.fabric8.kubernetes.api.model.resource.v1alpha3.DeviceRequestAllocationResult

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<DeviceRequestAllocationResultBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class DeviceRequestAllocationResult
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<DeviceRequestAllocationResultBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource

DeviceRequestAllocationResult contains the allocation result for one request.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DeviceRequestAllocationResult()	No args constructor for use in serialization
DeviceRequestAllocationResult(Boolean adminAccess, String device, String driver, String pool, String request, List<DeviceToleration> tolerations)

Method Summary

Modifier and Type	Method	Description
DeviceRequestAllocationResultBuilder	edit()
Map<String,Object>	getAdditionalProperties()
Boolean	getAdminAccess()	AdminAccess indicates that this device was allocated for administrative access.
String	getDevice()	Device references one device instance via its name in the driver's resource pool.
String	getDriver()	Driver specifies the name of the DRA driver whose kubelet plugin should be invoked to process the allocation once the claim is needed on a node.
String	getPool()	This name together with the driver name and the device name field identify which device was allocated (`<driver name>/<pool name>/<device name>`).
String	getRequest()	Request is the name of the request in the claim which caused this device to be allocated.
List<DeviceToleration>	getTolerations()	A copy of all tolerations specified in the request at the time when the device got allocated.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setAdminAccess(Boolean adminAccess)	AdminAccess indicates that this device was allocated for administrative access.
void	setDevice(String device)	Device references one device instance via its name in the driver's resource pool.
void	setDriver(String driver)	Driver specifies the name of the DRA driver whose kubelet plugin should be invoked to process the allocation once the claim is needed on a node.
void	setPool(String pool)	This name together with the driver name and the device name field identify which device was allocated (`<driver name>/<pool name>/<device name>`).
void	setRequest(String request)	Request is the name of the request in the claim which caused this device to be allocated.
void	setTolerations(List<DeviceToleration> tolerations)	A copy of all tolerations specified in the request at the time when the device got allocated.
DeviceRequestAllocationResultBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceRequestAllocationResult

public DeviceRequestAllocationResult()

No args constructor for use in serialization

DeviceRequestAllocationResult

public DeviceRequestAllocationResult(Boolean adminAccess,
                                     String device,
                                     String driver,
                                     String pool,
                                     String request,
                                     List<DeviceToleration> tolerations)

Method Detail

getAdminAccess

public Boolean getAdminAccess()

AdminAccess indicates that this device was allocated for administrative access. See the corresponding request field for a definition of mode.

This is an alpha field and requires enabling the DRAAdminAccess feature gate. Admin access is disabled if this field is unset or set to false, otherwise it is enabled.

setAdminAccess

public void setAdminAccess(Boolean adminAccess)

AdminAccess indicates that this device was allocated for administrative access. See the corresponding request field for a definition of mode.

This is an alpha field and requires enabling the DRAAdminAccess feature gate. Admin access is disabled if this field is unset or set to false, otherwise it is enabled.

getDevice

public String getDevice()

Device references one device instance via its name in the driver's resource pool. It must be a DNS label.

setDevice

public void setDevice(String device)

Device references one device instance via its name in the driver's resource pool. It must be a DNS label.

getDriver

public String getDriver()

Driver specifies the name of the DRA driver whose kubelet plugin should be invoked to process the allocation once the claim is needed on a node.

Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver.

setDriver

public void setDriver(String driver)

Driver specifies the name of the DRA driver whose kubelet plugin should be invoked to process the allocation once the claim is needed on a node.

Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver.

getPool

public String getPool()

This name together with the driver name and the device name field identify which device was allocated (`<driver name>/<pool name>/<device name>`).

Must not be longer than 253 characters and may contain one or more DNS sub-domains separated by slashes.

setPool

public void setPool(String pool)

This name together with the driver name and the device name field identify which device was allocated (`<driver name>/<pool name>/<device name>`).

Must not be longer than 253 characters and may contain one or more DNS sub-domains separated by slashes.

getRequest

public String getRequest()

Request is the name of the request in the claim which caused this device to be allocated. If it references a subrequest in the firstAvailable list on a DeviceRequest, this field must include both the name of the main request and the subrequest using the format <main request>/<subrequest>.

Multiple devices may have been allocated per request.

setRequest

public void setRequest(String request)

Request is the name of the request in the claim which caused this device to be allocated. If it references a subrequest in the firstAvailable list on a DeviceRequest, this field must include both the name of the main request and the subrequest using the format <main request>/<subrequest>.

Multiple devices may have been allocated per request.

getTolerations

public List<DeviceToleration> getTolerations()

A copy of all tolerations specified in the request at the time when the device got allocated.

The maximum number of tolerations is 16.

This is an alpha field and requires enabling the DRADeviceTaints feature gate.

setTolerations

public void setTolerations(List<DeviceToleration> tolerations)

A copy of all tolerations specified in the request at the time when the device got allocated.

The maximum number of tolerations is 16.

This is an alpha field and requires enabling the DRADeviceTaints feature gate.

edit

public DeviceRequestAllocationResultBuilder edit()

Specified by:

edit in interface io.fabric8.kubernetes.api.builder.Editable<DeviceRequestAllocationResultBuilder>

toBuilder

public DeviceRequestAllocationResultBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)