DataProviderResponse

Constructors

new DataProviderResponse(externalSourceId: String, definitions: ): DataProviderResponse

1
2
const dataProviderResponse = new DataProviderResponse(
  "string"
)

Properties

Methods

AddAlerts

addAlerts(alerts: Array<DataProviderAlertEvent>): DataProviderResponse

1
2
const resp = dataProviderResponse.addAlerts(
  [
    {
      "description": "string",
      "displayName": "string",
      "id": "string",
      "lastUpdated": "string",
      "updateSequenceNumber": "string",
      "url": "string"
    }
  ]
)

AddBuilds

addBuilds(builds: Array<DataProviderBuildEvent>): DataProviderResponse

1
2
const resp = dataProviderResponse.addBuilds(
  [
    {
      "description": "string",
      "displayName": "string",
      "lastUpdated": "string",
      "pipeline": {
        "pipelineId": "string"
      },
      "startedAt": "string",
      "state": "CANCELLED",
      "updateSequenceNumber": "string",
      "url": "string"
    }
  ]
)

AddBuiltInMetricValue

addBuiltInMetricValue(metricName: BuiltinMetricDefinitions, value: Number): DataProviderResponse

1
2
const resp = dataProviderResponse.addBuiltInMetricValue(
  "ari:cloud:compass::metric-definition/builtin/availability-28d",
  36
)

AddCustomEvents

addCustomEvents(customEvents: Array<DataProviderCustomEvent>): DataProviderResponse

1
2
const resp = dataProviderResponse.addCustomEvents(
  [
    {
      "description": "string",
      "displayName": "string",
      "icon": "CHECKPOINT",
      "id": "string",
      "lastUpdated": "string",
      "updateSequenceNumber": "string",
      "url": "string"
    }
  ]
)

AddCustomMetricValue

addCustomMetricValue(metricName: String, value: Number): DataProviderResponse

1
2
const resp = dataProviderResponse.addCustomMetricValue(
  "string",
  44
)

AddDeployments

addDeployments(deployments: Array<DataProviderDeploymentEvent>): DataProviderResponse

1
2
const resp = dataProviderResponse.addDeployments(
  [
    {
      "description": "string",
      "displayName": "string",
      "environment": {
        "category": "DEVELOPMENT",
        "displayName": "string",
        "environmentId": "string"
      },
      "lastUpdated": "string",
      "pipeline": {
        "displayName": "string",
        "pipelineId": "string",
        "url": "string"
      },
      "sequenceNumber": "string",
      "state": "CANCELLED",
      "updateSequenceNumber": "string",
      "url": "string"
    }
  ]
)

AddFlags

addFlags(flags: Array<DataProviderFlagEvent>): DataProviderResponse

1
2
const resp = dataProviderResponse.addFlags(
  [
    {
      "description": "string",
      "displayName": "string",
      "id": "string",
      "lastUpdated": "string",
      "updateSequenceNumber": "string",
      "url": "string"
    }
  ]
)

AddIncidents

addIncidents(incidents: Array<DataProviderIncidentEvent>): DataProviderResponse

1
2
const resp = dataProviderResponse.addIncidents(
  [
    {
      "description": "string",
      "displayName": "string",
      "id": "string",
      "lastUpdated": "string",
      "startTime": "string",
      "state": "DELETED",
      "updateSequenceNumber": "string",
      "url": "string"
    }
  ]
)

AddLifecycles

addLifecycles(lifecycles: Array<DataProviderLifecycleEvent>): DataProviderResponse

1
2
const resp = dataProviderResponse.addLifecycles(
  [
    {
      "description": "string",
      "displayName": "string",
      "id": "string",
      "lastUpdated": "string",
      "stage": "DEPRECATION",
      "updateSequenceNumber": "string",
      "url": "string"
    }
  ]
)

AddPullRequestEvents

addPullRequestEvents(pullRequestEvents: Array<DataProviderPullRequestEvent>): DataProviderResponse

1
2
const resp = dataProviderResponse.addPullRequestEvents(
  [
    {
      "description": "string",
      "displayName": "string",
      "id": "string",
      "lastUpdated": "string",
      "pullRequestUrl": "string",
      "repoUrl": "string",
      "status": "CREATED",
      "updateSequenceNumber": "string",
      "url": "string"
    }
  ]
)

AddPushEvents

addPushEvents(pushEvents: Array<DataProviderPushEvent>): DataProviderResponse

1
2
const resp = dataProviderResponse.addPushEvents(
  [
    {
      "branchName": "string",
      "description": "string",
      "displayName": "string",
      "id": "string",
      "lastUpdated": "string",
      "updateSequenceNumber": "string",
      "url": "string"
    }
  ]
)

AddVulnerabilityEvents

addVulnerabilityEvents(vulnerabilityEvents: Array<DataProviderVulnerabilityEvent>): DataProviderResponse

1
2
const resp = dataProviderResponse.addVulnerabilityEvents(
  [
    {
      "displayName": "string",
      "id": "string",
      "lastUpdated": "string",
      "severityLevel": "CRITICAL",
      "state": "DECLINED",
      "updateSequenceNumber": "string",
      "url": "string",
      "vulnerabilityStartTime": "string"
    }
  ]
)

Build

build(): DataProviderResult

1
2
const resp = dataProviderResponse.build()

BuildMetrics

buildMetrics(): DataProviderMetricsConfiguration

1
2
const resp = dataProviderResponse.buildMetrics()

Validate

validate(): Void

1
2
const resp = dataProviderResponse.validate()