Documentation

Google_Service_Recommender_Resource_ProjectsLocationsInsightTypesInsights extends Google_Service_Resource
in package

The "insights" collection of methods.

Typical usage is: $recommenderService = new Google_Service_Recommender(...); $insights = $recommenderService->insights;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Recommender_GoogleCloudRecommenderV1Insight
Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. (insights.get)
listProjectsLocationsInsightTypesInsights()  : Google_Service_Recommender_GoogleCloudRecommenderV1ListInsightsResponse
Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.
markAccepted()  : Google_Service_Recommender_GoogleCloudRecommenderV1Insight
Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

get()

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. (insights.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Recommender_GoogleCloudRecommenderV1Insight
Parameters
$name : string

Required. Name of the insight.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Recommender_GoogleCloudRecommenderV1Insight —

listProjectsLocationsInsightTypesInsights()

Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.

public listProjectsLocationsInsightTypesInsights(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Recommender_GoogleCloudRecommenderV1ListInsightsResponse

(insights.listProjectsLocationsInsightTypesInsights)

Parameters
$parent : string

Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOC ATION]/insightTypes/[INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.)

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken Optional. If present, retrieves the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters must be identical to those in the previous call.

opt_param

int pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.

opt_param

string filter Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE"

Return values
Google_Service_Recommender_GoogleCloudRecommenderV1ListInsightsResponse —

markAccepted()

Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight.

public markAccepted(string $name, Google_Service_Recommender_GoogleCloudRecommenderV1MarkInsightAcceptedRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Recommender_GoogleCloudRecommenderV1Insight

This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight. (insights.markAccepted)

Parameters
$name : string

Required. Name of the insight.

$postBody : Google_Service_Recommender_GoogleCloudRecommenderV1MarkInsightAcceptedRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Recommender_GoogleCloudRecommenderV1Insight —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results