Class BatchReadFeatureValuesRequest.Builder (3.8.0)

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

Request message for FeaturestoreService.BatchReadFeatureValues.

Protobuf type google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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. 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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.EntityTypeSpec>
Returns

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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.PassThroughField>
Returns

addEntityTypeSpecs(BatchReadFeatureValuesRequest.EntityTypeSpec value)

public BatchReadFeatureValuesRequest.Builder addEntityTypeSpecs(BatchReadFeatureValuesRequest.EntityTypeSpec value)

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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter Returns

addEntityTypeSpecs(BatchReadFeatureValuesRequest.EntityTypeSpec.Builder builderForValue)

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

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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter Returns

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. 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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Parameters Returns

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. 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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Parameters Returns

addEntityTypeSpecsBuilder()

public BatchReadFeatureValuesRequest.EntityTypeSpec.Builder addEntityTypeSpecsBuilder()

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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Returns

addEntityTypeSpecsBuilder(int index)

public BatchReadFeatureValuesRequest.EntityTypeSpec.Builder addEntityTypeSpecsBuilder(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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns

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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Parameter Returns

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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Parameter Returns

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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Parameters Returns

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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Parameters Returns

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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Returns

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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Parameter
NameDescription
indexint
Returns

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchReadFeatureValuesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns Overrides

build()

public BatchReadFeatureValuesRequest build()
Returns

buildPartial()

public BatchReadFeatureValuesRequest buildPartial()
Returns

clear()

public BatchReadFeatureValuesRequest.Builder clear()
Returns Overrides

clearBigqueryReadInstances()

public BatchReadFeatureValuesRequest.Builder clearBigqueryReadInstances()

Similar to csv_read_instances, but from BigQuery source.

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

Returns

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.v1.CsvSource csv_read_instances = 3;

Returns

clearDestination()

public BatchReadFeatureValuesRequest.Builder clearDestination()

Required. Specifies output location and format.

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

Returns

clearEntityTypeSpecs()

public BatchReadFeatureValuesRequest.Builder clearEntityTypeSpecs()

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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Returns

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BatchReadFeatureValuesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchReadFeatureValuesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns 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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Returns

clearReadOption()

public BatchReadFeatureValuesRequest.Builder clearReadOption()
Returns

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

clone()

public BatchReadFeatureValuesRequest.Builder clone()
Returns Overrides

getBigqueryReadInstances()

public BigQuerySource getBigqueryReadInstances()

Similar to csv_read_instances, but from BigQuery source.

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

Returns
TypeDescription
BigQuerySource

The bigqueryReadInstances.

getBigqueryReadInstancesBuilder()

public BigQuerySource.Builder getBigqueryReadInstancesBuilder()

Similar to csv_read_instances, but from BigQuery source.

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

Returns
TypeDescription
BigQuerySource.Builder

getBigqueryReadInstancesOrBuilder()

public BigQuerySourceOrBuilder getBigqueryReadInstancesOrBuilder()

Similar to csv_read_instances, but from BigQuery source.

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

Returns

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.v1.CsvSource csv_read_instances = 3;

Returns
TypeDescription
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.v1.CsvSource csv_read_instances = 3;

Returns
TypeDescription
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.v1.CsvSource csv_read_instances = 3;

Returns
TypeDescription
CsvSourceOrBuilder

getDefaultInstanceForType()

public BatchReadFeatureValuesRequest getDefaultInstanceForType()
Returns

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDestination()

public FeatureValueDestination getDestination()

Required. Specifies output location and format.

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

Returns
TypeDescription
FeatureValueDestination

The destination.

getDestinationBuilder()

public FeatureValueDestination.Builder getDestinationBuilder()

Required. Specifies output location and format.

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

Returns

getDestinationOrBuilder()

public FeatureValueDestinationOrBuilder getDestinationOrBuilder()

Required. Specifies output location and format.

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

Returns

getEntityTypeSpecs(int index)

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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns

getEntityTypeSpecsBuilder(int index)

public BatchReadFeatureValuesRequest.EntityTypeSpec.Builder getEntityTypeSpecsBuilder(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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns

getEntityTypeSpecsBuilderList()

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

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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<Builder>

getEntityTypeSpecsCount()

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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

getEntityTypeSpecsList()

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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<EntityTypeSpec>

getEntityTypeSpecsOrBuilder(int index)

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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns

getEntityTypeSpecsOrBuilderList()

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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.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
TypeDescription
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
TypeDescription
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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Parameter
NameDescription
indexint
Returns

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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Parameter
NameDescription
indexint
Returns

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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Returns
TypeDescription
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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Returns
TypeDescription
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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Returns
TypeDescription
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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Parameter
NameDescription
indexint
Returns

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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.PassThroughFieldOrBuilder>

getReadOptionCase()

public BatchReadFeatureValuesRequest.ReadOptionCase getReadOptionCase()
Returns

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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

hasBigqueryReadInstances()

public boolean hasBigqueryReadInstances()

Similar to csv_read_instances, but from BigQuery source.

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

Returns
TypeDescription
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.v1.CsvSource csv_read_instances = 3;

Returns
TypeDescription
boolean

Whether the csvReadInstances field is set.

hasDestination()

public boolean hasDestination()

Required. Specifies output location and format.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the startTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBigqueryReadInstances(BigQuerySource value)

public BatchReadFeatureValuesRequest.Builder mergeBigqueryReadInstances(BigQuerySource value)

Similar to csv_read_instances, but from BigQuery source.

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

Parameter
NameDescription
valueBigQuerySource
Returns

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.v1.CsvSource csv_read_instances = 3;

Parameter
NameDescription
valueCsvSource
Returns

mergeDestination(FeatureValueDestination value)

public BatchReadFeatureValuesRequest.Builder mergeDestination(FeatureValueDestination value)

Required. Specifies output location and format.

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

Parameter
NameDescription
valueFeatureValueDestination
Returns

mergeFrom(BatchReadFeatureValuesRequest other)

public BatchReadFeatureValuesRequest.Builder mergeFrom(BatchReadFeatureValuesRequest other)
Parameter
NameDescription
otherBatchReadFeatureValuesRequest
Returns

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchReadFeatureValuesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public BatchReadFeatureValuesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns 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
NameDescription
valueTimestamp
Returns

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchReadFeatureValuesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns Overrides

removeEntityTypeSpecs(int index)

public BatchReadFeatureValuesRequest.Builder removeEntityTypeSpecs(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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns

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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Parameter
NameDescription
indexint
Returns

setBigqueryReadInstances(BigQuerySource value)

public BatchReadFeatureValuesRequest.Builder setBigqueryReadInstances(BigQuerySource value)

Similar to csv_read_instances, but from BigQuery source.

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

Parameter
NameDescription
valueBigQuerySource
Returns

setBigqueryReadInstances(BigQuerySource.Builder builderForValue)

public BatchReadFeatureValuesRequest.Builder setBigqueryReadInstances(BigQuerySource.Builder builderForValue)

Similar to csv_read_instances, but from BigQuery source.

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

Parameter
NameDescription
builderForValueBigQuerySource.Builder
Returns

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.v1.CsvSource csv_read_instances = 3;

Parameter
NameDescription
valueCsvSource
Returns

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.v1.CsvSource csv_read_instances = 3;

Parameter
NameDescription
builderForValueCsvSource.Builder
Returns

setDestination(FeatureValueDestination value)

public BatchReadFeatureValuesRequest.Builder setDestination(FeatureValueDestination value)

Required. Specifies output location and format.

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

Parameter
NameDescription
valueFeatureValueDestination
Returns

setDestination(FeatureValueDestination.Builder builderForValue)

public BatchReadFeatureValuesRequest.Builder setDestination(FeatureValueDestination.Builder builderForValue)

Required. Specifies output location and format.

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

Parameter
NameDescription
builderForValueFeatureValueDestination.Builder
Returns

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. 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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Parameters Returns

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. 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.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];

Parameters Returns

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
NameDescription
valueString

The featurestore to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for featurestore to set.

Returns
TypeDescription
BatchReadFeatureValuesRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BatchReadFeatureValuesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns 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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Parameters Returns

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.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;

Parameters Returns

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

public BatchReadFeatureValuesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns 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
NameDescription
valueTimestamp
Returns

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
NameDescription
builderForValueBuilder
Returns

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchReadFeatureValuesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns Overrides