- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class IndexEndpointServiceClient.
Service Description: A service for managing Vertex AI's IndexEndpoints.
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:
$indexEndpointServiceClient = new IndexEndpointServiceClient();
try {
$formattedParent = $indexEndpointServiceClient->locationName('[PROJECT]', '[LOCATION]');
$indexEndpoint = new IndexEndpoint();
$operationResponse = $indexEndpointServiceClient->createIndexEndpoint($formattedParent, $indexEndpoint);
$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 = $indexEndpointServiceClient->createIndexEndpoint($formattedParent, $indexEndpoint);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $indexEndpointServiceClient->resumeOperation($operationName, 'createIndexEndpoint');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$indexEndpointServiceClient->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.
Methods
indexName
Formats a string containing the fully-qualified path to represent a index resource.
project
string
location
string
index
string
string
indexEndpointName
Formats a string containing the fully-qualified path to represent a index_endpoint resource.
project
string
location
string
indexEndpoint
string
string
locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
__construct
Constructor.
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 {@see} object or {@see} 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 {@see} .
↳ 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 {@see} 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 {@see} and {@see} 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.
createIndexEndpoint
Creates an IndexEndpoint.
Sample code:
$indexEndpointServiceClient = new IndexEndpointServiceClient();
try {
$formattedParent = $indexEndpointServiceClient->locationName('[PROJECT]', '[LOCATION]');
$indexEndpoint = new IndexEndpoint();
$operationResponse = $indexEndpointServiceClient->createIndexEndpoint($formattedParent, $indexEndpoint);
$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 = $indexEndpointServiceClient->createIndexEndpoint($formattedParent, $indexEndpoint);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $indexEndpointServiceClient->resumeOperation($operationName, 'createIndexEndpoint');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$indexEndpointServiceClient->close();
}
parent
string
Required. The resource name of the Location to create the IndexEndpoint in. Format: projects/{project}/locations/{location}
indexEndpoint
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
deleteIndexEndpoint
Deletes an IndexEndpoint.
Sample code:
$indexEndpointServiceClient = new IndexEndpointServiceClient();
try {
$formattedName = $indexEndpointServiceClient->indexEndpointName('[PROJECT]', '[LOCATION]', '[INDEX_ENDPOINT]');
$operationResponse = $indexEndpointServiceClient->deleteIndexEndpoint($formattedName);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $indexEndpointServiceClient->deleteIndexEndpoint($formattedName);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $indexEndpointServiceClient->resumeOperation($operationName, 'deleteIndexEndpoint');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$indexEndpointServiceClient->close();
}
name
string
Required. The name of the IndexEndpoint resource to be deleted. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
deployIndex
Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
Only non-empty Indexes can be deployed.
Sample code:
$indexEndpointServiceClient = new IndexEndpointServiceClient();
try {
$formattedIndexEndpoint = $indexEndpointServiceClient->indexEndpointName('[PROJECT]', '[LOCATION]', '[INDEX_ENDPOINT]');
$deployedIndex = new DeployedIndex();
$operationResponse = $indexEndpointServiceClient->deployIndex($formattedIndexEndpoint, $deployedIndex);
$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 = $indexEndpointServiceClient->deployIndex($formattedIndexEndpoint, $deployedIndex);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $indexEndpointServiceClient->resumeOperation($operationName, 'deployIndex');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$indexEndpointServiceClient->close();
}
indexEndpoint
string
Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndex
Google\Cloud\AIPlatform\V1\DeployedIndex
Required. The DeployedIndex to be created within the IndexEndpoint.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
getIndexEndpoint
Gets an IndexEndpoint.
Sample code:
$indexEndpointServiceClient = new IndexEndpointServiceClient();
try {
$formattedName = $indexEndpointServiceClient->indexEndpointName('[PROJECT]', '[LOCATION]', '[INDEX_ENDPOINT]');
$response = $indexEndpointServiceClient->getIndexEndpoint($formattedName);
} finally {
$indexEndpointServiceClient->close();
}
name
string
Required. The name of the IndexEndpoint resource. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
listIndexEndpoints
Lists IndexEndpoints in a Location.
Sample code:
$indexEndpointServiceClient = new IndexEndpointServiceClient();
try {
$formattedParent = $indexEndpointServiceClient->locationName('[PROJECT]', '[LOCATION]');
// Iterate over pages of elements
$pagedResponse = $indexEndpointServiceClient->listIndexEndpoints($formattedParent);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $indexEndpointServiceClient->listIndexEndpoints($formattedParent);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$indexEndpointServiceClient->close();
}
parent
string
Required. The resource name of the Location from which to list the IndexEndpoints. Format: projects/{project}/locations/{location}
optionalArgs
array
Optional.
↳ filter
string
Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * index_endpoint
supports = and !=. index_endpoint
represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename
. * display_name
supports =, != and regex() (uses re2
syntax) * labels
supports general map functions that is: labels.key=value
- key:value equality labels.key:* or labels:key - key existence A key including a space must be quoted.
labels."a key" . Some examples: *
index_endpoint="1" *
display_name="myDisplayName" *
regex(display_name, "^A") -> The display name starts with an A. * labels.myKey="myValue"
↳ 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
Optional. Mask specifying which fields to read.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
mutateDeployedIndex
Update an existing DeployedIndex under an IndexEndpoint.
Sample code:
$indexEndpointServiceClient = new IndexEndpointServiceClient();
try {
$formattedIndexEndpoint = $indexEndpointServiceClient->indexEndpointName('[PROJECT]', '[LOCATION]', '[INDEX_ENDPOINT]');
$deployedIndex = new DeployedIndex();
$operationResponse = $indexEndpointServiceClient->mutateDeployedIndex($formattedIndexEndpoint, $deployedIndex);
$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 = $indexEndpointServiceClient->mutateDeployedIndex($formattedIndexEndpoint, $deployedIndex);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $indexEndpointServiceClient->resumeOperation($operationName, 'mutateDeployedIndex');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$indexEndpointServiceClient->close();
}
indexEndpoint
string
Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndex
Google\Cloud\AIPlatform\V1\DeployedIndex
Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are DeployedIndex and DeployedIndex
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
undeployIndex
Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
Sample code:
$indexEndpointServiceClient = new IndexEndpointServiceClient();
try {
$formattedIndexEndpoint = $indexEndpointServiceClient->indexEndpointName('[PROJECT]', '[LOCATION]', '[INDEX_ENDPOINT]');
$deployedIndexId = 'deployed_index_id';
$operationResponse = $indexEndpointServiceClient->undeployIndex($formattedIndexEndpoint, $deployedIndexId);
$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 = $indexEndpointServiceClient->undeployIndex($formattedIndexEndpoint, $deployedIndexId);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $indexEndpointServiceClient->resumeOperation($operationName, 'undeployIndex');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$indexEndpointServiceClient->close();
}
indexEndpoint
string
Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndexId
string
Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
updateIndexEndpoint
Updates an IndexEndpoint.
Sample code:
$indexEndpointServiceClient = new IndexEndpointServiceClient();
try {
$indexEndpoint = new IndexEndpoint();
$updateMask = new FieldMask();
$response = $indexEndpointServiceClient->updateIndexEndpoint($indexEndpoint, $updateMask);
} finally {
$indexEndpointServiceClient->close();
}
indexEndpoint
Google\Cloud\AIPlatform\V1\IndexEndpoint
Required. The IndexEndpoint which replaces the resource on the server.
updateMask
Google\Protobuf\FieldMask
Required. The update mask applies to the resource. See google.protobuf.FieldMask.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
getLocation
Gets information about a location.
Sample code:
$indexEndpointServiceClient = new IndexEndpointServiceClient();
try {
$response = $indexEndpointServiceClient->getLocation();
} finally {
$indexEndpointServiceClient->close();
}
optionalArgs
array
Optional.
↳ name
string
Resource name for the location.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
listLocations
Lists information about the supported locations for this service.
Sample code:
$indexEndpointServiceClient = new IndexEndpointServiceClient();
try {
// Iterate over pages of elements
$pagedResponse = $indexEndpointServiceClient->listLocations();
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $indexEndpointServiceClient->listLocations();
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$indexEndpointServiceClient->close();
}
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 {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Sample code:
$indexEndpointServiceClient = new IndexEndpointServiceClient();
try {
$resource = 'resource';
$response = $indexEndpointServiceClient->getIamPolicy($resource);
} finally {
$indexEndpointServiceClient->close();
}
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 {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Sample code:
$indexEndpointServiceClient = new IndexEndpointServiceClient();
try {
$resource = 'resource';
$policy = new Policy();
$response = $indexEndpointServiceClient->setIamPolicy($resource, $policy);
} finally {
$indexEndpointServiceClient->close();
}
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 {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
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.
Sample code:
$indexEndpointServiceClient = new IndexEndpointServiceClient();
try {
$resource = 'resource';
$permissions = [];
$response = $indexEndpointServiceClient->testIamPermissions($resource, $permissions);
} finally {
$indexEndpointServiceClient->close();
}
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 {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
Constants
SERVICE_NAME
Value: 'google.cloud.aiplatform.v1.IndexEndpointService'
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.
