Reference documentation and code samples for the Google Cloud Chronicle V1 Client class IteratorStrategy.
Use progress tokens provided by the API.
Generated from protobuf message google.cloud.chronicle.v1.CustomAPICheckpointConfig.IteratorStrategy
Namespace
Google \ Cloud \ Chronicle \ V1 \ CustomAPICheckpointConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ checkpoint_value_path |
string
Required. Enter the exact location within a log record where the checkpoint value (like a timestamp or ID) is found. |
↳ checkpoint_variable |
string
Required. Specify a custom name you assign to store and reference the checkpoint value between polling cycles. |
getCheckpointValuePath
Required. Enter the exact location within a log record where the checkpoint value (like a timestamp or ID) is found.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCheckpointValuePath
Required. Enter the exact location within a log record where the checkpoint value (like a timestamp or ID) is found.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCheckpointVariable
Required. Specify a custom name you assign to store and reference the checkpoint value between polling cycles.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCheckpointVariable
Required. Specify a custom name you assign to store and reference the checkpoint value between polling cycles.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|