Package org.cdk8s.plus25.k8s

Class EphemeralContainer.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • name

        @Stability(Stable)
public EphemeralContainer.Builder name​(String name)
        Sets the value of EphemeralContainer.getName()
        Parameters:
        name - Name of the ephemeral container specified as a DNS_LABEL. This parameter is required. This name must be unique among all containers, init containers and ephemeral containers.
        Returns:
        this

      • args

        @Stability(Stable)
public EphemeralContainer.Builder args​(List<String> args)
        Sets the value of EphemeralContainer.getArgs()
        Parameters:
        args - Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
        Returns:
        this

      • command

        @Stability(Stable)
public EphemeralContainer.Builder command​(List<String> command)
        Sets the value of EphemeralContainer.getCommand()
        Parameters:
        command - Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
        Returns:
        this

      • envFrom

        @Stability(Stable)
public EphemeralContainer.Builder envFrom​(List<? extends EnvFromSource> envFrom)
        Sets the value of EphemeralContainer.getEnvFrom()
        Parameters:
        envFrom - List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
        Returns:
        this

      • imagePullPolicy

        @Stability(Stable)
public EphemeralContainer.Builder imagePullPolicy​(String imagePullPolicy)
        Sets the value of EphemeralContainer.getImagePullPolicy()
        Parameters:
        imagePullPolicy - Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
        Returns:
        this

      • securityContext

        @Stability(Stable)
public EphemeralContainer.Builder securityContext​(SecurityContext securityContext)
        Sets the value of EphemeralContainer.getSecurityContext()
        Parameters:
        securityContext - Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
        Returns:
        this

      • stdin

        @Stability(Stable)
public EphemeralContainer.Builder stdin​(Boolean stdin)
        Sets the value of EphemeralContainer.getStdin()
        Parameters:
        stdin - Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
        Returns:
        this

      • stdinOnce

        @Stability(Stable)
public EphemeralContainer.Builder stdinOnce​(Boolean stdinOnce)
        Sets the value of EphemeralContainer.getStdinOnce()
        Parameters:
        stdinOnce - Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
        Returns:
        this

      • targetContainerName

        @Stability(Stable)
public EphemeralContainer.Builder targetContainerName​(String targetContainerName)
        Sets the value of EphemeralContainer.getTargetContainerName()
        Parameters:
        targetContainerName - If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.

        The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.

        Returns:
        this

      • terminationMessagePath

        @Stability(Stable)
public EphemeralContainer.Builder terminationMessagePath​(String terminationMessagePath)
        Sets the value of EphemeralContainer.getTerminationMessagePath()
        Parameters:
        terminationMessagePath - Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
        Returns:
        this

      • terminationMessagePolicy

        @Stability(Stable)
public EphemeralContainer.Builder terminationMessagePolicy​(String terminationMessagePolicy)
        Sets the value of EphemeralContainer.getTerminationMessagePolicy()
        Parameters:
        terminationMessagePolicy - Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
        Returns:
        this

      • workingDir

        @Stability(Stable)
public EphemeralContainer.Builder workingDir​(String workingDir)
        Sets the value of EphemeralContainer.getWorkingDir()
        Parameters:
        workingDir - Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
        Returns:
        this