Cloud AI Platform v1 API - Class FeatureOnlineStoreServiceClient (2.27.0)

Version latest

• 2.27.0 (latest)
• 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

public abstract class FeatureOnlineStoreServiceClient

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

FeatureOnlineStoreService client wrapper, for convenient use.

Inheritance

object > FeatureOnlineStoreServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

FeatureOnlineStoreServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

A service for fetching feature values from the online store.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the FeatureOnlineStoreService service, which is a host of "aiplatform.googleapis.com" and a port of 443.

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default FeatureOnlineStoreService scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default FeatureOnlineStoreService scopes are:

• https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual FeatureOnlineStoreService.FeatureOnlineStoreServiceClient GrpcClient { get; }

The underlying gRPC FeatureOnlineStoreService client

Property Value
Type	Description
FeatureOnlineStoreServiceFeatureOnlineStoreServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

Create()

public static FeatureOnlineStoreServiceClient Create()

Synchronously creates a FeatureOnlineStoreServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use FeatureOnlineStoreServiceClientBuilder.

Returns
Type	Description
FeatureOnlineStoreServiceClient	The created FeatureOnlineStoreServiceClient.

CreateAsync(CancellationToken)

public static Task<FeatureOnlineStoreServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a FeatureOnlineStoreServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use FeatureOnlineStoreServiceClientBuilder.

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskFeatureOnlineStoreServiceClient	The task representing the created FeatureOnlineStoreServiceClient.

FetchFeatureValues(FeatureViewName, FeatureViewDataKey, CallSettings)

public virtual FetchFeatureValuesResponse FetchFeatureValues(FeatureViewName featureView, FeatureViewDataKey dataKey, CallSettings callSettings = null)

Fetch feature values under a FeatureView.

Parameters
Name	Description
featureView	FeatureViewName Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}
dataKey	FeatureViewDataKey Optional. The request key to fetch feature values for.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
FetchFeatureValuesResponse	The RPC response.

Example

// Create client
FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient = FeatureOnlineStoreServiceClient.Create();
// Initialize request argument(s)
FeatureViewName featureView = FeatureViewName.FromProjectLocationFeatureOnlineStoreFeatureView("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]");
FeatureViewDataKey dataKey = new FeatureViewDataKey();
// Make the request
FetchFeatureValuesResponse response = featureOnlineStoreServiceClient.FetchFeatureValues(featureView, dataKey);

FetchFeatureValues(FetchFeatureValuesRequest, CallSettings)

public virtual FetchFeatureValuesResponse FetchFeatureValues(FetchFeatureValuesRequest request, CallSettings callSettings = null)

Fetch feature values under a FeatureView.

Parameters
Name	Description
request	FetchFeatureValuesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
FetchFeatureValuesResponse	The RPC response.

Example

// Create client
FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient = FeatureOnlineStoreServiceClient.Create();
// Initialize request argument(s)
FetchFeatureValuesRequest request = new FetchFeatureValuesRequest
{
    FeatureViewAsFeatureViewName = FeatureViewName.FromProjectLocationFeatureOnlineStoreFeatureView("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]"),
    DataKey = new FeatureViewDataKey(),
    DataFormat = FeatureViewDataFormat.Unspecified,
};
// Make the request
FetchFeatureValuesResponse response = featureOnlineStoreServiceClient.FetchFeatureValues(request);

FetchFeatureValues(string, FeatureViewDataKey, CallSettings)

public virtual FetchFeatureValuesResponse FetchFeatureValues(string featureView, FeatureViewDataKey dataKey, CallSettings callSettings = null)

Fetch feature values under a FeatureView.

Parameters
Name	Description
featureView	string Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}
dataKey	FeatureViewDataKey Optional. The request key to fetch feature values for.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
FetchFeatureValuesResponse	The RPC response.

Example

// Create client
FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient = FeatureOnlineStoreServiceClient.Create();
// Initialize request argument(s)
string featureView = "projects/[PROJECT]/locations/[LOCATION]/featureOnlineStores/[FEATURE_ONLINE_STORE]/featureViews/[FEATURE_VIEW]";
FeatureViewDataKey dataKey = new FeatureViewDataKey();
// Make the request
FetchFeatureValuesResponse response = featureOnlineStoreServiceClient.FetchFeatureValues(featureView, dataKey);

FetchFeatureValuesAsync(FeatureViewName, FeatureViewDataKey, CallSettings)

public virtual Task<FetchFeatureValuesResponse> FetchFeatureValuesAsync(FeatureViewName featureView, FeatureViewDataKey dataKey, CallSettings callSettings = null)

Fetch feature values under a FeatureView.

Parameters
Name	Description
featureView	FeatureViewName Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}
dataKey	FeatureViewDataKey Optional. The request key to fetch feature values for.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskFetchFeatureValuesResponse	A Task containing the RPC response.

Example

// Create client
FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient = await FeatureOnlineStoreServiceClient.CreateAsync();
// Initialize request argument(s)
FeatureViewName featureView = FeatureViewName.FromProjectLocationFeatureOnlineStoreFeatureView("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]");
FeatureViewDataKey dataKey = new FeatureViewDataKey();
// Make the request
FetchFeatureValuesResponse response = await featureOnlineStoreServiceClient.FetchFeatureValuesAsync(featureView, dataKey);

FetchFeatureValuesAsync(FeatureViewName, FeatureViewDataKey, CancellationToken)

public virtual Task<FetchFeatureValuesResponse> FetchFeatureValuesAsync(FeatureViewName featureView, FeatureViewDataKey dataKey, CancellationToken cancellationToken)

Fetch feature values under a FeatureView.

Parameters
Name	Description
featureView	FeatureViewName Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}
dataKey	FeatureViewDataKey Optional. The request key to fetch feature values for.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskFetchFeatureValuesResponse	A Task containing the RPC response.

Example

// Create client
FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient = await FeatureOnlineStoreServiceClient.CreateAsync();
// Initialize request argument(s)
FeatureViewName featureView = FeatureViewName.FromProjectLocationFeatureOnlineStoreFeatureView("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]");
FeatureViewDataKey dataKey = new FeatureViewDataKey();
// Make the request
FetchFeatureValuesResponse response = await featureOnlineStoreServiceClient.FetchFeatureValuesAsync(featureView, dataKey);

FetchFeatureValuesAsync(FetchFeatureValuesRequest, CallSettings)

public virtual Task<FetchFeatureValuesResponse> FetchFeatureValuesAsync(FetchFeatureValuesRequest request, CallSettings callSettings = null)

Fetch feature values under a FeatureView.

Parameters
Name	Description
request	FetchFeatureValuesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskFetchFeatureValuesResponse	A Task containing the RPC response.

Example

// Create client
FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient = await FeatureOnlineStoreServiceClient.CreateAsync();
// Initialize request argument(s)
FetchFeatureValuesRequest request = new FetchFeatureValuesRequest
{
    FeatureViewAsFeatureViewName = FeatureViewName.FromProjectLocationFeatureOnlineStoreFeatureView("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]"),
    DataKey = new FeatureViewDataKey(),
    DataFormat = FeatureViewDataFormat.Unspecified,
};
// Make the request
FetchFeatureValuesResponse response = await featureOnlineStoreServiceClient.FetchFeatureValuesAsync(request);

FetchFeatureValuesAsync(FetchFeatureValuesRequest, CancellationToken)

public virtual Task<FetchFeatureValuesResponse> FetchFeatureValuesAsync(FetchFeatureValuesRequest request, CancellationToken cancellationToken)

Fetch feature values under a FeatureView.

Parameters
Name	Description
request	FetchFeatureValuesRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskFetchFeatureValuesResponse	A Task containing the RPC response.

Example

// Create client
FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient = await FeatureOnlineStoreServiceClient.CreateAsync();
// Initialize request argument(s)
FetchFeatureValuesRequest request = new FetchFeatureValuesRequest
{
    FeatureViewAsFeatureViewName = FeatureViewName.FromProjectLocationFeatureOnlineStoreFeatureView("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]"),
    DataKey = new FeatureViewDataKey(),
    DataFormat = FeatureViewDataFormat.Unspecified,
};
// Make the request
FetchFeatureValuesResponse response = await featureOnlineStoreServiceClient.FetchFeatureValuesAsync(request);

FetchFeatureValuesAsync(string, FeatureViewDataKey, CallSettings)

public virtual Task<FetchFeatureValuesResponse> FetchFeatureValuesAsync(string featureView, FeatureViewDataKey dataKey, CallSettings callSettings = null)

Fetch feature values under a FeatureView.

Parameters
Name	Description
featureView	string Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}
dataKey	FeatureViewDataKey Optional. The request key to fetch feature values for.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskFetchFeatureValuesResponse	A Task containing the RPC response.

Example

// Create client
FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient = await FeatureOnlineStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string featureView = "projects/[PROJECT]/locations/[LOCATION]/featureOnlineStores/[FEATURE_ONLINE_STORE]/featureViews/[FEATURE_VIEW]";
FeatureViewDataKey dataKey = new FeatureViewDataKey();
// Make the request
FetchFeatureValuesResponse response = await featureOnlineStoreServiceClient.FetchFeatureValuesAsync(featureView, dataKey);

FetchFeatureValuesAsync(string, FeatureViewDataKey, CancellationToken)

public virtual Task<FetchFeatureValuesResponse> FetchFeatureValuesAsync(string featureView, FeatureViewDataKey dataKey, CancellationToken cancellationToken)

Fetch feature values under a FeatureView.

Parameters
Name	Description
featureView	string Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}
dataKey	FeatureViewDataKey Optional. The request key to fetch feature values for.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskFetchFeatureValuesResponse	A Task containing the RPC response.

Example

// Create client
FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient = await FeatureOnlineStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string featureView = "projects/[PROJECT]/locations/[LOCATION]/featureOnlineStores/[FEATURE_ONLINE_STORE]/featureViews/[FEATURE_VIEW]";
FeatureViewDataKey dataKey = new FeatureViewDataKey();
// Make the request
FetchFeatureValuesResponse response = await featureOnlineStoreServiceClient.FetchFeatureValuesAsync(featureView, dataKey);

SearchNearestEntities(SearchNearestEntitiesRequest, CallSettings)

public virtual SearchNearestEntitiesResponse SearchNearestEntities(SearchNearestEntitiesRequest request, CallSettings callSettings = null)

Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.

Parameters
Name	Description
request	SearchNearestEntitiesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
SearchNearestEntitiesResponse	The RPC response.

Example

// Create client
FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient = FeatureOnlineStoreServiceClient.Create();
// Initialize request argument(s)
SearchNearestEntitiesRequest request = new SearchNearestEntitiesRequest
{
    FeatureViewAsFeatureViewName = FeatureViewName.FromProjectLocationFeatureOnlineStoreFeatureView("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]"),
    Query = new NearestNeighborQuery(),
    ReturnFullEntity = false,
};
// Make the request
SearchNearestEntitiesResponse response = featureOnlineStoreServiceClient.SearchNearestEntities(request);

SearchNearestEntitiesAsync(SearchNearestEntitiesRequest, CallSettings)

public virtual Task<SearchNearestEntitiesResponse> SearchNearestEntitiesAsync(SearchNearestEntitiesRequest request, CallSettings callSettings = null)

Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.

Parameters
Name	Description
request	SearchNearestEntitiesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskSearchNearestEntitiesResponse	A Task containing the RPC response.

Example

// Create client
FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient = await FeatureOnlineStoreServiceClient.CreateAsync();
// Initialize request argument(s)
SearchNearestEntitiesRequest request = new SearchNearestEntitiesRequest
{
    FeatureViewAsFeatureViewName = FeatureViewName.FromProjectLocationFeatureOnlineStoreFeatureView("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]"),
    Query = new NearestNeighborQuery(),
    ReturnFullEntity = false,
};
// Make the request
SearchNearestEntitiesResponse response = await featureOnlineStoreServiceClient.SearchNearestEntitiesAsync(request);

SearchNearestEntitiesAsync(SearchNearestEntitiesRequest, CancellationToken)

public virtual Task<SearchNearestEntitiesResponse> SearchNearestEntitiesAsync(SearchNearestEntitiesRequest request, CancellationToken cancellationToken)

Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.

Parameters
Name	Description
request	SearchNearestEntitiesRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskSearchNearestEntitiesResponse	A Task containing the RPC response.

Example

// Create client
FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient = await FeatureOnlineStoreServiceClient.CreateAsync();
// Initialize request argument(s)
SearchNearestEntitiesRequest request = new SearchNearestEntitiesRequest
{
    FeatureViewAsFeatureViewName = FeatureViewName.FromProjectLocationFeatureOnlineStoreFeatureView("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]"),
    Query = new NearestNeighborQuery(),
    ReturnFullEntity = false,
};
// Make the request
SearchNearestEntitiesResponse response = await featureOnlineStoreServiceClient.SearchNearestEntitiesAsync(request);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.