REST Resource: projects.locations.instances.rules.retrohunts

Resource: Retrohunt

Retrohunt is an execution of a Rule over a time range in the past.

JSON representation
{
  "name": string,
  "process_interval": {
    object (Interval)
  },
  "execution_interval": {
    object (Interval)
  },
  "state": enum (State),
  "progress_percentage": number
}
Fields
name

string

The resource name of the retrohunt. Retrohunt is the child of a rule revision. {rule} in the format below is structured as {rule_id@revision_id}. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}

process_interval

object (Interval)

Required. The start and end time of the event time range this retrohunt processes.

execution_interval

object (Interval)

Output only. The start and end time of the retrohunt execution. If the retrohunt is not yet finished, the end time of the interval will not be populated.

state

enum (State)

Output only. The state of the retrohunt.

progress_percentage

number

Output only. Percent progress of the retrohunt towards completion, from 0.00 to 100.00.

State

The possible states a retrohunt can be in.

Enums
STATE_UNSPECIFIED Unspecified or unknown retrohunt state.
RUNNING Running state.
DONE Done state.
CANCELLED Cancelled state.
FAILED Failed state.

Methods

create

Create a Retrohunt.

get

Get a Retrohunt.

list

List Retrohunts.