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