Class BatchReadFeatureValuesRequest.Builder (3.44.0)

public static final class BatchReadFeatureValuesRequest.Builder extends GeneratedMessageV3.Builder<BatchReadFeatureValuesRequest.Builder> implements BatchReadFeatureValuesRequestOrBuilder

Request message for FeaturestoreService.BatchReadFeatureValues.

Protobuf type google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest

Static Methods

getDescriptor()

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

Methods

addAllEntityTypeSpecs(Iterable<? extends BatchReadFeatureValuesRequest.EntityTypeSpec> values)

public BatchReadFeatureValuesRequest.Builder addAllEntityTypeSpecs(Iterable<? extends BatchReadFeatureValuesRequest.EntityTypeSpec> values)

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
values Iterable<? extends com.google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpec>
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

addAllPassThroughFields(Iterable<? extends BatchReadFeatureValuesRequest.PassThroughField> values)

public BatchReadFeatureValuesRequest.Builder addAllPassThroughFields(Iterable<? extends BatchReadFeatureValuesRequest.PassThroughField> values)

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
values Iterable<? extends com.google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.PassThroughField>
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

addEntityTypeSpecs(BatchReadFeatureValuesRequest.EntityTypeSpec value)

public BatchReadFeatureValuesRequest.Builder addEntityTypeSpecs(BatchReadFeatureValuesRequest.EntityTypeSpec value)

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
value BatchReadFeatureValuesRequest.EntityTypeSpec
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

addEntityTypeSpecs(BatchReadFeatureValuesRequest.EntityTypeSpec.Builder builderForValue)

public BatchReadFeatureValuesRequest.Builder addEntityTypeSpecs(BatchReadFeatureValuesRequest.EntityTypeSpec.Builder builderForValue)

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
builderForValue BatchReadFeatureValuesRequest.EntityTypeSpec.Builder
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

addEntityTypeSpecs(int index, BatchReadFeatureValuesRequest.EntityTypeSpec value)

public BatchReadFeatureValuesRequest.Builder addEntityTypeSpecs(int index, BatchReadFeatureValuesRequest.EntityTypeSpec value)

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

Parameters
Name Description
index int
value BatchReadFeatureValuesRequest.EntityTypeSpec
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

addEntityTypeSpecs(int index, BatchReadFeatureValuesRequest.EntityTypeSpec.Builder builderForValue)

public BatchReadFeatureValuesRequest.Builder addEntityTypeSpecs(int index, BatchReadFeatureValuesRequest.EntityTypeSpec.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue BatchReadFeatureValuesRequest.EntityTypeSpec.Builder
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

addEntityTypeSpecsBuilder()

public BatchReadFeatureValuesRequest.EntityTypeSpec.Builder addEntityTypeSpecsBuilder()

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
BatchReadFeatureValuesRequest.EntityTypeSpec.Builder

addEntityTypeSpecsBuilder(int index)

public BatchReadFeatureValuesRequest.EntityTypeSpec.Builder addEntityTypeSpecsBuilder(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.Builder

addPassThroughFields(BatchReadFeatureValuesRequest.PassThroughField value)

public BatchReadFeatureValuesRequest.Builder addPassThroughFields(BatchReadFeatureValuesRequest.PassThroughField value)

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

addPassThroughFields(BatchReadFeatureValuesRequest.PassThroughField.Builder builderForValue)

public BatchReadFeatureValuesRequest.Builder addPassThroughFields(BatchReadFeatureValuesRequest.PassThroughField.Builder builderForValue)

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

addPassThroughFields(int index, BatchReadFeatureValuesRequest.PassThroughField value)

public BatchReadFeatureValuesRequest.Builder addPassThroughFields(int index, BatchReadFeatureValuesRequest.PassThroughField value)

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;

Parameters
Name Description
index int
value BatchReadFeatureValuesRequest.PassThroughField
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

addPassThroughFields(int index, BatchReadFeatureValuesRequest.PassThroughField.Builder builderForValue)

public BatchReadFeatureValuesRequest.Builder addPassThroughFields(int index, BatchReadFeatureValuesRequest.PassThroughField.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue BatchReadFeatureValuesRequest.PassThroughField.Builder
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

addPassThroughFieldsBuilder()

public BatchReadFeatureValuesRequest.PassThroughField.Builder addPassThroughFieldsBuilder()

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
BatchReadFeatureValuesRequest.PassThroughField.Builder

addPassThroughFieldsBuilder(int index)

public BatchReadFeatureValuesRequest.PassThroughField.Builder addPassThroughFieldsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchReadFeatureValuesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BatchReadFeatureValuesRequest.Builder
Overrides

build()

public BatchReadFeatureValuesRequest build()
Returns
Type Description
BatchReadFeatureValuesRequest

buildPartial()

public BatchReadFeatureValuesRequest buildPartial()
Returns
Type Description
BatchReadFeatureValuesRequest

clear()

public BatchReadFeatureValuesRequest.Builder clear()
Returns
Type Description
BatchReadFeatureValuesRequest.Builder
Overrides

clearBigqueryReadInstances()

public BatchReadFeatureValuesRequest.Builder clearBigqueryReadInstances()

Similar to csv_read_instances, but from BigQuery source.

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

Returns
Type Description
BatchReadFeatureValuesRequest.Builder

clearCsvReadInstances()

public BatchReadFeatureValuesRequest.Builder clearCsvReadInstances()

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
BatchReadFeatureValuesRequest.Builder

clearDestination()

public BatchReadFeatureValuesRequest.Builder clearDestination()

Required. Specifies output location and format.

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

Returns
Type Description
BatchReadFeatureValuesRequest.Builder

clearEntityTypeSpecs()

public BatchReadFeatureValuesRequest.Builder clearEntityTypeSpecs()

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
BatchReadFeatureValuesRequest.Builder

clearFeaturestore()

public BatchReadFeatureValuesRequest.Builder clearFeaturestore()

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
BatchReadFeatureValuesRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BatchReadFeatureValuesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BatchReadFeatureValuesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchReadFeatureValuesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BatchReadFeatureValuesRequest.Builder
Overrides

clearPassThroughFields()

public BatchReadFeatureValuesRequest.Builder clearPassThroughFields()

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
BatchReadFeatureValuesRequest.Builder

clearReadOption()

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

clearStartTime()

public BatchReadFeatureValuesRequest.Builder clearStartTime()

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
BatchReadFeatureValuesRequest.Builder

clone()

public BatchReadFeatureValuesRequest.Builder clone()
Returns
Type Description
BatchReadFeatureValuesRequest.Builder
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.

getBigqueryReadInstancesBuilder()

public BigQuerySource.Builder getBigqueryReadInstancesBuilder()

Similar to csv_read_instances, but from BigQuery source.

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

Returns
Type Description
BigQuerySource.Builder

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.

getCsvReadInstancesBuilder()

public CsvSource.Builder getCsvReadInstancesBuilder()

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.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getDestinationBuilder()

public FeatureValueDestination.Builder getDestinationBuilder()

Required. Specifies output location and format.

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

Returns
Type Description
FeatureValueDestination.Builder

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

getEntityTypeSpecsBuilder(int index)

public BatchReadFeatureValuesRequest.EntityTypeSpec.Builder getEntityTypeSpecsBuilder(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.Builder

getEntityTypeSpecsBuilderList()

public List<BatchReadFeatureValuesRequest.EntityTypeSpec.Builder> getEntityTypeSpecsBuilderList()

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

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.

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

getPassThroughFieldsBuilder(int index)

public BatchReadFeatureValuesRequest.PassThroughField.Builder getPassThroughFieldsBuilder(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.Builder

getPassThroughFieldsBuilderList()

public List<BatchReadFeatureValuesRequest.PassThroughField.Builder> getPassThroughFieldsBuilderList()

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

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

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.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBigqueryReadInstances(BigQuerySource value)

public BatchReadFeatureValuesRequest.Builder mergeBigqueryReadInstances(BigQuerySource value)

Similar to csv_read_instances, but from BigQuery source.

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

Parameter
Name Description
value BigQuerySource
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

mergeCsvReadInstances(CsvSource value)

public BatchReadFeatureValuesRequest.Builder mergeCsvReadInstances(CsvSource value)

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;

Parameter
Name Description
value CsvSource
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

mergeDestination(FeatureValueDestination value)

public BatchReadFeatureValuesRequest.Builder mergeDestination(FeatureValueDestination value)

Required. Specifies output location and format.

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

Parameter
Name Description
value FeatureValueDestination
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

mergeFrom(BatchReadFeatureValuesRequest other)

public BatchReadFeatureValuesRequest.Builder mergeFrom(BatchReadFeatureValuesRequest other)
Parameter
Name Description
other BatchReadFeatureValuesRequest
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchReadFeatureValuesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchReadFeatureValuesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BatchReadFeatureValuesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BatchReadFeatureValuesRequest.Builder
Overrides

mergeStartTime(Timestamp value)

public BatchReadFeatureValuesRequest.Builder mergeStartTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchReadFeatureValuesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BatchReadFeatureValuesRequest.Builder
Overrides

removeEntityTypeSpecs(int index)

public BatchReadFeatureValuesRequest.Builder removeEntityTypeSpecs(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.Builder

removePassThroughFields(int index)

public BatchReadFeatureValuesRequest.Builder removePassThroughFields(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.Builder

setBigqueryReadInstances(BigQuerySource value)

public BatchReadFeatureValuesRequest.Builder setBigqueryReadInstances(BigQuerySource value)

Similar to csv_read_instances, but from BigQuery source.

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

Parameter
Name Description
value BigQuerySource
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

setBigqueryReadInstances(BigQuerySource.Builder builderForValue)

public BatchReadFeatureValuesRequest.Builder setBigqueryReadInstances(BigQuerySource.Builder builderForValue)

Similar to csv_read_instances, but from BigQuery source.

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

Parameter
Name Description
builderForValue BigQuerySource.Builder
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

setCsvReadInstances(CsvSource value)

public BatchReadFeatureValuesRequest.Builder setCsvReadInstances(CsvSource value)

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;

Parameter
Name Description
value CsvSource
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

setCsvReadInstances(CsvSource.Builder builderForValue)

public BatchReadFeatureValuesRequest.Builder setCsvReadInstances(CsvSource.Builder builderForValue)

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;

Parameter
Name Description
builderForValue CsvSource.Builder
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

setDestination(FeatureValueDestination value)

public BatchReadFeatureValuesRequest.Builder setDestination(FeatureValueDestination value)

Required. Specifies output location and format.

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

Parameter
Name Description
value FeatureValueDestination
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

setDestination(FeatureValueDestination.Builder builderForValue)

public BatchReadFeatureValuesRequest.Builder setDestination(FeatureValueDestination.Builder builderForValue)

Required. Specifies output location and format.

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

Parameter
Name Description
builderForValue FeatureValueDestination.Builder
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

setEntityTypeSpecs(int index, BatchReadFeatureValuesRequest.EntityTypeSpec value)

public BatchReadFeatureValuesRequest.Builder setEntityTypeSpecs(int index, BatchReadFeatureValuesRequest.EntityTypeSpec value)

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

Parameters
Name Description
index int
value BatchReadFeatureValuesRequest.EntityTypeSpec
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

setEntityTypeSpecs(int index, BatchReadFeatureValuesRequest.EntityTypeSpec.Builder builderForValue)

public BatchReadFeatureValuesRequest.Builder setEntityTypeSpecs(int index, BatchReadFeatureValuesRequest.EntityTypeSpec.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue BatchReadFeatureValuesRequest.EntityTypeSpec.Builder
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

setFeaturestore(String value)

public BatchReadFeatureValuesRequest.Builder setFeaturestore(String value)

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) = { ... }

Parameter
Name Description
value String

The featurestore to set.

Returns
Type Description
BatchReadFeatureValuesRequest.Builder

This builder for chaining.

setFeaturestoreBytes(ByteString value)

public BatchReadFeatureValuesRequest.Builder setFeaturestoreBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for featurestore to set.

Returns
Type Description
BatchReadFeatureValuesRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BatchReadFeatureValuesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BatchReadFeatureValuesRequest.Builder
Overrides

setPassThroughFields(int index, BatchReadFeatureValuesRequest.PassThroughField value)

public BatchReadFeatureValuesRequest.Builder setPassThroughFields(int index, BatchReadFeatureValuesRequest.PassThroughField value)

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;

Parameters
Name Description
index int
value BatchReadFeatureValuesRequest.PassThroughField
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

setPassThroughFields(int index, BatchReadFeatureValuesRequest.PassThroughField.Builder builderForValue)

public BatchReadFeatureValuesRequest.Builder setPassThroughFields(int index, BatchReadFeatureValuesRequest.PassThroughField.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue BatchReadFeatureValuesRequest.PassThroughField.Builder
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BatchReadFeatureValuesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BatchReadFeatureValuesRequest.Builder
Overrides

setStartTime(Timestamp value)

public BatchReadFeatureValuesRequest.Builder setStartTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

setStartTime(Timestamp.Builder builderForValue)

public BatchReadFeatureValuesRequest.Builder setStartTime(Timestamp.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BatchReadFeatureValuesRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchReadFeatureValuesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BatchReadFeatureValuesRequest.Builder
Overrides