Class FeatureGroup.BigQuery.Builder (3.56.0)

public static final class FeatureGroup.BigQuery.Builder extends GeneratedMessageV3.Builder<FeatureGroup.BigQuery.Builder> implements FeatureGroup.BigQueryOrBuilder

Input source type for BigQuery Tables and Views.

Protobuf type google.cloud.aiplatform.v1.FeatureGroup.BigQuery

Static Methods

getDescriptor()

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

Methods

addAllEntityIdColumns(Iterable<String> values)

public FeatureGroup.BigQuery.Builder addAllEntityIdColumns(Iterable<String> values)

Optional. Columns to construct entity_id / row keys. If not provided defaults to entity_id.

repeated string entity_id_columns = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The entityIdColumns to add.

Returns
Type Description
FeatureGroup.BigQuery.Builder

This builder for chaining.

addEntityIdColumns(String value)

public FeatureGroup.BigQuery.Builder addEntityIdColumns(String value)

Optional. Columns to construct entity_id / row keys. If not provided defaults to entity_id.

repeated string entity_id_columns = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The entityIdColumns to add.

Returns
Type Description
FeatureGroup.BigQuery.Builder

This builder for chaining.

addEntityIdColumnsBytes(ByteString value)

public FeatureGroup.BigQuery.Builder addEntityIdColumnsBytes(ByteString value)

Optional. Columns to construct entity_id / row keys. If not provided defaults to entity_id.

repeated string entity_id_columns = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the entityIdColumns to add.

Returns
Type Description
FeatureGroup.BigQuery.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public FeatureGroup.BigQuery build()
Returns
Type Description
FeatureGroup.BigQuery

buildPartial()

public FeatureGroup.BigQuery buildPartial()
Returns
Type Description
FeatureGroup.BigQuery

clear()

public FeatureGroup.BigQuery.Builder clear()
Returns
Type Description
FeatureGroup.BigQuery.Builder
Overrides

clearBigQuerySource()

public FeatureGroup.BigQuery.Builder clearBigQuerySource()

Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View.

.google.cloud.aiplatform.v1.BigQuerySource big_query_source = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FeatureGroup.BigQuery.Builder

clearDense()

public FeatureGroup.BigQuery.Builder clearDense()

Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and the following rows: (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores.

bool dense = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FeatureGroup.BigQuery.Builder

This builder for chaining.

clearEntityIdColumns()

public FeatureGroup.BigQuery.Builder clearEntityIdColumns()

Optional. Columns to construct entity_id / row keys. If not provided defaults to entity_id.

repeated string entity_id_columns = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FeatureGroup.BigQuery.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearStaticDataSource()

public FeatureGroup.BigQuery.Builder clearStaticDataSource()

Optional. Set if the data source is not a time-series.

bool static_data_source = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FeatureGroup.BigQuery.Builder

This builder for chaining.

clearTimeSeries()

public FeatureGroup.BigQuery.Builder clearTimeSeries()

Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary.

.google.cloud.aiplatform.v1.FeatureGroup.BigQuery.TimeSeries time_series = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FeatureGroup.BigQuery.Builder

clone()

public FeatureGroup.BigQuery.Builder clone()
Returns
Type Description
FeatureGroup.BigQuery.Builder
Overrides

getBigQuerySource()

public BigQuerySource getBigQuerySource()

Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View.

.google.cloud.aiplatform.v1.BigQuerySource big_query_source = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BigQuerySource

The bigQuerySource.

getBigQuerySourceBuilder()

public BigQuerySource.Builder getBigQuerySourceBuilder()

Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View.

.google.cloud.aiplatform.v1.BigQuerySource big_query_source = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BigQuerySource.Builder

getBigQuerySourceOrBuilder()

public BigQuerySourceOrBuilder getBigQuerySourceOrBuilder()

Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View.

.google.cloud.aiplatform.v1.BigQuerySource big_query_source = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BigQuerySourceOrBuilder

getDefaultInstanceForType()

public FeatureGroup.BigQuery getDefaultInstanceForType()
Returns
Type Description
FeatureGroup.BigQuery

getDense()

public boolean getDense()

Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and the following rows: (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores.

bool dense = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The dense.

getDescriptorForType()

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

getEntityIdColumns(int index)

public String getEntityIdColumns(int index)

Optional. Columns to construct entity_id / row keys. If not provided defaults to entity_id.

repeated string entity_id_columns = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The entityIdColumns at the given index.

getEntityIdColumnsBytes(int index)

public ByteString getEntityIdColumnsBytes(int index)

Optional. Columns to construct entity_id / row keys. If not provided defaults to entity_id.

repeated string entity_id_columns = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the entityIdColumns at the given index.

getEntityIdColumnsCount()

public int getEntityIdColumnsCount()

Optional. Columns to construct entity_id / row keys. If not provided defaults to entity_id.

repeated string entity_id_columns = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of entityIdColumns.

getEntityIdColumnsList()

public ProtocolStringList getEntityIdColumnsList()

Optional. Columns to construct entity_id / row keys. If not provided defaults to entity_id.

repeated string entity_id_columns = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the entityIdColumns.

getStaticDataSource()

public boolean getStaticDataSource()

Optional. Set if the data source is not a time-series.

bool static_data_source = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The staticDataSource.

getTimeSeries()

public FeatureGroup.BigQuery.TimeSeries getTimeSeries()

Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary.

.google.cloud.aiplatform.v1.FeatureGroup.BigQuery.TimeSeries time_series = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FeatureGroup.BigQuery.TimeSeries

The timeSeries.

getTimeSeriesBuilder()

public FeatureGroup.BigQuery.TimeSeries.Builder getTimeSeriesBuilder()

Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary.

.google.cloud.aiplatform.v1.FeatureGroup.BigQuery.TimeSeries time_series = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FeatureGroup.BigQuery.TimeSeries.Builder

getTimeSeriesOrBuilder()

public FeatureGroup.BigQuery.TimeSeriesOrBuilder getTimeSeriesOrBuilder()

Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary.

.google.cloud.aiplatform.v1.FeatureGroup.BigQuery.TimeSeries time_series = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FeatureGroup.BigQuery.TimeSeriesOrBuilder

hasBigQuerySource()

public boolean hasBigQuerySource()

Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View.

.google.cloud.aiplatform.v1.BigQuerySource big_query_source = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the bigQuerySource field is set.

hasTimeSeries()

public boolean hasTimeSeries()

Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary.

.google.cloud.aiplatform.v1.FeatureGroup.BigQuery.TimeSeries time_series = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the timeSeries field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBigQuerySource(BigQuerySource value)

public FeatureGroup.BigQuery.Builder mergeBigQuerySource(BigQuerySource value)

Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View.

.google.cloud.aiplatform.v1.BigQuerySource big_query_source = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value BigQuerySource
Returns
Type Description
FeatureGroup.BigQuery.Builder

mergeFrom(FeatureGroup.BigQuery other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeTimeSeries(FeatureGroup.BigQuery.TimeSeries value)

public FeatureGroup.BigQuery.Builder mergeTimeSeries(FeatureGroup.BigQuery.TimeSeries value)

Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary.

.google.cloud.aiplatform.v1.FeatureGroup.BigQuery.TimeSeries time_series = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FeatureGroup.BigQuery.TimeSeries
Returns
Type Description
FeatureGroup.BigQuery.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBigQuerySource(BigQuerySource value)

public FeatureGroup.BigQuery.Builder setBigQuerySource(BigQuerySource value)

Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View.

.google.cloud.aiplatform.v1.BigQuerySource big_query_source = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value BigQuerySource
Returns
Type Description
FeatureGroup.BigQuery.Builder

setBigQuerySource(BigQuerySource.Builder builderForValue)

public FeatureGroup.BigQuery.Builder setBigQuerySource(BigQuerySource.Builder builderForValue)

Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View.

.google.cloud.aiplatform.v1.BigQuerySource big_query_source = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue BigQuerySource.Builder
Returns
Type Description
FeatureGroup.BigQuery.Builder

setDense(boolean value)

public FeatureGroup.BigQuery.Builder setDense(boolean value)

Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and the following rows: (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores.

bool dense = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The dense to set.

Returns
Type Description
FeatureGroup.BigQuery.Builder

This builder for chaining.

setEntityIdColumns(int index, String value)

public FeatureGroup.BigQuery.Builder setEntityIdColumns(int index, String value)

Optional. Columns to construct entity_id / row keys. If not provided defaults to entity_id.

repeated string entity_id_columns = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The entityIdColumns to set.

Returns
Type Description
FeatureGroup.BigQuery.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setStaticDataSource(boolean value)

public FeatureGroup.BigQuery.Builder setStaticDataSource(boolean value)

Optional. Set if the data source is not a time-series.

bool static_data_source = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The staticDataSource to set.

Returns
Type Description
FeatureGroup.BigQuery.Builder

This builder for chaining.

setTimeSeries(FeatureGroup.BigQuery.TimeSeries value)

public FeatureGroup.BigQuery.Builder setTimeSeries(FeatureGroup.BigQuery.TimeSeries value)

Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary.

.google.cloud.aiplatform.v1.FeatureGroup.BigQuery.TimeSeries time_series = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FeatureGroup.BigQuery.TimeSeries
Returns
Type Description
FeatureGroup.BigQuery.Builder

setTimeSeries(FeatureGroup.BigQuery.TimeSeries.Builder builderForValue)

public FeatureGroup.BigQuery.Builder setTimeSeries(FeatureGroup.BigQuery.TimeSeries.Builder builderForValue)

Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary.

.google.cloud.aiplatform.v1.FeatureGroup.BigQuery.TimeSeries time_series = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue FeatureGroup.BigQuery.TimeSeries.Builder
Returns
Type Description
FeatureGroup.BigQuery.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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