Class FeaturestoreOnlineServingServiceClient (2.1.0)

public abstract 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
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default FeaturestoreOnlineServingService scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

The default FeaturestoreOnlineServingService scopes are:

GrpcClient

public virtual FeaturestoreOnlineServingService.FeaturestoreOnlineServingServiceClient GrpcClient { get; }

The underlying gRPC FeaturestoreOnlineServingService client

Property Value
TypeDescription
FeaturestoreOnlineServingService.FeaturestoreOnlineServingServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
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
TypeDescription
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
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
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
NameDescription
entityTypeEntityTypeName

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestReadFeatureValuesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
entityTypeString

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
entityTypeEntityTypeName

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
entityTypeEntityTypeName

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.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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
NameDescription
requestReadFeatureValuesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestReadFeatureValuesRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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
NameDescription
entityTypeString

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
entityTypeString

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.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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
TypeDescription
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
NameDescription
entityTypeEntityTypeName

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestStreamingReadFeatureValuesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
entityTypeString

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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