Reference documentation and code samples for the Google Cloud Chronicle V1 Client class RetrohuntMetadata.
Operation Metadata for Retrohunts.
Generated from protobuf message google.cloud.chronicle.v1.RetrohuntMetadata
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ retrohunt |
string
The name of the retrohunt. Format: |
↳ execution_interval |
Google\Type\Interval
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 filled. |
↳ progress_percentage |
float
Percent progress of the retrohunt towards completion, from 0.00 to 100.00. |
getRetrohunt
The name of the retrohunt.
Format:
projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}
| Returns | |
|---|---|
| Type | Description |
string |
|
setRetrohunt
The name of the retrohunt.
Format:
projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExecutionInterval
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 filled.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Interval|null |
|
hasExecutionInterval
clearExecutionInterval
setExecutionInterval
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 filled.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Interval
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProgressPercentage
Percent progress of the retrohunt towards completion, from 0.00 to 100.00.
| Returns | |
|---|---|
| Type | Description |
float |
|
setProgressPercentage
Percent progress of the retrohunt towards completion, from 0.00 to 100.00.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|