Class ImportFeatureValuesRequest (3.50.0)

public final class ImportFeatureValuesRequest extends GeneratedMessageV3 implements ImportFeatureValuesRequestOrBuilder

Request message for FeaturestoreService.ImportFeatureValues.

Protobuf type google.cloud.aiplatform.v1.ImportFeatureValuesRequest

Static Fields

AVRO_SOURCE_FIELD_NUMBER

public static final int AVRO_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

BIGQUERY_SOURCE_FIELD_NUMBER

public static final int BIGQUERY_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

CSV_SOURCE_FIELD_NUMBER

public static final int CSV_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_INGESTION_ANALYSIS_FIELD_NUMBER

public static final int DISABLE_INGESTION_ANALYSIS_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_ONLINE_SERVING_FIELD_NUMBER

public static final int DISABLE_ONLINE_SERVING_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_ID_FIELD_FIELD_NUMBER

public static final int ENTITY_ID_FIELD_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_TYPE_FIELD_NUMBER

public static final int ENTITY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

FEATURE_SPECS_FIELD_NUMBER

public static final int FEATURE_SPECS_FIELD_NUMBER
Field Value
Type Description
int

FEATURE_TIME_FIELD_FIELD_NUMBER

public static final int FEATURE_TIME_FIELD_FIELD_NUMBER
Field Value
Type Description
int

FEATURE_TIME_FIELD_NUMBER

public static final int FEATURE_TIME_FIELD_NUMBER
Field Value
Type Description
int

WORKER_COUNT_FIELD_NUMBER

public static final int WORKER_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ImportFeatureValuesRequest getDefaultInstance()
Returns
Type Description
ImportFeatureValuesRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ImportFeatureValuesRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAvroSource()

public AvroSource getAvroSource()

.google.cloud.aiplatform.v1.AvroSource avro_source = 2;

Returns
Type Description
AvroSource

The avroSource.

getAvroSourceOrBuilder()

public AvroSourceOrBuilder getAvroSourceOrBuilder()

.google.cloud.aiplatform.v1.AvroSource avro_source = 2;

Returns
Type Description
AvroSourceOrBuilder

getBigquerySource()

public BigQuerySource getBigquerySource()

.google.cloud.aiplatform.v1.BigQuerySource bigquery_source = 3;

Returns
Type Description
BigQuerySource

The bigquerySource.

getBigquerySourceOrBuilder()

public BigQuerySourceOrBuilder getBigquerySourceOrBuilder()

.google.cloud.aiplatform.v1.BigQuerySource bigquery_source = 3;

Returns
Type Description
BigQuerySourceOrBuilder

getCsvSource()

public CsvSource getCsvSource()

.google.cloud.aiplatform.v1.CsvSource csv_source = 4;

Returns
Type Description
CsvSource

The csvSource.

getCsvSourceOrBuilder()

public CsvSourceOrBuilder getCsvSourceOrBuilder()

.google.cloud.aiplatform.v1.CsvSource csv_source = 4;

Returns
Type Description
CsvSourceOrBuilder

getDefaultInstanceForType()

public ImportFeatureValuesRequest getDefaultInstanceForType()
Returns
Type Description
ImportFeatureValuesRequest

getDisableIngestionAnalysis()

public boolean getDisableIngestionAnalysis()

If true, API doesn't start ingestion analysis pipeline.

bool disable_ingestion_analysis = 12;

Returns
Type Description
boolean

The disableIngestionAnalysis.

getDisableOnlineServing()

public boolean getDisableOnlineServing()

If set, data will not be imported for online serving. This is typically used for backfilling, where Feature generation timestamps are not in the timestamp range needed for online serving.

bool disable_online_serving = 9;

Returns
Type Description
boolean

The disableOnlineServing.

getEntityIdField()

public String getEntityIdField()

Source column that holds entity IDs. If not provided, entity IDs are extracted from the column named entity_id.

string entity_id_field = 5;

Returns
Type Description
String

The entityIdField.

getEntityIdFieldBytes()

public ByteString getEntityIdFieldBytes()

Source column that holds entity IDs. If not provided, entity IDs are extracted from the column named entity_id.

string entity_id_field = 5;

Returns
Type Description
ByteString

The bytes for entityIdField.

getEntityType()

public String getEntityType()

Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}

string entity_type = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The entityType.

getEntityTypeBytes()

public ByteString getEntityTypeBytes()

Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}

string entity_type = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for entityType.

getFeatureSpecs(int index)

public ImportFeatureValuesRequest.FeatureSpec getFeatureSpecs(int index)

Required. Specifications defining which Feature values to import from the entity. The request fails if no feature_specs are provided, and having multiple feature_specs for one Feature is not allowed.

repeated .google.cloud.aiplatform.v1.ImportFeatureValuesRequest.FeatureSpec feature_specs = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ImportFeatureValuesRequest.FeatureSpec

getFeatureSpecsCount()

public int getFeatureSpecsCount()

Required. Specifications defining which Feature values to import from the entity. The request fails if no feature_specs are provided, and having multiple feature_specs for one Feature is not allowed.

repeated .google.cloud.aiplatform.v1.ImportFeatureValuesRequest.FeatureSpec feature_specs = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getFeatureSpecsList()

public List<ImportFeatureValuesRequest.FeatureSpec> getFeatureSpecsList()

Required. Specifications defining which Feature values to import from the entity. The request fails if no feature_specs are provided, and having multiple feature_specs for one Feature is not allowed.

repeated .google.cloud.aiplatform.v1.ImportFeatureValuesRequest.FeatureSpec feature_specs = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<FeatureSpec>

getFeatureSpecsOrBuilder(int index)

public ImportFeatureValuesRequest.FeatureSpecOrBuilder getFeatureSpecsOrBuilder(int index)

Required. Specifications defining which Feature values to import from the entity. The request fails if no feature_specs are provided, and having multiple feature_specs for one Feature is not allowed.

repeated .google.cloud.aiplatform.v1.ImportFeatureValuesRequest.FeatureSpec feature_specs = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ImportFeatureValuesRequest.FeatureSpecOrBuilder

getFeatureSpecsOrBuilderList()

public List<? extends ImportFeatureValuesRequest.FeatureSpecOrBuilder> getFeatureSpecsOrBuilderList()

Required. Specifications defining which Feature values to import from the entity. The request fails if no feature_specs are provided, and having multiple feature_specs for one Feature is not allowed.

repeated .google.cloud.aiplatform.v1.ImportFeatureValuesRequest.FeatureSpec feature_specs = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.ImportFeatureValuesRequest.FeatureSpecOrBuilder>

getFeatureTime()

public Timestamp getFeatureTime()

Single Feature timestamp for all entities being imported. The timestamp must not have higher than millisecond precision.

.google.protobuf.Timestamp feature_time = 7;

Returns
Type Description
Timestamp

The featureTime.

getFeatureTimeField()

public String getFeatureTimeField()

Source column that holds the Feature timestamp for all Feature values in each entity.

string feature_time_field = 6;

Returns
Type Description
String

The featureTimeField.

getFeatureTimeFieldBytes()

public ByteString getFeatureTimeFieldBytes()

Source column that holds the Feature timestamp for all Feature values in each entity.

string feature_time_field = 6;

Returns
Type Description
ByteString

The bytes for featureTimeField.

getFeatureTimeOrBuilder()

public TimestampOrBuilder getFeatureTimeOrBuilder()

Single Feature timestamp for all entities being imported. The timestamp must not have higher than millisecond precision.

.google.protobuf.Timestamp feature_time = 7;

Returns
Type Description
TimestampOrBuilder

getFeatureTimeSourceCase()

public ImportFeatureValuesRequest.FeatureTimeSourceCase getFeatureTimeSourceCase()
Returns
Type Description
ImportFeatureValuesRequest.FeatureTimeSourceCase

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceCase()

public ImportFeatureValuesRequest.SourceCase getSourceCase()
Returns
Type Description
ImportFeatureValuesRequest.SourceCase

getWorkerCount()

public int getWorkerCount()

Specifies the number of workers that are used to write data to the Featurestore. Consider the online serving capacity that you require to achieve the desired import throughput without interfering with online serving. The value must be positive, and less than or equal to 100. If not set, defaults to using 1 worker. The low count ensures minimal impact on online serving performance.

int32 worker_count = 11;

Returns
Type Description
int

The workerCount.

hasAvroSource()

public boolean hasAvroSource()

.google.cloud.aiplatform.v1.AvroSource avro_source = 2;

Returns
Type Description
boolean

Whether the avroSource field is set.

hasBigquerySource()

public boolean hasBigquerySource()

.google.cloud.aiplatform.v1.BigQuerySource bigquery_source = 3;

Returns
Type Description
boolean

Whether the bigquerySource field is set.

hasCsvSource()

public boolean hasCsvSource()

.google.cloud.aiplatform.v1.CsvSource csv_source = 4;

Returns
Type Description
boolean

Whether the csvSource field is set.

hasFeatureTime()

public boolean hasFeatureTime()

Single Feature timestamp for all entities being imported. The timestamp must not have higher than millisecond precision.

.google.protobuf.Timestamp feature_time = 7;

Returns
Type Description
boolean

Whether the featureTime field is set.

hasFeatureTimeField()

public boolean hasFeatureTimeField()

Source column that holds the Feature timestamp for all Feature values in each entity.

string feature_time_field = 6;

Returns
Type Description
boolean

Whether the featureTimeField field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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