Class BatchReadFeatureValuesRequest (3.44.0)

public final class BatchReadFeatureValuesRequest extends GeneratedMessageV3 implements BatchReadFeatureValuesRequestOrBuilder

Request message for FeaturestoreService.BatchReadFeatureValues.

Protobuf type google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest

Static Fields

BIGQUERY_READ_INSTANCES_FIELD_NUMBER

public static final int BIGQUERY_READ_INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

CSV_READ_INSTANCES_FIELD_NUMBER

public static final int CSV_READ_INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_FIELD_NUMBER

public static final int DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_TYPE_SPECS_FIELD_NUMBER

public static final int ENTITY_TYPE_SPECS_FIELD_NUMBER
Field Value
Type Description
int

FEATURESTORE_FIELD_NUMBER

public static final int FEATURESTORE_FIELD_NUMBER
Field Value
Type Description
int

PASS_THROUGH_FIELDS_FIELD_NUMBER

public static final int PASS_THROUGH_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BatchReadFeatureValuesRequest getDefaultInstance()
Returns
Type Description
BatchReadFeatureValuesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BatchReadFeatureValuesRequest.Builder newBuilder()
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

newBuilder(BatchReadFeatureValuesRequest prototype)

public static BatchReadFeatureValuesRequest.Builder newBuilder(BatchReadFeatureValuesRequest prototype)
Parameter
Name Description
prototype BatchReadFeatureValuesRequest
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

parseDelimitedFrom(InputStream input)

public static BatchReadFeatureValuesRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BatchReadFeatureValuesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchReadFeatureValuesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchReadFeatureValuesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BatchReadFeatureValuesRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BatchReadFeatureValuesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchReadFeatureValuesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchReadFeatureValuesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchReadFeatureValuesRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BatchReadFeatureValuesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchReadFeatureValuesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchReadFeatureValuesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchReadFeatureValuesRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BatchReadFeatureValuesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchReadFeatureValuesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchReadFeatureValuesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BatchReadFeatureValuesRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BatchReadFeatureValuesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchReadFeatureValuesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchReadFeatureValuesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BatchReadFeatureValuesRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BatchReadFeatureValuesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchReadFeatureValuesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchReadFeatureValuesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BatchReadFeatureValuesRequest> parser()
Returns
Type Description
Parser<BatchReadFeatureValuesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBigqueryReadInstances()

public 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 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 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 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

getDefaultInstanceForType()

public BatchReadFeatureValuesRequest getDefaultInstanceForType()
Returns
Type Description
BatchReadFeatureValuesRequest

getDestination()

public 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 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 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];

Parameter
Name Description
index int
Returns
Type Description
BatchReadFeatureValuesRequest.EntityTypeSpec

getEntityTypeSpecsCount()

public 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];

Returns
Type Description
int

getEntityTypeSpecsList()

public 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];

Returns
Type Description
List<EntityTypeSpec>

getEntityTypeSpecsOrBuilder(int index)

public 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];

Parameter
Name Description
index int
Returns
Type Description
BatchReadFeatureValuesRequest.EntityTypeSpecOrBuilder

getEntityTypeSpecsOrBuilderList()

public 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];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpecOrBuilder>

getFeaturestore()

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.

getFeaturestoreBytes()

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.

getParserForType()

public Parser<BatchReadFeatureValuesRequest> getParserForType()
Returns
Type Description
Parser<BatchReadFeatureValuesRequest>
Overrides

getPassThroughFields(int index)

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
Returns
Type Description
BatchReadFeatureValuesRequest.PassThroughField

getPassThroughFieldsCount()

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

getPassThroughFieldsList()

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;

Returns
Type Description
List<PassThroughField>

getPassThroughFieldsOrBuilder(int index)

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
Returns
Type Description
BatchReadFeatureValuesRequest.PassThroughFieldOrBuilder

getPassThroughFieldsOrBuilderList()

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>

getReadOptionCase()

public BatchReadFeatureValuesRequest.ReadOptionCase getReadOptionCase()
Returns
Type Description
BatchReadFeatureValuesRequest.ReadOptionCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

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.

getStartTimeOrBuilder()

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];

Returns
Type Description
TimestampOrBuilder

hasBigqueryReadInstances()

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.

hasCsvReadInstances()

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.

hasDestination()

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.

hasStartTime()

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BatchReadFeatureValuesRequest.Builder newBuilderForType()
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchReadFeatureValuesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BatchReadFeatureValuesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BatchReadFeatureValuesRequest.Builder toBuilder()
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException