Google Cloud Ai Platform V1 Client - Class FeaturestoreOnlineServingServiceClient (0.31.0)

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreOnlineServingServiceClient;
use Google\Cloud\AIPlatform\V1\FeatureSelector;
use Google\Cloud\AIPlatform\V1\IdMatcher;
use Google\Cloud\AIPlatform\V1\ReadFeatureValuesRequest;
use Google\Cloud\AIPlatform\V1\ReadFeatureValuesResponse;

/**
 * @param string $formattedEntityType                The resource name of the EntityType for the entity being read.
 *                                                   Value format:
 *                                                   `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
 *                                                   For example, for a machine learning model predicting user clicks on a
 *                                                   website, an EntityType ID could be `user`. Please see
 *                                                   {@see FeaturestoreOnlineServingServiceClient::entityTypeName()} for help formatting this field.
 * @param string $entityId                           ID for a specific entity. For example,
 *                                                   for a machine learning model predicting user clicks on a website, an entity
 *                                                   ID could be `user_123`.
 * @param string $featureSelectorIdMatcherIdsElement The following are accepted as `ids`:
 *
 *                                                   * A single-element list containing only `*`, which selects all Features
 *                                                   in the target EntityType, or
 *                                                   * A list containing only Feature IDs, which selects only Features with
 *                                                   those IDs in the target EntityType.
 */
function read_feature_values_sample(
    string $formattedEntityType,
    string $entityId,
    string $featureSelectorIdMatcherIdsElement
): void {
    // Create a client.
    $featurestoreOnlineServingServiceClient = new FeaturestoreOnlineServingServiceClient();

    // Prepare the request message.
    $featureSelectorIdMatcherIds = [$featureSelectorIdMatcherIdsElement,];
    $featureSelectorIdMatcher = (new IdMatcher())
        ->setIds($featureSelectorIdMatcherIds);
    $featureSelector = (new FeatureSelector())
        ->setIdMatcher($featureSelectorIdMatcher);
    $request = (new ReadFeatureValuesRequest())
        ->setEntityType($formattedEntityType)
        ->setEntityId($entityId)
        ->setFeatureSelector($featureSelector);

    // Call the API and handle any network failures.
    try {
        /** @var ReadFeatureValuesResponse $response */
        $response = $featurestoreOnlineServingServiceClient->readFeatureValues($request);
        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
{
    $formattedEntityType = FeaturestoreOnlineServingServiceClient::entityTypeName(
        '[PROJECT]',
        '[LOCATION]',
        '[FEATURESTORE]',
        '[ENTITY_TYPE]'
    );
    $entityId = '[ENTITY_ID]';
    $featureSelectorIdMatcherIdsElement = '[IDS]';

    read_feature_values_sample($formattedEntityType, $entityId, $featureSelectorIdMatcherIdsElement);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\ServerStream;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreOnlineServingServiceClient;
use Google\Cloud\AIPlatform\V1\FeatureSelector;
use Google\Cloud\AIPlatform\V1\IdMatcher;
use Google\Cloud\AIPlatform\V1\ReadFeatureValuesResponse;
use Google\Cloud\AIPlatform\V1\StreamingReadFeatureValuesRequest;

/**
 * @param string $formattedEntityType                The resource name of the entities' type.
 *                                                   Value format:
 *                                                   `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
 *                                                   For example,
 *                                                   for a machine learning model predicting user clicks on a website, an
 *                                                   EntityType ID could be `user`. Please see
 *                                                   {@see FeaturestoreOnlineServingServiceClient::entityTypeName()} for help formatting this field.
 * @param string $entityIdsElement                   IDs of entities to read Feature values of. The maximum number of
 *                                                   IDs is 100. For example, for a machine learning model predicting user
 *                                                   clicks on a website, an entity ID could be `user_123`.
 * @param string $featureSelectorIdMatcherIdsElement The following are accepted as `ids`:
 *
 *                                                   * A single-element list containing only `*`, which selects all Features
 *                                                   in the target EntityType, or
 *                                                   * A list containing only Feature IDs, which selects only Features with
 *                                                   those IDs in the target EntityType.
 */
function streaming_read_feature_values_sample(
    string $formattedEntityType,
    string $entityIdsElement,
    string $featureSelectorIdMatcherIdsElement
): void {
    // Create a client.
    $featurestoreOnlineServingServiceClient = new FeaturestoreOnlineServingServiceClient();

    // Prepare the request message.
    $entityIds = [$entityIdsElement,];
    $featureSelectorIdMatcherIds = [$featureSelectorIdMatcherIdsElement,];
    $featureSelectorIdMatcher = (new IdMatcher())
        ->setIds($featureSelectorIdMatcherIds);
    $featureSelector = (new FeatureSelector())
        ->setIdMatcher($featureSelectorIdMatcher);
    $request = (new StreamingReadFeatureValuesRequest())
        ->setEntityType($formattedEntityType)
        ->setEntityIds($entityIds)
        ->setFeatureSelector($featureSelector);

    // Call the API and handle any network failures.
    try {
        /** @var ServerStream $stream */
        $stream = $featurestoreOnlineServingServiceClient->streamingReadFeatureValues($request);

        /** @var ReadFeatureValuesResponse $element */
        foreach ($stream->readAll() 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
{
    $formattedEntityType = FeaturestoreOnlineServingServiceClient::entityTypeName(
        '[PROJECT]',
        '[LOCATION]',
        '[FEATURESTORE]',
        '[ENTITY_TYPE]'
    );
    $entityIdsElement = '[ENTITY_IDS]';
    $featureSelectorIdMatcherIdsElement = '[IDS]';

    streaming_read_feature_values_sample(
        $formattedEntityType,
        $entityIdsElement,
        $featureSelectorIdMatcherIdsElement
    );
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreOnlineServingServiceClient;
use Google\Cloud\AIPlatform\V1\WriteFeatureValuesPayload;
use Google\Cloud\AIPlatform\V1\WriteFeatureValuesRequest;
use Google\Cloud\AIPlatform\V1\WriteFeatureValuesResponse;

/**
 * @param string $formattedEntityType The resource name of the EntityType for the entities being
 *                                    written. Value format:
 *                                    `projects/{project}/locations/{location}/featurestores/
 *                                    {featurestore}/entityTypes/{entityType}`. For example,
 *                                    for a machine learning model predicting user clicks on a website, an
 *                                    EntityType ID could be `user`. Please see
 *                                    {@see FeaturestoreOnlineServingServiceClient::entityTypeName()} for help formatting this field.
 * @param string $payloadsEntityId    The ID of the entity.
 */
function write_feature_values_sample(string $formattedEntityType, string $payloadsEntityId): void
{
    // Create a client.
    $featurestoreOnlineServingServiceClient = new FeaturestoreOnlineServingServiceClient();

    // Prepare the request message.
    $payloadsFeatureValues = [];
    $writeFeatureValuesPayload = (new WriteFeatureValuesPayload())
        ->setEntityId($payloadsEntityId)
        ->setFeatureValues($payloadsFeatureValues);
    $payloads = [$writeFeatureValuesPayload,];
    $request = (new WriteFeatureValuesRequest())
        ->setEntityType($formattedEntityType)
        ->setPayloads($payloads);

    // Call the API and handle any network failures.
    try {
        /** @var WriteFeatureValuesResponse $response */
        $response = $featurestoreOnlineServingServiceClient->writeFeatureValues($request);
        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
{
    $formattedEntityType = FeaturestoreOnlineServingServiceClient::entityTypeName(
        '[PROJECT]',
        '[LOCATION]',
        '[FEATURESTORE]',
        '[ENTITY_TYPE]'
    );
    $payloadsEntityId = '[ENTITY_ID]';

    write_feature_values_sample($formattedEntityType, $payloadsEntityId);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreOnlineServingServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

/**
 * 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 get_location_sample(): void
{
    // Create a client.
    $featurestoreOnlineServingServiceClient = new FeaturestoreOnlineServingServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $featurestoreOnlineServingServiceClient->getLocation($request);
        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\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreOnlineServingServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

/**
 * 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 list_locations_sample(): void
{
    // Create a client.
    $featurestoreOnlineServingServiceClient = new FeaturestoreOnlineServingServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

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

        /** @var Location $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());
    }
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreOnlineServingServiceClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $featurestoreOnlineServingServiceClient = new FeaturestoreOnlineServingServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $featurestoreOnlineServingServiceClient->getIamPolicy($request);
        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
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreOnlineServingServiceClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $featurestoreOnlineServingServiceClient = new FeaturestoreOnlineServingServiceClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new SetIamPolicyRequest())
        ->setResource($resource)
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $featurestoreOnlineServingServiceClient->setIamPolicy($request);
        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
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreOnlineServingServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $featurestoreOnlineServingServiceClient = new FeaturestoreOnlineServingServiceClient();

    // Prepare the request message.
    $permissions = [$permissionsElement,];
    $request = (new TestIamPermissionsRequest())
        ->setResource($resource)
        ->setPermissions($permissions);

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $featurestoreOnlineServingServiceClient->testIamPermissions($request);
        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
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}