Package io.kubernetes.client.openapi.models

Class V1PodSpec

java.lang.Object
io.kubernetes.client.openapi.models.V1PodSpec
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2022-12-05T08:14:34.919Z[Etc/UTC]") public class V1PodSpec extends Object
PodSpec is a description of a pod.

  • Field Details

  • Constructor Details

    • V1PodSpec

      public V1PodSpec()

  • Method Details

    • activeDeadlineSeconds

      public V1PodSpec activeDeadlineSeconds(Long activeDeadlineSeconds)

    • getActiveDeadlineSeconds

      @Nullable public Long 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

      public void setActiveDeadlineSeconds(Long activeDeadlineSeconds)

    • affinity

      public V1PodSpec affinity(V1Affinity affinity)

    • getAffinity

      @Nullable public V1Affinity getAffinity()
      Get affinity
      Returns:
      affinity

    • setAffinity

      public void setAffinity(V1Affinity affinity)

    • automountServiceAccountToken

      public V1PodSpec automountServiceAccountToken(Boolean automountServiceAccountToken)

    • getAutomountServiceAccountToken

      @Nullable public Boolean getAutomountServiceAccountToken()
      AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
      Returns:
      automountServiceAccountToken

    • setAutomountServiceAccountToken

      public void setAutomountServiceAccountToken(Boolean automountServiceAccountToken)

    • containers

      public V1PodSpec containers(List<V1Container> containers)

    • addContainersItem

      public V1PodSpec addContainersItem(V1Container containersItem)

    • getContainers

      public List<V1Container> 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

      public void setContainers(List<V1Container> containers)

    • dnsConfig

      public V1PodSpec dnsConfig(V1PodDNSConfig dnsConfig)

    • getDnsConfig

      @Nullable public V1PodDNSConfig getDnsConfig()
      Get dnsConfig
      Returns:
      dnsConfig

    • setDnsConfig

      public void setDnsConfig(V1PodDNSConfig dnsConfig)

    • dnsPolicy

      public V1PodSpec dnsPolicy(String dnsPolicy)

    • getDnsPolicy

      @Nullable public String 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

      public void setDnsPolicy(String dnsPolicy)

    • enableServiceLinks

      public V1PodSpec enableServiceLinks(Boolean enableServiceLinks)

    • getEnableServiceLinks

      @Nullable public Boolean 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

      public void setEnableServiceLinks(Boolean enableServiceLinks)

    • ephemeralContainers

      public V1PodSpec ephemeralContainers(List<V1EphemeralContainer> ephemeralContainers)

    • addEphemeralContainersItem

      public V1PodSpec addEphemeralContainersItem(V1EphemeralContainer ephemeralContainersItem)

    • getEphemeralContainers

      @Nullable public List<V1EphemeralContainer> 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

      public void setEphemeralContainers(List<V1EphemeralContainer> ephemeralContainers)

    • hostAliases

      public V1PodSpec hostAliases(List<V1HostAlias> hostAliases)

    • addHostAliasesItem

      public V1PodSpec addHostAliasesItem(V1HostAlias hostAliasesItem)

    • getHostAliases

      @Nullable public List<V1HostAlias> 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

      public void setHostAliases(List<V1HostAlias> hostAliases)

    • hostIPC

      public V1PodSpec hostIPC(Boolean hostIPC)

    • getHostIPC

      @Nullable public Boolean getHostIPC()
      Use the host's ipc namespace. Optional: Default to false.
      Returns:
      hostIPC

    • setHostIPC

      public void setHostIPC(Boolean hostIPC)

    • hostNetwork

      public V1PodSpec hostNetwork(Boolean hostNetwork)

    • getHostNetwork

      @Nullable public Boolean 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

      public void setHostNetwork(Boolean hostNetwork)

    • hostPID

      public V1PodSpec hostPID(Boolean hostPID)

    • getHostPID

      @Nullable public Boolean getHostPID()
      Use the host's pid namespace. Optional: Default to false.
      Returns:
      hostPID

    • setHostPID

      public void setHostPID(Boolean hostPID)

    • hostUsers

      public V1PodSpec hostUsers(Boolean hostUsers)

    • getHostUsers

      @Nullable public Boolean 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

      public void setHostUsers(Boolean hostUsers)

    • hostname

      public V1PodSpec hostname(String hostname)

    • getHostname

      @Nullable public String 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

      public void setHostname(String hostname)

    • imagePullSecrets

      public V1PodSpec imagePullSecrets(List<V1LocalObjectReference> imagePullSecrets)

    • addImagePullSecretsItem

      public V1PodSpec addImagePullSecretsItem(V1LocalObjectReference imagePullSecretsItem)

    • getImagePullSecrets

      @Nullable public List<V1LocalObjectReference> 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

      public void setImagePullSecrets(List<V1LocalObjectReference> imagePullSecrets)

    • initContainers

      public V1PodSpec initContainers(List<V1Container> initContainers)

    • addInitContainersItem

      public V1PodSpec addInitContainersItem(V1Container initContainersItem)

    • getInitContainers

      @Nullable public List<V1Container> 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

      public void setInitContainers(List<V1Container> initContainers)

    • nodeName

      public V1PodSpec nodeName(String nodeName)

    • getNodeName

      @Nullable public String 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

      public void setNodeName(String nodeName)

    • nodeSelector

      public V1PodSpec nodeSelector(Map<String,String> nodeSelector)

    • putNodeSelectorItem

      public V1PodSpec putNodeSelectorItem(String key, String nodeSelectorItem)

    • getNodeSelector

      @Nullable public Map<String,String> 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

      public void setNodeSelector(Map<String,String> nodeSelector)

    • os

      public V1PodSpec os(V1PodOS os)

    • getOs

      @Nullable public V1PodOS getOs()
      Get os
      Returns:
      os

    • setOs

      public void setOs(V1PodOS os)

    • overhead

      public V1PodSpec overhead(Map<String,Quantity> overhead)

    • putOverheadItem

      public V1PodSpec putOverheadItem(String key, Quantity overheadItem)

    • getOverhead

      @Nullable public Map<String,Quantity> 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

      public void setOverhead(Map<String,Quantity> overhead)

    • preemptionPolicy

      public V1PodSpec preemptionPolicy(String preemptionPolicy)

    • getPreemptionPolicy

      @Nullable public String getPreemptionPolicy()
      PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
      Returns:
      preemptionPolicy

    • setPreemptionPolicy

      public void setPreemptionPolicy(String preemptionPolicy)

    • priority

      public V1PodSpec priority(Integer priority)

    • getPriority

      @Nullable public Integer 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

      public void setPriority(Integer priority)

    • priorityClassName

      public V1PodSpec priorityClassName(String priorityClassName)

    • getPriorityClassName

      @Nullable public String 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

      public void setPriorityClassName(String priorityClassName)

    • readinessGates

      public V1PodSpec readinessGates(List<V1PodReadinessGate> readinessGates)

    • addReadinessGatesItem

      public V1PodSpec addReadinessGatesItem(V1PodReadinessGate readinessGatesItem)

    • getReadinessGates

      @Nullable public List<V1PodReadinessGate> 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

      public void setReadinessGates(List<V1PodReadinessGate> readinessGates)

    • restartPolicy

      public V1PodSpec restartPolicy(String restartPolicy)

    • getRestartPolicy

      @Nullable public String getRestartPolicy()
      Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
      Returns:
      restartPolicy

    • setRestartPolicy

      public void setRestartPolicy(String restartPolicy)

    • runtimeClassName

      public V1PodSpec runtimeClassName(String runtimeClassName)

    • getRuntimeClassName

      @Nullable public String 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

      public void setRuntimeClassName(String runtimeClassName)

    • schedulerName

      public V1PodSpec schedulerName(String schedulerName)

    • getSchedulerName

      @Nullable public String 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

      public void setSchedulerName(String schedulerName)

    • securityContext

      public V1PodSpec securityContext(V1PodSecurityContext securityContext)

    • getSecurityContext

      @Nullable public V1PodSecurityContext getSecurityContext()
      Get securityContext
      Returns:
      securityContext

    • setSecurityContext

      public void setSecurityContext(V1PodSecurityContext securityContext)

    • serviceAccount

      public V1PodSpec serviceAccount(String serviceAccount)

    • getServiceAccount

      @Nullable public String getServiceAccount()
      DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
      Returns:
      serviceAccount

    • setServiceAccount

      public void setServiceAccount(String serviceAccount)

    • serviceAccountName

      public V1PodSpec serviceAccountName(String serviceAccountName)

    • getServiceAccountName

      @Nullable public String 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

      public void setServiceAccountName(String serviceAccountName)

    • setHostnameAsFQDN

      public V1PodSpec setHostnameAsFQDN(Boolean setHostnameAsFQDN)

    • getSetHostnameAsFQDN

      @Nullable public Boolean 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

      public void setSetHostnameAsFQDN(Boolean setHostnameAsFQDN)

    • shareProcessNamespace

      public V1PodSpec shareProcessNamespace(Boolean shareProcessNamespace)

    • getShareProcessNamespace

      @Nullable public Boolean getShareProcessNamespace()
      Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.
      Returns:
      shareProcessNamespace

    • setShareProcessNamespace

      public void setShareProcessNamespace(Boolean shareProcessNamespace)

    • subdomain

      public V1PodSpec subdomain(String subdomain)

    • getSubdomain

      @Nullable public String 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

      public void setSubdomain(String subdomain)

    • terminationGracePeriodSeconds

      public V1PodSpec terminationGracePeriodSeconds(Long terminationGracePeriodSeconds)

    • getTerminationGracePeriodSeconds

      @Nullable public Long 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

      public void setTerminationGracePeriodSeconds(Long terminationGracePeriodSeconds)

    • tolerations

      public V1PodSpec tolerations(List<V1Toleration> tolerations)

    • addTolerationsItem

      public V1PodSpec addTolerationsItem(V1Toleration tolerationsItem)

    • getTolerations

      @Nullable public List<V1Toleration> getTolerations()
      If specified, the pod's tolerations.
      Returns:
      tolerations

    • setTolerations

      public void setTolerations(List<V1Toleration> tolerations)

    • topologySpreadConstraints

      public V1PodSpec topologySpreadConstraints(List<V1TopologySpreadConstraint> topologySpreadConstraints)

    • addTopologySpreadConstraintsItem

      public V1PodSpec addTopologySpreadConstraintsItem(V1TopologySpreadConstraint topologySpreadConstraintsItem)

    • getTopologySpreadConstraints

      @Nullable public List<V1TopologySpreadConstraint> 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

      public V1PodSpec volumes(List<V1Volume> volumes)

    • addVolumesItem

      public V1PodSpec addVolumesItem(V1Volume volumesItem)

    • getVolumes

      @Nullable public List<V1Volume> 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

      public void setVolumes(List<V1Volume> volumes)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object