Reference documentation and code samples for the Google Cloud Chronicle V1 Client class CustomAPITransferNode.
Container for a specific API interaction.
Generated from protobuf message google.cloud.chronicle.v1.CustomAPITransferNode
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ request_settings |
CustomAPIRequestConfig
Required. Define the technical parameters for the outgoing API call, including paths, headers, and payloads. |
↳ response_mapping |
CustomAPIResponseConfig
Required. Provide rules that tell the platform how to locate and extract the relevant security data from the API's reply. |
↳ pagination_strategy |
CustomAPIPagination
Required. Select how the connector should request subsequent pages when the data is too large for a single response. |
↳ checkpointing |
CustomAPICheckpointConfig
Required. Configure settings that allow the connector to remember where it left off in the previous poll (e.g., tracking the last fetched timestamp). |
↳ dependent_requests_config |
CustomAPIDependentRequestsConfig
Optional. Configuration for dependent requests (child chaining). |
getRequestSettings
Required. Define the technical parameters for the outgoing API call, including paths, headers, and payloads.
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig|null |
|
hasRequestSettings
clearRequestSettings
setRequestSettings
Required. Define the technical parameters for the outgoing API call, including paths, headers, and payloads.
| Parameter | |
|---|---|
| Name | Description |
var |
CustomAPIRequestConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResponseMapping
Required. Provide rules that tell the platform how to locate and extract the relevant security data from the API's reply.
| Returns | |
|---|---|
| Type | Description |
CustomAPIResponseConfig|null |
|
hasResponseMapping
clearResponseMapping
setResponseMapping
Required. Provide rules that tell the platform how to locate and extract the relevant security data from the API's reply.
| Parameter | |
|---|---|
| Name | Description |
var |
CustomAPIResponseConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPaginationStrategy
Required. Select how the connector should request subsequent pages when the data is too large for a single response.
| Returns | |
|---|---|
| Type | Description |
CustomAPIPagination|null |
|
hasPaginationStrategy
clearPaginationStrategy
setPaginationStrategy
Required. Select how the connector should request subsequent pages when the data is too large for a single response.
| Parameter | |
|---|---|
| Name | Description |
var |
CustomAPIPagination
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCheckpointing
Required. Configure settings that allow the connector to remember where it left off in the previous poll (e.g., tracking the last fetched timestamp).
| Returns | |
|---|---|
| Type | Description |
CustomAPICheckpointConfig|null |
|
hasCheckpointing
clearCheckpointing
setCheckpointing
Required. Configure settings that allow the connector to remember where it left off in the previous poll (e.g., tracking the last fetched timestamp).
| Parameter | |
|---|---|
| Name | Description |
var |
CustomAPICheckpointConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDependentRequestsConfig
Optional. Configuration for dependent requests (child chaining).
| Returns | |
|---|---|
| Type | Description |
CustomAPIDependentRequestsConfig|null |
|
hasDependentRequestsConfig
clearDependentRequestsConfig
setDependentRequestsConfig
Optional. Configuration for dependent requests (child chaining).
| Parameter | |
|---|---|
| Name | Description |
var |
CustomAPIDependentRequestsConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|