Class ImportFeatureValuesRequest (3.4.0)

public final class ImportFeatureValuesRequest extends GeneratedMessageV3 implements ImportFeatureValuesRequestOrBuilder

Request message for FeaturestoreService.ImportFeatureValues.

Protobuf type google.cloud.aiplatform.v1beta1.ImportFeatureValuesRequest

Static Fields

AVRO_SOURCE_FIELD_NUMBER

public static final int AVRO_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

BIGQUERY_SOURCE_FIELD_NUMBER

public static final int BIGQUERY_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

CSV_SOURCE_FIELD_NUMBER

public static final int CSV_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

DISABLE_INGESTION_ANALYSIS_FIELD_NUMBER

public static final int DISABLE_INGESTION_ANALYSIS_FIELD_NUMBER
Field Value
TypeDescription
int

DISABLE_ONLINE_SERVING_FIELD_NUMBER

public static final int DISABLE_ONLINE_SERVING_FIELD_NUMBER
Field Value
TypeDescription
int

ENTITY_ID_FIELD_FIELD_NUMBER

public static final int ENTITY_ID_FIELD_FIELD_NUMBER
Field Value
TypeDescription
int

ENTITY_TYPE_FIELD_NUMBER

public static final int ENTITY_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

FEATURE_SPECS_FIELD_NUMBER

public static final int FEATURE_SPECS_FIELD_NUMBER
Field Value
TypeDescription
int

FEATURE_TIME_FIELD_FIELD_NUMBER

public static final int FEATURE_TIME_FIELD_FIELD_NUMBER
Field Value
TypeDescription
int

FEATURE_TIME_FIELD_NUMBER

public static final int FEATURE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

WORKER_COUNT_FIELD_NUMBER

public static final int WORKER_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ImportFeatureValuesRequest getDefaultInstance()
Returns
TypeDescription
ImportFeatureValuesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ImportFeatureValuesRequest.Builder newBuilder()
Returns
TypeDescription
ImportFeatureValuesRequest.Builder

newBuilder(ImportFeatureValuesRequest prototype)

public static ImportFeatureValuesRequest.Builder newBuilder(ImportFeatureValuesRequest prototype)
Parameter
NameDescription
prototypeImportFeatureValuesRequest
Returns
TypeDescription
ImportFeatureValuesRequest.Builder

parseDelimitedFrom(InputStream input)

public static ImportFeatureValuesRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImportFeatureValuesRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportFeatureValuesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportFeatureValuesRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ImportFeatureValuesRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ImportFeatureValuesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ImportFeatureValuesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportFeatureValuesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ImportFeatureValuesRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ImportFeatureValuesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ImportFeatureValuesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportFeatureValuesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ImportFeatureValuesRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ImportFeatureValuesRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportFeatureValuesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportFeatureValuesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ImportFeatureValuesRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImportFeatureValuesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportFeatureValuesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportFeatureValuesRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ImportFeatureValuesRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ImportFeatureValuesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ImportFeatureValuesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportFeatureValuesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ImportFeatureValuesRequest> parser()
Returns
TypeDescription
Parser<ImportFeatureValuesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAvroSource()

public AvroSource getAvroSource()

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

Returns
TypeDescription
AvroSource

The avroSource.

getAvroSourceOrBuilder()

public AvroSourceOrBuilder getAvroSourceOrBuilder()

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

Returns
TypeDescription
AvroSourceOrBuilder

getBigquerySource()

public BigQuerySource getBigquerySource()

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

Returns
TypeDescription
BigQuerySource

The bigquerySource.

getBigquerySourceOrBuilder()

public BigQuerySourceOrBuilder getBigquerySourceOrBuilder()

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

Returns
TypeDescription
BigQuerySourceOrBuilder

getCsvSource()

public CsvSource getCsvSource()

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

Returns
TypeDescription
CsvSource

The csvSource.

getCsvSourceOrBuilder()

public CsvSourceOrBuilder getCsvSourceOrBuilder()

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

Returns
TypeDescription
CsvSourceOrBuilder

getDefaultInstanceForType()

public ImportFeatureValuesRequest getDefaultInstanceForType()
Returns
TypeDescription
ImportFeatureValuesRequest

getDisableIngestionAnalysis()

public boolean getDisableIngestionAnalysis()

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

bool disable_ingestion_analysis = 12;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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.v1beta1.ImportFeatureValuesRequest.FeatureSpec feature_specs = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta1.ImportFeatureValuesRequest.FeatureSpec feature_specs = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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.v1beta1.ImportFeatureValuesRequest.FeatureSpec feature_specs = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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.v1beta1.ImportFeatureValuesRequest.FeatureSpec feature_specs = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta1.ImportFeatureValuesRequest.FeatureSpec feature_specs = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1beta1.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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getFeatureTimeSourceCase()

public ImportFeatureValuesRequest.FeatureTimeSourceCase getFeatureTimeSourceCase()
Returns
TypeDescription
ImportFeatureValuesRequest.FeatureTimeSourceCase

getParserForType()

public Parser<ImportFeatureValuesRequest> getParserForType()
Returns
TypeDescription
Parser<ImportFeatureValuesRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceCase()

public ImportFeatureValuesRequest.SourceCase getSourceCase()
Returns
TypeDescription
ImportFeatureValuesRequest.SourceCase

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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

The workerCount.

hasAvroSource()

public boolean hasAvroSource()

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

Returns
TypeDescription
boolean

Whether the avroSource field is set.

hasBigquerySource()

public boolean hasBigquerySource()

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

Returns
TypeDescription
boolean

Whether the bigquerySource field is set.

hasCsvSource()

public boolean hasCsvSource()

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

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

Whether the featureTimeField field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ImportFeatureValuesRequest.Builder newBuilderForType()
Returns
TypeDescription
ImportFeatureValuesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ImportFeatureValuesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ImportFeatureValuesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ImportFeatureValuesRequest.Builder toBuilder()
Returns
TypeDescription
ImportFeatureValuesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException