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: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		job_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})],
		force_cancel: Annotated[pydantic.types.StrictStr | None, 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: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
job_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
force_cancel: Annotated[pydantic.types.StrictStr | None, 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: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		job_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})],
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		log_level: Annotated[pydantic.types.StrictStr | None, 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: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
job_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
log_level: Annotated[pydantic.types.StrictStr | None, 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: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		job_id: 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: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
job_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
**kwargs

Return

edgeimpulse_api.models.get_job_response.GetJobResponse

get_organization_jobs_logs

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

Get logs

Get the logs for a job.

Parameters

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

Return

edgeimpulse_api.models.log_stdout_response.LogStdoutResponse

get_organization_socket_token

edgeimpulse_api.api.organization_jobs_api.get_organization_socket_token(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.socket_token_response.SocketTokenResponse

Get socket token for an organization

Get a token to authenticate with the web socket interface.

Parameters

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

Return

edgeimpulse_api.models.socket_token_response.SocketTokenResponse

list_active_organization_jobs

edgeimpulse_api.api.organization_jobs_api.list_active_organization_jobs(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		root_only: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.list_jobs_response.ListJobsResponse

List active jobs

Get all active jobs for this organization

Parameters

self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
root_only: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None
**kwargs

Return

edgeimpulse_api.models.list_jobs_response.ListJobsResponse

list_all_organization_jobs

edgeimpulse_api.api.organization_jobs_api.list_all_organization_jobs(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		start_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description='Start date', extra={})] = None,
		end_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description='End date', extra={})] = None,
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		exclude_pipeline_transform_jobs: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude pipeline / transformation jobs', extra={})] = None,
		root_only: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None,
		key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Job key to filter on', extra={})] = None,
		category: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Job category to filter on', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.list_jobs_response.ListJobsResponse

List all jobs

Get all jobs for this organization

Parameters

self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
start_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description='Start date', extra={})] = None
end_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description='End date', extra={})] = None
limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
exclude_pipeline_transform_jobs: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude pipeline / transformation jobs', extra={})] = None
root_only: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None
key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Job key to filter on', extra={})] = None
category: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Job category to filter on', extra={})] = None
**kwargs

Return

edgeimpulse_api.models.list_jobs_response.ListJobsResponse

list_finished_organization_jobs

edgeimpulse_api.api.organization_jobs_api.list_finished_organization_jobs(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		start_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description='Start date', extra={})] = None,
		end_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description='End date', extra={})] = None,
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		root_only: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.list_jobs_response.ListJobsResponse

List finished jobs

Get all finished jobs for this organization

Parameters

self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
start_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description='Start date', extra={})] = None
end_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description='End date', extra={})] = None
limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
root_only: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None
**kwargs

Return

edgeimpulse_api.models.list_jobs_response.ListJobsResponse

Previousorganization_data_campaigns_api module Nextorganization_pipelines_api module

Last updated 24 days ago