Class FeaturestoreOnlineServingServiceClient (1.0.0)

Version 1.0.0

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

public abstract class FeaturestoreOnlineServingServiceClient

FeaturestoreOnlineServingService client wrapper, for convenient use.

Inheritance

Object > FeaturestoreOnlineServingServiceClient

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Derived Types

FeaturestoreOnlineServingServiceClientImpl

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
IReadOnlyList<String>

Remarks

The default FeaturestoreOnlineServingService scopes are:

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

GrpcClient

public virtual FeaturestoreOnlineServingService.FeaturestoreOnlineServingServiceClient GrpcClient { get; }

The underlying gRPC FeaturestoreOnlineServingService client

Property Value
Type	Description
FeaturestoreOnlineServingService.FeaturestoreOnlineServingServiceClient

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(CancellationToken))

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
Task<FeaturestoreOnlineServingServiceClient>	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
Task<ReadFeatureValuesResponse>	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
Task<ReadFeatureValuesResponse>	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
Task<ReadFeatureValuesResponse>	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
Task<ReadFeatureValuesResponse>	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
Task<ReadFeatureValuesResponse>	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
Task<ReadFeatureValuesResponse>	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
FeaturestoreOnlineServingServiceClient.StreamingReadFeatureValuesStream	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
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
FeaturestoreOnlineServingServiceClient.StreamingReadFeatureValuesStream	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
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
FeaturestoreOnlineServingServiceClient.StreamingReadFeatureValuesStream	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
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