Reference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::CustomAPITransferNode.
Container for a specific API interaction.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#checkpointing
def checkpointing() -> ::Google::Cloud::Chronicle::V1::CustomAPICheckpointConfig
Returns
- (::Google::Cloud::Chronicle::V1::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).
#checkpointing=
def checkpointing=(value) -> ::Google::Cloud::Chronicle::V1::CustomAPICheckpointConfig
Parameter
- value (::Google::Cloud::Chronicle::V1::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).
Returns
- (::Google::Cloud::Chronicle::V1::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
def dependent_requests_config() -> ::Google::Cloud::Chronicle::V1::CustomAPIDependentRequestsConfig
Returns
- (::Google::Cloud::Chronicle::V1::CustomAPIDependentRequestsConfig) — Optional. Configuration for dependent requests (child chaining).
#dependent_requests_config=
def dependent_requests_config=(value) -> ::Google::Cloud::Chronicle::V1::CustomAPIDependentRequestsConfig
Parameter
- value (::Google::Cloud::Chronicle::V1::CustomAPIDependentRequestsConfig) — Optional. Configuration for dependent requests (child chaining).
Returns
- (::Google::Cloud::Chronicle::V1::CustomAPIDependentRequestsConfig) — Optional. Configuration for dependent requests (child chaining).
#pagination_strategy
def pagination_strategy() -> ::Google::Cloud::Chronicle::V1::CustomAPIPagination
Returns
- (::Google::Cloud::Chronicle::V1::CustomAPIPagination) — Required. Select how the connector should request subsequent pages when the data is too large for a single response.
#pagination_strategy=
def pagination_strategy=(value) -> ::Google::Cloud::Chronicle::V1::CustomAPIPagination
Parameter
- value (::Google::Cloud::Chronicle::V1::CustomAPIPagination) — Required. Select how the connector should request subsequent pages when the data is too large for a single response.
Returns
- (::Google::Cloud::Chronicle::V1::CustomAPIPagination) — Required. Select how the connector should request subsequent pages when the data is too large for a single response.
#request_settings
def request_settings() -> ::Google::Cloud::Chronicle::V1::CustomAPIRequestConfig
Returns
- (::Google::Cloud::Chronicle::V1::CustomAPIRequestConfig) — Required. Define the technical parameters for the outgoing API call, including paths, headers, and payloads.
#request_settings=
def request_settings=(value) -> ::Google::Cloud::Chronicle::V1::CustomAPIRequestConfig
Parameter
- value (::Google::Cloud::Chronicle::V1::CustomAPIRequestConfig) — Required. Define the technical parameters for the outgoing API call, including paths, headers, and payloads.
Returns
- (::Google::Cloud::Chronicle::V1::CustomAPIRequestConfig) — Required. Define the technical parameters for the outgoing API call, including paths, headers, and payloads.
#response_mapping
def response_mapping() -> ::Google::Cloud::Chronicle::V1::CustomAPIResponseConfig
Returns
- (::Google::Cloud::Chronicle::V1::CustomAPIResponseConfig) — Required. Provide rules that tell the platform how to locate and extract the relevant security data from the API's reply.
#response_mapping=
def response_mapping=(value) -> ::Google::Cloud::Chronicle::V1::CustomAPIResponseConfig
Parameter
- value (::Google::Cloud::Chronicle::V1::CustomAPIResponseConfig) — Required. Provide rules that tell the platform how to locate and extract the relevant security data from the API's reply.
Returns
- (::Google::Cloud::Chronicle::V1::CustomAPIResponseConfig) — Required. Provide rules that tell the platform how to locate and extract the relevant security data from the API's reply.