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

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class IndexServiceClient.

Service Description: A service for creating and managing Vertex AI's Index resources.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$indexServiceClient = new IndexServiceClient();
try {
    $formattedParent = $indexServiceClient->locationName('[PROJECT]', '[LOCATION]');
    $index = new Index();
    $operationResponse = $indexServiceClient->createIndex($formattedParent, $index);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $indexServiceClient->createIndex($formattedParent, $index);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $indexServiceClient->resumeOperation($operationName, 'createIndex');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $indexServiceClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This service has a new (beta) implementation. See Google\Cloud\AIPlatform\V1\Client\IndexServiceClient to use the new surface.

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
options array

Optional. Options for configuring the service API wrapper.

↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "

↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.

↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .

↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.

↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.

↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.

↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createIndex

Creates an Index.

Parameters
NameDescription
parent string

Required. The resource name of the Location to create the Index in. Format: projects/{project}/locations/{location}

index Google\Cloud\AIPlatform\V1\Index

Required. The Index to create.

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse
Example 
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);
}

deleteIndex

Deletes an Index.

An Index can only be deleted when all its DeployedIndexes had been undeployed.

Parameters
NameDescription
name string

Required. The name of the Index resource to be deleted. Format: projects/{project}/locations/{location}/indexes/{index}

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse
Example 
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);
}

getIndex

Gets an Index.

Parameters
NameDescription
name string

Required. The name of the Index resource. Format: projects/{project}/locations/{location}/indexes/{index}

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\Index
Example 
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);
}

listIndexes

Lists Indexes in a Location.

Parameters
NameDescription
parent string

Required. The resource name of the Location from which to list the Indexes. Format: projects/{project}/locations/{location}

optionalArgs array

Optional.

↳ filter string

The standard list filter.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ readMask FieldMask

Mask specifying which fields to read.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\PagedListResponse
Example 
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);
}

removeDatapoints

Remove Datapoints from an Index.

Parameters
NameDescription
index string

Required. The name of the Index resource to be updated. Format: projects/{project}/locations/{location}/indexes/{index}

optionalArgs array

Optional.

↳ datapointIds string[]

A list of datapoint ids to be deleted.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\RemoveDatapointsResponse
Example 
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);
}

updateIndex

Updates an Index.

Parameters
NameDescription
index Google\Cloud\AIPlatform\V1\Index

Required. The Index which updates the resource on the server.

optionalArgs array

Optional.

↳ updateMask FieldMask

The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse
Example 
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);
}

upsertDatapoints

Add/update Datapoints into an Index.

Parameters
NameDescription
index string

Required. The name of the Index resource to be updated. Format: projects/{project}/locations/{location}/indexes/{index}

optionalArgs array

Optional.

↳ datapoints IndexDatapoint[]

A list of datapoints to be created/updated.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\UpsertDatapointsResponse
Example 
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);
}

getLocation

Gets information about a location.

Parameters
NameDescription
optionalArgs array

Optional.

↳ name string

Resource name for the location.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Location\Location
Example 
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());
    }
}

listLocations

Lists information about the supported locations for this service.

Parameters
NameDescription
optionalArgs array

Optional.

↳ name string

The resource that owns the locations collection, if applicable.

↳ filter string

The standard list filter.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\PagedListResponse
Example 
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());
    }
}

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
NameDescription
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

optionalArgs array

Optional.

↳ options GetPolicyOptions

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iam\V1\Policy
Example 
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);
}

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
NameDescription
resource string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policy Google\Cloud\Iam\V1\Policy

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

optionalArgs array

Optional.

↳ updateMask FieldMask

OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag"

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iam\V1\Policy
Example 
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);
}

testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
NameDescription
resource string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissions string[]

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.

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iam\V1\TestIamPermissionsResponse
Example 
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);
}

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
TypeDescription
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
NameDescription
operationName string

The name of the long running operation

methodName string

The name of the method used to start the operation

Returns
TypeDescription
Google\ApiCore\OperationResponse

static::indexName

Formats a string containing the fully-qualified path to represent a index resource.

Parameters
NameDescription
project string
location string
index string
Returns
TypeDescription
stringThe formatted index resource.

static::indexEndpointName

Formats a string containing the fully-qualified path to represent a index_endpoint resource.

Parameters
NameDescription
project string
location string
indexEndpoint string
Returns
TypeDescription
stringThe formatted index_endpoint resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
stringThe formatted location resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • index: projects/{project}/locations/{location}/indexes/{index}
  • indexEndpoint: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
  • location: projects/{project}/locations/{location}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
NameDescription
formattedName string

The formatted name string

template string

Optional name of template to match

Returns
TypeDescription
arrayAn associative array from name component IDs to component values.

Constants

SERVICE_NAME

Value: 'google.cloud.aiplatform.v1.IndexService'

The name of the service.

SERVICE_ADDRESS

Value: 'aiplatform.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.