Insights
extends CloudApiBase
in
implements
CloudApiInterface
Class Insights
Table of Contents
| $client | ClientInterface | |
|---|---|---|
| getAll() | Returns Insight data for all sites associated with the application by its UUID. | InsightsResponse |
| getEnvironment() | Returns Insight data for all sites associated with the environment by its UUID. | InsightsResponse |
| get() | Returns insight data for a particular site. | InsightResponse |
| getAllAlerts() | Returns a list of Insight alerts for this site. | InsightAlertsResponse |
| getAlert() | Returns a specific Insight alert for this site. | InsightAlertResponse |
| ignoreAlert() | Ignores an alert. An ignored alert will be included will not be counted in the Insight score calculation. | OperationResponse |
| restoreAlert() | Restores an alert. A restored alert will be included in the calculation of the Insight score. | OperationResponse |
| revoke() | Revokes an Insight install so it can no longer submit data using the Acquia Connector module. | OperationResponse |
| unrevoke() | Un-revokes an Insight site so it can once again submit data using the Acquia Connector module. | OperationResponse |
| getModules() | Returns a list of Drupal modules for this site. | InsightModulesResponse |
| __construct() | Client constructor. | mixed |
Properties
$client
protected
ClientInterface
$client
Methods
getAll()
Returns Insight data for all sites associated with the application by its UUID.
public
getAll(
$applicationUuid :
string
)
: InsightsResponse
Parameters
- $applicationUuid : string
Return values
InsightsResponsegetEnvironment()
Returns Insight data for all sites associated with the environment by its UUID.
public
getEnvironment(
$environmentUuid :
string
)
: InsightsResponse
Parameters
- $environmentUuid : string
Return values
InsightsResponseget()
Returns insight data for a particular site.
public
get(
$siteId :
string
)
: InsightResponse
Parameters
- $siteId : string
Return values
InsightResponsegetAllAlerts()
Returns a list of Insight alerts for this site.
public
getAllAlerts(
$siteId :
string
)
: InsightAlertsResponse
Parameters
- $siteId : string
Return values
InsightAlertsResponsegetAlert()
Returns a specific Insight alert for this site.
public
getAlert(
$siteId :
string
, $alertUuid :
string
)
: InsightAlertResponse
Parameters
- $siteId : string
- $alertUuid : string
Return values
InsightAlertResponseignoreAlert()
Ignores an alert. An ignored alert will be included will not be counted in the Insight score calculation.
public
ignoreAlert(
$siteId :
string
, $alertUuid :
string
)
: OperationResponse
Parameters
- $siteId : string
- $alertUuid : string
Return values
OperationResponserestoreAlert()
Restores an alert. A restored alert will be included in the calculation of the Insight score.
public
restoreAlert(
$siteId :
string
, $alertUuid :
string
)
: OperationResponse
Parameters
- $siteId : string
- $alertUuid : string
Return values
OperationResponserevoke()
Revokes an Insight install so it can no longer submit data using the Acquia Connector module.
public
revoke(
$siteId :
string
)
: OperationResponse
Parameters
- $siteId : string
Return values
OperationResponseunrevoke()
Un-revokes an Insight site so it can once again submit data using the Acquia Connector module.
public
unrevoke(
$siteId :
string
)
: OperationResponse
Note that the site must also be unblocked using the Acquia Connector module.
Parameters
- $siteId : string
Return values
OperationResponsegetModules()
Returns a list of Drupal modules for this site.
public
getModules(
$siteId :
string
)
: InsightModulesResponse
Parameters
- $siteId : string
Return values
InsightModulesResponse__construct()
Client constructor.
public
__construct(
$client :
ClientInterface
)
: mixed
Parameters
- $client : ClientInterface