Google Cloud Ai Platform V1 Client - Class ExportFeatureValuesRequest (0.38.0)

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

Request message for FeaturestoreService.ExportFeatureValues.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ snapshot_export`	`Google\Cloud\AIPlatform\V1\ExportFeatureValuesRequest\SnapshotExport` Exports the latest Feature values of all entities of the EntityType within a time range.
`↳ full_export`	`Google\Cloud\AIPlatform\V1\ExportFeatureValuesRequest\FullExport` Exports all historical values of all entities of the EntityType within a time range
`↳ entity_type`	`string` Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
`↳ destination`	`Google\Cloud\AIPlatform\V1\FeatureValueDestination` Required. Specifies destination location and format.
`↳ feature_selector`	`Google\Cloud\AIPlatform\V1\FeatureSelector` Required. Selects Features to export values of.
`↳ settings`	`array<Google\Cloud\AIPlatform\V1\DestinationFeatureSetting>` Per-Feature export settings.

getSnapshotExport

Exports the latest Feature values of all entities of the EntityType within a time range.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\ExportFeatureValuesRequest\SnapshotExport\|null`

hasSnapshotExport

setSnapshotExport

Exports the latest Feature values of all entities of the EntityType within a time range.

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\ExportFeatureValuesRequest\SnapshotExport`

Returns
Type	Description
`$this`

getFullExport

Exports all historical values of all entities of the EntityType within a time range

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\ExportFeatureValuesRequest\FullExport\|null`

hasFullExport

setFullExport

Exports all historical values of all entities of the EntityType within a time range

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\ExportFeatureValuesRequest\FullExport`

Returns
Type	Description
`$this`

getEntityType

Required. The resource name of the EntityType from which to export Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

Returns
Type	Description
`string`

setEntityType

Required. The resource name of the EntityType from which to export Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDestination

Required. Specifies destination location and format.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\FeatureValueDestination\|null`

hasDestination

clearDestination

setDestination

Required. Specifies destination location and format.

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\FeatureValueDestination`

Returns
Type	Description
`$this`

getFeatureSelector

Required. Selects Features to export values of.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\FeatureSelector\|null`

hasFeatureSelector

clearFeatureSelector

setFeatureSelector

Required. Selects Features to export values of.

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\FeatureSelector`

Returns
Type	Description
`$this`

getSettings

Per-Feature export settings.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setSettings

Per-Feature export settings.

Parameter
Name	Description
`var`	`array<Google\Cloud\AIPlatform\V1\DestinationFeatureSetting>`

Returns
Type	Description
`$this`

getMode

Returns
Type	Description
`string`

static::build

Parameter
Name	Description
`entityType`	`string` Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Please see Google\Cloud\AIPlatform\V1\FeaturestoreServiceClient::entityTypeName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\ExportFeatureValuesRequest`