Cloud AI Platform v1 API - Class BatchReadFeatureValuesRequest (2.6.0)

public sealed class BatchReadFeatureValuesRequest : IMessage<BatchReadFeatureValuesRequest>, IEquatable<BatchReadFeatureValuesRequest>, IDeepCloneable<BatchReadFeatureValuesRequest>, IBufferMessage, IMessage

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

Request message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues].

Inheritance

Object > BatchReadFeatureValuesRequest

Implements

IMessage<BatchReadFeatureValuesRequest>, IEquatable<BatchReadFeatureValuesRequest>, IDeepCloneable<BatchReadFeatureValuesRequest>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

BatchReadFeatureValuesRequest()

public BatchReadFeatureValuesRequest()

BatchReadFeatureValuesRequest(BatchReadFeatureValuesRequest)

public BatchReadFeatureValuesRequest(BatchReadFeatureValuesRequest other)

Parameter
Name	Description
`other`	`BatchReadFeatureValuesRequest`

Properties

BigqueryReadInstances

public BigQuerySource BigqueryReadInstances { get; set; }

Similar to csv_read_instances, but from BigQuery source.

Property Value
Type	Description
`BigQuerySource`

CsvReadInstances

public CsvSource CsvReadInstances { get; set; }

Each read instance consists of exactly one read timestamp and one or more entity IDs identifying entities of the corresponding EntityTypes whose Features are requested.

Each output instance contains Feature values of requested entities concatenated together as of the read time.

An example read instance may be foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z.

An example output instance may be foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z, foo_entity_feature1_value, bar_entity_feature2_value.

Timestamp in each read instance must be millisecond-aligned.

csv_read_instances are read instances stored in a plain-text CSV file. The header should be: [ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp

The columns can be in any order.

Values in the timestamp column must use the RFC 3339 format, e.g. 2012-07-30T10:43:17.123Z.

Property Value
Type	Description
`CsvSource`

Destination

public FeatureValueDestination Destination { get; set; }

Required. Specifies output location and format.

Property Value
Type	Description
`FeatureValueDestination`

EntityTypeSpecs

public RepeatedField<BatchReadFeatureValuesRequest.Types.EntityTypeSpec> EntityTypeSpecs { get; }

Required. Specifies EntityType grouping Features to read values of and settings. Each EntityType referenced in [BatchReadFeatureValuesRequest.entity_type_specs] must have a column specifying entity IDs in the EntityType in [BatchReadFeatureValuesRequest.request][] .

Property Value
Type	Description
`RepeatedField<BatchReadFeatureValuesRequest.Types.EntityTypeSpec>`

Featurestore

public string Featurestore { get; set; }

Required. The resource name of the Featurestore from which to query Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

Property Value
Type	Description
`String`

FeaturestoreAsFeaturestoreName

public FeaturestoreName FeaturestoreAsFeaturestoreName { get; set; }

FeaturestoreName-typed view over the Featurestore resource name property.

Property Value
Type	Description
`FeaturestoreName`

PassThroughFields

public RepeatedField<BatchReadFeatureValuesRequest.Types.PassThroughField> PassThroughFields { get; }

When not empty, the specified fields in the *_read_instances source will be joined as-is in the output, in addition to those fields from the Featurestore Entity.

For BigQuery source, the type of the pass-through values will be automatically inferred. For CSV source, the pass-through values will be passed as opaque bytes.

Property Value
Type	Description
`RepeatedField<BatchReadFeatureValuesRequest.Types.PassThroughField>`

ReadOptionCase

public BatchReadFeatureValuesRequest.ReadOptionOneofCase ReadOptionCase { get; }

Property Value
Type	Description
`BatchReadFeatureValuesRequest.ReadOptionOneofCase`

StartTime

public Timestamp StartTime { get; set; }

Optional. Excludes Feature values with feature generation timestamp before this timestamp. If not set, retrieve oldest values kept in Feature Store. Timestamp, if present, must not have higher than millisecond precision.

Property Value
Type	Description
`Timestamp`