Google Cloud Chronicle V1 Client - Class CustomAPICheckpointConfig (0.7.1)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class CustomAPICheckpointConfig.

Checkpoint configuration to enable sequential (cursor-based) polling.

Generated from protobuf message google.cloud.chronicle.v1.CustomAPICheckpointConfig

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ none_strategy`	`CustomAPICheckpointConfig\NoneStrategy` Fetch all available data in one go without tracking progress.
`↳ latest_timestamp_strategy`	`CustomAPICheckpointConfig\LatestTimestampStrategy` Track the timestamp of the newest record to fetch newer ones next.
`↳ latest_record_strategy`	`CustomAPICheckpointConfig\LatestRecordStrategy` Track the highest record ID to fetch only new records next.
`↳ iterator_strategy`	`CustomAPICheckpointConfig\IteratorStrategy` Use progress tokens provided by the API.

getNoneStrategy

Fetch all available data in one go without tracking progress.

Returns
Type	Description
`CustomAPICheckpointConfig\NoneStrategy\|null`

hasNoneStrategy

setNoneStrategy

Fetch all available data in one go without tracking progress.

Parameter
Name	Description
`var`	`CustomAPICheckpointConfig\NoneStrategy`

Returns
Type	Description
`$this`

getLatestTimestampStrategy

Track the timestamp of the newest record to fetch newer ones next.

Returns
Type	Description
`CustomAPICheckpointConfig\LatestTimestampStrategy\|null`

hasLatestTimestampStrategy

setLatestTimestampStrategy

Track the timestamp of the newest record to fetch newer ones next.

Parameter
Name	Description
`var`	`CustomAPICheckpointConfig\LatestTimestampStrategy`

Returns
Type	Description
`$this`

getLatestRecordStrategy

Track the highest record ID to fetch only new records next.

Returns
Type	Description
`CustomAPICheckpointConfig\LatestRecordStrategy\|null`

hasLatestRecordStrategy

setLatestRecordStrategy