def list_jobs(
self,
created_before: Optional[Union[datetime.datetime,
datetime.date]] = None,
created_after: Optional[Union[datetime.datetime,
datetime.date]] = None,
has_labels: Optional[Dict[str, str]] = None,
execution_states: Optional[Set[
quantum.enums.ExecutionStatus.State]] = None,
):
"""Returns the list of jobs in the project.
All historical jobs can be retrieved using this method and filtering
options are available too, to narrow down the search baesd on:
* creation time
* job labels
* execution states
Args:
created_after: retrieve jobs that were created after this date
or time.
created_before: retrieve jobs that were created after this date
or time.
has_labels: retrieve jobs that have labels on them specified by
this dict. If the value is set to `*`, filters having the label
regardless of the label value will be filtered. For example, to
query programs that have the shape label and have the color
label with value red can be queried using
{'color': 'red', 'shape':'*'}
execution_states: retrieve jobs that have an execution state that
is contained in `execution_states`. See
`quantum.enums.ExecutionStatus.State` enum for accepted values.
"""
client = self.context.client
response = client.list_jobs(
self.project_id,
None,
created_before=created_before,
created_after=created_after,
has_labels=has_labels,
execution_states=execution_states,
)
return [
engine_job.EngineJob(
project_id=engine_client._ids_from_job_name(j.name)[0],
program_id=engine_client._ids_from_job_name(j.name)[1],
job_id=engine_client._ids_from_job_name(j.name)[2],
context=self.context,
_job=j,
) for j in response
]
async def list_jobs_async(
self,
created_before: Optional[Union[datetime.datetime,
datetime.date]] = None,
created_after: Optional[Union[datetime.datetime,
datetime.date]] = None,
has_labels: Optional[Dict[str, str]] = None,
execution_states: Optional[Set[quantum.ExecutionStatus.State]] = None,
) -> Sequence[engine_job.EngineJob]:
"""Returns the list of jobs for this program.
Args:
project_id: A project_id of the parent Google Cloud Project.
program_id: Unique ID of the program within the parent project.
created_after: retrieve jobs that were created after this date
or time.
created_before: retrieve jobs that were created after this date
or time.
has_labels: retrieve jobs that have labels on them specified by
this dict. If the value is set to `*`, filters having the label
regardless of the label value will be filtered. For example, to
query programs that have the shape label and have the color
label with value red can be queried using
{'color': 'red', 'shape':'*'}
execution_states: retrieve jobs that have an execution state that
is contained in `execution_states`. See
`quantum.ExecutionStatus.State` enum for accepted values.
"""
client = self.context.client
response = await client.list_jobs_async(
self.project_id,
self.program_id,
created_before=created_before,
created_after=created_after,
has_labels=has_labels,
execution_states=execution_states,
)
return [
engine_job.EngineJob(
project_id=engine_client._ids_from_job_name(j.name)[0],
program_id=engine_client._ids_from_job_name(j.name)[1],
job_id=engine_client._ids_from_job_name(j.name)[2],
context=self.context,
_job=j,
) for j in response
]