organization_jobs_api module

OrganizationJobsApi

class edgeimpulse_api.api.organization_jobs_api.OrganizationJobsApi(
		api_client=None
)

Parameters

  • api_client=None

Methods

cancel_organization_job

edgeimpulse_api.api.organization_jobs_api.cancel_organization_job(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})],
		force_cancel: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="If set to 'true', we won't wait for the job cluster to cancel the job, and will mark the job as finished.", extra={})] = None,
		**kwargs
)> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Cancel job

Cancel a running job.

Parameters

  • self

  • organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

  • job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]

  • force_cancel: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="If set to 'true', we won't wait for the job cluster to cancel the job, and will mark the job as finished.", extra={})] = None

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

download_organization_jobs_logs

edgeimpulse_api.api.organization_jobs_api.download_organization_jobs_logs(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})],
		limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		log_level: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Log level (error, warn, info, debug)', extra={})] = None,
		**kwargs
)> str

Download logs

Download the logs for a job (as a text file).

Parameters

  • self

  • organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

  • job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]

  • limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

  • log_level: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Log level (error, warn, info, debug)', extra={})] = None

  • **kwargs

Return

str

get_organization_job_status

edgeimpulse_api.api.organization_jobs_api.get_organization_job_status(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})],
		**kwargs
)> edgeimpulse_api.models.get_job_response.GetJobResponse

Get job status

Get the status for a job.

Parameters

  • self

  • organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

  • job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]

  • **kwargs

Return

edgeimpulse_api.models.get_job_response.GetJobResponse

get_organization_jobs_logs