Documentation

Google_Service_Recommender_Resource_ProjectsLocationsRecommendersRecommendations extends Google_Service_Resource
in package

The "recommendations" collection of methods.

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

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_GoogleCloudRecommenderV1Recommendation
Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender. (recommendations.get)
listProjectsLocationsRecommendersRecommendations()  : Google_Service_Recommender_GoogleCloudRecommenderV1ListRecommendationsResponse
Lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender.
markClaimed()  : Google_Service_Recommender_GoogleCloudRecommenderV1Recommendation
Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state.
markFailed()  : Google_Service_Recommender_GoogleCloudRecommenderV1Recommendation
Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. (recommendations.markFailed)
markSucceeded()  : Google_Service_Recommender_GoogleCloudRecommenderV1Recommendation
Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.
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 recommendation. Requires the recommender.*.get IAM permission for the specified recommender. (recommendations.get)

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

Required. Name of the recommendation.

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

Optional parameters.

Return values
Google_Service_Recommender_GoogleCloudRecommenderV1Recommendation —

listProjectsLocationsRecommendersRecommendations()

Lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender.

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

(recommendations.listProjectsLocationsRecommendersRecommendations)

Parameters
$parent : string

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

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

Optional parameters.

Tags
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 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

string filter Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"

Return values
Google_Service_Recommender_GoogleCloudRecommenderV1ListRecommendationsResponse —

markClaimed()

Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state.

public markClaimed(string $name, Google_Service_Recommender_GoogleCloudRecommenderV1MarkRecommendationClaimedRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Recommender_GoogleCloudRecommenderV1Recommendation

MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. (recommendations.markClaimed)

Parameters
$name : string

Required. Name of the recommendation.

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

Optional parameters.

Return values
Google_Service_Recommender_GoogleCloudRecommenderV1Recommendation —

markFailed()

Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. (recommendations.markFailed)

public markFailed(string $name, Google_Service_Recommender_GoogleCloudRecommenderV1MarkRecommendationFailedRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Recommender_GoogleCloudRecommenderV1Recommendation
Parameters
$name : string

Required. Name of the recommendation.

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

Optional parameters.

Return values
Google_Service_Recommender_GoogleCloudRecommenderV1Recommendation —

markSucceeded()

Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.

public markSucceeded(string $name, Google_Service_Recommender_GoogleCloudRecommenderV1MarkRecommendationSucceededRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Recommender_GoogleCloudRecommenderV1Recommendation

(recommendations.markSucceeded)

Parameters
$name : string

Required. Name of the recommendation.

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

Optional parameters.

Return values
Google_Service_Recommender_GoogleCloudRecommenderV1Recommendation —

convertToArrayAndStripNulls()

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

Search results