Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class FeaturestoreServiceClient.
Service Description: The service that handles CRUD and List for resources for Featurestore.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
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.
Namespace
Google \ Cloud \ AIPlatform \ V1 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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 |
↳ 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. |
batchCreateFeatures
Creates a batch of Features in a given EntityType.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::batchCreateFeaturesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\BatchCreateFeaturesRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\BatchCreateFeaturesRequest;
use Google\Cloud\AIPlatform\V1\BatchCreateFeaturesResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\CreateFeatureRequest;
use Google\Cloud\AIPlatform\V1\Feature;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource name of the EntityType/FeatureGroup to create the
* batch of Features under. Format:
* `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
* `projects/{project}/locations/{location}/featureGroups/{feature_group}`
* Please see {@see FeaturestoreServiceClient::entityTypeName()} for help formatting this field.
* @param string $formattedRequestsParent The resource name of the EntityType or FeatureGroup to create a
* Feature. Format for entity_type as parent:
* `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
* Format for feature_group as parent:
* `projects/{project}/locations/{location}/featureGroups/{feature_group}`
* Please see {@see FeaturestoreServiceClient::entityTypeName()} for help formatting this field.
* @param string $requestsFeatureId The ID to use for the Feature, which will become the final
* component of the Feature's resource name.
*
* This value may be up to 128 characters, and valid characters are
* `[a-z0-9_]`. The first character cannot be a number.
*
* The value must be unique within an EntityType/FeatureGroup.
*/
function batch_create_features_sample(
string $formattedParent,
string $formattedRequestsParent,
string $requestsFeatureId
): void {
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$requestsFeature = new Feature();
$createFeatureRequest = (new CreateFeatureRequest())
->setParent($formattedRequestsParent)
->setFeature($requestsFeature)
->setFeatureId($requestsFeatureId);
$requests = [$createFeatureRequest,];
$request = (new BatchCreateFeaturesRequest())
->setParent($formattedParent)
->setRequests($requests);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $featurestoreServiceClient->batchCreateFeatures($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var BatchCreateFeaturesResponse $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 = FeaturestoreServiceClient::entityTypeName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]',
'[ENTITY_TYPE]'
);
$formattedRequestsParent = FeaturestoreServiceClient::entityTypeName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]',
'[ENTITY_TYPE]'
);
$requestsFeatureId = '[FEATURE_ID]';
batch_create_features_sample($formattedParent, $formattedRequestsParent, $requestsFeatureId);
}
batchReadFeatureValues
Batch reads Feature values from a Featurestore.
This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::batchReadFeatureValuesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\BatchReadFeatureValuesRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\BatchReadFeatureValuesRequest;
use Google\Cloud\AIPlatform\V1\BatchReadFeatureValuesRequest\EntityTypeSpec;
use Google\Cloud\AIPlatform\V1\BatchReadFeatureValuesResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\FeatureSelector;
use Google\Cloud\AIPlatform\V1\FeatureValueDestination;
use Google\Cloud\AIPlatform\V1\IdMatcher;
use Google\Rpc\Status;
/**
* @param string $formattedFeaturestore The resource name of the Featurestore from which to query Feature
* values. Format:
* `projects/{project}/locations/{location}/featurestores/{featurestore}`
* Please see {@see FeaturestoreServiceClient::featurestoreName()} for help formatting this field.
* @param string $entityTypeSpecsEntityTypeId ID of the EntityType to select Features. The EntityType id is
* the
* [entity_type_id][google.cloud.aiplatform.v1.CreateEntityTypeRequest.entity_type_id]
* specified during EntityType creation.
* @param string $entityTypeSpecsFeatureSelectorIdMatcherIdsElement The following are accepted as `ids`:
*
* * A single-element list containing only `*`, which selects all Features
* in the target EntityType, or
* * A list containing only Feature IDs, which selects only Features with
* those IDs in the target EntityType.
*/
function batch_read_feature_values_sample(
string $formattedFeaturestore,
string $entityTypeSpecsEntityTypeId,
string $entityTypeSpecsFeatureSelectorIdMatcherIdsElement
): void {
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$destination = new FeatureValueDestination();
$entityTypeSpecsFeatureSelectorIdMatcherIds = [
$entityTypeSpecsFeatureSelectorIdMatcherIdsElement,
];
$entityTypeSpecsFeatureSelectorIdMatcher = (new IdMatcher())
->setIds($entityTypeSpecsFeatureSelectorIdMatcherIds);
$entityTypeSpecsFeatureSelector = (new FeatureSelector())
->setIdMatcher($entityTypeSpecsFeatureSelectorIdMatcher);
$entityTypeSpec = (new EntityTypeSpec())
->setEntityTypeId($entityTypeSpecsEntityTypeId)
->setFeatureSelector($entityTypeSpecsFeatureSelector);
$entityTypeSpecs = [$entityTypeSpec,];
$request = (new BatchReadFeatureValuesRequest())
->setFeaturestore($formattedFeaturestore)
->setDestination($destination)
->setEntityTypeSpecs($entityTypeSpecs);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $featurestoreServiceClient->batchReadFeatureValues($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var BatchReadFeatureValuesResponse $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
{
$formattedFeaturestore = FeaturestoreServiceClient::featurestoreName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]'
);
$entityTypeSpecsEntityTypeId = '[ENTITY_TYPE_ID]';
$entityTypeSpecsFeatureSelectorIdMatcherIdsElement = '[IDS]';
batch_read_feature_values_sample(
$formattedFeaturestore,
$entityTypeSpecsEntityTypeId,
$entityTypeSpecsFeatureSelectorIdMatcherIdsElement
);
}
createEntityType
Creates a new EntityType in a given Featurestore.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::createEntityTypeAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\CreateEntityTypeRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\CreateEntityTypeRequest;
use Google\Cloud\AIPlatform\V1\EntityType;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource name of the Featurestore to create EntityTypes.
* Format:
* `projects/{project}/locations/{location}/featurestores/{featurestore}`
* Please see {@see FeaturestoreServiceClient::featurestoreName()} for help formatting this field.
* @param string $entityTypeId The ID to use for the EntityType, which will become the final
* component of the EntityType's resource name.
*
* This value may be up to 60 characters, and valid characters are
* `[a-z0-9_]`. The first character cannot be a number.
*
* The value must be unique within a featurestore.
*/
function create_entity_type_sample(string $formattedParent, string $entityTypeId): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = (new CreateEntityTypeRequest())
->setParent($formattedParent)
->setEntityTypeId($entityTypeId);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $featurestoreServiceClient->createEntityType($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var EntityType $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 = FeaturestoreServiceClient::featurestoreName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]'
);
$entityTypeId = '[ENTITY_TYPE_ID]';
create_entity_type_sample($formattedParent, $entityTypeId);
}
createFeature
Creates a new Feature in a given EntityType.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::createFeatureAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\CreateFeatureRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\CreateFeatureRequest;
use Google\Cloud\AIPlatform\V1\Feature;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource name of the EntityType or FeatureGroup to create a
* Feature. Format for entity_type as parent:
* `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
* Format for feature_group as parent:
* `projects/{project}/locations/{location}/featureGroups/{feature_group}`
* Please see {@see FeaturestoreServiceClient::entityTypeName()} for help formatting this field.
* @param string $featureId The ID to use for the Feature, which will become the final
* component of the Feature's resource name.
*
* This value may be up to 128 characters, and valid characters are
* `[a-z0-9_]`. The first character cannot be a number.
*
* The value must be unique within an EntityType/FeatureGroup.
*/
function create_feature_sample(string $formattedParent, string $featureId): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$feature = new Feature();
$request = (new CreateFeatureRequest())
->setParent($formattedParent)
->setFeature($feature)
->setFeatureId($featureId);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $featurestoreServiceClient->createFeature($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Feature $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 = FeaturestoreServiceClient::entityTypeName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]',
'[ENTITY_TYPE]'
);
$featureId = '[FEATURE_ID]';
create_feature_sample($formattedParent, $featureId);
}
createFeaturestore
Creates a new Featurestore in a given project and location.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::createFeaturestoreAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\CreateFeaturestoreRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\CreateFeaturestoreRequest;
use Google\Cloud\AIPlatform\V1\Featurestore;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource name of the Location to create Featurestores.
* Format:
* `projects/{project}/locations/{location}`
* Please see {@see FeaturestoreServiceClient::locationName()} for help formatting this field.
* @param string $featurestoreId The ID to use for this Featurestore, which will become the final
* component of the Featurestore's resource name.
*
* This value may be up to 60 characters, and valid characters are
* `[a-z0-9_]`. The first character cannot be a number.
*
* The value must be unique within the project and location.
*/
function create_featurestore_sample(string $formattedParent, string $featurestoreId): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$featurestore = new Featurestore();
$request = (new CreateFeaturestoreRequest())
->setParent($formattedParent)
->setFeaturestore($featurestore)
->setFeaturestoreId($featurestoreId);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $featurestoreServiceClient->createFeaturestore($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Featurestore $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 = FeaturestoreServiceClient::locationName('[PROJECT]', '[LOCATION]');
$featurestoreId = '[FEATURESTORE_ID]';
create_featurestore_sample($formattedParent, $featurestoreId);
}
deleteEntityType
Deletes a single EntityType. The EntityType must not have any Features
or force must be set to true for the request to succeed.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::deleteEntityTypeAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\DeleteEntityTypeRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteEntityTypeRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the EntityType to be deleted.
* Format:
* `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
* Please see {@see FeaturestoreServiceClient::entityTypeName()} for help formatting this field.
*/
function delete_entity_type_sample(string $formattedName): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = (new DeleteEntityTypeRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $featurestoreServiceClient->deleteEntityType($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 = FeaturestoreServiceClient::entityTypeName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]',
'[ENTITY_TYPE]'
);
delete_entity_type_sample($formattedName);
}
deleteFeature
Deletes a single Feature.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::deleteFeatureAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\DeleteFeatureRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteFeatureRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the Features to be deleted.
* Format:
* `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
* `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`
* Please see {@see FeaturestoreServiceClient::featureName()} for help formatting this field.
*/
function delete_feature_sample(string $formattedName): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = (new DeleteFeatureRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $featurestoreServiceClient->deleteFeature($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 = FeaturestoreServiceClient::featureName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]',
'[ENTITY_TYPE]',
'[FEATURE]'
);
delete_feature_sample($formattedName);
}
deleteFeatureValues
Delete Feature values from Featurestore.
The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done.
If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::deleteFeatureValuesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\DeleteFeatureValuesRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteFeatureValuesRequest;
use Google\Cloud\AIPlatform\V1\DeleteFeatureValuesResponse;
use Google\Rpc\Status;
/**
* @param string $formattedEntityType The resource name of the EntityType grouping the Features for
* which values are being deleted from. Format:
* `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
* Please see {@see FeaturestoreServiceClient::entityTypeName()} for help formatting this field.
*/
function delete_feature_values_sample(string $formattedEntityType): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = (new DeleteFeatureValuesRequest())
->setEntityType($formattedEntityType);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $featurestoreServiceClient->deleteFeatureValues($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var DeleteFeatureValuesResponse $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
{
$formattedEntityType = FeaturestoreServiceClient::entityTypeName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]',
'[ENTITY_TYPE]'
);
delete_feature_values_sample($formattedEntityType);
}
deleteFeaturestore
Deletes a single Featurestore. The Featurestore must not contain any
EntityTypes or force must be set to true for the request to succeed.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::deleteFeaturestoreAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\DeleteFeaturestoreRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteFeaturestoreRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the Featurestore to be deleted.
* Format:
* `projects/{project}/locations/{location}/featurestores/{featurestore}`
* Please see {@see FeaturestoreServiceClient::featurestoreName()} for help formatting this field.
*/
function delete_featurestore_sample(string $formattedName): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = (new DeleteFeaturestoreRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $featurestoreServiceClient->deleteFeaturestore($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 = FeaturestoreServiceClient::featurestoreName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]'
);
delete_featurestore_sample($formattedName);
}
exportFeatureValues
Exports Feature values from all the entities of a target EntityType.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::exportFeatureValuesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\ExportFeatureValuesRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\ExportFeatureValuesRequest;
use Google\Cloud\AIPlatform\V1\ExportFeatureValuesResponse;
use Google\Cloud\AIPlatform\V1\FeatureSelector;
use Google\Cloud\AIPlatform\V1\FeatureValueDestination;
use Google\Cloud\AIPlatform\V1\IdMatcher;
use Google\Rpc\Status;
/**
* @param string $formattedEntityType The resource name of the EntityType from which to export Feature
* values. Format:
* `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
* Please see {@see FeaturestoreServiceClient::entityTypeName()} for help formatting this field.
* @param string $featureSelectorIdMatcherIdsElement The following are accepted as `ids`:
*
* * A single-element list containing only `*`, which selects all Features
* in the target EntityType, or
* * A list containing only Feature IDs, which selects only Features with
* those IDs in the target EntityType.
*/
function export_feature_values_sample(
string $formattedEntityType,
string $featureSelectorIdMatcherIdsElement
): void {
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$destination = new FeatureValueDestination();
$featureSelectorIdMatcherIds = [$featureSelectorIdMatcherIdsElement,];
$featureSelectorIdMatcher = (new IdMatcher())
->setIds($featureSelectorIdMatcherIds);
$featureSelector = (new FeatureSelector())
->setIdMatcher($featureSelectorIdMatcher);
$request = (new ExportFeatureValuesRequest())
->setEntityType($formattedEntityType)
->setDestination($destination)
->setFeatureSelector($featureSelector);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $featurestoreServiceClient->exportFeatureValues($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ExportFeatureValuesResponse $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
{
$formattedEntityType = FeaturestoreServiceClient::entityTypeName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]',
'[ENTITY_TYPE]'
);
$featureSelectorIdMatcherIdsElement = '[IDS]';
export_feature_values_sample($formattedEntityType, $featureSelectorIdMatcherIdsElement);
}
getEntityType
Gets details of a single EntityType.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::getEntityTypeAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\GetEntityTypeRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\EntityType |
|
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\EntityType;
use Google\Cloud\AIPlatform\V1\GetEntityTypeRequest;
/**
* @param string $formattedName The name of the EntityType resource.
* Format:
* `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
* Please see {@see FeaturestoreServiceClient::entityTypeName()} for help formatting this field.
*/
function get_entity_type_sample(string $formattedName): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = (new GetEntityTypeRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var EntityType $response */
$response = $featurestoreServiceClient->getEntityType($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 = FeaturestoreServiceClient::entityTypeName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]',
'[ENTITY_TYPE]'
);
get_entity_type_sample($formattedName);
}
getFeature
Gets details of a single Feature.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::getFeatureAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\GetFeatureRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\Feature |
|
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\Feature;
use Google\Cloud\AIPlatform\V1\GetFeatureRequest;
/**
* @param string $formattedName The name of the Feature resource.
* Format for entity_type as parent:
* `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
* Format for feature_group as parent:
* `projects/{project}/locations/{location}/featureGroups/{feature_group}`
* Please see {@see FeaturestoreServiceClient::featureName()} for help formatting this field.
*/
function get_feature_sample(string $formattedName): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = (new GetFeatureRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Feature $response */
$response = $featurestoreServiceClient->getFeature($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 = FeaturestoreServiceClient::featureName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]',
'[ENTITY_TYPE]',
'[FEATURE]'
);
get_feature_sample($formattedName);
}
getFeaturestore
Gets details of a single Featurestore.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::getFeaturestoreAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\GetFeaturestoreRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\Featurestore |
|
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\Featurestore;
use Google\Cloud\AIPlatform\V1\GetFeaturestoreRequest;
/**
* @param string $formattedName The name of the Featurestore resource. Please see
* {@see FeaturestoreServiceClient::featurestoreName()} for help formatting this field.
*/
function get_featurestore_sample(string $formattedName): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = (new GetFeaturestoreRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Featurestore $response */
$response = $featurestoreServiceClient->getFeaturestore($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 = FeaturestoreServiceClient::featurestoreName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]'
);
get_featurestore_sample($formattedName);
}
importFeatureValues
Imports Feature values into the Featurestore from a source storage.
The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done.
If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done.
There are also scenarios where the caller can cause inconsistency.
- Source data for import contains multiple distinct Feature values for the same entity ID and timestamp.
- Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy.
- Online serving cluster is under-provisioned.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::importFeatureValuesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\ImportFeatureValuesRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\ImportFeatureValuesRequest;
use Google\Cloud\AIPlatform\V1\ImportFeatureValuesRequest\FeatureSpec;
use Google\Cloud\AIPlatform\V1\ImportFeatureValuesResponse;
use Google\Rpc\Status;
/**
* @param string $formattedEntityType The resource name of the EntityType grouping the Features for
* which values are being imported. Format:
* `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
* Please see {@see FeaturestoreServiceClient::entityTypeName()} for help formatting this field.
* @param string $featureSpecsId ID of the Feature to import values of. This Feature must exist
* in the target EntityType, or the request will fail.
*/
function import_feature_values_sample(string $formattedEntityType, string $featureSpecsId): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$featureSpec = (new FeatureSpec())
->setId($featureSpecsId);
$featureSpecs = [$featureSpec,];
$request = (new ImportFeatureValuesRequest())
->setEntityType($formattedEntityType)
->setFeatureSpecs($featureSpecs);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $featurestoreServiceClient->importFeatureValues($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ImportFeatureValuesResponse $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
{
$formattedEntityType = FeaturestoreServiceClient::entityTypeName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]',
'[ENTITY_TYPE]'
);
$featureSpecsId = '[ID]';
import_feature_values_sample($formattedEntityType, $featureSpecsId);
}
listEntityTypes
Lists EntityTypes in a given Featurestore.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::listEntityTypesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\ListEntityTypesRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\EntityType;
use Google\Cloud\AIPlatform\V1\ListEntityTypesRequest;
/**
* @param string $formattedParent The resource name of the Featurestore to list EntityTypes.
* Format:
* `projects/{project}/locations/{location}/featurestores/{featurestore}`
* Please see {@see FeaturestoreServiceClient::featurestoreName()} for help formatting this field.
*/
function list_entity_types_sample(string $formattedParent): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = (new ListEntityTypesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $featurestoreServiceClient->listEntityTypes($request);
/** @var EntityType $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 = FeaturestoreServiceClient::featurestoreName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]'
);
list_entity_types_sample($formattedParent);
}
listFeatures
Lists Features in a given EntityType.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::listFeaturesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\ListFeaturesRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\Feature;
use Google\Cloud\AIPlatform\V1\ListFeaturesRequest;
/**
* @param string $formattedParent The resource name of the Location to list Features.
* Format for entity_type as parent:
* `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
* Format for feature_group as parent:
* `projects/{project}/locations/{location}/featureGroups/{feature_group}`
* Please see {@see FeaturestoreServiceClient::entityTypeName()} for help formatting this field.
*/
function list_features_sample(string $formattedParent): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = (new ListFeaturesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $featurestoreServiceClient->listFeatures($request);
/** @var Feature $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 = FeaturestoreServiceClient::entityTypeName(
'[PROJECT]',
'[LOCATION]',
'[FEATURESTORE]',
'[ENTITY_TYPE]'
);
list_features_sample($formattedParent);
}
listFeaturestores
Lists Featurestores in a given project and location.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::listFeaturestoresAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\ListFeaturestoresRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\Featurestore;
use Google\Cloud\AIPlatform\V1\ListFeaturestoresRequest;
/**
* @param string $formattedParent The resource name of the Location to list Featurestores.
* Format:
* `projects/{project}/locations/{location}`
* Please see {@see FeaturestoreServiceClient::locationName()} for help formatting this field.
*/
function list_featurestores_sample(string $formattedParent): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = (new ListFeaturestoresRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $featurestoreServiceClient->listFeaturestores($request);
/** @var Featurestore $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 = FeaturestoreServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_featurestores_sample($formattedParent);
}
searchFeatures
Searches Features matching a query in a given project.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::searchFeaturesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\SearchFeaturesRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\Feature;
use Google\Cloud\AIPlatform\V1\SearchFeaturesRequest;
/**
* @param string $formattedLocation The resource name of the Location to search Features.
* Format:
* `projects/{project}/locations/{location}`
* Please see {@see FeaturestoreServiceClient::locationName()} for help formatting this field.
*/
function search_features_sample(string $formattedLocation): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = (new SearchFeaturesRequest())
->setLocation($formattedLocation);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $featurestoreServiceClient->searchFeatures($request);
/** @var Feature $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
{
$formattedLocation = FeaturestoreServiceClient::locationName('[PROJECT]', '[LOCATION]');
search_features_sample($formattedLocation);
}
updateEntityType
Updates the parameters of a single EntityType.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::updateEntityTypeAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\UpdateEntityTypeRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\EntityType |
|
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\EntityType;
use Google\Cloud\AIPlatform\V1\UpdateEntityTypeRequest;
/**
* 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 update_entity_type_sample(): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$entityType = new EntityType();
$request = (new UpdateEntityTypeRequest())
->setEntityType($entityType);
// Call the API and handle any network failures.
try {
/** @var EntityType $response */
$response = $featurestoreServiceClient->updateEntityType($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateFeature
Updates the parameters of a single Feature.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::updateFeatureAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\UpdateFeatureRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\Feature |
|
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\Feature;
use Google\Cloud\AIPlatform\V1\UpdateFeatureRequest;
/**
* 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 update_feature_sample(): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$feature = new Feature();
$request = (new UpdateFeatureRequest())
->setFeature($feature);
// Call the API and handle any network failures.
try {
/** @var Feature $response */
$response = $featurestoreServiceClient->updateFeature($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateFeaturestore
Updates the parameters of a single Featurestore.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::updateFeaturestoreAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\UpdateFeaturestoreRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
use Google\Cloud\AIPlatform\V1\Featurestore;
use Google\Cloud\AIPlatform\V1\UpdateFeaturestoreRequest;
use Google\Rpc\Status;
/**
* 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 update_featurestore_sample(): void
{
// Create a client.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$featurestore = new Featurestore();
$request = (new UpdateFeaturestoreRequest())
->setFeaturestore($featurestore);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $featurestoreServiceClient->updateFeaturestore($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Featurestore $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());
}
}
getLocation
Gets information about a location.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::getLocationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\Cloud\Location\Location |
|
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
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.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $featurestoreServiceClient->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.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::listLocationsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
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.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $featurestoreServiceClient->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.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::getIamPolicyAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\Policy |
|
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
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.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $featurestoreServiceClient->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.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::setIamPolicyAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\Policy |
|
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
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.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// 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 = $featurestoreServiceClient->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.
The async variant is Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient::testIamPermissionsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
A request to house fields associated with the call. |
callOptions |
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 | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\FeaturestoreServiceClient;
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.
$featurestoreServiceClient = new FeaturestoreServiceClient();
// 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 = $featurestoreServiceClient->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);
}
batchCreateFeaturesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\BatchCreateFeaturesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
batchReadFeatureValuesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\BatchReadFeatureValuesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
createEntityTypeAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\CreateEntityTypeRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
createFeatureAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\CreateFeatureRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
createFeaturestoreAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\CreateFeaturestoreRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
deleteEntityTypeAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\DeleteEntityTypeRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
deleteFeatureAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\DeleteFeatureRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
deleteFeatureValuesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\DeleteFeatureValuesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
deleteFeaturestoreAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\DeleteFeaturestoreRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
exportFeatureValuesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\ExportFeatureValuesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
getEntityTypeAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\GetEntityTypeRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\AIPlatform\V1\EntityType> |
|
getFeatureAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\GetFeatureRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\AIPlatform\V1\Feature> |
|
getFeaturestoreAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\GetFeaturestoreRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\AIPlatform\V1\Featurestore> |
|
importFeatureValuesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\ImportFeatureValuesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
listEntityTypesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\ListEntityTypesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listFeaturesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\ListFeaturesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listFeaturestoresAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\ListFeaturestoresRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
searchFeaturesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\SearchFeaturesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
updateEntityTypeAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\UpdateEntityTypeRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\AIPlatform\V1\EntityType> |
|
updateFeatureAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\UpdateFeatureRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\AIPlatform\V1\Feature> |
|
updateFeaturestoreAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\AIPlatform\V1\UpdateFeaturestoreRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
getLocationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location> |
|
listLocationsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
getIamPolicyAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
|
setIamPolicyAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
|
testIamPermissionsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\TestIamPermissionsResponse> |
|
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\LongRunning\Client\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 | |
|---|---|
| Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
static::entityTypeName
Formats a string containing the fully-qualified path to represent a entity_type resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
featurestore |
string
|
entityType |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted entity_type resource. |
static::featureName
Formats a string containing the fully-qualified path to represent a feature resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
featurestore |
string
|
entityType |
string
|
feature |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted feature resource. |
static::featureGroupName
Formats a string containing the fully-qualified path to represent a feature_group resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
featureGroup |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted feature_group resource. |
static::featurestoreName
Formats a string containing the fully-qualified path to represent a featurestore resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
featurestore |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted featurestore resource. |
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted location resource. |
static::projectLocationFeatureGroupFeatureName
Formats a string containing the fully-qualified path to represent a project_location_feature_group_feature resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
featureGroup |
string
|
feature |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted project_location_feature_group_feature resource. |
static::projectLocationFeaturestoreEntityTypeFeatureName
Formats a string containing the fully-qualified path to represent a project_location_featurestore_entity_type_feature resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
featurestore |
string
|
entityType |
string
|
feature |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted project_location_featurestore_entity_type_feature 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
- entityType: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
- feature: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}
- featureGroup: projects/{project}/locations/{location}/featureGroups/{feature_group}
- featurestore: projects/{project}/locations/{location}/featurestores/{featurestore}
- location: projects/{project}/locations/{location}
- projectLocationFeatureGroupFeature: projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}
- projectLocationFeaturestoreEntityTypeFeature: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}
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 | |
|---|---|
| Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
| Returns | |
|---|---|
| Type | Description |
array |
An associative array from name component IDs to component values. |