README.md

Destinations.Pq

Overview

Available Operations

• clear - Clear the persistent queue for a Destination
• get - Get information about the latest job to clear the persistent queue for a Destination

clear

Clear the persistent queue (PQ) for the specified Destination.

Example Usage

from cribl_control_plane import CriblControlPlane, models
import os


with CriblControlPlane(
    "https://api.example.com",
    security=models.Security(
        bearer_auth=os.getenv("CRIBLCONTROLPLANE_BEARER_AUTH", ""),
    ),
) as ccp_client:

    res = ccp_client.destinations.pq.clear(id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
id	str	✔️	The id of the Destination to clear the PQ for.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.CountedString

Errors

Error Type	Status Code	Content Type
errors.Error	500	application/json
errors.APIError	4XX, 5XX	*/*

get

Get information about the latest job to clear the persistent queue (PQ) for the specified Destination.

Example Usage

from cribl_control_plane import CriblControlPlane, models
import os


with CriblControlPlane(
    "https://api.example.com",
    security=models.Security(
        bearer_auth=os.getenv("CRIBLCONTROLPLANE_BEARER_AUTH", ""),
    ),
) as ccp_client:

    res = ccp_client.destinations.pq.get(id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
id	str	✔️	The id of the Destination to get PQ job information for.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.CountedJobInfo

Errors

Error Type	Status Code	Content Type
errors.Error	500	application/json
errors.APIError	4XX, 5XX	*/*