Services
RPC methods exposed by this API.JobService
| Method | Request | Response | Description |
|---|---|---|---|
| ListJobs | ListJobsRequest | ListJobsResponse | List jobs. |
| CancelJob | CancelJobRequest | CancelJobResponse | Requests cancellation of an active job. If the job hasn’t started yet, it will be cancelled immediately. Jobs that are already finished, failed, or cancelled are not affected. Cancelled jobs have implementation-based behavior, but in every case it’s valid to cancel a job at any time. |
| RetryJob | RetryJobRequest | RetryJobResponse | Requests a retry of a job. Jobs that are finished, in progress or in the process of being cancelled are not affected. |
Messages
Data models used across requests/responses.CancelJobRequest
| Field | Type | Label | Description |
|---|---|---|---|
| job_id | string |
CancelJobResponse
This message has no fields.DataExportJobDetails
| Field | Type | Label | Description |
|---|---|---|---|
| request | sift.exports.v1.ExportDataRequest | ||
| storage_key | string |
DataExportStatusDetails
| Field | Type | Label | Description |
|---|---|---|---|
| error_message | string |
DataImportJobDetails
| Field | Type | Label | Description |
|---|---|---|---|
| data_import_id | string |
DataImportStatusDetails
| Field | Type | Label | Description |
|---|---|---|---|
| points_processed | uint64 | ||
| points_total | uint64 |
Job
| Field | Type | Label | Description |
|---|---|---|---|
| job_id | string | ||
| organization_id | string | ||
| created_by_user_id | string | ||
| modified_by_user_id | string | ||
| created_date | google.protobuf.Timestamp | ||
| modified_date | google.protobuf.Timestamp | ||
| started_date | google.protobuf.Timestamp | ||
| completed_date | google.protobuf.Timestamp | ||
| job_type | JobType | ||
| job_status | JobStatus | ||
| job_status_details | JobStatusDetails | ||
| job_details | JobDetails |
JobDetails
| Field | Type | Label | Description |
|---|---|---|---|
| oneof details. rule_evaluation | RuleEvaluationJobDetails | ||
| oneof details. data_import | DataImportJobDetails | ||
| oneof details. data_export | DataExportJobDetails |
JobStatusDetails
| Field | Type | Label | Description |
|---|---|---|---|
| oneof status. rule_evaluation | RuleEvaluationStatusDetails | ||
| oneof status. data_import | DataImportStatusDetails | ||
| oneof status. data_export | DataExportStatusDetails |
ListJobsRequest
| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 50 jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional. | |
| page_token | string | A page token, received from a previous ListJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListJobs must match the call that provided the page token. Optional. | |
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are: job_id, created_by_user_id, modified_by_user_id, created_date, modified_date, started_date, completed_date, and job_status For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional. | |
| organization_id | string | This field is only required if your user belongs to multiple organizations. | |
| order_by | string | How to order the retrieved jobs. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are created_date, modified_date, started_date, completed_date, job_status. If left empty, items are ordered by created_date in descending order (newest-first). For more information about the format of this field, read this Example: “created_date desc,modified_date” |
ListJobsResponse
| Field | Type | Label | Description |
|---|---|---|---|
| jobs | Job | repeated | |
| next_page_token | string |
RetryJobRequest
| Field | Type | Label | Description |
|---|---|---|---|
| job_id | string |
RetryJobResponse
| Field | Type | Label | Description |
|---|---|---|---|
| job | Job |
RuleEvaluationJobDetails
| Field | Type | Label | Description |
|---|---|---|---|
| report_id | string |
RuleEvaluationStatusDetails
This message has no fields.Enums
Allowed constant values used in message fields.JobStatus
| Name | Number | Description |
|---|---|---|
| JOB_STATUS_UNSPECIFIED | 0 | |
| JOB_STATUS_CREATED | 1 | |
| JOB_STATUS_RUNNING | 2 | |
| JOB_STATUS_FINISHED | 3 | |
| JOB_STATUS_FAILED | 4 | |
| JOB_STATUS_CANCELLED | 5 | |
| JOB_STATUS_CANCEL_REQUESTED | 6 |
JobType
| Name | Number | Description |
|---|---|---|
| JOB_TYPE_UNSPECIFIED | 0 | |
| JOB_TYPE_RULE_EVALUATION | 1 | |
| JOB_TYPE_DATA_IMPORT | 2 | |
| JOB_TYPE_DATA_EXPORT | 3 |