com.pulumi.kubernetes.storage.v1beta1.outputs.CSINodeDriver Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kubernetes Show documentation
Show all versions of kubernetes Show documentation
A Pulumi package for creating and managing Kubernetes resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.kubernetes.storage.v1beta1.outputs;
import com.pulumi.core.annotations.CustomType;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import com.pulumi.kubernetes.storage.v1beta1.outputs.VolumeNodeResources;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
@CustomType
public final class CSINodeDriver {
/**
* @return allocatable represents the volume resources of a node that are available for scheduling.
*
*/
private @Nullable VolumeNodeResources allocatable;
/**
* @return This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver.
*
*/
private String name;
/**
* @return nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required.
*
*/
private String nodeID;
/**
* @return topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology.
*
*/
private @Nullable List topologyKeys;
private CSINodeDriver() {}
/**
* @return allocatable represents the volume resources of a node that are available for scheduling.
*
*/
public Optional allocatable() {
return Optional.ofNullable(this.allocatable);
}
/**
* @return This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver.
*
*/
public String name() {
return this.name;
}
/**
* @return nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required.
*
*/
public String nodeID() {
return this.nodeID;
}
/**
* @return topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology.
*
*/
public List topologyKeys() {
return this.topologyKeys == null ? List.of() : this.topologyKeys;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(CSINodeDriver defaults) {
return new Builder(defaults);
}
@CustomType.Builder
public static final class Builder {
private @Nullable VolumeNodeResources allocatable;
private String name;
private String nodeID;
private @Nullable List topologyKeys;
public Builder() {}
public Builder(CSINodeDriver defaults) {
Objects.requireNonNull(defaults);
this.allocatable = defaults.allocatable;
this.name = defaults.name;
this.nodeID = defaults.nodeID;
this.topologyKeys = defaults.topologyKeys;
}
@CustomType.Setter
public Builder allocatable(@Nullable VolumeNodeResources allocatable) {
this.allocatable = allocatable;
return this;
}
@CustomType.Setter
public Builder name(String name) {
if (name == null) {
throw new MissingRequiredPropertyException("CSINodeDriver", "name");
}
this.name = name;
return this;
}
@CustomType.Setter
public Builder nodeID(String nodeID) {
if (nodeID == null) {
throw new MissingRequiredPropertyException("CSINodeDriver", "nodeID");
}
this.nodeID = nodeID;
return this;
}
@CustomType.Setter
public Builder topologyKeys(@Nullable List topologyKeys) {
this.topologyKeys = topologyKeys;
return this;
}
public Builder topologyKeys(String... topologyKeys) {
return topologyKeys(List.of(topologyKeys));
}
public CSINodeDriver build() {
final var _resultValue = new CSINodeDriver();
_resultValue.allocatable = allocatable;
_resultValue.name = name;
_resultValue.nodeID = nodeID;
_resultValue.topologyKeys = topologyKeys;
return _resultValue;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy