Google Cloud Ai Platform V1 Client - Class IndexServiceClient (0.21.0)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\IndexServiceClient;
use Google\Cloud\AIPlatform\V1\CreateIndexRequest;
use Google\Cloud\AIPlatform\V1\Index;
use Google\Rpc\Status;

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

    // Prepare the request message.
    $index = (new Index())
        ->setDisplayName($indexDisplayName);
    $request = (new CreateIndexRequest())
        ->setParent($formattedParent)
        ->setIndex($index);

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

        if ($response->operationSucceeded()) {
            /** @var Index $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 = IndexServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $indexDisplayName = '[DISPLAY_NAME]';

    create_index_sample($formattedParent, $indexDisplayName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\IndexServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteIndexRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the Index resource to be deleted.
 *                              Format:
 *                              `projects/{project}/locations/{location}/indexes/{index}`
 *                              Please see {@see IndexServiceClient::indexName()} for help formatting this field.
 */
function delete_index_sample(string $formattedName): void
{
    // Create a client.
    $indexServiceClient = new IndexServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $indexServiceClient->deleteIndex($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 = IndexServiceClient::indexName('[PROJECT]', '[LOCATION]', '[INDEX]');

    delete_index_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\IndexServiceClient;
use Google\Cloud\AIPlatform\V1\GetIndexRequest;
use Google\Cloud\AIPlatform\V1\Index;

/**
 * @param string $formattedName The name of the Index resource.
 *                              Format:
 *                              `projects/{project}/locations/{location}/indexes/{index}`
 *                              Please see {@see IndexServiceClient::indexName()} for help formatting this field.
 */
function get_index_sample(string $formattedName): void
{
    // Create a client.
    $indexServiceClient = new IndexServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Index $response */
        $response = $indexServiceClient->getIndex($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 = IndexServiceClient::indexName('[PROJECT]', '[LOCATION]', '[INDEX]');

    get_index_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\IndexServiceClient;
use Google\Cloud\AIPlatform\V1\Index;
use Google\Cloud\AIPlatform\V1\ListIndexesRequest;

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

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

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

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

    list_indexes_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\IndexServiceClient;
use Google\Cloud\AIPlatform\V1\RemoveDatapointsRequest;
use Google\Cloud\AIPlatform\V1\RemoveDatapointsResponse;

/**
 * @param string $formattedIndex The name of the Index resource to be updated.
 *                               Format:
 *                               `projects/{project}/locations/{location}/indexes/{index}`
 *                               Please see {@see IndexServiceClient::indexName()} for help formatting this field.
 */
function remove_datapoints_sample(string $formattedIndex): void
{
    // Create a client.
    $indexServiceClient = new IndexServiceClient();

    // Prepare the request message.
    $request = (new RemoveDatapointsRequest())
        ->setIndex($formattedIndex);

    // Call the API and handle any network failures.
    try {
        /** @var RemoveDatapointsResponse $response */
        $response = $indexServiceClient->removeDatapoints($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
{
    $formattedIndex = IndexServiceClient::indexName('[PROJECT]', '[LOCATION]', '[INDEX]');

    remove_datapoints_sample($formattedIndex);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\IndexServiceClient;
use Google\Cloud\AIPlatform\V1\Index;
use Google\Cloud\AIPlatform\V1\UpdateIndexRequest;
use Google\Rpc\Status;

/**
 * @param string $indexDisplayName The display name of the Index.
 *                                 The name can be up to 128 characters long and can consist of any UTF-8
 *                                 characters.
 */
function update_index_sample(string $indexDisplayName): void
{
    // Create a client.
    $indexServiceClient = new IndexServiceClient();

    // Prepare the request message.
    $index = (new Index())
        ->setDisplayName($indexDisplayName);
    $request = (new UpdateIndexRequest())
        ->setIndex($index);

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

        if ($response->operationSucceeded()) {
            /** @var Index $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
{
    $indexDisplayName = '[DISPLAY_NAME]';

    update_index_sample($indexDisplayName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\IndexServiceClient;
use Google\Cloud\AIPlatform\V1\UpsertDatapointsRequest;
use Google\Cloud\AIPlatform\V1\UpsertDatapointsResponse;

/**
 * @param string $formattedIndex The name of the Index resource to be updated.
 *                               Format:
 *                               `projects/{project}/locations/{location}/indexes/{index}`
 *                               Please see {@see IndexServiceClient::indexName()} for help formatting this field.
 */
function upsert_datapoints_sample(string $formattedIndex): void
{
    // Create a client.
    $indexServiceClient = new IndexServiceClient();

    // Prepare the request message.
    $request = (new UpsertDatapointsRequest())
        ->setIndex($formattedIndex);

    // Call the API and handle any network failures.
    try {
        /** @var UpsertDatapointsResponse $response */
        $response = $indexServiceClient->upsertDatapoints($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
{
    $formattedIndex = IndexServiceClient::indexName('[PROJECT]', '[LOCATION]', '[INDEX]');

    upsert_datapoints_sample($formattedIndex);
}

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

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

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

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

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

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

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

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

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