Packages

case class PodSpec(activeDeadlineSeconds: Optional[Long] = Optional.Absent, affinity: Optional[Affinity] = Optional.Absent, automountServiceAccountToken: Optional[Boolean] = Optional.Absent, containers: Optional[Vector[Container]] = Optional.Absent, dnsConfig: Optional[PodDNSConfig] = Optional.Absent, dnsPolicy: Optional[String] = Optional.Absent, enableServiceLinks: Optional[Boolean] = Optional.Absent, ephemeralContainers: Optional[Vector[EphemeralContainer]] = Optional.Absent, hostAliases: Optional[Vector[HostAlias]] = Optional.Absent, hostIPC: Optional[Boolean] = Optional.Absent, hostNetwork: Optional[Boolean] = Optional.Absent, hostPID: Optional[Boolean] = Optional.Absent, hostname: Optional[String] = Optional.Absent, imagePullSecrets: Optional[Vector[LocalObjectReference]] = Optional.Absent, initContainers: Optional[Vector[Container]] = Optional.Absent, nodeName: Optional[String] = Optional.Absent, nodeSelector: Optional[Map[String, String]] = Optional.Absent, os: Optional[PodOS] = Optional.Absent, overhead: Optional[Map[String, Quantity]] = Optional.Absent, preemptionPolicy: Optional[String] = Optional.Absent, priority: Optional[Int] = Optional.Absent, priorityClassName: Optional[String] = Optional.Absent, readinessGates: Optional[Vector[PodReadinessGate]] = Optional.Absent, restartPolicy: Optional[String] = Optional.Absent, runtimeClassName: Optional[String] = Optional.Absent, schedulerName: Optional[String] = Optional.Absent, securityContext: Optional[PodSecurityContext] = Optional.Absent, serviceAccount: Optional[String] = Optional.Absent, serviceAccountName: Optional[String] = Optional.Absent, setHostnameAsFQDN: Optional[Boolean] = Optional.Absent, shareProcessNamespace: Optional[Boolean] = Optional.Absent, subdomain: Optional[String] = Optional.Absent, terminationGracePeriodSeconds: Optional[Long] = Optional.Absent, tolerations: Optional[Vector[Toleration]] = Optional.Absent, topologySpreadConstraints: Optional[Vector[TopologySpreadConstraint]] = Optional.Absent, volumes: Optional[Vector[Volume]] = Optional.Absent) extends Product with Serializable

PodSpec is a description of a pod.

activeDeadlineSeconds

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.

automountServiceAccountToken

AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.

containers

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.

dnsPolicy

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'.

enableServiceLinks

EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.

ephemeralContainers

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. This field is beta-level and available on clusters that haven't disabled the EphemeralContainers feature gate.

hostAliases

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.

hostIPC

Use the host's ipc namespace. Optional: Default to false.

hostNetwork

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.

hostPID

Use the host's pid namespace. Optional: Default to false.

hostname

Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.

imagePullSecrets

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. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

initContainers

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/

nodeName

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.

nodeSelector

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/

overhead

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 This field is beta-level as of Kubernetes v1.18, and is only honored by servers that enable the PodOverhead feature.

preemptionPolicy

PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.

priority

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.

priorityClassName

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.

readinessGates

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

restartPolicy

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

runtimeClassName

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 This is a beta feature as of Kubernetes v1.14.

schedulerName

If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

serviceAccount

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

serviceAccountName

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/

setHostnameAsFQDN

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.

shareProcessNamespace

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.

subdomain

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.

terminationGracePeriodSeconds

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.

tolerations

If specified, the pod's tolerations.

topologySpreadConstraints

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.

volumes

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PodSpec
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PodSpec(activeDeadlineSeconds: Optional[Long] = Optional.Absent, affinity: Optional[Affinity] = Optional.Absent, automountServiceAccountToken: Optional[Boolean] = Optional.Absent, containers: Optional[Vector[Container]] = Optional.Absent, dnsConfig: Optional[PodDNSConfig] = Optional.Absent, dnsPolicy: Optional[String] = Optional.Absent, enableServiceLinks: Optional[Boolean] = Optional.Absent, ephemeralContainers: Optional[Vector[EphemeralContainer]] = Optional.Absent, hostAliases: Optional[Vector[HostAlias]] = Optional.Absent, hostIPC: Optional[Boolean] = Optional.Absent, hostNetwork: Optional[Boolean] = Optional.Absent, hostPID: Optional[Boolean] = Optional.Absent, hostname: Optional[String] = Optional.Absent, imagePullSecrets: Optional[Vector[LocalObjectReference]] = Optional.Absent, initContainers: Optional[Vector[Container]] = Optional.Absent, nodeName: Optional[String] = Optional.Absent, nodeSelector: Optional[Map[String, String]] = Optional.Absent, os: Optional[PodOS] = Optional.Absent, overhead: Optional[Map[String, Quantity]] = Optional.Absent, preemptionPolicy: Optional[String] = Optional.Absent, priority: Optional[Int] = Optional.Absent, priorityClassName: Optional[String] = Optional.Absent, readinessGates: Optional[Vector[PodReadinessGate]] = Optional.Absent, restartPolicy: Optional[String] = Optional.Absent, runtimeClassName: Optional[String] = Optional.Absent, schedulerName: Optional[String] = Optional.Absent, securityContext: Optional[PodSecurityContext] = Optional.Absent, serviceAccount: Optional[String] = Optional.Absent, serviceAccountName: Optional[String] = Optional.Absent, setHostnameAsFQDN: Optional[Boolean] = Optional.Absent, shareProcessNamespace: Optional[Boolean] = Optional.Absent, subdomain: Optional[String] = Optional.Absent, terminationGracePeriodSeconds: Optional[Long] = Optional.Absent, tolerations: Optional[Vector[Toleration]] = Optional.Absent, topologySpreadConstraints: Optional[Vector[TopologySpreadConstraint]] = Optional.Absent, volumes: Optional[Vector[Volume]] = Optional.Absent)

    activeDeadlineSeconds

    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.

    automountServiceAccountToken

    AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.

    containers

    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.

    dnsPolicy

    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'.

    enableServiceLinks

    EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.

    ephemeralContainers

    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. This field is beta-level and available on clusters that haven't disabled the EphemeralContainers feature gate.

    hostAliases

    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.

    hostIPC

    Use the host's ipc namespace. Optional: Default to false.

    hostNetwork

    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.

    hostPID

    Use the host's pid namespace. Optional: Default to false.

    hostname

    Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.

    imagePullSecrets

    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. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

    initContainers

    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/

    nodeName

    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.

    nodeSelector

    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/

    overhead

    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 This field is beta-level as of Kubernetes v1.18, and is only honored by servers that enable the PodOverhead feature.

    preemptionPolicy

    PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.

    priority

    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.

    priorityClassName

    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.

    readinessGates

    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

    restartPolicy

    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

    runtimeClassName

    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 This is a beta feature as of Kubernetes v1.14.

    schedulerName

    If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

    serviceAccount

    DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

    serviceAccountName

    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/

    setHostnameAsFQDN

    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.

    shareProcessNamespace

    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.

    subdomain

    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.

    terminationGracePeriodSeconds

    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.

    tolerations

    If specified, the pod's tolerations.

    topologySpreadConstraints

    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.

    volumes

    List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val activeDeadlineSeconds: Optional[Long]
  5. val affinity: Optional[Affinity]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val automountServiceAccountToken: Optional[Boolean]
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. val containers: Optional[Vector[Container]]
  10. val dnsConfig: Optional[PodDNSConfig]
  11. val dnsPolicy: Optional[String]
  12. val enableServiceLinks: Optional[Boolean]
  13. val ephemeralContainers: Optional[Vector[EphemeralContainer]]
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def getActiveDeadlineSeconds: IO[K8sFailure, Long]

    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.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  16. def getAffinity: IO[K8sFailure, Affinity]

    Gets affinity.

    Gets affinity.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  17. def getAutomountServiceAccountToken: IO[K8sFailure, Boolean]

    AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.

    AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def getContainers: IO[K8sFailure, Vector[Container]]

    List of containers belonging to the pod.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  20. def getDnsConfig: IO[K8sFailure, PodDNSConfig]

    Gets dnsConfig.

    Gets dnsConfig.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  21. def getDnsPolicy: IO[K8sFailure, String]

    Set DNS policy for the pod.

    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'.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  22. def getEnableServiceLinks: IO[K8sFailure, Boolean]

    EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links.

    EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  23. def getEphemeralContainers: IO[K8sFailure, Vector[EphemeralContainer]]

    List of ephemeral containers run in this pod.

    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. This field is beta-level and available on clusters that haven't disabled the EphemeralContainers feature gate.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  24. def getHostAliases: IO[K8sFailure, Vector[HostAlias]]

    HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  25. def getHostIPC: IO[K8sFailure, Boolean]

    Use the host's ipc namespace.

    Use the host's ipc namespace. Optional: Default to false.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  26. def getHostNetwork: IO[K8sFailure, Boolean]

    Host networking requested for this pod.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  27. def getHostPID: IO[K8sFailure, Boolean]

    Use the host's pid namespace.

    Use the host's pid namespace. Optional: Default to false.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  28. def getHostname: IO[K8sFailure, String]

    Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.

    Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  29. def getImagePullSecrets: IO[K8sFailure, Vector[LocalObjectReference]]

    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.

    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. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  30. def getInitContainers: IO[K8sFailure, Vector[Container]]

    List of initialization containers belonging to the pod.

    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/

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  31. def getNodeName: IO[K8sFailure, String]

    NodeName is a request to schedule this pod onto a specific node.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  32. def getNodeSelector: IO[K8sFailure, Map[String, String]]

    NodeSelector is a selector which must be true for the pod to fit on a node.

    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/

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  33. def getOs: IO[K8sFailure, PodOS]

    Gets os.

    Gets os.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  34. def getOverhead: IO[K8sFailure, Map[String, Quantity]]

    Overhead represents the resource overhead associated with running a pod for a given RuntimeClass.

    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 This field is beta-level as of Kubernetes v1.18, and is only honored by servers that enable the PodOverhead feature.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  35. def getPreemptionPolicy: IO[K8sFailure, String]

    PreemptionPolicy is the Policy for preempting pods with lower priority.

    PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  36. def getPriority: IO[K8sFailure, Int]

    The priority value.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  37. def getPriorityClassName: IO[K8sFailure, String]

    If specified, indicates the pod's priority.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  38. def getReadinessGates: IO[K8sFailure, Vector[PodReadinessGate]]

    If specified, all readiness gates will be evaluated for pod readiness.

    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

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  39. def getRestartPolicy: IO[K8sFailure, String]

    Restart policy for all containers within the pod.

    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

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  40. def getRuntimeClassName: IO[K8sFailure, String]

    RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod.

    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 This is a beta feature as of Kubernetes v1.14.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  41. def getSchedulerName: IO[K8sFailure, String]

    If specified, the pod will be dispatched by specified scheduler.

    If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  42. def getSecurityContext: IO[K8sFailure, PodSecurityContext]

    Gets securityContext.

    Gets securityContext.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  43. def getServiceAccount: IO[K8sFailure, String]

    DeprecatedServiceAccount is a depreciated alias for ServiceAccountName.

    DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  44. def getServiceAccountName: IO[K8sFailure, String]

    ServiceAccountName is the name of the ServiceAccount to use to run this pod.

    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/

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  45. def getSetHostnameAsFQDN: IO[K8sFailure, Boolean]

    If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  46. def getShareProcessNamespace: IO[K8sFailure, Boolean]

    Share a single process namespace between all of the containers in a pod.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  47. def getSubdomain: IO[K8sFailure, String]

    If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>".

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  48. def getTerminationGracePeriodSeconds: IO[K8sFailure, Long]

    Optional duration in seconds the pod needs to terminate gracefully.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  49. def getTolerations: IO[K8sFailure, Vector[Toleration]]

    If specified, the pod's tolerations.

    If specified, the pod's tolerations.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  50. def getTopologySpreadConstraints: IO[K8sFailure, Vector[TopologySpreadConstraint]]

    TopologySpreadConstraints describes how a group of pods ought to spread across topology domains.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  51. def getVolumes: IO[K8sFailure, Vector[Volume]]

    List of volumes that can be mounted by containers belonging to the pod.

    List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  52. val hostAliases: Optional[Vector[HostAlias]]
  53. val hostIPC: Optional[Boolean]
  54. val hostNetwork: Optional[Boolean]
  55. val hostPID: Optional[Boolean]
  56. val hostname: Optional[String]
  57. val imagePullSecrets: Optional[Vector[LocalObjectReference]]
  58. val initContainers: Optional[Vector[Container]]
  59. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  60. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  61. val nodeName: Optional[String]
  62. val nodeSelector: Optional[Map[String, String]]
  63. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  64. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  65. val os: Optional[PodOS]
  66. val overhead: Optional[Map[String, Quantity]]
  67. val preemptionPolicy: Optional[String]
  68. val priority: Optional[Int]
  69. val priorityClassName: Optional[String]
  70. val readinessGates: Optional[Vector[PodReadinessGate]]
  71. val restartPolicy: Optional[String]
  72. val runtimeClassName: Optional[String]
  73. val schedulerName: Optional[String]
  74. val securityContext: Optional[PodSecurityContext]
  75. val serviceAccount: Optional[String]
  76. val serviceAccountName: Optional[String]
  77. val setHostnameAsFQDN: Optional[Boolean]
  78. val shareProcessNamespace: Optional[Boolean]
  79. val subdomain: Optional[String]
  80. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  81. val terminationGracePeriodSeconds: Optional[Long]
  82. val tolerations: Optional[Vector[Toleration]]
  83. val topologySpreadConstraints: Optional[Vector[TopologySpreadConstraint]]
  84. val volumes: Optional[Vector[Volume]]
  85. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  86. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  87. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped