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.
| 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: |
↳ 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}
| 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.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Interval|null |
|
hasProcessInterval
clearProcessInterval
setProcessInterval
Required. The start and end time of the event time range this retrohunt processes.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Interval
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Interval|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Interval
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The state of the retrohunt.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. The state of the retrohunt.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProgressPercentage
Output only. Percent progress of the retrohunt towards completion, from 0.00 to 100.00.
| Returns | |
|---|---|
| Type | Description |
float |
|
setProgressPercentage
Output only. Percent progress of the retrohunt towards completion, from 0.00 to 100.00.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|