- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public interface BatchReadFeatureValuesRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBigqueryReadInstances()
public abstract BigQuerySource getBigqueryReadInstances()Similar to csv_read_instances, but from BigQuery source.
.google.cloud.aiplatform.v1beta1.BigQuerySource bigquery_read_instances = 5;
| Returns | |
|---|---|
| Type | Description |
BigQuerySource | The bigqueryReadInstances. |
getBigqueryReadInstancesOrBuilder()
public abstract BigQuerySourceOrBuilder getBigqueryReadInstancesOrBuilder()Similar to csv_read_instances, but from BigQuery source.
.google.cloud.aiplatform.v1beta1.BigQuerySource bigquery_read_instances = 5;
| Returns | |
|---|---|
| Type | Description |
BigQuerySourceOrBuilder | |
getCsvReadInstances()
public abstract CsvSource 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.
.google.cloud.aiplatform.v1beta1.CsvSource csv_read_instances = 3;
| Returns | |
|---|---|
| Type | Description |
CsvSource | The csvReadInstances. |
getCsvReadInstancesOrBuilder()
public abstract CsvSourceOrBuilder getCsvReadInstancesOrBuilder() 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.
.google.cloud.aiplatform.v1beta1.CsvSource csv_read_instances = 3;
| Returns | |
|---|---|
| Type | Description |
CsvSourceOrBuilder | |
getDestination()
public abstract FeatureValueDestination getDestination()Required. Specifies output location and format.
.google.cloud.aiplatform.v1beta1.FeatureValueDestination destination = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
FeatureValueDestination | The destination. |
getDestinationOrBuilder()
public abstract FeatureValueDestinationOrBuilder getDestinationOrBuilder()Required. Specifies output location and format.
.google.cloud.aiplatform.v1beta1.FeatureValueDestination destination = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
FeatureValueDestinationOrBuilder | |
getEntityTypeSpecs(int index)
public abstract BatchReadFeatureValuesRequest.EntityTypeSpec getEntityTypeSpecs(int index)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][] .
repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
BatchReadFeatureValuesRequest.EntityTypeSpec | |
getEntityTypeSpecsCount()
public abstract int getEntityTypeSpecsCount()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][] .
repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | |
getEntityTypeSpecsList()
public abstract List<BatchReadFeatureValuesRequest.EntityTypeSpec> getEntityTypeSpecsList()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][] .
repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<EntityTypeSpec> | |
getEntityTypeSpecsOrBuilder(int index)
public abstract BatchReadFeatureValuesRequest.EntityTypeSpecOrBuilder getEntityTypeSpecsOrBuilder(int index)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][] .
repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
BatchReadFeatureValuesRequest.EntityTypeSpecOrBuilder | |
getEntityTypeSpecsOrBuilderList()
public abstract List<? extends BatchReadFeatureValuesRequest.EntityTypeSpecOrBuilder> getEntityTypeSpecsOrBuilderList()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][] .
repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpecOrBuilder> | |
getFeaturestore()
public abstract String getFeaturestore() Required. The resource name of the Featurestore from which to query Feature
values. Format:
projects/{project}/locations/{location}/featurestores/{featurestore}
string featurestore = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The featurestore. |
getFeaturestoreBytes()
public abstract ByteString getFeaturestoreBytes() Required. The resource name of the Featurestore from which to query Feature
values. Format:
projects/{project}/locations/{location}/featurestores/{featurestore}
string featurestore = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for featurestore. |
getPassThroughFields(int index)
public abstract BatchReadFeatureValuesRequest.PassThroughField getPassThroughFields(int index)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.
repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
BatchReadFeatureValuesRequest.PassThroughField | |
getPassThroughFieldsCount()
public abstract int getPassThroughFieldsCount()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.
repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;
| Returns | |
|---|---|
| Type | Description |
int | |
getPassThroughFieldsList()
public abstract List<BatchReadFeatureValuesRequest.PassThroughField> getPassThroughFieldsList()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.
repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;
| Returns | |
|---|---|
| Type | Description |
List<PassThroughField> | |
getPassThroughFieldsOrBuilder(int index)
public abstract BatchReadFeatureValuesRequest.PassThroughFieldOrBuilder getPassThroughFieldsOrBuilder(int index)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.
repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
BatchReadFeatureValuesRequest.PassThroughFieldOrBuilder | |
getPassThroughFieldsOrBuilderList()
public abstract List<? extends BatchReadFeatureValuesRequest.PassThroughFieldOrBuilder> getPassThroughFieldsOrBuilderList()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.
repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.PassThroughFieldOrBuilder> | |
getReadOptionCase()
public abstract BatchReadFeatureValuesRequest.ReadOptionCase getReadOptionCase()| Returns | |
|---|---|
| Type | Description |
BatchReadFeatureValuesRequest.ReadOptionCase | |
getStartTime()
public abstract Timestamp 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.
.google.protobuf.Timestamp start_time = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The startTime. |
getStartTimeOrBuilder()
public abstract TimestampOrBuilder getStartTimeOrBuilder()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.
.google.protobuf.Timestamp start_time = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
hasBigqueryReadInstances()
public abstract boolean hasBigqueryReadInstances()Similar to csv_read_instances, but from BigQuery source.
.google.cloud.aiplatform.v1beta1.BigQuerySource bigquery_read_instances = 5;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the bigqueryReadInstances field is set. |
hasCsvReadInstances()
public abstract boolean hasCsvReadInstances() 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.
.google.cloud.aiplatform.v1beta1.CsvSource csv_read_instances = 3;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the csvReadInstances field is set. |
hasDestination()
public abstract boolean hasDestination()Required. Specifies output location and format.
.google.cloud.aiplatform.v1beta1.FeatureValueDestination destination = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the destination field is set. |
hasStartTime()
public abstract boolean hasStartTime()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.
.google.protobuf.Timestamp start_time = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the startTime field is set. |