Class V1PodSpec
java.lang.Object
io.kubernetes.client.openapi.models.V1PodSpec
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2023-06-18T15:05:57.863601Z[Etc/UTC]")
public class V1PodSpec
extends Object
PodSpec is a description of a pod.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionactiveDeadlineSeconds
(Long activeDeadlineSeconds) addContainersItem
(V1Container containersItem) addEphemeralContainersItem
(V1EphemeralContainer ephemeralContainersItem) addHostAliasesItem
(V1HostAlias hostAliasesItem) addImagePullSecretsItem
(V1LocalObjectReference imagePullSecretsItem) addInitContainersItem
(V1Container initContainersItem) addReadinessGatesItem
(V1PodReadinessGate readinessGatesItem) addResourceClaimsItem
(V1PodResourceClaim resourceClaimsItem) addSchedulingGatesItem
(V1PodSchedulingGate schedulingGatesItem) addTolerationsItem
(V1Toleration tolerationsItem) addTopologySpreadConstraintsItem
(V1TopologySpreadConstraint topologySpreadConstraintsItem) addVolumesItem
(V1Volume volumesItem) affinity
(V1Affinity affinity) automountServiceAccountToken
(Boolean automountServiceAccountToken) containers
(List<V1Container> containers) dnsConfig
(V1PodDNSConfig dnsConfig) enableServiceLinks
(Boolean enableServiceLinks) ephemeralContainers
(List<V1EphemeralContainer> ephemeralContainers) boolean
Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers.Get affinityAutomountServiceAccountToken indicates whether a service account token should be automatically mounted.List of containers belonging to the pod.Get dnsConfigSet DNS policy for the pod.EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links.List of ephemeral containers run in this pod.HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified.Use the host's ipc namespace.Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.Host networking requested for this pod.Use the host's pid namespace.Use the host's user namespace.ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.List of initialization containers belonging to the pod.NodeName is a request to schedule this pod onto a specific node.NodeSelector is a selector which must be true for the pod to fit on a node.getOs()
Get osOverhead represents the resource overhead associated with running a pod for a given RuntimeClass.PreemptionPolicy is the Policy for preempting pods with lower priority.The priority value.If specified, indicates the pod's priority.If specified, all readiness gates will be evaluated for pod readiness.ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start.Restart policy for all containers within the pod.RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod.If specified, the pod will be dispatched by specified scheduler.SchedulingGates is an opaque list of values that if specified will block scheduling the pod.Get securityContextDeprecatedServiceAccount is a depreciated alias for ServiceAccountName.ServiceAccountName is the name of the ServiceAccount to use to run this pod.If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).Share a single process namespace between all of the containers in a pod.If specified, the fully qualified Pod hostname will be \"<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>\".Optional duration in seconds the pod needs to terminate gracefully.If specified, the pod's tolerations.TopologySpreadConstraints describes how a group of pods ought to spread across topology domains.List of volumes that can be mounted by containers belonging to the pod.int
hashCode()
hostAliases
(List<V1HostAlias> hostAliases) hostNetwork
(Boolean hostNetwork) imagePullSecrets
(List<V1LocalObjectReference> imagePullSecrets) initContainers
(List<V1Container> initContainers) nodeSelector
(Map<String, String> nodeSelector) preemptionPolicy
(String preemptionPolicy) priorityClassName
(String priorityClassName) putNodeSelectorItem
(String key, String nodeSelectorItem) putOverheadItem
(String key, Quantity overheadItem) readinessGates
(List<V1PodReadinessGate> readinessGates) resourceClaims
(List<V1PodResourceClaim> resourceClaims) restartPolicy
(String restartPolicy) runtimeClassName
(String runtimeClassName) schedulerName
(String schedulerName) schedulingGates
(List<V1PodSchedulingGate> schedulingGates) securityContext
(V1PodSecurityContext securityContext) serviceAccount
(String serviceAccount) serviceAccountName
(String serviceAccountName) void
setActiveDeadlineSeconds
(Long activeDeadlineSeconds) void
setAffinity
(V1Affinity affinity) void
setAutomountServiceAccountToken
(Boolean automountServiceAccountToken) void
setContainers
(List<V1Container> containers) void
setDnsConfig
(V1PodDNSConfig dnsConfig) void
setDnsPolicy
(String dnsPolicy) void
setEnableServiceLinks
(Boolean enableServiceLinks) void
setEphemeralContainers
(List<V1EphemeralContainer> ephemeralContainers) void
setHostAliases
(List<V1HostAlias> hostAliases) void
setHostIPC
(Boolean hostIPC) void
setHostname
(String hostname) setHostnameAsFQDN
(Boolean setHostnameAsFQDN) void
setHostNetwork
(Boolean hostNetwork) void
setHostPID
(Boolean hostPID) void
setHostUsers
(Boolean hostUsers) void
setImagePullSecrets
(List<V1LocalObjectReference> imagePullSecrets) void
setInitContainers
(List<V1Container> initContainers) void
setNodeName
(String nodeName) void
setNodeSelector
(Map<String, String> nodeSelector) void
void
setOverhead
(Map<String, Quantity> overhead) void
setPreemptionPolicy
(String preemptionPolicy) void
setPriority
(Integer priority) void
setPriorityClassName
(String priorityClassName) void
setReadinessGates
(List<V1PodReadinessGate> readinessGates) void
setResourceClaims
(List<V1PodResourceClaim> resourceClaims) void
setRestartPolicy
(String restartPolicy) void
setRuntimeClassName
(String runtimeClassName) void
setSchedulerName
(String schedulerName) void
setSchedulingGates
(List<V1PodSchedulingGate> schedulingGates) void
setSecurityContext
(V1PodSecurityContext securityContext) void
setServiceAccount
(String serviceAccount) void
setServiceAccountName
(String serviceAccountName) void
setSetHostnameAsFQDN
(Boolean setHostnameAsFQDN) void
setShareProcessNamespace
(Boolean shareProcessNamespace) void
setSubdomain
(String subdomain) void
setTerminationGracePeriodSeconds
(Long terminationGracePeriodSeconds) void
setTolerations
(List<V1Toleration> tolerations) void
setTopologySpreadConstraints
(List<V1TopologySpreadConstraint> topologySpreadConstraints) void
setVolumes
(List<V1Volume> volumes) shareProcessNamespace
(Boolean shareProcessNamespace) terminationGracePeriodSeconds
(Long terminationGracePeriodSeconds) tolerations
(List<V1Toleration> tolerations) topologySpreadConstraints
(List<V1TopologySpreadConstraint> topologySpreadConstraints) toString()
-
Field Details
-
SERIALIZED_NAME_ACTIVE_DEADLINE_SECONDS
- See Also:
-
SERIALIZED_NAME_AFFINITY
- See Also:
-
SERIALIZED_NAME_AUTOMOUNT_SERVICE_ACCOUNT_TOKEN
- See Also:
-
SERIALIZED_NAME_CONTAINERS
- See Also:
-
SERIALIZED_NAME_DNS_CONFIG
- See Also:
-
SERIALIZED_NAME_DNS_POLICY
- See Also:
-
SERIALIZED_NAME_ENABLE_SERVICE_LINKS
- See Also:
-
SERIALIZED_NAME_EPHEMERAL_CONTAINERS
- See Also:
-
SERIALIZED_NAME_HOST_ALIASES
- See Also:
-
SERIALIZED_NAME_HOST_I_P_C
- See Also:
-
SERIALIZED_NAME_HOST_NETWORK
- See Also:
-
SERIALIZED_NAME_HOST_P_I_D
- See Also:
-
SERIALIZED_NAME_HOST_USERS
- See Also:
-
SERIALIZED_NAME_HOSTNAME
- See Also:
-
SERIALIZED_NAME_IMAGE_PULL_SECRETS
- See Also:
-
SERIALIZED_NAME_INIT_CONTAINERS
- See Also:
-
SERIALIZED_NAME_NODE_NAME
- See Also:
-
SERIALIZED_NAME_NODE_SELECTOR
- See Also:
-
SERIALIZED_NAME_OS
- See Also:
-
SERIALIZED_NAME_OVERHEAD
- See Also:
-
SERIALIZED_NAME_PREEMPTION_POLICY
- See Also:
-
SERIALIZED_NAME_PRIORITY
- See Also:
-
SERIALIZED_NAME_PRIORITY_CLASS_NAME
- See Also:
-
SERIALIZED_NAME_READINESS_GATES
- See Also:
-
SERIALIZED_NAME_RESOURCE_CLAIMS
- See Also:
-
SERIALIZED_NAME_RESTART_POLICY
- See Also:
-
SERIALIZED_NAME_RUNTIME_CLASS_NAME
- See Also:
-
SERIALIZED_NAME_SCHEDULER_NAME
- See Also:
-
SERIALIZED_NAME_SCHEDULING_GATES
- See Also:
-
SERIALIZED_NAME_SECURITY_CONTEXT
- See Also:
-
SERIALIZED_NAME_SERVICE_ACCOUNT
- See Also:
-
SERIALIZED_NAME_SERVICE_ACCOUNT_NAME
- See Also:
-
SERIALIZED_NAME_SET_HOSTNAME_AS_F_Q_D_N
- See Also:
-
SERIALIZED_NAME_SHARE_PROCESS_NAMESPACE
- See Also:
-
SERIALIZED_NAME_SUBDOMAIN
- See Also:
-
SERIALIZED_NAME_TERMINATION_GRACE_PERIOD_SECONDS
- See Also:
-
SERIALIZED_NAME_TOLERATIONS
- See Also:
-
SERIALIZED_NAME_TOPOLOGY_SPREAD_CONSTRAINTS
- See Also:
-
SERIALIZED_NAME_VOLUMES
- See Also:
-
-
Constructor Details
-
V1PodSpec
public V1PodSpec()
-
-
Method Details
-
activeDeadlineSeconds
-
getActiveDeadlineSeconds
Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.- Returns:
- activeDeadlineSeconds
-
setActiveDeadlineSeconds
-
affinity
-
getAffinity
Get affinity- Returns:
- affinity
-
setAffinity
-
automountServiceAccountToken
-
getAutomountServiceAccountToken
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.- Returns:
- automountServiceAccountToken
-
setAutomountServiceAccountToken
-
containers
-
addContainersItem
-
getContainers
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.- Returns:
- containers
-
setContainers
-
dnsConfig
-
getDnsConfig
Get dnsConfig- Returns:
- dnsConfig
-
setDnsConfig
-
dnsPolicy
-
getDnsPolicy
Set DNS policy for the pod. Defaults to \"ClusterFirst\". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.- Returns:
- dnsPolicy
-
setDnsPolicy
-
enableServiceLinks
-
getEnableServiceLinks
EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.- Returns:
- enableServiceLinks
-
setEnableServiceLinks
-
ephemeralContainers
-
addEphemeralContainersItem
-
getEphemeralContainers
List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.- Returns:
- ephemeralContainers
-
setEphemeralContainers
-
hostAliases
-
addHostAliasesItem
-
getHostAliases
HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.- Returns:
- hostAliases
-
setHostAliases
-
hostIPC
-
getHostIPC
Use the host's ipc namespace. Optional: Default to false.- Returns:
- hostIPC
-
setHostIPC
-
hostNetwork
-
getHostNetwork
Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.- Returns:
- hostNetwork
-
setHostNetwork
-
hostPID
-
getHostPID
Use the host's pid namespace. Optional: Default to false.- Returns:
- hostPID
-
setHostPID
-
hostUsers
-
getHostUsers
Use the host's user namespace. Optional: Default to true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the host user namespace, such as loading a kernel module with CAP_SYS_MODULE. When set to false, a new userns is created for the pod. Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host. This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature.- Returns:
- hostUsers
-
setHostUsers
-
hostname
-
getHostname
Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.- Returns:
- hostname
-
setHostname
-
imagePullSecrets
-
addImagePullSecretsItem
-
getImagePullSecrets
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod- Returns:
- imagePullSecrets
-
setImagePullSecrets
-
initContainers
-
addInitContainersItem
-
getInitContainers
List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/- Returns:
- initContainers
-
setInitContainers
-
nodeName
-
getNodeName
NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.- Returns:
- nodeName
-
setNodeName
-
nodeSelector
-
putNodeSelectorItem
-
getNodeSelector
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/- Returns:
- nodeSelector
-
setNodeSelector
-
os
-
getOs
Get os- Returns:
- os
-
setOs
-
overhead
-
putOverheadItem
-
getOverhead
Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md- Returns:
- overhead
-
setOverhead
-
preemptionPolicy
-
getPreemptionPolicy
PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.- Returns:
- preemptionPolicy
-
setPreemptionPolicy
-
priority
-
getPriority
The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.- Returns:
- priority
-
setPriority
-
priorityClassName
-
getPriorityClassName
If specified, indicates the pod's priority. \"system-node-critical\" and \"system-cluster-critical\" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.- Returns:
- priorityClassName
-
setPriorityClassName
-
readinessGates
-
addReadinessGatesItem
-
getReadinessGates
If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to \"True\" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates- Returns:
- readinessGates
-
setReadinessGates
-
resourceClaims
-
addResourceClaimsItem
-
getResourceClaims
ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start. The resources will be made available to those containers which consume them by name. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable.- Returns:
- resourceClaims
-
setResourceClaims
-
restartPolicy
-
getRestartPolicy
Restart policy for all containers within the pod. One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy- Returns:
- restartPolicy
-
setRestartPolicy
-
runtimeClassName
-
getRuntimeClassName
RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the \"legacy\" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class- Returns:
- runtimeClassName
-
setRuntimeClassName
-
schedulerName
-
getSchedulerName
If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.- Returns:
- schedulerName
-
setSchedulerName
-
schedulingGates
-
addSchedulingGatesItem
-
getSchedulingGates
SchedulingGates is an opaque list of values that if specified will block scheduling the pod. If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the scheduler will not attempt to schedule the pod. SchedulingGates can only be set at pod creation time, and be removed only afterwards. This is a beta feature enabled by the PodSchedulingReadiness feature gate.- Returns:
- schedulingGates
-
setSchedulingGates
-
securityContext
-
getSecurityContext
Get securityContext- Returns:
- securityContext
-
setSecurityContext
-
serviceAccount
-
getServiceAccount
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.- Returns:
- serviceAccount
-
setServiceAccount
-
serviceAccountName
-
getServiceAccountName
ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/- Returns:
- serviceAccountName
-
setServiceAccountName
-
setHostnameAsFQDN
-
getSetHostnameAsFQDN
If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.- Returns:
- setHostnameAsFQDN
-
setSetHostnameAsFQDN
-
subdomain
-
getSubdomain
If specified, the fully qualified Pod hostname will be \"<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>\". If not specified, the pod will not have a domainname at all.- Returns:
- subdomain
-
setSubdomain
-
terminationGracePeriodSeconds
-
getTerminationGracePeriodSeconds
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.- Returns:
- terminationGracePeriodSeconds
-
setTerminationGracePeriodSeconds
-
tolerations
-
addTolerationsItem
-
getTolerations
If specified, the pod's tolerations.- Returns:
- tolerations
-
setTolerations
-
topologySpreadConstraints
public V1PodSpec topologySpreadConstraints(List<V1TopologySpreadConstraint> topologySpreadConstraints) -
addTopologySpreadConstraintsItem
public V1PodSpec addTopologySpreadConstraintsItem(V1TopologySpreadConstraint topologySpreadConstraintsItem) -
getTopologySpreadConstraints
TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.- Returns:
- topologySpreadConstraints
-
setTopologySpreadConstraints
public void setTopologySpreadConstraints(List<V1TopologySpreadConstraint> topologySpreadConstraints) -
volumes
-
addVolumesItem
-
getVolumes
List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes- Returns:
- volumes
-
setVolumes
-
equals
-
hashCode
public int hashCode() -
toString
-