bauplan.schema
class APIError
class APIMetadata
class APIResponse
class APIResponseWithData
class APIResponseWithError
class Actor
class Branch
class Commit
class DetachedRef
class Entry
class GetBranchesResponse
Parameters
data_fetcherCallable[[int, Optional[str]], APIResponse]
data_mapperCallable[[Dict[str, Any]], T]
itersizeint
limitint | None
class GetCommitsResponse
Parameters
data_fetcherCallable[[int, Optional[str]], APIResponse]
data_mapperCallable[[Dict[str, Any]], T]
itersizeint
limitint | None
class GetNamespacesResponse
Parameters
data_fetcherCallable[[int, Optional[str]], APIResponse]
data_mapperCallable[[Dict[str, Any]], T]
itersizeint
limitint | None
class GetTablesResponse
Parameters
data_fetcherCallable[[int, Optional[str]], APIResponse]
data_mapperCallable[[Dict[str, Any]], T]
itersizeint
limitint | None
class GetTagsResponse
Parameters
data_fetcherCallable[[int, Optional[str]], APIResponse]
data_mapperCallable[[Dict[str, Any]], T]
itersizeint
limitint | None
class Job
EXPERIMENTAL AND SUBJECT TO CHANGE.
Job is a model for a job in the Bauplan system. It is tracked as a result of a code snapshot run.
def finished_after
Check if the job finished within the given timedelta from now.
Parameters
startdatetime
def finished_before
Check if the job finished before the given timedelta from now.
Parameters
enddatetime
def finished_between
Check if the job finished between two datetimes.
Parameters
startdatetime
enddatetime
def from_proto
Parameters
job_pbcommon_pb.JobInfo
def has_finished_range
Parameters
after_timeOptional[datetime]
before_timeOptional[datetime]
def has_id
Check if the job has the specified ID or ID prefix.
Parameters
check_idstr
def has_status
Check if the job has specified status.
Parameters
check_statusUnion[str, JobState]
class JobContext
EXPERIMENTAL AND SUBJECT TO CHANGE.
JobContext is a model for immediate working context of a particular job. This currently includes: (1) Ref, (2) Code Snapshot, (3) Logs. A JobContext should enable a variety of workflows for iterating on an existing Job.
def from_pb
Parameters
get_context_pbjob_context_pb.GetJobContextResponse
class JobLogEvent
EXPERIMENTAL AND SUBJECT TO CHANGE.
JobLogEvent is a model for a particular log message from a particular job.
When you output logs within a Python model, they are persisted as JobLogEvents.
def from_proto
Parameters
event_pbrunner_events_pb.RunnerEvent
filter_by_typeOptional[runner_events_pb.RuntimeLogEvent.LogType]
class JobLogLevel
class JobLogList
EXPERIMENTAL AND SUBJECT TO CHANGE.
JobLogList is a model for all of the logs from a particular job. This model is primarily provided as a convenience for "common" interactions with a job's log messages.
def error_messages
Parameters
def from_pb
Parameters
getlog_pbget_logs_pb.GetLogsResponse
filter_by_typerunner_events_pb.RuntimeLogEvent.LogType
class JobLogStream
class JobState
class Namespace
class PartitionField
class Ref
A branch or a tag