Method: integrations.fetchAffectedItems

Full name: projects.locations.instances.integrations.fetchAffectedItems

Get items that can be affected due to a change in the integration (for example, removal of the integration). Affected items can be instances of the integration, Job instances and Playbooks.

HTTP request


Path parameters

Parameters
name

string

Required. The unique name of the integration. Format: projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}

Request body

The request body must be empty.

Response body

Response message for Geting items that can be affected due to a change in the integration (ex: integration removal). Affected items can be instances of the integration, Job instances and Playbooks.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "affectedIntegrationInstances": [
    {
      object (AffectedIntegrationInstance)
    }
  ],
  "affectedJobsInstances": [
    {
      object (AffectedJobInstance)
    }
  ],
  "affectedPlaybooks": [
    {
      object (AffectedPlaybook)
    }
  ]
}
Fields
affectedIntegrationInstances[]

object (AffectedIntegrationInstance)

Output only. List of affected Integration instances.
affectedJobsInstances[]

object (AffectedJobInstance)

Output only. List of affected Job instances.
affectedPlaybooks[]

object (AffectedPlaybook)

Output only. List of affected Playbooks.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

AffectedIntegrationInstance

Affected Integration instance.

JSON representation 
{
  "displayName": string,
  "environment": string
}
Fields
displayName

string

Output only. Integration instance display name.
environment

string

Output only. Integration instance environment.

AffectedJobInstance

Affected Job instance.

JSON representation 
{
  "displayName": string,
  "legacy": boolean
}
Fields
displayName

string

Output only. Job instance display name.
legacy

boolean

Output only. True if the Job instance is considered as legacy. Legacy jobs cannot be automatically updated.

AffectedPlaybook

Affected Playbook.

JSON representation 
{
  "displayName": string,
  "environments": [
    string
  ]
}
Fields
displayName

string

Output only. Playbook display name.
environments[]

string

Output only. Playbook's environments.