Cloud AI Platform v1 API - Class FeaturestoreOnlineServingServiceClient (3.6.0)

public abstract class FeaturestoreOnlineServingServiceClient

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

FeaturestoreOnlineServingService client wrapper, for convenient use.

Inheritance

object > FeaturestoreOnlineServingServiceClient

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

A service for serving online feature values.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the FeaturestoreOnlineServingService 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 FeaturestoreOnlineServingService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default FeaturestoreOnlineServingService scopes are:

GrpcClient

public virtual FeaturestoreOnlineServingService.FeaturestoreOnlineServingServiceClient GrpcClient { get; }

The underlying gRPC FeaturestoreOnlineServingService client

Property Value
Type Description
FeaturestoreOnlineServingServiceFeaturestoreOnlineServingServiceClient

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 FeaturestoreOnlineServingServiceClient Create()

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

Returns
Type Description
FeaturestoreOnlineServingServiceClient

The created FeaturestoreOnlineServingServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskFeaturestoreOnlineServingServiceClient

The task representing the created FeaturestoreOnlineServingServiceClient.

ReadFeatureValues(EntityTypeName, CallSettings)

public virtual ReadFeatureValuesResponse ReadFeatureValues(EntityTypeName entityType, CallSettings callSettings = null)

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Parameters
Name Description
entityType EntityTypeName

Required. The resource name of the EntityType for the entity being read. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
ReadFeatureValuesResponse

The RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = FeaturestoreOnlineServingServiceClient.Create();
// Initialize request argument(s)
EntityTypeName entityType = EntityTypeName.FromProjectLocationFeaturestoreEntityType("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
// Make the request
ReadFeatureValuesResponse response = featurestoreOnlineServingServiceClient.ReadFeatureValues(entityType);

ReadFeatureValues(ReadFeatureValuesRequest, CallSettings)

public virtual ReadFeatureValuesResponse ReadFeatureValues(ReadFeatureValuesRequest request, CallSettings callSettings = null)

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Parameters
Name Description
request ReadFeatureValuesRequest

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
ReadFeatureValuesResponse

The RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = FeaturestoreOnlineServingServiceClient.Create();
// Initialize request argument(s)
ReadFeatureValuesRequest request = new ReadFeatureValuesRequest
{
    EntityTypeAsEntityTypeName = EntityTypeName.FromProjectLocationFeaturestoreEntityType("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]"),
    EntityId = "",
    FeatureSelector = new FeatureSelector(),
};
// Make the request
ReadFeatureValuesResponse response = featurestoreOnlineServingServiceClient.ReadFeatureValues(request);

ReadFeatureValues(string, CallSettings)

public virtual ReadFeatureValuesResponse ReadFeatureValues(string entityType, CallSettings callSettings = null)

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Parameters
Name Description
entityType string

Required. The resource name of the EntityType for the entity being read. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
ReadFeatureValuesResponse

The RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = FeaturestoreOnlineServingServiceClient.Create();
// Initialize request argument(s)
string entityType = "projects/[PROJECT]/locations/[LOCATION]/featurestores/[FEATURESTORE]/entityTypes/[ENTITY_TYPE]";
// Make the request
ReadFeatureValuesResponse response = featurestoreOnlineServingServiceClient.ReadFeatureValues(entityType);

ReadFeatureValuesAsync(EntityTypeName, CallSettings)

public virtual Task<ReadFeatureValuesResponse> ReadFeatureValuesAsync(EntityTypeName entityType, CallSettings callSettings = null)

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Parameters
Name Description
entityType EntityTypeName

Required. The resource name of the EntityType for the entity being read. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskReadFeatureValuesResponse

A Task containing the RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = await FeaturestoreOnlineServingServiceClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName entityType = EntityTypeName.FromProjectLocationFeaturestoreEntityType("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
// Make the request
ReadFeatureValuesResponse response = await featurestoreOnlineServingServiceClient.ReadFeatureValuesAsync(entityType);

ReadFeatureValuesAsync(EntityTypeName, CancellationToken)

public virtual Task<ReadFeatureValuesResponse> ReadFeatureValuesAsync(EntityTypeName entityType, CancellationToken cancellationToken)

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Parameters
Name Description
entityType EntityTypeName

Required. The resource name of the EntityType for the entity being read. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskReadFeatureValuesResponse

A Task containing the RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = await FeaturestoreOnlineServingServiceClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName entityType = EntityTypeName.FromProjectLocationFeaturestoreEntityType("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
// Make the request
ReadFeatureValuesResponse response = await featurestoreOnlineServingServiceClient.ReadFeatureValuesAsync(entityType);

ReadFeatureValuesAsync(ReadFeatureValuesRequest, CallSettings)

public virtual Task<ReadFeatureValuesResponse> ReadFeatureValuesAsync(ReadFeatureValuesRequest request, CallSettings callSettings = null)

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Parameters
Name Description
request ReadFeatureValuesRequest

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
TaskReadFeatureValuesResponse

A Task containing the RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = await FeaturestoreOnlineServingServiceClient.CreateAsync();
// Initialize request argument(s)
ReadFeatureValuesRequest request = new ReadFeatureValuesRequest
{
    EntityTypeAsEntityTypeName = EntityTypeName.FromProjectLocationFeaturestoreEntityType("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]"),
    EntityId = "",
    FeatureSelector = new FeatureSelector(),
};
// Make the request
ReadFeatureValuesResponse response = await featurestoreOnlineServingServiceClient.ReadFeatureValuesAsync(request);

ReadFeatureValuesAsync(ReadFeatureValuesRequest, CancellationToken)

public virtual Task<ReadFeatureValuesResponse> ReadFeatureValuesAsync(ReadFeatureValuesRequest request, CancellationToken cancellationToken)

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Parameters
Name Description
request ReadFeatureValuesRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskReadFeatureValuesResponse

A Task containing the RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = await FeaturestoreOnlineServingServiceClient.CreateAsync();
// Initialize request argument(s)
ReadFeatureValuesRequest request = new ReadFeatureValuesRequest
{
    EntityTypeAsEntityTypeName = EntityTypeName.FromProjectLocationFeaturestoreEntityType("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]"),
    EntityId = "",
    FeatureSelector = new FeatureSelector(),
};
// Make the request
ReadFeatureValuesResponse response = await featurestoreOnlineServingServiceClient.ReadFeatureValuesAsync(request);

ReadFeatureValuesAsync(string, CallSettings)

public virtual Task<ReadFeatureValuesResponse> ReadFeatureValuesAsync(string entityType, CallSettings callSettings = null)

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Parameters
Name Description
entityType string

Required. The resource name of the EntityType for the entity being read. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskReadFeatureValuesResponse

A Task containing the RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = await FeaturestoreOnlineServingServiceClient.CreateAsync();
// Initialize request argument(s)
string entityType = "projects/[PROJECT]/locations/[LOCATION]/featurestores/[FEATURESTORE]/entityTypes/[ENTITY_TYPE]";
// Make the request
ReadFeatureValuesResponse response = await featurestoreOnlineServingServiceClient.ReadFeatureValuesAsync(entityType);

ReadFeatureValuesAsync(string, CancellationToken)

public virtual Task<ReadFeatureValuesResponse> ReadFeatureValuesAsync(string entityType, CancellationToken cancellationToken)

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Parameters
Name Description
entityType string

Required. The resource name of the EntityType for the entity being read. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskReadFeatureValuesResponse

A Task containing the RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = await FeaturestoreOnlineServingServiceClient.CreateAsync();
// Initialize request argument(s)
string entityType = "projects/[PROJECT]/locations/[LOCATION]/featurestores/[FEATURESTORE]/entityTypes/[ENTITY_TYPE]";
// Make the request
ReadFeatureValuesResponse response = await featurestoreOnlineServingServiceClient.ReadFeatureValuesAsync(entityType);

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.

StreamingReadFeatureValues(EntityTypeName, CallSettings)

public virtual FeaturestoreOnlineServingServiceClient.StreamingReadFeatureValuesStream StreamingReadFeatureValues(EntityTypeName entityType, CallSettings callSettings = null)

Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.

Parameters
Name Description
entityType EntityTypeName

Required. The resource name of the entities' type. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
FeaturestoreOnlineServingServiceClientStreamingReadFeatureValuesStream

The server stream.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = FeaturestoreOnlineServingServiceClient.Create();
// Initialize request argument(s)
EntityTypeName entityType = EntityTypeName.FromProjectLocationFeaturestoreEntityType("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
// Make the request, returning a streaming response
using FeaturestoreOnlineServingServiceClient.StreamingReadFeatureValuesStream response = featurestoreOnlineServingServiceClient.StreamingReadFeatureValues(entityType);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadFeatureValuesResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadFeatureValuesResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

StreamingReadFeatureValues(StreamingReadFeatureValuesRequest, CallSettings)

public virtual FeaturestoreOnlineServingServiceClient.StreamingReadFeatureValuesStream StreamingReadFeatureValues(StreamingReadFeatureValuesRequest request, CallSettings callSettings = null)

Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.

Parameters
Name Description
request StreamingReadFeatureValuesRequest

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
FeaturestoreOnlineServingServiceClientStreamingReadFeatureValuesStream

The server stream.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = FeaturestoreOnlineServingServiceClient.Create();
// Initialize request argument(s)
StreamingReadFeatureValuesRequest request = new StreamingReadFeatureValuesRequest
{
    EntityTypeAsEntityTypeName = EntityTypeName.FromProjectLocationFeaturestoreEntityType("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]"),
    EntityIds = { "", },
    FeatureSelector = new FeatureSelector(),
};
// Make the request, returning a streaming response
using FeaturestoreOnlineServingServiceClient.StreamingReadFeatureValuesStream response = featurestoreOnlineServingServiceClient.StreamingReadFeatureValues(request);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadFeatureValuesResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadFeatureValuesResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

StreamingReadFeatureValues(string, CallSettings)

public virtual FeaturestoreOnlineServingServiceClient.StreamingReadFeatureValuesStream StreamingReadFeatureValues(string entityType, CallSettings callSettings = null)

Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.

Parameters
Name Description
entityType string

Required. The resource name of the entities' type. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
FeaturestoreOnlineServingServiceClientStreamingReadFeatureValuesStream

The server stream.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = FeaturestoreOnlineServingServiceClient.Create();
// Initialize request argument(s)
string entityType = "projects/[PROJECT]/locations/[LOCATION]/featurestores/[FEATURESTORE]/entityTypes/[ENTITY_TYPE]";
// Make the request, returning a streaming response
using FeaturestoreOnlineServingServiceClient.StreamingReadFeatureValuesStream response = featurestoreOnlineServingServiceClient.StreamingReadFeatureValues(entityType);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadFeatureValuesResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadFeatureValuesResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

WriteFeatureValues(EntityTypeName, IEnumerable<WriteFeatureValuesPayload>, CallSettings)

public virtual WriteFeatureValuesResponse WriteFeatureValues(EntityTypeName entityType, IEnumerable<WriteFeatureValuesPayload> payloads, CallSettings callSettings = null)

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

Parameters
Name Description
entityType EntityTypeName

Required. The resource name of the EntityType for the entities being written. Value format: projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

payloads IEnumerableWriteFeatureValuesPayload

Required. The entities to be written. Up to 100,000 feature values can be written across all payloads.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
WriteFeatureValuesResponse

The RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = FeaturestoreOnlineServingServiceClient.Create();
// Initialize request argument(s)
EntityTypeName entityType = EntityTypeName.FromProjectLocationFeaturestoreEntityType("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
IEnumerable<WriteFeatureValuesPayload> payloads = new WriteFeatureValuesPayload[]
{
    new WriteFeatureValuesPayload(),
};
// Make the request
WriteFeatureValuesResponse response = featurestoreOnlineServingServiceClient.WriteFeatureValues(entityType, payloads);

WriteFeatureValues(WriteFeatureValuesRequest, CallSettings)

public virtual WriteFeatureValuesResponse WriteFeatureValues(WriteFeatureValuesRequest request, CallSettings callSettings = null)

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

Parameters
Name Description
request WriteFeatureValuesRequest

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
WriteFeatureValuesResponse

The RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = FeaturestoreOnlineServingServiceClient.Create();
// Initialize request argument(s)
WriteFeatureValuesRequest request = new WriteFeatureValuesRequest
{
    EntityTypeAsEntityTypeName = EntityTypeName.FromProjectLocationFeaturestoreEntityType("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]"),
    Payloads =
    {
        new WriteFeatureValuesPayload(),
    },
};
// Make the request
WriteFeatureValuesResponse response = featurestoreOnlineServingServiceClient.WriteFeatureValues(request);

WriteFeatureValues(string, IEnumerable<WriteFeatureValuesPayload>, CallSettings)

public virtual WriteFeatureValuesResponse WriteFeatureValues(string entityType, IEnumerable<WriteFeatureValuesPayload> payloads, CallSettings callSettings = null)

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

Parameters
Name Description
entityType string

Required. The resource name of the EntityType for the entities being written. Value format: projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

payloads IEnumerableWriteFeatureValuesPayload

Required. The entities to be written. Up to 100,000 feature values can be written across all payloads.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
WriteFeatureValuesResponse

The RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = FeaturestoreOnlineServingServiceClient.Create();
// Initialize request argument(s)
string entityType = "projects/[PROJECT]/locations/[LOCATION]/featurestores/[FEATURESTORE]/entityTypes/[ENTITY_TYPE]";
IEnumerable<WriteFeatureValuesPayload> payloads = new WriteFeatureValuesPayload[]
{
    new WriteFeatureValuesPayload(),
};
// Make the request
WriteFeatureValuesResponse response = featurestoreOnlineServingServiceClient.WriteFeatureValues(entityType, payloads);

WriteFeatureValuesAsync(EntityTypeName, IEnumerable<WriteFeatureValuesPayload>, CallSettings)

public virtual Task<WriteFeatureValuesResponse> WriteFeatureValuesAsync(EntityTypeName entityType, IEnumerable<WriteFeatureValuesPayload> payloads, CallSettings callSettings = null)

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

Parameters
Name Description
entityType EntityTypeName

Required. The resource name of the EntityType for the entities being written. Value format: projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

payloads IEnumerableWriteFeatureValuesPayload

Required. The entities to be written. Up to 100,000 feature values can be written across all payloads.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskWriteFeatureValuesResponse

A Task containing the RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = await FeaturestoreOnlineServingServiceClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName entityType = EntityTypeName.FromProjectLocationFeaturestoreEntityType("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
IEnumerable<WriteFeatureValuesPayload> payloads = new WriteFeatureValuesPayload[]
{
    new WriteFeatureValuesPayload(),
};
// Make the request
WriteFeatureValuesResponse response = await featurestoreOnlineServingServiceClient.WriteFeatureValuesAsync(entityType, payloads);

WriteFeatureValuesAsync(EntityTypeName, IEnumerable<WriteFeatureValuesPayload>, CancellationToken)

public virtual Task<WriteFeatureValuesResponse> WriteFeatureValuesAsync(EntityTypeName entityType, IEnumerable<WriteFeatureValuesPayload> payloads, CancellationToken cancellationToken)

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

Parameters
Name Description
entityType EntityTypeName

Required. The resource name of the EntityType for the entities being written. Value format: projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

payloads IEnumerableWriteFeatureValuesPayload

Required. The entities to be written. Up to 100,000 feature values can be written across all payloads.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskWriteFeatureValuesResponse

A Task containing the RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = await FeaturestoreOnlineServingServiceClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName entityType = EntityTypeName.FromProjectLocationFeaturestoreEntityType("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
IEnumerable<WriteFeatureValuesPayload> payloads = new WriteFeatureValuesPayload[]
{
    new WriteFeatureValuesPayload(),
};
// Make the request
WriteFeatureValuesResponse response = await featurestoreOnlineServingServiceClient.WriteFeatureValuesAsync(entityType, payloads);

WriteFeatureValuesAsync(WriteFeatureValuesRequest, CallSettings)

public virtual Task<WriteFeatureValuesResponse> WriteFeatureValuesAsync(WriteFeatureValuesRequest request, CallSettings callSettings = null)

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

Parameters
Name Description
request WriteFeatureValuesRequest

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
TaskWriteFeatureValuesResponse

A Task containing the RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = await FeaturestoreOnlineServingServiceClient.CreateAsync();
// Initialize request argument(s)
WriteFeatureValuesRequest request = new WriteFeatureValuesRequest
{
    EntityTypeAsEntityTypeName = EntityTypeName.FromProjectLocationFeaturestoreEntityType("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]"),
    Payloads =
    {
        new WriteFeatureValuesPayload(),
    },
};
// Make the request
WriteFeatureValuesResponse response = await featurestoreOnlineServingServiceClient.WriteFeatureValuesAsync(request);

WriteFeatureValuesAsync(WriteFeatureValuesRequest, CancellationToken)

public virtual Task<WriteFeatureValuesResponse> WriteFeatureValuesAsync(WriteFeatureValuesRequest request, CancellationToken cancellationToken)

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

Parameters
Name Description
request WriteFeatureValuesRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskWriteFeatureValuesResponse

A Task containing the RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = await FeaturestoreOnlineServingServiceClient.CreateAsync();
// Initialize request argument(s)
WriteFeatureValuesRequest request = new WriteFeatureValuesRequest
{
    EntityTypeAsEntityTypeName = EntityTypeName.FromProjectLocationFeaturestoreEntityType("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]"),
    Payloads =
    {
        new WriteFeatureValuesPayload(),
    },
};
// Make the request
WriteFeatureValuesResponse response = await featurestoreOnlineServingServiceClient.WriteFeatureValuesAsync(request);

WriteFeatureValuesAsync(string, IEnumerable<WriteFeatureValuesPayload>, CallSettings)

public virtual Task<WriteFeatureValuesResponse> WriteFeatureValuesAsync(string entityType, IEnumerable<WriteFeatureValuesPayload> payloads, CallSettings callSettings = null)

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

Parameters
Name Description
entityType string

Required. The resource name of the EntityType for the entities being written. Value format: projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

payloads IEnumerableWriteFeatureValuesPayload

Required. The entities to be written. Up to 100,000 feature values can be written across all payloads.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskWriteFeatureValuesResponse

A Task containing the RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = await FeaturestoreOnlineServingServiceClient.CreateAsync();
// Initialize request argument(s)
string entityType = "projects/[PROJECT]/locations/[LOCATION]/featurestores/[FEATURESTORE]/entityTypes/[ENTITY_TYPE]";
IEnumerable<WriteFeatureValuesPayload> payloads = new WriteFeatureValuesPayload[]
{
    new WriteFeatureValuesPayload(),
};
// Make the request
WriteFeatureValuesResponse response = await featurestoreOnlineServingServiceClient.WriteFeatureValuesAsync(entityType, payloads);

WriteFeatureValuesAsync(string, IEnumerable<WriteFeatureValuesPayload>, CancellationToken)

public virtual Task<WriteFeatureValuesResponse> WriteFeatureValuesAsync(string entityType, IEnumerable<WriteFeatureValuesPayload> payloads, CancellationToken cancellationToken)

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

Parameters
Name Description
entityType string

Required. The resource name of the EntityType for the entities being written. Value format: projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

payloads IEnumerableWriteFeatureValuesPayload

Required. The entities to be written. Up to 100,000 feature values can be written across all payloads.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskWriteFeatureValuesResponse

A Task containing the RPC response.

Example
// Create client
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient = await FeaturestoreOnlineServingServiceClient.CreateAsync();
// Initialize request argument(s)
string entityType = "projects/[PROJECT]/locations/[LOCATION]/featurestores/[FEATURESTORE]/entityTypes/[ENTITY_TYPE]";
IEnumerable<WriteFeatureValuesPayload> payloads = new WriteFeatureValuesPayload[]
{
    new WriteFeatureValuesPayload(),
};
// Make the request
WriteFeatureValuesResponse response = await featurestoreOnlineServingServiceClient.WriteFeatureValuesAsync(entityType, payloads);