Public Member Functions | Private Attributes | List of all members
python_utils.dockerjob.DockerJob Class Reference

Public Member Functions

def __init__ (self, spec)
 
def ip_address (self)
 
def is_running (self)
 
def kill (self, suppress_failure=False)
 
def mapped_port (self, port)
 
def wait_for_healthy (self, timeout_seconds)
 

Private Attributes

 _container_name
 
 _job
 
 _spec
 

Detailed Description

Encapsulates a job

Definition at line 130 of file dockerjob.py.

Constructor & Destructor Documentation

◆ __init__()

def python_utils.dockerjob.DockerJob.__init__ (   self,
  spec 
)

Definition at line 133 of file dockerjob.py.

Member Function Documentation

◆ ip_address()

def python_utils.dockerjob.DockerJob.ip_address (   self)

Definition at line 144 of file dockerjob.py.

◆ is_running()

def python_utils.dockerjob.DockerJob.is_running (   self)
Polls a job and returns True if given job is still running.

Definition at line 157 of file dockerjob.py.

◆ kill()

def python_utils.dockerjob.DockerJob.kill (   self,
  suppress_failure = False 
)
Sends kill signal to the container.

Definition at line 151 of file dockerjob.py.

◆ mapped_port()

def python_utils.dockerjob.DockerJob.mapped_port (   self,
  port 
)

Definition at line 141 of file dockerjob.py.

◆ wait_for_healthy()

def python_utils.dockerjob.DockerJob.wait_for_healthy (   self,
  timeout_seconds 
)

Definition at line 147 of file dockerjob.py.

Member Data Documentation

◆ _container_name

python_utils.dockerjob.DockerJob._container_name
private

Definition at line 139 of file dockerjob.py.

◆ _job

python_utils.dockerjob.DockerJob._job
private

Definition at line 135 of file dockerjob.py.

◆ _spec

python_utils.dockerjob.DockerJob._spec
private

Definition at line 134 of file dockerjob.py.


The documentation for this class was generated from the following file:


grpc
Author(s):
autogenerated on Fri May 16 2025 03:03:42