com.google.cloud.aiplatform.v1beta1

Interface BatchReadFeatureValuesRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

BatchReadFeatureValuesRequest, BatchReadFeatureValuesRequest.Builder

public interface BatchReadFeatureValuesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
BigQuerySource	getBigqueryReadInstances() Similar to csv_read_instances, but from BigQuery source.
BigQuerySourceOrBuilder	getBigqueryReadInstancesOrBuilder() Similar to csv_read_instances, but from BigQuery source.
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.
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.
FeatureValueDestination	getDestination() Required.
FeatureValueDestinationOrBuilder	getDestinationOrBuilder() Required.
BatchReadFeatureValuesRequest.EntityTypeSpec	getEntityTypeSpecs(int index) Required.
int	getEntityTypeSpecsCount() Required.
List<BatchReadFeatureValuesRequest.EntityTypeSpec>	getEntityTypeSpecsList() Required.
BatchReadFeatureValuesRequest.EntityTypeSpecOrBuilder	getEntityTypeSpecsOrBuilder(int index) Required.
List<? extends BatchReadFeatureValuesRequest.EntityTypeSpecOrBuilder>	getEntityTypeSpecsOrBuilderList() Required.
String	getFeaturestore() Required.
com.google.protobuf.ByteString	getFeaturestoreBytes() Required.
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.
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.
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.
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.
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.
BatchReadFeatureValuesRequest.ReadOptionCase	getReadOptionCase()
com.google.protobuf.Timestamp	getStartTime() Optional.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Optional.
boolean	hasBigqueryReadInstances() Similar to csv_read_instances, but from BigQuery source.
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.
boolean	hasDestination() Required.
boolean	hasStartTime() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasCsvReadInstances

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:

Whether the csvReadInstances field is set.

getCsvReadInstances

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:

The csvReadInstances.

getCsvReadInstancesOrBuilder

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;

hasBigqueryReadInstances

boolean hasBigqueryReadInstances()

 Similar to csv_read_instances, but from BigQuery source.
 

.google.cloud.aiplatform.v1beta1.BigQuerySource bigquery_read_instances = 5;

Returns:

Whether the bigqueryReadInstances field is set.

getBigqueryReadInstances

BigQuerySource getBigqueryReadInstances()

 Similar to csv_read_instances, but from BigQuery source.
 

.google.cloud.aiplatform.v1beta1.BigQuerySource bigquery_read_instances = 5;

Returns:

The bigqueryReadInstances.

getBigqueryReadInstancesOrBuilder

BigQuerySourceOrBuilder getBigqueryReadInstancesOrBuilder()

 Similar to csv_read_instances, but from BigQuery source.
 

.google.cloud.aiplatform.v1beta1.BigQuerySource bigquery_read_instances = 5;

getFeaturestore

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:

The featurestore.

getFeaturestoreBytes

com.google.protobuf.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:

The bytes for featurestore.

hasDestination

boolean hasDestination()

 Required. Specifies output location and format.
 

.google.cloud.aiplatform.v1beta1.FeatureValueDestination destination = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the destination field is set.

getDestination

FeatureValueDestination getDestination()

 Required. Specifies output location and format.
 

.google.cloud.aiplatform.v1beta1.FeatureValueDestination destination = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

The destination.

getDestinationOrBuilder

FeatureValueDestinationOrBuilder getDestinationOrBuilder()

 Required. Specifies output location and format.
 

.google.cloud.aiplatform.v1beta1.FeatureValueDestination destination = 4 [(.google.api.field_behavior) = REQUIRED];

getPassThroughFieldsList

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;

getPassThroughFields

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;

getPassThroughFieldsCount

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;

getPassThroughFieldsOrBuilderList

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;

getPassThroughFieldsOrBuilder

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;

getEntityTypeSpecsList

List<BatchReadFeatureValuesRequest.EntityTypeSpec> getEntityTypeSpecsList()

 Required. Specifies EntityType grouping Features to read values of and
 settings.
 

repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

getEntityTypeSpecs

BatchReadFeatureValuesRequest.EntityTypeSpec getEntityTypeSpecs(int index)

 Required. Specifies EntityType grouping Features to read values of and
 settings.
 

repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

getEntityTypeSpecsCount

int getEntityTypeSpecsCount()

 Required. Specifies EntityType grouping Features to read values of and
 settings.
 

repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

getEntityTypeSpecsOrBuilderList

List<? extends BatchReadFeatureValuesRequest.EntityTypeSpecOrBuilder> getEntityTypeSpecsOrBuilderList()

 Required. Specifies EntityType grouping Features to read values of and
 settings.
 

repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

getEntityTypeSpecsOrBuilder

BatchReadFeatureValuesRequest.EntityTypeSpecOrBuilder getEntityTypeSpecsOrBuilder(int index)

 Required. Specifies EntityType grouping Features to read values of and
 settings.
 

repeated .google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

hasStartTime

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:

Whether the startTime field is set.

getStartTime

com.google.protobuf.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:

The startTime.

getStartTimeOrBuilder

com.google.protobuf.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];

getReadOptionCase

BatchReadFeatureValuesRequest.ReadOptionCase getReadOptionCase()