class ProjectsLocationsFeaturestores extends Resource (View source)

The "featurestores" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $featurestores = $aiplatformService->projects_locations_featurestores;

Methods

batchReadFeatureValues(string $featurestore, GoogleCloudAiplatformV1BatchReadFeatureValuesRequest $postBody, array $optParams = [])

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. (featurestores.batchReadFeatureValues)

create(string $parent, GoogleCloudAiplatformV1Featurestore $postBody, array $optParams = [])

Creates a new Featurestore in a given project and location.

delete(string $name, array $optParams = [])

Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force must be set to true for the request to succeed.

get(string $name, array $optParams = [])

Gets details of a single Featurestore. (featurestores.get)

getIamPolicy(string $resource, array $optParams = [])

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

listProjectsLocationsFeaturestores(string $parent, array $optParams = [])

Lists Featurestores in a given project and location.

patch(string $name, GoogleCloudAiplatformV1Featurestore $postBody, array $optParams = [])

Updates the parameters of a single Featurestore. (featurestores.patch)

searchFeatures(string $location, array $optParams = [])

Searches Features matching a query in a given project.

setIamPolicy(string $resource, GoogleIamV1SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (featurestores.setIamPolicy)

testIamPermissions(string $resource, array $optParams = [])

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.

Details

GoogleLongrunningOperation batchReadFeatureValues(string $featurestore, GoogleCloudAiplatformV1BatchReadFeatureValuesRequest $postBody, array $optParams = [])

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. (featurestores.batchReadFeatureValues)

Parameters

string $featurestore

Required. The resource name of the Featurestore from which to query Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

GoogleCloudAiplatformV1BatchReadFeatureValuesRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleLongrunningOperation create(string $parent, GoogleCloudAiplatformV1Featurestore $postBody, array $optParams = [])

Creates a new Featurestore in a given project and location.

(featurestores.create)

Parameters

string $parent

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

GoogleCloudAiplatformV1Featurestore $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force must be set to true for the request to succeed.

(featurestores.delete)

Parameters

string $name

Required. The name of the Featurestore to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleCloudAiplatformV1Featurestore get(string $name, array $optParams = [])

Gets details of a single Featurestore. (featurestores.get)

Parameters

string $name

Required. The name of the Featurestore resource.

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Featurestore

Exceptions

Exception

GoogleIamV1Policy getIamPolicy(string $resource, array $optParams = [])

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

Parameters

string $resource

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

array $optParams

Optional parameters.

Return Value

GoogleIamV1Policy

Exceptions

Exception

GoogleCloudAiplatformV1ListFeaturestoresResponse listProjectsLocationsFeaturestores(string $parent, array $optParams = [])

Lists Featurestores in a given project and location.

(featurestores.listProjectsLocationsFeaturestores)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListFeaturestoresResponse

Exceptions

Exception

GoogleLongrunningOperation patch(string $name, GoogleCloudAiplatformV1Featurestore $postBody, array $optParams = [])

Updates the parameters of a single Featurestore. (featurestores.patch)

Parameters

string $name

Output only. Name of the Featurestore. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

GoogleCloudAiplatformV1Featurestore $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleCloudAiplatformV1SearchFeaturesResponse searchFeatures(string $location, array $optParams = [])

Searches Features matching a query in a given project.

(featurestores.searchFeatures)

Parameters

string $location

Required. The resource name of the Location to search Features. Format: projects/{project}/locations/{location}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1SearchFeaturesResponse

Exceptions

Exception

GoogleIamV1Policy setIamPolicy(string $resource, GoogleIamV1SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (featurestores.setIamPolicy)

Parameters

string $resource

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

GoogleIamV1SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleIamV1Policy

Exceptions

Exception

GoogleIamV1TestIamPermissionsResponse testIamPermissions(string $resource, array $optParams = [])

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. (featurestores.testIamPermissions)

Parameters

string $resource

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

array $optParams

Optional parameters.

Return Value

GoogleIamV1TestIamPermissionsResponse

Exceptions

Exception