Google Cloud Ai Platform V1 Client - Class ImportFeatureValuesRequest (1.12.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ImportFeatureValuesRequest.

Request message for FeaturestoreService.ImportFeatureValues.

Generated from protobuf message google.cloud.aiplatform.v1.ImportFeatureValuesRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ avro_source AvroSource
↳ bigquery_source BigQuerySource
↳ csv_source CsvSource
↳ feature_time_field string

Source column that holds the Feature timestamp for all Feature values in each entity.
↳ feature_time Google\Protobuf\Timestamp

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

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}
↳ entity_id_field string

Source column that holds entity IDs. If not provided, entity IDs are extracted from the column named entity_id.
↳ feature_specs array<ImportFeatureValuesRequest\FeatureSpec>

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.
↳ disable_online_serving bool

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.
↳ worker_count int

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.
↳ disable_ingestion_analysis bool

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

getAvroSource

Generated from protobuf field .google.cloud.aiplatform.v1.AvroSource avro_source = 2;

Returns
Type Description
AvroSource|null

hasAvroSource

setAvroSource

Generated from protobuf field .google.cloud.aiplatform.v1.AvroSource avro_source = 2;

Parameter
Name Description
var AvroSource
Returns
Type Description
$this

getBigquerySource

Generated from protobuf field .google.cloud.aiplatform.v1.BigQuerySource bigquery_source = 3;

Returns
Type Description
BigQuerySource|null

hasBigquerySource

setBigquerySource

Generated from protobuf field .google.cloud.aiplatform.v1.BigQuerySource bigquery_source = 3;

Parameter
Name Description
var BigQuerySource
Returns
Type Description
$this

getCsvSource

Generated from protobuf field .google.cloud.aiplatform.v1.CsvSource csv_source = 4;

Returns
Type Description
CsvSource|null

hasCsvSource

setCsvSource

Generated from protobuf field .google.cloud.aiplatform.v1.CsvSource csv_source = 4;

Parameter
Name Description
var CsvSource
Returns
Type Description
$this

getFeatureTimeField

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

Returns
Type Description
string

hasFeatureTimeField

setFeatureTimeField

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

Parameter
Name Description
var string
Returns
Type Description
$this

getFeatureTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasFeatureTime

setFeatureTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

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}

Returns
Type Description
string

setEntityType

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}

Parameter
Name Description
var string
Returns
Type Description
$this

getEntityIdField

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

Returns
Type Description
string

setEntityIdField

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

Parameter
Name Description
var string
Returns
Type Description
$this

getFeatureSpecs

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFeatureSpecs

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.

Parameter
Name Description
var array<ImportFeatureValuesRequest\FeatureSpec>
Returns
Type Description
$this

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.

Returns
Type Description
bool

setDisableOnlineServing

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

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.

Returns
Type Description
int

setWorkerCount

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getDisableIngestionAnalysis

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

Returns
Type Description
bool

setDisableIngestionAnalysis

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getSource

Returns
Type Description
string

getFeatureTimeSource

Returns
Type Description
string

static::build

Parameter
Name Description
entityType string

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} Please see FeaturestoreServiceClient::entityTypeName() for help formatting this field.
Returns
Type Description
ImportFeatureValuesRequest