Interface ContainerHealthCheck.Builder

    • Method Detail

      • command

        ContainerHealthCheck.Builder command​(Collection<String> command)

        A string array that specifies the command that the container runs to determine if it's healthy.

        Parameters:
        command - A string array that specifies the command that the container runs to determine if it's healthy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • command

        ContainerHealthCheck.Builder command​(String... command)

        A string array that specifies the command that the container runs to determine if it's healthy.

        Parameters:
        command - A string array that specifies the command that the container runs to determine if it's healthy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • interval

        ContainerHealthCheck.Builder interval​(Integer interval)

        The time period (in seconds) between each health check.

        Parameters:
        interval - The time period (in seconds) between each health check.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • timeout

        ContainerHealthCheck.Builder timeout​(Integer timeout)

        The time period (in seconds) to wait for a health check to succeed before a failed health check is counted.

        Parameters:
        timeout - The time period (in seconds) to wait for a health check to succeed before a failed health check is counted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • retries

        ContainerHealthCheck.Builder retries​(Integer retries)

        The number of times to retry a failed health check before the container is considered unhealthy. The first run of the command does not count as a retry.

        Parameters:
        retries - The number of times to retry a failed health check before the container is considered unhealthy. The first run of the command does not count as a retry.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • startPeriod

        ContainerHealthCheck.Builder startPeriod​(Integer startPeriod)

        The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.

        Parameters:
        startPeriod - The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.
        Returns:
        Returns a reference to this object so that method calls can be chained together.