Google Cloud Ai Platform V1 Client - Class IndexEndpointServiceClient (0.20.0)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\IndexEndpointServiceClient;
use Google\Cloud\AIPlatform\V1\CreateIndexEndpointRequest;
use Google\Cloud\AIPlatform\V1\IndexEndpoint;
use Google\Rpc\Status;

/**
 * @param string $formattedParent          The resource name of the Location to create the IndexEndpoint in.
 *                                         Format: `projects/{project}/locations/{location}`
 *                                         Please see {@see IndexEndpointServiceClient::locationName()} for help formatting this field.
 * @param string $indexEndpointDisplayName The display name of the IndexEndpoint.
 *                                         The name can be up to 128 characters long and can consist of any UTF-8
 *                                         characters.
 */
function create_index_endpoint_sample(
    string $formattedParent,
    string $indexEndpointDisplayName
): void {
    // Create a client.
    $indexEndpointServiceClient = new IndexEndpointServiceClient();

    // Prepare the request message.
    $indexEndpoint = (new IndexEndpoint())
        ->setDisplayName($indexEndpointDisplayName);
    $request = (new CreateIndexEndpointRequest())
        ->setParent($formattedParent)
        ->setIndexEndpoint($indexEndpoint);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $indexEndpointServiceClient->createIndexEndpoint($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var IndexEndpoint $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = IndexEndpointServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $indexEndpointDisplayName = '[DISPLAY_NAME]';

    create_index_endpoint_sample($formattedParent, $indexEndpointDisplayName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\IndexEndpointServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteIndexEndpointRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the IndexEndpoint resource to be deleted.
 *                              Format:
 *                              `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
 *                              Please see {@see IndexEndpointServiceClient::indexEndpointName()} for help formatting this field.
 */
function delete_index_endpoint_sample(string $formattedName): void
{
    // Create a client.
    $indexEndpointServiceClient = new IndexEndpointServiceClient();

    // Prepare the request message.
    $request = (new DeleteIndexEndpointRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $indexEndpointServiceClient->deleteIndexEndpoint($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = IndexEndpointServiceClient::indexEndpointName(
        '[PROJECT]',
        '[LOCATION]',
        '[INDEX_ENDPOINT]'
    );

    delete_index_endpoint_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\IndexEndpointServiceClient;
use Google\Cloud\AIPlatform\V1\DeployIndexRequest;
use Google\Cloud\AIPlatform\V1\DeployIndexResponse;
use Google\Cloud\AIPlatform\V1\DeployedIndex;
use Google\Rpc\Status;

/**
 * @param string $formattedIndexEndpoint      The name of the IndexEndpoint resource into which to deploy an
 *                                            Index. Format:
 *                                            `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
 *                                            Please see {@see IndexEndpointServiceClient::indexEndpointName()} for help formatting this field.
 * @param string $deployedIndexId             The user specified ID of the DeployedIndex.
 *                                            The ID can be up to 128 characters long and must start with a letter and
 *                                            only contain letters, numbers, and underscores.
 *                                            The ID must be unique within the project it is created in.
 * @param string $formattedDeployedIndexIndex The name of the Index this is the deployment of.
 *                                            We may refer to this Index as the DeployedIndex's "original" Index. Please see
 *                                            {@see IndexEndpointServiceClient::indexName()} for help formatting this field.
 */
function deploy_index_sample(
    string $formattedIndexEndpoint,
    string $deployedIndexId,
    string $formattedDeployedIndexIndex
): void {
    // Create a client.
    $indexEndpointServiceClient = new IndexEndpointServiceClient();

    // Prepare the request message.
    $deployedIndex = (new DeployedIndex())
        ->setId($deployedIndexId)
        ->setIndex($formattedDeployedIndexIndex);
    $request = (new DeployIndexRequest())
        ->setIndexEndpoint($formattedIndexEndpoint)
        ->setDeployedIndex($deployedIndex);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $indexEndpointServiceClient->deployIndex($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var DeployIndexResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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
{
    $formattedIndexEndpoint = IndexEndpointServiceClient::indexEndpointName(
        '[PROJECT]',
        '[LOCATION]',
        '[INDEX_ENDPOINT]'
    );
    $deployedIndexId = '[ID]';
    $formattedDeployedIndexIndex = IndexEndpointServiceClient::indexName(
        '[PROJECT]',
        '[LOCATION]',
        '[INDEX]'
    );

    deploy_index_sample($formattedIndexEndpoint, $deployedIndexId, $formattedDeployedIndexIndex);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\IndexEndpointServiceClient;
use Google\Cloud\AIPlatform\V1\GetIndexEndpointRequest;
use Google\Cloud\AIPlatform\V1\IndexEndpoint;

/**
 * @param string $formattedName The name of the IndexEndpoint resource.
 *                              Format:
 *                              `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
 *                              Please see {@see IndexEndpointServiceClient::indexEndpointName()} for help formatting this field.
 */
function get_index_endpoint_sample(string $formattedName): void
{
    // Create a client.
    $indexEndpointServiceClient = new IndexEndpointServiceClient();

    // Prepare the request message.
    $request = (new GetIndexEndpointRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var IndexEndpoint $response */
        $response = $indexEndpointServiceClient->getIndexEndpoint($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
{
    $formattedName = IndexEndpointServiceClient::indexEndpointName(
        '[PROJECT]',
        '[LOCATION]',
        '[INDEX_ENDPOINT]'
    );

    get_index_endpoint_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\IndexEndpointServiceClient;
use Google\Cloud\AIPlatform\V1\IndexEndpoint;
use Google\Cloud\AIPlatform\V1\ListIndexEndpointsRequest;

/**
 * @param string $formattedParent The resource name of the Location from which to list the
 *                                IndexEndpoints. Format: `projects/{project}/locations/{location}`
 *                                Please see {@see IndexEndpointServiceClient::locationName()} for help formatting this field.
 */
function list_index_endpoints_sample(string $formattedParent): void
{
    // Create a client.
    $indexEndpointServiceClient = new IndexEndpointServiceClient();

    // Prepare the request message.
    $request = (new ListIndexEndpointsRequest())
        ->setParent($formattedParent);

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

        /** @var IndexEndpoint $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 = IndexEndpointServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_index_endpoints_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\IndexEndpointServiceClient;
use Google\Cloud\AIPlatform\V1\DeployedIndex;
use Google\Cloud\AIPlatform\V1\MutateDeployedIndexRequest;
use Google\Cloud\AIPlatform\V1\MutateDeployedIndexResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedIndexEndpoint      The name of the IndexEndpoint resource into which to deploy an
 *                                            Index. Format:
 *                                            `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
 *                                            Please see {@see IndexEndpointServiceClient::indexEndpointName()} for help formatting this field.
 * @param string $deployedIndexId             The user specified ID of the DeployedIndex.
 *                                            The ID can be up to 128 characters long and must start with a letter and
 *                                            only contain letters, numbers, and underscores.
 *                                            The ID must be unique within the project it is created in.
 * @param string $formattedDeployedIndexIndex The name of the Index this is the deployment of.
 *                                            We may refer to this Index as the DeployedIndex's "original" Index. Please see
 *                                            {@see IndexEndpointServiceClient::indexName()} for help formatting this field.
 */
function mutate_deployed_index_sample(
    string $formattedIndexEndpoint,
    string $deployedIndexId,
    string $formattedDeployedIndexIndex
): void {
    // Create a client.
    $indexEndpointServiceClient = new IndexEndpointServiceClient();

    // Prepare the request message.
    $deployedIndex = (new DeployedIndex())
        ->setId($deployedIndexId)
        ->setIndex($formattedDeployedIndexIndex);
    $request = (new MutateDeployedIndexRequest())
        ->setIndexEndpoint($formattedIndexEndpoint)
        ->setDeployedIndex($deployedIndex);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $indexEndpointServiceClient->mutateDeployedIndex($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var MutateDeployedIndexResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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
{
    $formattedIndexEndpoint = IndexEndpointServiceClient::indexEndpointName(
        '[PROJECT]',
        '[LOCATION]',
        '[INDEX_ENDPOINT]'
    );
    $deployedIndexId = '[ID]';
    $formattedDeployedIndexIndex = IndexEndpointServiceClient::indexName(
        '[PROJECT]',
        '[LOCATION]',
        '[INDEX]'
    );

    mutate_deployed_index_sample(
        $formattedIndexEndpoint,
        $deployedIndexId,
        $formattedDeployedIndexIndex
    );
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\IndexEndpointServiceClient;
use Google\Cloud\AIPlatform\V1\UndeployIndexRequest;
use Google\Cloud\AIPlatform\V1\UndeployIndexResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedIndexEndpoint The name of the IndexEndpoint resource from which to undeploy an
 *                                       Index. Format:
 *                                       `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
 *                                       Please see {@see IndexEndpointServiceClient::indexEndpointName()} for help formatting this field.
 * @param string $deployedIndexId        The ID of the DeployedIndex to be undeployed from the
 *                                       IndexEndpoint.
 */
function undeploy_index_sample(string $formattedIndexEndpoint, string $deployedIndexId): void
{
    // Create a client.
    $indexEndpointServiceClient = new IndexEndpointServiceClient();

    // Prepare the request message.
    $request = (new UndeployIndexRequest())
        ->setIndexEndpoint($formattedIndexEndpoint)
        ->setDeployedIndexId($deployedIndexId);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $indexEndpointServiceClient->undeployIndex($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var UndeployIndexResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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
{
    $formattedIndexEndpoint = IndexEndpointServiceClient::indexEndpointName(
        '[PROJECT]',
        '[LOCATION]',
        '[INDEX_ENDPOINT]'
    );
    $deployedIndexId = '[DEPLOYED_INDEX_ID]';

    undeploy_index_sample($formattedIndexEndpoint, $deployedIndexId);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\IndexEndpointServiceClient;
use Google\Cloud\AIPlatform\V1\IndexEndpoint;
use Google\Cloud\AIPlatform\V1\UpdateIndexEndpointRequest;
use Google\Protobuf\FieldMask;

/**
 * @param string $indexEndpointDisplayName The display name of the IndexEndpoint.
 *                                         The name can be up to 128 characters long and can consist of any UTF-8
 *                                         characters.
 */
function update_index_endpoint_sample(string $indexEndpointDisplayName): void
{
    // Create a client.
    $indexEndpointServiceClient = new IndexEndpointServiceClient();

    // Prepare the request message.
    $indexEndpoint = (new IndexEndpoint())
        ->setDisplayName($indexEndpointDisplayName);
    $updateMask = new FieldMask();
    $request = (new UpdateIndexEndpointRequest())
        ->setIndexEndpoint($indexEndpoint)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var IndexEndpoint $response */
        $response = $indexEndpointServiceClient->updateIndexEndpoint($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
{
    $indexEndpointDisplayName = '[DISPLAY_NAME]';

    update_index_endpoint_sample($indexEndpointDisplayName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\IndexEndpointServiceClient;
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.
    $indexEndpointServiceClient = new IndexEndpointServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $indexEndpointServiceClient->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\IndexEndpointServiceClient;
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.
    $indexEndpointServiceClient = new IndexEndpointServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $indexEndpointServiceClient->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\IndexEndpointServiceClient;
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.
    $indexEndpointServiceClient = new IndexEndpointServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $indexEndpointServiceClient->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\IndexEndpointServiceClient;
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.
    $indexEndpointServiceClient = new IndexEndpointServiceClient();

    // 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 = $indexEndpointServiceClient->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\IndexEndpointServiceClient;
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.
    $indexEndpointServiceClient = new IndexEndpointServiceClient();

    // 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 = $indexEndpointServiceClient->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);
}