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 messagegoogle.cloud.chronicle.v1.Retrohunt
Namespace
Google \ Cloud \ Chronicle \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
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}
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}
Returns
Type
Description
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}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getProcessInterval
Required. The start and end time of the event time range this retrohunt
processes.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Chronicle V1 Client - Class Retrohunt (0.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [0.1.2 (latest)](/php/docs/reference/cloud-chronicle/latest/V1.Retrohunt)\n- [0.1.1](/php/docs/reference/cloud-chronicle/0.1.1/V1.Retrohunt) \nReference documentation and code samples for the Google Cloud Chronicle V1 Client class Retrohunt.\n\nRetrohunt is an execution of a Rule over a time range in the past.\n\nGenerated from protobuf message `google.cloud.chronicle.v1.Retrohunt`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Chronicle \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe resource name of the retrohunt.\n\nRetrohunt is the child of a rule revision. {rule} in the format below is\nstructured as {rule_id@revision_id}.\nFormat:\n`projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}`\n\n### setName\n\nThe resource name of the retrohunt.\n\nRetrohunt is the child of a rule revision. {rule} in the format below is\nstructured as {rule_id@revision_id}.\nFormat:\n`projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}`\n\n### getProcessInterval\n\nRequired. The start and end time of the event time range this retrohunt\nprocesses.\n\n### hasProcessInterval\n\n### clearProcessInterval\n\n### setProcessInterval\n\nRequired. The start and end time of the event time range this retrohunt\nprocesses.\n\n### getExecutionInterval\n\nOutput only. The start and end time of the retrohunt execution. If the\nretrohunt is not yet finished, the end time of the interval will not be\npopulated.\n\n### hasExecutionInterval\n\n### clearExecutionInterval\n\n### setExecutionInterval\n\nOutput only. The start and end time of the retrohunt execution. If the\nretrohunt is not yet finished, the end time of the interval will not be\npopulated.\n\n### getState\n\nOutput only. The state of the retrohunt.\n\n### setState\n\nOutput only. The state of the retrohunt.\n\n### getProgressPercentage\n\nOutput only. Percent progress of the retrohunt towards completion, from\n0.00 to 100.00.\n\n### setProgressPercentage\n\nOutput only. Percent progress of the retrohunt towards completion, from\n0.00 to 100.00."]]
