BackgroundOperationID
Background operation ID.
| Full name | MFiles.BackgroundOperationID |
|---|---|
| Proto file | mfiles/structs.proto |
Fields
| Field | Type | Number | Description |
|---|---|---|---|
type | BackgroundOperationType | 1 | Operation type.Values: BACKGROUND_OPERATION_TYPE_UNKNOWN (0), BACKGROUND_OPERATION_TYPE_INDEX_METADATA (1), BACKGROUND_OPERATION_TYPE_REFRESH_EXTERNAL_OBJECT_TYPE (2), BACKGROUND_OPERATION_TYPE_REFRESH_EXTERNAL_LOCATION (3), BACKGROUND_OPERATION_TYPE_PERFORM_OCR_TASK (4), BACKGROUND_OPERATION_TYPE_RUN_PERFORMANCE_MEASUREMENTS (5), BACKGROUND_OPERATION_TYPE_CLEAN_UP_ACL_DEPENDENCY_SETS (6). |
id | int32 | 2 | Specifies an ID for the operation (e.g. object type ID). |
Used by methods
- IRPCBackgroundOperationsAdmin.GetBackgroundOperationStatus -- Gets the run state of a background operation, such as an external object type refresh.
- IRPCBackgroundOperationsAdmin.StartBackgroundOperation -- Starts a background operation now, such as a full refresh of an external object type from its external database.
- IRPCBackgroundOperationsAdmin.WaitForBackgroundOperationCompletion -- Waits until a background operation has finished, or stops it.
Used in fields
GetBackgroundOperationStatusRequest.background_operation_id-- The operation:type, andid(the object type ID or the external location ID for the refresh types).StartBackgroundOperationRequest.background_operation_id-- The operation to start.WaitForBackgroundOperationCompletionRequest.background_operation_id-- The operation to wait for.