Update ScheduledExposureCalculation

Updates a scheduled exposure calculation.

PATCH /v1/scheduledExposureCalculations/{scheduledExposureCalculation}

Update ScheduledExposureCalculation

cURL

curl --request PATCH \
  --url https://metrics.eu.confidence.dev/v1/scheduledExposureCalculations/{scheduledExposureCalculation} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "exposureCalculationSpec": {},
  "scheduleStartTime": {},
  "scheduleIntervals": [
    {}
  ],
  "entity": "<string>",
  "nextAssignmentStartTime": {},
  "nextAssignmentEndTime": {},
  "nextScheduledRunTime": {},
  "executedCalculationsCount": {},
  "iteration": {},
  "createTime": {},
  "updateTime": {},
  "status": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "scheduleEndTime": {},
  "exposureTable": "<string>",
  "state": {},
  "exposedEntitiesMetric": "<string>",
  "exposedEntitiesMetricSchedule": "<string>",
  "labels": [
    {}
  ],
  "activeRetrigger": "<string>",
  "owner": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

scheduledExposureCalculation · string · required

Query Parameters

updateMask · object

The list of fields to update. Fields are specified relative to the ScheduledExposureCalculation (e.g. labels; not scheduled_exposure_calculation.labels).

Body

application/json

The body is of type object.

Response

200 - application/json

OK

Represents the schedule of a exposure calculation.

exposureCalculationSpec · object · required

Defines how to calculate exposure.

scheduleStartTime · object · required

The timestamp of when the schedule should start running.

scheduleIntervals · object[] · required

Length of the scheduling intervals, incremented each time the schedule runs until the last which is the length that is continued indefinitely.

entity · string · required

Resource name of the entity that is being exposed.

nextAssignmentStartTime · object · required

The start time of assignments for the next scheduled run.

nextAssignmentEndTime · object · required

The end time of assignments for the next scheduled run.

nextScheduledRunTime · object · required

The time when the exposure calculation is scheduled to run the next time. If the calculation is cancelled, this field contains the latest time it was scheduled to run before cancellation.

executedCalculationsCount · object · required

The number of calculations that has been executed so far.

iteration · object · required

The iteration of the schedule. A new iteration is created every time the schedule is retriggered.

createTime · object · required

Time when the scheduled exposure calculation was first created.

updateTime · object · required

Time when the scheduled exposure calculation was last updated.

status · object · required

Status of the schedule. This explains more in depth of where the schedule is now, if it's waiting for data or if it's currently executing

creator · string · required

Reference to the identity that created this scheduled exposure calculation.

updater · string · required

Reference to the identity that last updated this scheduled exposure calculation.

name · string

Unique identifier of the scheduled exposure calculation. For example: scheduledExposureCalculations/0smva5nxuhv4yts6paxt

scheduleEndTime · object

The time when the exposure calculation will end. Once the schedule reaches the end it will be cancelled and no new calculations will be triggered. If no end is specified the schedule will continue indefinitely.

exposureTable · string

Resource name of the exposure table.

state · object

Current state of the schedule.

exposedEntitiesMetric · string

Resource name of the metric that counts exposures.

exposedEntitiesMetricSchedule · string

Resource name of the metric schedule that counts exposures.

labels · object[]

Custom labels for this scheduled exposure calculation.

Show child attributes

activeRetrigger · string

Reference to a retrigger if one is active.

owner · string

The owner of the resource. If not set will default to the creator.