Add Google PubSub destination to the Observability Pipelines API (#2844)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -30324,6 +30324,7 @@ components:
       - $ref: '#/components/schemas/ObservabilityPipelineSocketDestination'
       - $ref: '#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestination'
       - $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestination'
+      - $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubDestination'
     ObservabilityPipelineConfigProcessorItem:
       description: A processor for the pipeline.
       oneOf:
@@ -31385,6 +31386,65 @@ components:
       type: string
       x-enum-varnames:
       - GOOGLE_CLOUD_STORAGE
+    ObservabilityPipelineGooglePubSubDestination:
+      description: The `google_pubsub` destination publishes logs to a Google Cloud
+        Pub/Sub topic.
+      properties:
+        auth:
+          $ref: '#/components/schemas/ObservabilityPipelineGcpAuth'
+        encoding:
+          $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubDestinationEncoding'
+        id:
+          description: The unique identifier for this component.
+          example: google-pubsub-destination
+          type: string
+        inputs:
+          description: A list of component IDs whose output is used as the `input`
+            for this component.
+          example:
+          - filter-processor
+          items:
+            type: string
+          type: array
+        project:
+          description: The GCP project ID that owns the Pub/Sub topic.
+          example: my-gcp-project
+          type: string
+        tls:
+          $ref: '#/components/schemas/ObservabilityPipelineTls'
+        topic:
+          description: The Pub/Sub topic name to publish logs to.
+          example: logs-subscription
+          type: string
+        type:
+          $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubDestinationType'
+      required:
+      - id
+      - type
+      - inputs
+      - encoding
+      - project
+      - topic
+      type: object
+    ObservabilityPipelineGooglePubSubDestinationEncoding:
+      description: Encoding format for log events.
+      enum:
+      - json
+      - raw_message
+      example: json
+      type: string
+      x-enum-varnames:
+      - JSON
+      - RAW_MESSAGE
+    ObservabilityPipelineGooglePubSubDestinationType:
+      default: google_pubsub
+      description: The destination type. The value should always be `google_pubsub`.
+      enum:
+      - google_pubsub
+      example: google_pubsub
+      type: string
+      x-enum-varnames:
+      - GOOGLE_PUBSUB
     ObservabilityPipelineGooglePubSubSource:
       description: The `google_pubsub` source ingests logs from a Google Cloud Pub/Sub
         subscription.

docs/datadog_api_client.v2.model.rst

@@ -13577,6 +13577,27 @@ datadog\_api\_client.v2.model.observability\_pipeline\_google\_cloud\_storage\_d
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.observability\_pipeline\_google\_pub\_sub\_destination module
+-------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.observability\_pipeline\_google\_pub\_sub\_destination\_encoding module
+-----------------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination_encoding
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.observability\_pipeline\_google\_pub\_sub\_destination\_type module
+-------------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.observability\_pipeline\_google\_pub\_sub\_source module
 --------------------------------------------------------------------------------------
 

src/datadog_api_client/v2/model/observability_pipeline_config.py

@@ -73,6 +73,9 @@
     from datadog_api_client.v2.model.observability_pipeline_crowd_strike_next_gen_siem_destination import (
         ObservabilityPipelineCrowdStrikeNextGenSiemDestination,
     )
+    from datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination import (
+        ObservabilityPipelineGooglePubSubDestination,
+    )
     from datadog_api_client.v2.model.observability_pipeline_filter_processor import ObservabilityPipelineFilterProcessor
     from datadog_api_client.v2.model.observability_pipeline_parse_json_processor import (
         ObservabilityPipelineParseJSONProcessor,
@@ -199,6 +202,7 @@ def __init__(
                 ObservabilityPipelineSocketDestination,
                 ObservabilityPipelineAmazonSecurityLakeDestination,
                 ObservabilityPipelineCrowdStrikeNextGenSiemDestination,
+                ObservabilityPipelineGooglePubSubDestination,
             ]
         ],
         sources: List[

src/datadog_api_client/v2/model/observability_pipeline_config_destination_item.py

@@ -120,6 +120,12 @@ def __init__(self, **kwargs):
 
         :param compression: Compression configuration for log events.
         :type compression: ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression, optional
+
+        :param project: The GCP project ID that owns the Pub/Sub topic.
+        :type project: str
+
+        :param topic: The Pub/Sub topic name to publish logs to.
+        :type topic: str
         """
         super().__init__(kwargs)
 
@@ -182,6 +188,9 @@ def _composed_schemas(_):
         from datadog_api_client.v2.model.observability_pipeline_crowd_strike_next_gen_siem_destination import (
             ObservabilityPipelineCrowdStrikeNextGenSiemDestination,
         )
+        from datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination import (
+            ObservabilityPipelineGooglePubSubDestination,
+        )
 
         return {
             "oneOf": [
@@ -203,5 +212,6 @@ def _composed_schemas(_):
                 ObservabilityPipelineSocketDestination,
                 ObservabilityPipelineAmazonSecurityLakeDestination,
                 ObservabilityPipelineCrowdStrikeNextGenSiemDestination,
+                ObservabilityPipelineGooglePubSubDestination,
             ],
         }

src/datadog_api_client/v2/model/observability_pipeline_google_pub_sub_destination.py

@@ -0,0 +1,111 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import List, Union, TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v2.model.observability_pipeline_gcp_auth import ObservabilityPipelineGcpAuth
+    from datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination_encoding import (
+        ObservabilityPipelineGooglePubSubDestinationEncoding,
+    )
+    from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
+    from datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination_type import (
+        ObservabilityPipelineGooglePubSubDestinationType,
+    )
+
+
+class ObservabilityPipelineGooglePubSubDestination(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v2.model.observability_pipeline_gcp_auth import ObservabilityPipelineGcpAuth
+        from datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination_encoding import (
+            ObservabilityPipelineGooglePubSubDestinationEncoding,
+        )
+        from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
+        from datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination_type import (
+            ObservabilityPipelineGooglePubSubDestinationType,
+        )
+
+        return {
+            "auth": (ObservabilityPipelineGcpAuth,),
+            "encoding": (ObservabilityPipelineGooglePubSubDestinationEncoding,),
+            "id": (str,),
+            "inputs": ([str],),
+            "project": (str,),
+            "tls": (ObservabilityPipelineTls,),
+            "topic": (str,),
+            "type": (ObservabilityPipelineGooglePubSubDestinationType,),
+        }
+
+    attribute_map = {
+        "auth": "auth",
+        "encoding": "encoding",
+        "id": "id",
+        "inputs": "inputs",
+        "project": "project",
+        "tls": "tls",
+        "topic": "topic",
+        "type": "type",
+    }
+
+    def __init__(
+        self_,
+        encoding: ObservabilityPipelineGooglePubSubDestinationEncoding,
+        id: str,
+        inputs: List[str],
+        project: str,
+        topic: str,
+        type: ObservabilityPipelineGooglePubSubDestinationType,
+        auth: Union[ObservabilityPipelineGcpAuth, UnsetType] = unset,
+        tls: Union[ObservabilityPipelineTls, UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        The ``google_pubsub`` destination publishes logs to a Google Cloud Pub/Sub topic.
+
+        :param auth: GCP credentials used to authenticate with Google Cloud Storage.
+        :type auth: ObservabilityPipelineGcpAuth, optional
+
+        :param encoding: Encoding format for log events.
+        :type encoding: ObservabilityPipelineGooglePubSubDestinationEncoding
+
+        :param id: The unique identifier for this component.
+        :type id: str
+
+        :param inputs: A list of component IDs whose output is used as the ``input`` for this component.
+        :type inputs: [str]
+
+        :param project: The GCP project ID that owns the Pub/Sub topic.
+        :type project: str
+
+        :param tls: Configuration for enabling TLS encryption between the pipeline component and external services.
+        :type tls: ObservabilityPipelineTls, optional
+
+        :param topic: The Pub/Sub topic name to publish logs to.
+        :type topic: str
+
+        :param type: The destination type. The value should always be ``google_pubsub``.
+        :type type: ObservabilityPipelineGooglePubSubDestinationType
+        """
+        if auth is not unset:
+            kwargs["auth"] = auth
+        if tls is not unset:
+            kwargs["tls"] = tls
+        super().__init__(kwargs)
+
+        self_.encoding = encoding
+        self_.id = id
+        self_.inputs = inputs
+        self_.project = project
+        self_.topic = topic
+        self_.type = type

src/datadog_api_client/v2/model/observability_pipeline_google_pub_sub_destination_encoding.py

@@ -0,0 +1,40 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class ObservabilityPipelineGooglePubSubDestinationEncoding(ModelSimple):
+    """
+    Encoding format for log events.
+
+    :param value: Must be one of ["json", "raw_message"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "json",
+        "raw_message",
+    }
+    JSON: ClassVar["ObservabilityPipelineGooglePubSubDestinationEncoding"]
+    RAW_MESSAGE: ClassVar["ObservabilityPipelineGooglePubSubDestinationEncoding"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+ObservabilityPipelineGooglePubSubDestinationEncoding.JSON = ObservabilityPipelineGooglePubSubDestinationEncoding("json")
+ObservabilityPipelineGooglePubSubDestinationEncoding.RAW_MESSAGE = ObservabilityPipelineGooglePubSubDestinationEncoding(
+    "raw_message"
+)

src/datadog_api_client/v2/model/observability_pipeline_google_pub_sub_destination_type.py

@@ -0,0 +1,37 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class ObservabilityPipelineGooglePubSubDestinationType(ModelSimple):
+    """
+    The destination type. The value should always be `google_pubsub`.
+
+    :param value: If omitted defaults to "google_pubsub". Must be one of ["google_pubsub"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "google_pubsub",
+    }
+    GOOGLE_PUBSUB: ClassVar["ObservabilityPipelineGooglePubSubDestinationType"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+ObservabilityPipelineGooglePubSubDestinationType.GOOGLE_PUBSUB = ObservabilityPipelineGooglePubSubDestinationType(
+    "google_pubsub"
+)

src/datadog_api_client/v2/models/__init__.py

@@ -2617,6 +2617,15 @@
 from datadog_api_client.v2.model.observability_pipeline_google_cloud_storage_destination_type import (
     ObservabilityPipelineGoogleCloudStorageDestinationType,
 )
+from datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination import (
+    ObservabilityPipelineGooglePubSubDestination,
+)
+from datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination_encoding import (
+    ObservabilityPipelineGooglePubSubDestinationEncoding,
+)
+from datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination_type import (
+    ObservabilityPipelineGooglePubSubDestinationType,
+)
 from datadog_api_client.v2.model.observability_pipeline_google_pub_sub_source import (
     ObservabilityPipelineGooglePubSubSource,
 )
@@ -6299,6 +6308,9 @@
     "ObservabilityPipelineGoogleCloudStorageDestinationAcl",
     "ObservabilityPipelineGoogleCloudStorageDestinationStorageClass",
     "ObservabilityPipelineGoogleCloudStorageDestinationType",
+    "ObservabilityPipelineGooglePubSubDestination",
+    "ObservabilityPipelineGooglePubSubDestinationEncoding",
+    "ObservabilityPipelineGooglePubSubDestinationType",
     "ObservabilityPipelineGooglePubSubSource",
     "ObservabilityPipelineGooglePubSubSourceType",
     "ObservabilityPipelineHttpClientSource",