Recommender V1 Client - Class RecommenderClient (1.9.1)

use Google\ApiCore\ApiException;
use Google\Cloud\Recommender\V1\Insight;
use Google\Cloud\Recommender\V1\RecommenderClient;

/**
 * @param string $formattedName Name of the insight. Please see
 *                              {@see RecommenderClient::insightName()} for help formatting this field.
 */
function get_insight_sample(string $formattedName): void
{
    // Create a client.
    $recommenderClient = new RecommenderClient();

    // Call the API and handle any network failures.
    try {
        /** @var Insight $response */
        $response = $recommenderClient->getInsight($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecommenderClient::insightName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSIGHT_TYPE]',
        '[INSIGHT]'
    );

    get_insight_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Recommender\V1\InsightTypeConfig;
use Google\Cloud\Recommender\V1\RecommenderClient;

/**
 * @param string $formattedName Name of the InsightTypeConfig to get.
 *
 *                              Acceptable formats:
 *
 *                              * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`
 *
 *                              * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`
 *
 *                              * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`
 *
 *                              * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`
 *                              Please see {@see RecommenderClient::insightTypeConfigName()} for help formatting this field.
 */
function get_insight_type_config_sample(string $formattedName): void
{
    // Create a client.
    $recommenderClient = new RecommenderClient();

    // Call the API and handle any network failures.
    try {
        /** @var InsightTypeConfig $response */
        $response = $recommenderClient->getInsightTypeConfig($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecommenderClient::insightTypeConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSIGHT_TYPE]'
    );

    get_insight_type_config_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Recommender\V1\Recommendation;
use Google\Cloud\Recommender\V1\RecommenderClient;

/**
 * @param string $formattedName Name of the recommendation. Please see
 *                              {@see RecommenderClient::recommendationName()} for help formatting this field.
 */
function get_recommendation_sample(string $formattedName): void
{
    // Create a client.
    $recommenderClient = new RecommenderClient();

    // Call the API and handle any network failures.
    try {
        /** @var Recommendation $response */
        $response = $recommenderClient->getRecommendation($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecommenderClient::recommendationName(
        '[PROJECT]',
        '[LOCATION]',
        '[RECOMMENDER]',
        '[RECOMMENDATION]'
    );

    get_recommendation_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Recommender\V1\RecommenderClient;
use Google\Cloud\Recommender\V1\RecommenderConfig;

/**
 * @param string $formattedName Name of the Recommendation Config to get.
 *
 *                              Acceptable formats:
 *
 *                              * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`
 *
 *                              * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`
 *
 *                              * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`
 *
 *                              * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`
 *                              Please see {@see RecommenderClient::recommenderConfigName()} for help formatting this field.
 */
function get_recommender_config_sample(string $formattedName): void
{
    // Create a client.
    $recommenderClient = new RecommenderClient();

    // Call the API and handle any network failures.
    try {
        /** @var RecommenderConfig $response */
        $response = $recommenderClient->getRecommenderConfig($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecommenderClient::recommenderConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[RECOMMENDER]'
    );

    get_recommender_config_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Recommender\V1\Insight;
use Google\Cloud\Recommender\V1\RecommenderClient;

/**
 * @param string $formattedParent The container resource on which to execute the request.
 *                                Acceptable formats:
 *
 *                                * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
 *
 *                                * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
 *
 *                                * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
 *
 *                                * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
 *
 *                                * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/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. Please see
 *                                {@see RecommenderClient::insightTypeName()} for help formatting this field.
 */
function list_insights_sample(string $formattedParent): void
{
    // Create a client.
    $recommenderClient = new RecommenderClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $recommenderClient->listInsights($formattedParent);

        /** @var Insight $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RecommenderClient::insightTypeName('[PROJECT]', '[LOCATION]', '[INSIGHT_TYPE]');

    list_insights_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Recommender\V1\Recommendation;
use Google\Cloud\Recommender\V1\RecommenderClient;

/**
 * @param string $formattedParent The container resource on which to execute the request.
 *                                Acceptable formats:
 *
 *                                * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
 *
 *                                * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
 *
 *                                * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
 *
 *                                * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
 *
 *                                * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/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. Please see
 *                                {@see RecommenderClient::recommenderName()} for help formatting this field.
 */
function list_recommendations_sample(string $formattedParent): void
{
    // Create a client.
    $recommenderClient = new RecommenderClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $recommenderClient->listRecommendations($formattedParent);

        /** @var Recommendation $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RecommenderClient::recommenderName('[PROJECT]', '[LOCATION]', '[RECOMMENDER]');

    list_recommendations_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Recommender\V1\Insight;
use Google\Cloud\Recommender\V1\RecommenderClient;

/**
 * @param string $formattedName Name of the insight. Please see
 *                              {@see RecommenderClient::insightName()} for help formatting this field.
 * @param string $etag          Fingerprint of the Insight. Provides optimistic locking.
 */
function mark_insight_accepted_sample(string $formattedName, string $etag): void
{
    // Create a client.
    $recommenderClient = new RecommenderClient();

    // Call the API and handle any network failures.
    try {
        /** @var Insight $response */
        $response = $recommenderClient->markInsightAccepted($formattedName, $etag);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecommenderClient::insightName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSIGHT_TYPE]',
        '[INSIGHT]'
    );
    $etag = '[ETAG]';

    mark_insight_accepted_sample($formattedName, $etag);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Recommender\V1\Recommendation;
use Google\Cloud\Recommender\V1\RecommenderClient;

/**
 * @param string $formattedName Name of the recommendation. Please see
 *                              {@see RecommenderClient::recommendationName()} for help formatting this field.
 * @param string $etag          Fingerprint of the Recommendation. Provides optimistic locking.
 */
function mark_recommendation_claimed_sample(string $formattedName, string $etag): void
{
    // Create a client.
    $recommenderClient = new RecommenderClient();

    // Call the API and handle any network failures.
    try {
        /** @var Recommendation $response */
        $response = $recommenderClient->markRecommendationClaimed($formattedName, $etag);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecommenderClient::recommendationName(
        '[PROJECT]',
        '[LOCATION]',
        '[RECOMMENDER]',
        '[RECOMMENDATION]'
    );
    $etag = '[ETAG]';

    mark_recommendation_claimed_sample($formattedName, $etag);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Recommender\V1\Recommendation;
use Google\Cloud\Recommender\V1\RecommenderClient;

/**
 * @param string $formattedName Name of the recommendation. Please see
 *                              {@see RecommenderClient::recommendationName()} for help formatting this field.
 */
function mark_recommendation_dismissed_sample(string $formattedName): void
{
    // Create a client.
    $recommenderClient = new RecommenderClient();

    // Call the API and handle any network failures.
    try {
        /** @var Recommendation $response */
        $response = $recommenderClient->markRecommendationDismissed($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecommenderClient::recommendationName(
        '[PROJECT]',
        '[LOCATION]',
        '[RECOMMENDER]',
        '[RECOMMENDATION]'
    );

    mark_recommendation_dismissed_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Recommender\V1\Recommendation;
use Google\Cloud\Recommender\V1\RecommenderClient;

/**
 * @param string $formattedName Name of the recommendation. Please see
 *                              {@see RecommenderClient::recommendationName()} for help formatting this field.
 * @param string $etag          Fingerprint of the Recommendation. Provides optimistic locking.
 */
function mark_recommendation_failed_sample(string $formattedName, string $etag): void
{
    // Create a client.
    $recommenderClient = new RecommenderClient();

    // Call the API and handle any network failures.
    try {
        /** @var Recommendation $response */
        $response = $recommenderClient->markRecommendationFailed($formattedName, $etag);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecommenderClient::recommendationName(
        '[PROJECT]',
        '[LOCATION]',
        '[RECOMMENDER]',
        '[RECOMMENDATION]'
    );
    $etag = '[ETAG]';

    mark_recommendation_failed_sample($formattedName, $etag);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Recommender\V1\Recommendation;
use Google\Cloud\Recommender\V1\RecommenderClient;

/**
 * @param string $formattedName Name of the recommendation. Please see
 *                              {@see RecommenderClient::recommendationName()} for help formatting this field.
 * @param string $etag          Fingerprint of the Recommendation. Provides optimistic locking.
 */
function mark_recommendation_succeeded_sample(string $formattedName, string $etag): void
{
    // Create a client.
    $recommenderClient = new RecommenderClient();

    // Call the API and handle any network failures.
    try {
        /** @var Recommendation $response */
        $response = $recommenderClient->markRecommendationSucceeded($formattedName, $etag);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecommenderClient::recommendationName(
        '[PROJECT]',
        '[LOCATION]',
        '[RECOMMENDER]',
        '[RECOMMENDATION]'
    );
    $etag = '[ETAG]';

    mark_recommendation_succeeded_sample($formattedName, $etag);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Recommender\V1\InsightTypeConfig;
use Google\Cloud\Recommender\V1\RecommenderClient;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_insight_type_config_sample(): void
{
    // Create a client.
    $recommenderClient = new RecommenderClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $insightTypeConfig = new InsightTypeConfig();

    // Call the API and handle any network failures.
    try {
        /** @var InsightTypeConfig $response */
        $response = $recommenderClient->updateInsightTypeConfig($insightTypeConfig);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

use Google\ApiCore\ApiException;
use Google\Cloud\Recommender\V1\RecommenderClient;
use Google\Cloud\Recommender\V1\RecommenderConfig;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_recommender_config_sample(): void
{
    // Create a client.
    $recommenderClient = new RecommenderClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $recommenderConfig = new RecommenderConfig();

    // Call the API and handle any network failures.
    try {
        /** @var RecommenderConfig $response */
        $response = $recommenderClient->updateRecommenderConfig($recommenderConfig);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}