public final class BatchReadFeatureValuesRequest extends GeneratedMessageV3 implements BatchReadFeatureValuesRequestOrBuilder
Request message for
FeaturestoreService.BatchReadFeatureValues.
Protobuf type google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest
Static Fields
public static final int BIGQUERY_READ_INSTANCES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int CSV_READ_INSTANCES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DESTINATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ENTITY_TYPE_SPECS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int FEATURESTORE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PASS_THROUGH_FIELDS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int START_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static BatchReadFeatureValuesRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static BatchReadFeatureValuesRequest.Builder newBuilder()
public static BatchReadFeatureValuesRequest.Builder newBuilder(BatchReadFeatureValuesRequest prototype)
public static BatchReadFeatureValuesRequest parseDelimitedFrom(InputStream input)
public static BatchReadFeatureValuesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchReadFeatureValuesRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static BatchReadFeatureValuesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchReadFeatureValuesRequest parseFrom(ByteString data)
public static BatchReadFeatureValuesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchReadFeatureValuesRequest parseFrom(CodedInputStream input)
public static BatchReadFeatureValuesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchReadFeatureValuesRequest parseFrom(InputStream input)
public static BatchReadFeatureValuesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchReadFeatureValuesRequest parseFrom(ByteBuffer data)
public static BatchReadFeatureValuesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<BatchReadFeatureValuesRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public BigQuerySource getBigqueryReadInstances()
Similar to csv_read_instances, but from BigQuery source.
.google.cloud.aiplatform.v1beta1.BigQuerySource bigquery_read_instances = 5;
public BigQuerySourceOrBuilder getBigqueryReadInstancesOrBuilder()
Similar to csv_read_instances, but from BigQuery source.
.google.cloud.aiplatform.v1beta1.BigQuerySource bigquery_read_instances = 5;
public 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.
|
public 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;
public BatchReadFeatureValuesRequest getDefaultInstanceForType()
public FeatureValueDestination getDestination()
Required. Specifies output location and format.
.google.cloud.aiplatform.v1beta1.FeatureValueDestination destination = 4 [(.google.api.field_behavior) = REQUIRED];
public FeatureValueDestinationOrBuilder getDestinationOrBuilder()
Required. Specifies output location and format.
.google.cloud.aiplatform.v1beta1.FeatureValueDestination destination = 4 [(.google.api.field_behavior) = REQUIRED];
public 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
|
public 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 | |
public 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];
public 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
|
public 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> | |
public 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.
|
public 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.
|
public Parser<BatchReadFeatureValuesRequest> getParserForType()
Overrides
public 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
|
public 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 | |
public 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;
public 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
|
public 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> | |
public BatchReadFeatureValuesRequest.ReadOptionCase getReadOptionCase()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public 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.
|
public 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];
public final UnknownFieldSet getUnknownFields()
Overrides
public 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.
|
public 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.
|
public 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.
|
public 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.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public BatchReadFeatureValuesRequest.Builder newBuilderForType()
protected BatchReadFeatureValuesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public BatchReadFeatureValuesRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
