Reference documentation and code samples for the Google Cloud Chronicle V1 Client class Retrohunt.
Retrohunt is an execution of a Rule over a time range in the past.
Generated from protobuf message google.cloud.chronicle.v1.Retrohunt
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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
Google\Type\Interval
Required. The start and end time of the event time range this retrohunt processes.
↳ execution_interval
Google\Type\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
int
Output only. The state of the retrohunt.
↳ progress_percentage
float
Output only. Percent progress of the retrohunt towards completion, from 0.00 to 100.00.
getName
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}
string
setName
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}
var
string
$this
getProcessInterval
Required. The start and end time of the event time range this retrohunt processes.
hasProcessInterval
clearProcessInterval
setProcessInterval
Required. The start and end time of the event time range this retrohunt processes.
$this
getExecutionInterval
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.
hasExecutionInterval
clearExecutionInterval
setExecutionInterval
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.
$this
getState
Output only. The state of the retrohunt.
int
setState
Output only. The state of the retrohunt.
var
int
$this
getProgressPercentage
Output only. Percent progress of the retrohunt towards completion, from 0.00 to 100.00.
float
setProgressPercentage
Output only. Percent progress of the retrohunt towards completion, from 0.00 to 100.00.
var
float
$this
