Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class BatchReadFeatureValuesRequest.
Request message for FeaturestoreService.BatchReadFeatureValues.
Generated from protobuf message google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ csv_read_instances |
Google\Cloud\AIPlatform\V1\CsvSource
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 |
↳ bigquery_read_instances |
Google\Cloud\AIPlatform\V1\BigQuerySource
Similar to csv_read_instances, but from BigQuery source. |
↳ featurestore |
string
Required. The resource name of the Featurestore from which to query Feature values. Format: |
↳ destination |
Google\Cloud\AIPlatform\V1\FeatureValueDestination
Required. Specifies output location and format. |
↳ pass_through_fields |
array<Google\Cloud\AIPlatform\V1\BatchReadFeatureValuesRequest\PassThroughField>
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. |
↳ entity_type_specs |
array<Google\Cloud\AIPlatform\V1\BatchReadFeatureValuesRequest\EntityTypeSpec>
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 . |
↳ start_time |
Google\Protobuf\Timestamp
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. |
getCsvReadInstances
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.
Generated from protobuf field .google.cloud.aiplatform.v1.CsvSource csv_read_instances = 3;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\CsvSource|null | |
hasCsvReadInstances
setCsvReadInstances
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.
Generated from protobuf field .google.cloud.aiplatform.v1.CsvSource csv_read_instances = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\CsvSource
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBigqueryReadInstances
Similar to csv_read_instances, but from BigQuery source.
Generated from protobuf field .google.cloud.aiplatform.v1.BigQuerySource bigquery_read_instances = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\BigQuerySource|null | |
hasBigqueryReadInstances
setBigqueryReadInstances
Similar to csv_read_instances, but from BigQuery source.
Generated from protobuf field .google.cloud.aiplatform.v1.BigQuerySource bigquery_read_instances = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\BigQuerySource
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFeaturestore
Required. The resource name of the Featurestore from which to query Feature values.
Format:
projects/{project}/locations/{location}/featurestores/{featurestore}
Generated from protobuf field string featurestore = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setFeaturestore
Required. The resource name of the Featurestore from which to query Feature values.
Format:
projects/{project}/locations/{location}/featurestores/{featurestore}
Generated from protobuf field string featurestore = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDestination
Required. Specifies output location and format.
Generated from protobuf field .google.cloud.aiplatform.v1.FeatureValueDestination destination = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\FeatureValueDestination|null | |
hasDestination
clearDestination
setDestination
Required. Specifies output location and format.
Generated from protobuf field .google.cloud.aiplatform.v1.FeatureValueDestination destination = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\FeatureValueDestination
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPassThroughFields
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.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setPassThroughFields
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.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\BatchReadFeatureValuesRequest\PassThroughField>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEntityTypeSpecs
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 .
Generated from protobuf field repeated .google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setEntityTypeSpecs
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 .
Generated from protobuf field repeated .google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\BatchReadFeatureValuesRequest\EntityTypeSpec>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartTime
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.
Generated from protobuf field .google.protobuf.Timestamp start_time = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
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.
Generated from protobuf field .google.protobuf.Timestamp start_time = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReadOption
| Returns | |
|---|---|
| Type | Description |
string | |