DedupKeyOverlays

Overview

Available Operations

• renderTemplate - Render Dedup Key template
• getForAlertSource - Get Dedup Key Overlay for Alert Source
• update - Update Dedup Key Overlay

renderTemplate

Render Dedup Key template

Example Usage

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";

const squadcastSDK = new SquadcastSDK({
  refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});

async function run() {
  const result = await squadcastSDK.dedupKeyOverlays.renderTemplate({
    serviceID: "<id>",
    v3ServicesOverlayRenderDedupKeyTemplateRequest: {
      overlayTemplateType: "<value>",
      template: "<value>",
      payload: "<value>",
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SquadcastSDKCore } from "@solarwinds/squadcast-sdk-typescript/core.js";
import { dedupKeyOverlaysRenderTemplate } from "@solarwinds/squadcast-sdk-typescript/funcs/dedupKeyOverlaysRenderTemplate.js";

// Use `SquadcastSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const squadcastSDK = new SquadcastSDKCore({
  refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});

async function run() {
  const res = await dedupKeyOverlaysRenderTemplate(squadcastSDK, {
    serviceID: "<id>",
    v3ServicesOverlayRenderDedupKeyTemplateRequest: {
      overlayTemplateType: "<value>",
      template: "<value>",
      payload: "<value>",
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("dedupKeyOverlaysRenderTemplate failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.OverlayRenderDedupKeyTemplateRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.OverlayRenderDedupKeyTemplateResponse>

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

getForAlertSource

Get Dedup Key Overlay for Alert Source

Example Usage

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";

const squadcastSDK = new SquadcastSDK({
  refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});

async function run() {
  const result = await squadcastSDK.dedupKeyOverlays.getForAlertSource({
    serviceID: "<id>",
    alertSource: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SquadcastSDKCore } from "@solarwinds/squadcast-sdk-typescript/core.js";
import { dedupKeyOverlaysGetForAlertSource } from "@solarwinds/squadcast-sdk-typescript/funcs/dedupKeyOverlaysGetForAlertSource.js";

// Use `SquadcastSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const squadcastSDK = new SquadcastSDKCore({
  refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});

async function run() {
  const res = await dedupKeyOverlaysGetForAlertSource(squadcastSDK, {
    serviceID: "<id>",
    alertSource: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("dedupKeyOverlaysGetForAlertSource failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.OverlayGetDedupKeyOverlayForAlertSourceRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.OverlayGetDedupKeyOverlayForAlertSourceResponse>

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

update

Update Dedup Key Overlay

Example Usage

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";

const squadcastSDK = new SquadcastSDK({
  refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});

async function run() {
  const result = await squadcastSDK.dedupKeyOverlays.update({
    serviceID: "<id>",
    alertSource: "<value>",
    v3ServicesOverlayUpdateDedupKeyOverlayRequest: {
      overlayTemplateType: "<value>",
      dedupKeyOverlay: {
        template: "<value>",
        duration: 360400,
      },
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SquadcastSDKCore } from "@solarwinds/squadcast-sdk-typescript/core.js";
import { dedupKeyOverlaysUpdate } from "@solarwinds/squadcast-sdk-typescript/funcs/dedupKeyOverlaysUpdate.js";

// Use `SquadcastSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const squadcastSDK = new SquadcastSDKCore({
  refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});

async function run() {
  const res = await dedupKeyOverlaysUpdate(squadcastSDK, {
    serviceID: "<id>",
    alertSource: "<value>",
    v3ServicesOverlayUpdateDedupKeyOverlayRequest: {
      overlayTemplateType: "<value>",
      dedupKeyOverlay: {
        template: "<value>",
        duration: 360400,
      },
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("dedupKeyOverlaysUpdate failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.OverlayUpdateDedupKeyOverlayRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.OverlayUpdateDedupKeyOverlayResponse>

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*