Cloud AI Platform v1beta1 API - Class FeatureOnlineStoreServiceClient (1.0.0-beta10)

public abstract class FeatureOnlineStoreServiceClient

Reference documentation and code samples for the Cloud AI Platform v1beta1 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.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.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.

StreamingFetchFeatureValues(CallSettings, BidirectionalStreamingSettings)

public virtual FeatureOnlineStoreServiceClient.StreamingFetchFeatureValuesStream StreamingFetchFeatureValues(CallSettings callSettings = null, BidirectionalStreamingSettings streamingSettings = null)

Bidirectional streaming RPC to fetch feature values under a FeatureView. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.

Parameters
Name	Description
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.
`streamingSettings`	`BidirectionalStreamingSettings` If not null, applies streaming overrides to this RPC call.

Returns
Type	Description
`FeatureOnlineStoreServiceClientStreamingFetchFeatureValuesStream`	The client-server stream.

Example

// Create client
FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient = FeatureOnlineStoreServiceClient.Create();
// Initialize streaming call, retrieving the stream object
using FeatureOnlineStoreServiceClient.StreamingFetchFeatureValuesStream response = featureOnlineStoreServiceClient.StreamingFetchFeatureValues();

// Sending requests and retrieving responses can be arbitrarily interleaved
// Exact sequence will depend on client/server behavior

// Create task to do something with responses from server
Task responseHandlerTask = Task.Run(async () =>
{
    // Note that C# 8 code can use await foreach
    AsyncResponseStream<StreamingFetchFeatureValuesResponse> responseStream = response.GetResponseStream();
    while (await responseStream.MoveNextAsync())
    {
        StreamingFetchFeatureValuesResponse responseItem = responseStream.Current;
        // Do something with streamed response
    }
    // The response stream has completed
});

// Send requests to the server
bool done = false;
while (!done)
{
    // Initialize a request
    StreamingFetchFeatureValuesRequest request = new StreamingFetchFeatureValuesRequest
    {
        FeatureViewAsFeatureViewName = FeatureViewName.FromProjectLocationFeatureOnlineStoreFeatureView("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]"),
        DataKeys =
        {
            new FeatureViewDataKey(),
        },
        DataFormat = FeatureViewDataFormat.Unspecified,
    };
    // Stream a request to the server
    await response.WriteAsync(request);
    // Set "done" to true when sending requests is complete
}

// Complete writing requests to the stream
await response.WriteCompleteAsync();
// Await the response handler
// This will complete once all server responses have been processed
await responseHandlerTask;