CommitOptions
Class: warmhub.CommitOptions
CommitOptions(message: Omittable[str] = UNSET, committer: Omittable[str] = UNSET, component_ref: Omittable[str] = UNSET, chunk_size: Omittable[int] = UNSET, stream_id: Omittable[str] = UNSET, submission_id: Omittable[str] = UNSET, skip_existing: Omittable[bool] = UNSET, retry: Omittable[RetryPolicy | Mapping[str, JsonValue] | Literal[False]] = UNSET)Per-commit knobs shared by repo.apply and OperationBuilder.
Defined here rather than in a private module so the repository handle can import it without a cycle.
Every field is Omittable, and none of them is nullable. The backend
declares componentRef, committer and message as
z.string().optional() — a schema that rejects null outright — so a
None default here is not merely unidiomatic, it puts an explicit
"committer": null on the wire for every commit that did not name a
committer. UNSET is what drops the key instead; see
_unset for the three-state vocabulary.
The stream controls (chunk_size, stream_id, submission_id,
skip_existing)
never reach the wire as such, but they default to UNSET too: one rule
for the whole options object is what a reader can rely on, and
bool(UNSET) raising is a better failure for if opts.chunk_size: than
None silently agreeing with 0.
Properties and attributes
Section titled “Properties and attributes”message
Section titled “message”message = UNSETDocumentation is not yet available.
committer
Section titled “committer”committer = UNSETDocumentation is not yet available.
component_ref
Section titled “component_ref”component_ref = UNSETDocumentation is not yet available.
chunk_size
Section titled “chunk_size”chunk_size = UNSETDocumentation is not yet available.
stream_id
Section titled “stream_id”stream_id = UNSETDocumentation is not yet available.
submission_id
Section titled “submission_id”submission_id = UNSETCaller-owned UUID shared by every chunk in one logical submission.
skip_existing
Section titled “skip_existing”skip_existing = UNSETDocumentation is not yet available.
retry = UNSETA RetryPolicy (or its wire-spelled mapping), or False to disable
the bounded transient retry. UNSET means the default policy — which
is why this field in particular cannot use None for “not provided”:
False and “absent” are different instructions.