Cloud AI Platform v1 API - Class FeaturestoreService.FeaturestoreServiceBase (3.5.0)

Version 3.5.0

• 3.10.0 (latest)
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(FeaturestoreService), "BindService")]
public abstract class FeaturestoreService.FeaturestoreServiceBase

Reference documentation and code samples for the Cloud AI Platform v1 API class FeaturestoreService.FeaturestoreServiceBase.

Base class for server-side implementations of FeaturestoreService

Inheritance

object > FeaturestoreService.FeaturestoreServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Methods

BatchCreateFeatures(BatchCreateFeaturesRequest, ServerCallContext)

public virtual Task<Operation> BatchCreateFeatures(BatchCreateFeaturesRequest request, ServerCallContext context)

Creates a batch of Features in a given EntityType.

Parameters
Name	Description
request	BatchCreateFeaturesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

BatchReadFeatureValues(BatchReadFeatureValuesRequest, ServerCallContext)

public virtual Task<Operation> BatchReadFeatureValues(BatchReadFeatureValuesRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	BatchReadFeatureValuesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateEntityType(CreateEntityTypeRequest, ServerCallContext)

public virtual Task<Operation> CreateEntityType(CreateEntityTypeRequest request, ServerCallContext context)

Creates a new EntityType in a given Featurestore.

Parameters
Name	Description
request	CreateEntityTypeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateFeature(CreateFeatureRequest, ServerCallContext)

public virtual Task<Operation> CreateFeature(CreateFeatureRequest request, ServerCallContext context)

Creates a new Feature in a given EntityType.

Parameters
Name	Description
request	CreateFeatureRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateFeaturestore(CreateFeaturestoreRequest, ServerCallContext)

public virtual Task<Operation> CreateFeaturestore(CreateFeaturestoreRequest request, ServerCallContext context)

Creates a new Featurestore in a given project and location.

Parameters
Name	Description
request	CreateFeaturestoreRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteEntityType(DeleteEntityTypeRequest, ServerCallContext)

public virtual Task<Operation> DeleteEntityType(DeleteEntityTypeRequest request, ServerCallContext context)

Deletes a single EntityType. The EntityType must not have any Features or force must be set to true for the request to succeed.

Parameters
Name	Description
request	DeleteEntityTypeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteFeature(DeleteFeatureRequest, ServerCallContext)

public virtual Task<Operation> DeleteFeature(DeleteFeatureRequest request, ServerCallContext context)

Deletes a single Feature.

Parameters
Name	Description
request	DeleteFeatureRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteFeatureValues(DeleteFeatureValuesRequest, ServerCallContext)

public virtual Task<Operation> DeleteFeatureValues(DeleteFeatureValuesRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	DeleteFeatureValuesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteFeaturestore(DeleteFeaturestoreRequest, ServerCallContext)

public virtual Task<Operation> DeleteFeaturestore(DeleteFeaturestoreRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	DeleteFeaturestoreRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ExportFeatureValues(ExportFeatureValuesRequest, ServerCallContext)

public virtual Task<Operation> ExportFeatureValues(ExportFeatureValuesRequest request, ServerCallContext context)

Exports Feature values from all the entities of a target EntityType.

Parameters
Name	Description
request	ExportFeatureValuesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetEntityType(GetEntityTypeRequest, ServerCallContext)

public virtual Task<EntityType> GetEntityType(GetEntityTypeRequest request, ServerCallContext context)

Gets details of a single EntityType.

Parameters
Name	Description
request	GetEntityTypeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEntityType	The response to send back to the client (wrapped by a task).

GetFeature(GetFeatureRequest, ServerCallContext)

public virtual Task<Feature> GetFeature(GetFeatureRequest request, ServerCallContext context)

Gets details of a single Feature.

Parameters
Name	Description
request	GetFeatureRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskFeature	The response to send back to the client (wrapped by a task).

GetFeaturestore(GetFeaturestoreRequest, ServerCallContext)

public virtual Task<Featurestore> GetFeaturestore(GetFeaturestoreRequest request, ServerCallContext context)

Gets details of a single Featurestore.

Parameters
Name	Description
request	GetFeaturestoreRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskFeaturestore	The response to send back to the client (wrapped by a task).

ImportFeatureValues(ImportFeatureValuesRequest, ServerCallContext)

public virtual Task<Operation> ImportFeatureValues(ImportFeatureValuesRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	ImportFeatureValuesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ListEntityTypes(ListEntityTypesRequest, ServerCallContext)

public virtual Task<ListEntityTypesResponse> ListEntityTypes(ListEntityTypesRequest request, ServerCallContext context)

Lists EntityTypes in a given Featurestore.

Parameters
Name	Description
request	ListEntityTypesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListEntityTypesResponse	The response to send back to the client (wrapped by a task).

ListFeatures(ListFeaturesRequest, ServerCallContext)

public virtual Task<ListFeaturesResponse> ListFeatures(ListFeaturesRequest request, ServerCallContext context)

Lists Features in a given EntityType.

Parameters
Name	Description
request	ListFeaturesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListFeaturesResponse	The response to send back to the client (wrapped by a task).

ListFeaturestores(ListFeaturestoresRequest, ServerCallContext)

public virtual Task<ListFeaturestoresResponse> ListFeaturestores(ListFeaturestoresRequest request, ServerCallContext context)

Lists Featurestores in a given project and location.

Parameters
Name	Description
request	ListFeaturestoresRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListFeaturestoresResponse	The response to send back to the client (wrapped by a task).

SearchFeatures(SearchFeaturesRequest, ServerCallContext)

public virtual Task<SearchFeaturesResponse> SearchFeatures(SearchFeaturesRequest request, ServerCallContext context)

Searches Features matching a query in a given project.

Parameters
Name	Description
request	SearchFeaturesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchFeaturesResponse	The response to send back to the client (wrapped by a task).

UpdateEntityType(UpdateEntityTypeRequest, ServerCallContext)

public virtual Task<EntityType> UpdateEntityType(UpdateEntityTypeRequest request, ServerCallContext context)

Updates the parameters of a single EntityType.

Parameters
Name	Description
request	UpdateEntityTypeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEntityType	The response to send back to the client (wrapped by a task).

UpdateFeature(UpdateFeatureRequest, ServerCallContext)

public virtual Task<Feature> UpdateFeature(UpdateFeatureRequest request, ServerCallContext context)

Updates the parameters of a single Feature.

Parameters
Name	Description
request	UpdateFeatureRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskFeature	The response to send back to the client (wrapped by a task).

UpdateFeaturestore(UpdateFeaturestoreRequest, ServerCallContext)

public virtual Task<Operation> UpdateFeaturestore(UpdateFeaturestoreRequest request, ServerCallContext context)

Updates the parameters of a single Featurestore.

Parameters
Name	Description
request	UpdateFeaturestoreRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).