Reference documentation and code samples for the Google Cloud Chronicle V1 Client class CustomAPIDependentRequestsConfig.
Configuration for dependent requests (child chaining).
Generated from protobuf message google.cloud.chronicle.v1.CustomAPIDependentRequestsConfig
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ item_id_json_path |
string
Required. Enter the specific field in the response that uniquely identifies an individual record or alert. |
↳ item_id_variable |
string
Optional. Specify a custom variable name to hold the extracted ID, which can be linked as a placeholder in dependent requests. |
↳ dependent_requests |
array<CustomAPITransferNode>
Optional. Add follow-up API calls triggered for each item found in the primary request (e.g., fetching full event details for a list of basic alert IDs). Note: In MVP, the child depth fan-out limit is capped at 1. |
getItemIdJsonPath
Required. Enter the specific field in the response that uniquely identifies an individual record or alert.
| Returns | |
|---|---|
| Type | Description |
string |
|
setItemIdJsonPath
Required. Enter the specific field in the response that uniquely identifies an individual record or alert.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getItemIdVariable
Optional. Specify a custom variable name to hold the extracted ID, which can be linked as a placeholder in dependent requests.
| Returns | |
|---|---|
| Type | Description |
string |
|
setItemIdVariable
Optional. Specify a custom variable name to hold the extracted ID, which can be linked as a placeholder in dependent requests.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDependentRequests
Optional. Add follow-up API calls triggered for each item found in the primary request (e.g., fetching full event details for a list of basic alert IDs). Note: In MVP, the child depth fan-out limit is capped at 1.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<CustomAPITransferNode> |
|
setDependentRequests
Optional. Add follow-up API calls triggered for each item found in the primary request (e.g., fetching full event details for a list of basic alert IDs). Note: In MVP, the child depth fan-out limit is capped at 1.
| Parameter | |
|---|---|
| Name | Description |
var |
array<CustomAPITransferNode>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|