Regenerate client from commit 8730ba1 of spec repo

Author: ci.datadog-api-spec

.generator/schemas/v2/openapi.yaml

@@ -1350,6 +1350,20 @@ components:
       required: true
       schema:
         type: string
+    RumPermanentRetentionFilterApplicationIDParameter:
+      description: RUM application ID.
+      in: path
+      name: app_id
+      required: true
+      schema:
+        type: string
+    RumPermanentRetentionFilterIDParameter:
+      description: Permanent retention filter ID.
+      in: path
+      name: rf_id
+      required: true
+      schema:
+        type: string
     RumRetentionFilterIDParameter:
       description: Retention filter ID.
       in: path
@@ -60288,6 +60302,221 @@ components:
             $ref: "#/components/schemas/RumMetricResponseData"
           type: array
       type: object
+    RumPermanentCrossProductSampling:
+      description: Cross-product retention settings for a permanent retention filter.
+      properties:
+        session_replay_enabled:
+          description: Indicates whether Session Replay cross-product retention is active. Read-only.
+          example: true
+          type: boolean
+        session_replay_sample_rate:
+          description: Percentage (0–100) of retained sessions (with an ingested replay) whose replay is kept.
+          example: 75.0
+          format: double
+          maximum: 100
+          minimum: 0
+          type: number
+        trace_enabled:
+          description: Indicates whether Trace cross-product retention is active. Read-only.
+          example: true
+          type: boolean
+        trace_sample_rate:
+          description: Percentage (0–100) of retained sessions (with ingested traces) whose traces are indexed.
+          example: 25.0
+          format: double
+          maximum: 100
+          minimum: 0
+          type: number
+      type: object
+    RumPermanentCrossProductSamplingEditability:
+      description: Flags indicating which `cross_product_sampling` rates can be updated for this filter. Read-only.
+      properties:
+        session_replay_sample_rate:
+          description: If `true`, `cross_product_sampling.session_replay_sample_rate` can be updated on this filter.
+          example: true
+          type: boolean
+        trace_sample_rate:
+          description: If `true`, `cross_product_sampling.trace_sample_rate` can be updated on this filter.
+          example: true
+          type: boolean
+      type: object
+    RumPermanentCrossProductSamplingUpdate:
+      description: |-
+        Partial update of the cross-product sample rates for a permanent retention filter.
+        Only rates with a matching `cross_product_sampling_editability` flag set to `true` can be updated.
+      properties:
+        session_replay_sample_rate:
+          description: |-
+            Percentage (0–100) of retained sessions (with an ingested replay) whose replay is kept.
+            Omit to leave unchanged. Rejected if the filter's `cross_product_sampling_editability.session_replay_sample_rate` is `false`.
+          example: 75.0
+          format: double
+          maximum: 100
+          minimum: 0
+          type: number
+        trace_sample_rate:
+          description: |-
+            Percentage (0–100) of retained sessions (with ingested traces) whose traces are indexed.
+            Omit to leave unchanged. Rejected if the filter's `cross_product_sampling_editability.trace_sample_rate` is `false`.
+          example: 25.0
+          format: double
+          maximum: 100
+          minimum: 0
+          type: number
+      type: object
+    RumPermanentRetentionFilterAttributes:
+      description: The attributes of a permanent retention filter.
+      properties:
+        cross_product_sampling:
+          $ref: "#/components/schemas/RumPermanentCrossProductSampling"
+        cross_product_sampling_editability:
+          $ref: "#/components/schemas/RumPermanentCrossProductSamplingEditability"
+        enabled:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterEnabled"
+        event_type:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterEventType"
+        name:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterName"
+        query:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterQuery"
+        sample_rate:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterSampleRate"
+      type: object
+    RumPermanentRetentionFilterData:
+      description: A permanent retention filter.
+      properties:
+        attributes:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterAttributes"
+        id:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterID"
+        meta:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterMeta"
+        type:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterType"
+      type: object
+    RumPermanentRetentionFilterEnabled:
+      description: Indicates whether the permanent retention filter is active. Read-only.
+      example: true
+      type: boolean
+    RumPermanentRetentionFilterEventType:
+      description: The type of RUM events the filter applies to. Read-only.
+      enum:
+        - session
+        - view
+        - action
+        - error
+        - resource
+        - long_task
+        - vital
+        - operation
+      example: "session"
+      type: string
+      x-enum-varnames:
+        - SESSION
+        - VIEW
+        - ACTION
+        - ERROR
+        - RESOURCE
+        - LONG_TASK
+        - VITAL
+        - OPERATION
+    RumPermanentRetentionFilterID:
+      description: Permanent retention filter ID.
+      example: "4b95d361-f65d-4515-9824-c9aaeba5ac2a"
+      type: string
+    RumPermanentRetentionFilterMeta:
+      description: Metadata about the permanent retention filter.
+      properties:
+        source:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterMetaSource"
+        updated_at:
+          description: Unix epoch (in milliseconds) of the last update.
+          example: 1735689600000
+          format: int64
+          type: integer
+        updated_by_handle:
+          description: Handle of the user who last updated the filter.
+          example: "jane.doe@example.com"
+          type: string
+      type: object
+    RumPermanentRetentionFilterMetaSource:
+      description: The source of the last update to a permanent retention filter.
+      enum:
+        - default
+        - ui
+        - terraform
+      example: "default"
+      type: string
+      x-enum-varnames:
+        - DEFAULT
+        - UI
+        - TERRAFORM
+    RumPermanentRetentionFilterName:
+      description: The name of a permanent retention filter. Read-only.
+      example: "Preconfigured permanent retention filter"
+      type: string
+    RumPermanentRetentionFilterQuery:
+      description: The query string for a permanent retention filter. Read-only.
+      example: "@type:session"
+      type: string
+    RumPermanentRetentionFilterResponse:
+      description: A permanent retention filter response body.
+      properties:
+        data:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterData"
+      type: object
+    RumPermanentRetentionFilterSampleRate:
+      description: The retention sample rate for a permanent retention filter, from 0 to 100. Read-only.
+      example: 100.0
+      format: double
+      maximum: 100
+      minimum: 0
+      type: number
+    RumPermanentRetentionFilterType:
+      default: permanent_retention_filters
+      description: The resource type. The value must be `permanent_retention_filters`.
+      enum:
+        - permanent_retention_filters
+      example: permanent_retention_filters
+      type: string
+      x-enum-varnames: ["PERMANENT_RETENTION_FILTERS"]
+    RumPermanentRetentionFilterUpdateAttributes:
+      description: The attributes of a permanent retention filter that can be updated.
+      properties:
+        cross_product_sampling:
+          $ref: "#/components/schemas/RumPermanentCrossProductSamplingUpdate"
+      type: object
+    RumPermanentRetentionFilterUpdateData:
+      description: The permanent retention filter properties to update.
+      properties:
+        attributes:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterUpdateAttributes"
+        id:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterID"
+        type:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterType"
+      required:
+        - id
+        - type
+        - attributes
+      type: object
+    RumPermanentRetentionFilterUpdateRequest:
+      description: The permanent retention filter body to update.
+      properties:
+        data:
+          $ref: "#/components/schemas/RumPermanentRetentionFilterUpdateData"
+      required:
+        - data
+      type: object
+    RumPermanentRetentionFiltersResponse:
+      description: All permanent retention filters for a RUM application.
+      properties:
+        data:
+          description: A list of RUM permanent retention filters.
+          items:
+            $ref: "#/components/schemas/RumPermanentRetentionFilterData"
+          type: array
+      type: object
     RumRetentionFilterAttributes:
       description: The object describing attributes of a RUM retention filter.
       properties:
@@ -117003,6 +117232,97 @@ paths:
         operator: OR
         permissions:
           - rum_apps_write
+  /api/v2/rum/applications/{app_id}/permanent_retention_filters:
+    get:
+      description: Get the list of permanent retention filters for a RUM application.
+      operationId: ListPermanentRetentionFilters
+      parameters:
+        - $ref: "#/components/parameters/RumPermanentRetentionFilterApplicationIDParameter"
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RumPermanentRetentionFiltersResponse"
+          description: OK
+        "403":
+          $ref: "#/components/responses/NotAuthorizedResponse"
+        "429":
+          $ref: "#/components/responses/TooManyRequestsResponse"
+      summary: Get all permanent retention filters
+      tags:
+        - Rum Permanent Retention Filters
+  /api/v2/rum/applications/{app_id}/permanent_retention_filters/{rf_id}:
+    get:
+      description: Get a single permanent retention filter for a RUM application.
+      operationId: GetPermanentRetentionFilter
+      parameters:
+        - $ref: "#/components/parameters/RumPermanentRetentionFilterApplicationIDParameter"
+        - $ref: "#/components/parameters/RumPermanentRetentionFilterIDParameter"
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RumPermanentRetentionFilterResponse"
+          description: OK
+        "403":
+          $ref: "#/components/responses/NotAuthorizedResponse"
+        "404":
+          $ref: "#/components/responses/NotFoundResponse"
+        "429":
+          $ref: "#/components/responses/TooManyRequestsResponse"
+      summary: Get a permanent retention filter
+      tags:
+        - Rum Permanent Retention Filters
+    patch:
+      description: |-
+        Update the cross-product sample rates of a permanent retention filter for a RUM application.
+        Only `cross_product_sampling.session_replay_sample_rate` and `cross_product_sampling.trace_sample_rate` can be updated,
+        and only when the matching flag in `cross_product_sampling_editability` is `true` on the filter.
+        Any other field, including `name`, `event_type`, `query`, `sample_rate`, `enabled`, `session_replay_enabled`,
+        `trace_enabled`, and `cross_product_sampling_editability`, is read-only and cannot be sent in the payload.
+        Returns the updated permanent retention filter when the request is successful.
+      operationId: UpdatePermanentRetentionFilter
+      parameters:
+        - $ref: "#/components/parameters/RumPermanentRetentionFilterApplicationIDParameter"
+        - $ref: "#/components/parameters/RumPermanentRetentionFilterIDParameter"
+      requestBody:
+        content:
+          application/json:
+            examples:
+              default:
+                value:
+                  data:
+                    attributes:
+                      cross_product_sampling:
+                        session_replay_sample_rate: 75.0
+                        trace_sample_rate: 25.0
+                    id: 4b95d361-f65d-4515-9824-c9aaeba5ac2a
+                    type: permanent_retention_filters
+            schema:
+              $ref: "#/components/schemas/RumPermanentRetentionFilterUpdateRequest"
+        description: New cross-product sample rates for the permanent retention filter.
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RumPermanentRetentionFilterResponse"
+          description: Updated
+        "400":
+          $ref: "#/components/responses/BadRequestResponse"
+        "403":
+          $ref: "#/components/responses/NotAuthorizedResponse"
+        "404":
+          $ref: "#/components/responses/NotFoundResponse"
+        "429":
+          $ref: "#/components/responses/TooManyRequestsResponse"
+      summary: Update a permanent retention filter
+      tags:
+        - Rum Permanent Retention Filters
+      x-codegen-request-body-name: body
   /api/v2/rum/applications/{app_id}/relationships/retention_filters:
     patch:
       description: |-
@@ -135172,6 +135492,15 @@ tags:
       description: Find out more at
       url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/
     name: Rum Metrics
+  - description: |-
+      Manage permanent retention filters through [Manage Applications](https://app.datadoghq.com/rum/list) in RUM for your organization.
+
+      Permanent retention filters are preconfigured filters that ship with each RUM application.
+      They cannot be created, deleted, or reordered. Their identity (`name`, `event_type`, `query`, `sample_rate`, `enabled`)
+      and cross-product enabled flags (`session_replay_enabled`, `trace_enabled`) are fixed.
+      You can adjust only the cross-product sample rates (`session_replay_sample_rate`, `trace_sample_rate`),
+      and only when the corresponding editability flag is `true`.
+    name: Rum Permanent Retention Filters
   - description: Manage heatmap snapshots for RUM replay sessions. Create, update, delete, and retrieve snapshots to visualize user interactions on specific views.
     name: Rum Replay Heatmaps
   - description: Create and manage playlists of RUM replay sessions. Organize, categorize, and share collections of replay sessions for analysis and collaboration.

examples/v2/rum-permanent-retention-filters/GetPermanentRetentionFilter.java

@@ -0,0 +1,28 @@
+// Get a permanent retention filter returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.RumPermanentRetentionFiltersApi;
+import com.datadog.api.client.v2.model.RumPermanentRetentionFilterResponse;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    RumPermanentRetentionFiltersApi apiInstance =
+        new RumPermanentRetentionFiltersApi(defaultClient);
+
+    try {
+      RumPermanentRetentionFilterResponse result =
+          apiInstance.getPermanentRetentionFilter(
+              "a33671aa-24fd-4dcd-ba4b-5bbdbafe7690", "default_synthetics");
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println(
+          "Exception when calling RumPermanentRetentionFiltersApi#getPermanentRetentionFilter");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}