com.pulumi.kubernetes.storage.v1beta1.inputs.CSINodeDriverArgs 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.inputs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import com.pulumi.kubernetes.storage.v1beta1.inputs.VolumeNodeResourcesArgs;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* CSINodeDriver holds information about the specification of one CSI driver installed on a node
*
*/
public final class CSINodeDriverArgs extends com.pulumi.resources.ResourceArgs {
public static final CSINodeDriverArgs Empty = new CSINodeDriverArgs();
/**
* allocatable represents the volume resources of a node that are available for scheduling.
*
*/
@Import(name="allocatable")
private @Nullable Output allocatable;
/**
* @return allocatable represents the volume resources of a node that are available for scheduling.
*
*/
public Optional> allocatable() {
return Optional.ofNullable(this.allocatable);
}
/**
* 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.
*
*/
@Import(name="name", required=true)
private Output name;
/**
* @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 Output name() {
return this.name;
}
/**
* 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.
*
*/
@Import(name="nodeID", required=true)
private Output nodeID;
/**
* @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 Output nodeID() {
return this.nodeID;
}
/**
* 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.
*
*/
@Import(name="topologyKeys")
private @Nullable Output> topologyKeys;
/**
* @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 Optional>> topologyKeys() {
return Optional.ofNullable(this.topologyKeys);
}
private CSINodeDriverArgs() {}
private CSINodeDriverArgs(CSINodeDriverArgs $) {
this.allocatable = $.allocatable;
this.name = $.name;
this.nodeID = $.nodeID;
this.topologyKeys = $.topologyKeys;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(CSINodeDriverArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private CSINodeDriverArgs $;
public Builder() {
$ = new CSINodeDriverArgs();
}
public Builder(CSINodeDriverArgs defaults) {
$ = new CSINodeDriverArgs(Objects.requireNonNull(defaults));
}
/**
* @param allocatable allocatable represents the volume resources of a node that are available for scheduling.
*
* @return builder
*
*/
public Builder allocatable(@Nullable Output allocatable) {
$.allocatable = allocatable;
return this;
}
/**
* @param allocatable allocatable represents the volume resources of a node that are available for scheduling.
*
* @return builder
*
*/
public Builder allocatable(VolumeNodeResourcesArgs allocatable) {
return allocatable(Output.of(allocatable));
}
/**
* @param name 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.
*
* @return builder
*
*/
public Builder name(Output name) {
$.name = name;
return this;
}
/**
* @param name 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.
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param nodeID 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.
*
* @return builder
*
*/
public Builder nodeID(Output nodeID) {
$.nodeID = nodeID;
return this;
}
/**
* @param nodeID 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.
*
* @return builder
*
*/
public Builder nodeID(String nodeID) {
return nodeID(Output.of(nodeID));
}
/**
* @param topologyKeys 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.
*
* @return builder
*
*/
public Builder topologyKeys(@Nullable Output> topologyKeys) {
$.topologyKeys = topologyKeys;
return this;
}
/**
* @param topologyKeys 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.
*
* @return builder
*
*/
public Builder topologyKeys(List topologyKeys) {
return topologyKeys(Output.of(topologyKeys));
}
/**
* @param topologyKeys 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.
*
* @return builder
*
*/
public Builder topologyKeys(String... topologyKeys) {
return topologyKeys(List.of(topologyKeys));
}
public CSINodeDriverArgs build() {
if ($.name == null) {
throw new MissingRequiredPropertyException("CSINodeDriverArgs", "name");
}
if ($.nodeID == null) {
throw new MissingRequiredPropertyException("CSINodeDriverArgs", "nodeID");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy