Skip to main content

Module objects

Module objects 

Source
Expand description

Generated transport-independent contract objects.

Structs§

AttemptLease
AttemptLease contract value.
CallerApplication
CallerApplication contract value.
CallerInstallation
CallerInstallation contract value.
CallerResource
CallerResource contract value.
CallerService
CallerService contract value.
CallerUser
CallerUser contract value.
CallerWorkload
CallerWorkload contract value.
ColumnGroupCompactionCommit
ColumnGroupCompactionCommit contract value.
ColumnGroupCompactionProgress
ColumnGroupCompactionProgress contract value.
ComputeClassCpu
ComputeClassCpu contract value.
ComputeClassGpu
ComputeClassGpu contract value.
CreateTaskRequest
CreateTaskRequest contract value.
CreateTaskResponseAccepted
CreateTaskResponseAccepted contract value.
CreateTaskResponseSkipped
CreateTaskResponseSkipped contract value.
CreateWorkerPoolRequest
CreateWorkerPoolRequest contract value.
DeletionApplicationProgress
DeletionApplicationProgress contract value.
DrainWorkerResponse
DrainWorkerResponse contract value.
EnrichmentComputeDefinition
One child of an Enrichment refresh, writing the values of its assigned source files. Its parent is the refresh.
EnrichmentRefreshDefinition
Refresh one Enrichment against its source Table’s version at an exact Project commit, computing only the rows whose inputs changed since the version its values are current for, and publish one Enrichment version.
FinishAttemptOutcomeCancelled
FinishAttemptOutcomeCancelled contract value.
FinishAttemptOutcomeFailed
FinishAttemptOutcomeFailed contract value.
FinishAttemptOutcomeSucceeded
FinishAttemptOutcomeSucceeded contract value.
FinishAttemptRequest
FinishAttemptRequest contract value.
FinishAttemptResponse
FinishAttemptResponse contract value.
HeartbeatWorkerRequest
HeartbeatWorkerRequest contract value.
HeartbeatWorkerResponse
HeartbeatWorkerResponse contract value.
InvocationPage
InvocationPage contract value.
InvocationPageRequest
InvocationPageRequest contract value.
LegacyCompactionParameters
Planning parameters that a coordinator pins, so that every worker plans the same way.
LegacyTableCompactionWorkerDefinition
One child of a legacy table maintenance Task. It compacts one column group at the coordinator’s snapshot and returns the operations for the coordinator to commit.
LegacyTableDefinition
One legacy keyed table, and whether to strip manifest metadata it no longer needs.
LegacyTableMaintenanceDefinition
One legacy keyed table to flush and compact, whether to strip manifest metadata it no longer needs, and whether to compact its column groups in parallel child Tasks that this Task commits as one transaction.
ListTaskSpecsResponse
ListTaskSpecsResponse contract value.
ListTasksRequest
ListTasksRequest contract value.
ListTasksResponse
ListTasksResponse contract value.
ListWorkerAttemptsRequest
ListWorkerAttemptsRequest contract value.
ListWorkerAttemptsResponse
ListWorkerAttemptsResponse contract value.
ListWorkerPoolsRequest
ListWorkerPoolsRequest contract value.
ListWorkerPoolsResponse
ListWorkerPoolsResponse contract value.
ListWorkerSessionsRequest
ListWorkerSessionsRequest contract value.
ListWorkerSessionsResponse
ListWorkerSessionsResponse contract value.
LocationRefreshDefinition
List a Location’s root, reconcile its inventory by path, and publish the inventory and a refresh Location version in one commit. The read target must be latestOnBranch.
MaintenanceTaskProgress
MaintenanceTaskProgress contract value.
PollTaskResponse
PollTaskResponse contract value.
PublishedVersion
PublishedVersion contract value.
RegisterWorkerRequest
RegisterWorkerRequest contract value.
RegisterWorkerResponse
RegisterWorkerResponse contract value.
ResourceProfileDetails
ResourceProfileDetails contract value.
ResourceUsage
ResourceUsage contract value.
ResourceUsageHistory
ResourceUsageHistory contract value.
ResourceUsageRequest
ResourceUsageRequest contract value.
ResourceUsageSummary
ResourceUsageSummary contract value.
RunTriggerRequest
RunTriggerRequest contract value.
SubmitTaskRequest
SubmitTaskRequest contract value.
TableMaintenanceDefinition
Compact and recluster the latest state of one Table branch, publishing each step as a new Table version. The read target must be latestOnBranch.
Task
One durable Task. claim is absent only from servers that predate it.
TaskAttempt
TaskAttempt contract value.
TaskDetails
TaskDetails contract value.
TaskFailure
TaskFailure contract value.
TaskOptions
TaskOptions contract value.
TaskProgress
TaskProgress contract value.
TaskReadTargetCommitOnBranch
TaskReadTargetCommitOnBranch contract value.
TaskReadTargetLatestOnBranch
TaskReadTargetLatestOnBranch contract value.
TaskRequirements
TaskRequirements contract value.
TaskResourceReference
TaskResourceReference contract value.
TaskResult
The resource versions a successful Task published, and the Project commit that published them when it published any.
TaskSpecDefaults
TaskSpecDefaults contract value.
TaskSpecId
TaskSpecId contract value.
TaskStats
TaskStats contract value.
TaskStatsRequest
TaskStatsRequest contract value.
TaskTrigger
TaskTrigger contract value.
TaskWorkProgress
TaskWorkProgress contract value.
TaskWorker
TaskWorker contract value.
TestTriggerRequest
TestTriggerRequest contract value.
TestTriggerResponse
TestTriggerResponse contract value.
TriggerAction
TriggerAction contract value.
TriggerDefinition
TriggerDefinition contract value.
TriggerInvocation
TriggerInvocation contract value.
TriggerOccurrenceJournalEvent
TriggerOccurrenceJournalEvent contract value.
TriggerOccurrenceManual
TriggerOccurrenceManual contract value.
TriggerOccurrenceSchedule
TriggerOccurrenceSchedule contract value.
TriggerPage
TriggerPage contract value.
TriggerPageRequest
TriggerPageRequest contract value.
TriggerSourceInterval
TriggerSourceInterval contract value.
TriggerSourceJournalEvent
TriggerSourceJournalEvent contract value.
UpdateTriggerRequest
UpdateTriggerRequest contract value.
VectorIndexRefreshDefinition
Build an immutable successor of a Vector Index from its source Table. With latest, the pinned versions are authorized at submission and the current state is resolved when the Task runs.
WorkerAttempt
WorkerAttempt contract value.
WorkerCapabilities
WorkerCapabilities contract value.
WorkerGpuResources
WorkerGpuResources contract value.
WorkerIdentityUser
WorkerIdentityUser contract value.
WorkerIdentityWorkload
WorkerIdentityWorkload contract value.
WorkerPool
WorkerPool contract value.
WorkerPoolDetails
WorkerPoolDetails contract value.
WorkerPoolResponse
WorkerPoolResponse contract value.
WorkerPoolStats
WorkerPoolStats contract value.
WorkerResources
WorkerResources contract value.
WorkerSession
WorkerSession contract value.
WorkerSessionTags
WorkerSessionTags contract value.
WorkerTask
WorkerTask contract value.

Enums§

AttemptStatus
AttemptStatus contract value.
Caller
Caller contract value.
ColumnGroupCompactionStep
ColumnGroupCompactionStep contract value.
ComputeClass
ComputeClass contract value.
CreateTaskResponse
CreateTaskResponse contract value.
FinishAttemptOutcome
FinishAttemptOutcome contract value.
GpuRuntime
GpuRuntime contract value.
InvocationStatus
InvocationStatus contract value.
LegacyCompactionStrategy
LegacyCompactionStrategy contract value.
MaintenanceTaskStage
MaintenanceTaskStage contract value.
ResourceEventType
ResourceEventType contract value.
ResourceProfile
ResourceProfile contract value.
ResourceUsageSource
ResourceUsageSource contract value.
TaskCancellationReason
TaskCancellationReason contract value.
TaskClaim
Who may claim a Task. pool, the default, lets WorkerPools and Workers claim it when their capabilities meet its requirements. submitter reserves it for its submitter: only a Worker session authenticated as the submitter, without a WorkerPool, claims it by ID, and only its installed handlers are checked, since the submitter chose the machine. A submitter-claimed Task that no Worker claims within five minutes of becoming claimable fails with not_claimed.
TaskDefinition
What one Task does. The arm names the kind of Task; each kind has one specification version, which the Task’s taskSpecId reports.
TaskOrigin
TaskOrigin contract value.
TaskOverlapPolicy
TaskOverlapPolicy contract value.
TaskProgressPhase
TaskProgressPhase contract value.
TaskReadTarget
TaskReadTarget contract value.
TaskResourceRole
TaskResourceRole contract value.
TaskStatus
TaskStatus contract value.
TaskStopReason
TaskStopReason contract value.
TaskWorkStage
TaskWorkStage contract value.
TasksError
Typed errors declared by this service contract.
TriggerOccurrence
TriggerOccurrence contract value.
TriggerSource
TriggerSource contract value.
VectorIndexBuildMode
VectorIndexBuildMode contract value.
WorkerIdentity
WorkerIdentity contract value.
WorkerPoolStatus
WorkerPoolStatus contract value.
WorkerSessionStatus
WorkerSessionStatus contract value.