databricks.FeatureEngineeringFeature
Create FeatureEngineeringFeature Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FeatureEngineeringFeature(name: string, args: FeatureEngineeringFeatureArgs, opts?: CustomResourceOptions);@overload
def FeatureEngineeringFeature(resource_name: str,
args: FeatureEngineeringFeatureArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FeatureEngineeringFeature(resource_name: str,
opts: Optional[ResourceOptions] = None,
full_name: Optional[str] = None,
function: Optional[FeatureEngineeringFeatureFunctionArgs] = None,
inputs: Optional[Sequence[str]] = None,
source: Optional[FeatureEngineeringFeatureSourceArgs] = None,
time_window: Optional[FeatureEngineeringFeatureTimeWindowArgs] = None,
description: Optional[str] = None,
filter_condition: Optional[str] = None)func NewFeatureEngineeringFeature(ctx *Context, name string, args FeatureEngineeringFeatureArgs, opts ...ResourceOption) (*FeatureEngineeringFeature, error)public FeatureEngineeringFeature(string name, FeatureEngineeringFeatureArgs args, CustomResourceOptions? opts = null)
public FeatureEngineeringFeature(String name, FeatureEngineeringFeatureArgs args)
public FeatureEngineeringFeature(String name, FeatureEngineeringFeatureArgs args, CustomResourceOptions options)
type: databricks:FeatureEngineeringFeature
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FeatureEngineeringFeatureArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FeatureEngineeringFeatureArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FeatureEngineeringFeatureArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FeatureEngineeringFeatureArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FeatureEngineeringFeatureArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var featureEngineeringFeatureResource = new Databricks.FeatureEngineeringFeature("featureEngineeringFeatureResource", new()
{
FullName = "string",
Function = new Databricks.Inputs.FeatureEngineeringFeatureFunctionArgs
{
FunctionType = "string",
ExtraParameters = new[]
{
new Databricks.Inputs.FeatureEngineeringFeatureFunctionExtraParameterArgs
{
Key = "string",
Value = "string",
},
},
},
Inputs = new[]
{
"string",
},
Source = new Databricks.Inputs.FeatureEngineeringFeatureSourceArgs
{
DeltaTableSource = new Databricks.Inputs.FeatureEngineeringFeatureSourceDeltaTableSourceArgs
{
EntityColumns = new[]
{
"string",
},
FullName = "string",
TimeseriesColumn = "string",
},
},
TimeWindow = new Databricks.Inputs.FeatureEngineeringFeatureTimeWindowArgs
{
Continuous = new Databricks.Inputs.FeatureEngineeringFeatureTimeWindowContinuousArgs
{
WindowDuration = "string",
Offset = "string",
},
Sliding = new Databricks.Inputs.FeatureEngineeringFeatureTimeWindowSlidingArgs
{
SlideDuration = "string",
WindowDuration = "string",
},
Tumbling = new Databricks.Inputs.FeatureEngineeringFeatureTimeWindowTumblingArgs
{
WindowDuration = "string",
},
},
Description = "string",
FilterCondition = "string",
});
example, err := databricks.NewFeatureEngineeringFeature(ctx, "featureEngineeringFeatureResource", &databricks.FeatureEngineeringFeatureArgs{
FullName: pulumi.String("string"),
Function: &databricks.FeatureEngineeringFeatureFunctionArgs{
FunctionType: pulumi.String("string"),
ExtraParameters: databricks.FeatureEngineeringFeatureFunctionExtraParameterArray{
&databricks.FeatureEngineeringFeatureFunctionExtraParameterArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
Inputs: pulumi.StringArray{
pulumi.String("string"),
},
Source: &databricks.FeatureEngineeringFeatureSourceArgs{
DeltaTableSource: &databricks.FeatureEngineeringFeatureSourceDeltaTableSourceArgs{
EntityColumns: pulumi.StringArray{
pulumi.String("string"),
},
FullName: pulumi.String("string"),
TimeseriesColumn: pulumi.String("string"),
},
},
TimeWindow: &databricks.FeatureEngineeringFeatureTimeWindowArgs{
Continuous: &databricks.FeatureEngineeringFeatureTimeWindowContinuousArgs{
WindowDuration: pulumi.String("string"),
Offset: pulumi.String("string"),
},
Sliding: &databricks.FeatureEngineeringFeatureTimeWindowSlidingArgs{
SlideDuration: pulumi.String("string"),
WindowDuration: pulumi.String("string"),
},
Tumbling: &databricks.FeatureEngineeringFeatureTimeWindowTumblingArgs{
WindowDuration: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
FilterCondition: pulumi.String("string"),
})
var featureEngineeringFeatureResource = new FeatureEngineeringFeature("featureEngineeringFeatureResource", FeatureEngineeringFeatureArgs.builder()
.fullName("string")
.function(FeatureEngineeringFeatureFunctionArgs.builder()
.functionType("string")
.extraParameters(FeatureEngineeringFeatureFunctionExtraParameterArgs.builder()
.key("string")
.value("string")
.build())
.build())
.inputs("string")
.source(FeatureEngineeringFeatureSourceArgs.builder()
.deltaTableSource(FeatureEngineeringFeatureSourceDeltaTableSourceArgs.builder()
.entityColumns("string")
.fullName("string")
.timeseriesColumn("string")
.build())
.build())
.timeWindow(FeatureEngineeringFeatureTimeWindowArgs.builder()
.continuous(FeatureEngineeringFeatureTimeWindowContinuousArgs.builder()
.windowDuration("string")
.offset("string")
.build())
.sliding(FeatureEngineeringFeatureTimeWindowSlidingArgs.builder()
.slideDuration("string")
.windowDuration("string")
.build())
.tumbling(FeatureEngineeringFeatureTimeWindowTumblingArgs.builder()
.windowDuration("string")
.build())
.build())
.description("string")
.filterCondition("string")
.build());
feature_engineering_feature_resource = databricks.FeatureEngineeringFeature("featureEngineeringFeatureResource",
full_name="string",
function={
"function_type": "string",
"extra_parameters": [{
"key": "string",
"value": "string",
}],
},
inputs=["string"],
source={
"delta_table_source": {
"entity_columns": ["string"],
"full_name": "string",
"timeseries_column": "string",
},
},
time_window={
"continuous": {
"window_duration": "string",
"offset": "string",
},
"sliding": {
"slide_duration": "string",
"window_duration": "string",
},
"tumbling": {
"window_duration": "string",
},
},
description="string",
filter_condition="string")
const featureEngineeringFeatureResource = new databricks.FeatureEngineeringFeature("featureEngineeringFeatureResource", {
fullName: "string",
"function": {
functionType: "string",
extraParameters: [{
key: "string",
value: "string",
}],
},
inputs: ["string"],
source: {
deltaTableSource: {
entityColumns: ["string"],
fullName: "string",
timeseriesColumn: "string",
},
},
timeWindow: {
continuous: {
windowDuration: "string",
offset: "string",
},
sliding: {
slideDuration: "string",
windowDuration: "string",
},
tumbling: {
windowDuration: "string",
},
},
description: "string",
filterCondition: "string",
});
type: databricks:FeatureEngineeringFeature
properties:
description: string
filterCondition: string
fullName: string
function:
extraParameters:
- key: string
value: string
functionType: string
inputs:
- string
source:
deltaTableSource:
entityColumns:
- string
fullName: string
timeseriesColumn: string
timeWindow:
continuous:
offset: string
windowDuration: string
sliding:
slideDuration: string
windowDuration: string
tumbling:
windowDuration: string
FeatureEngineeringFeature Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The FeatureEngineeringFeature resource accepts the following input properties:
- Full
Name string - The full three-part name (catalog, schema, name) of the feature
- Function
Feature
Engineering Feature Function - The function by which the feature is computed
- Inputs List<string>
- The input columns from which the feature is computed
- Source
Feature
Engineering Feature Source - The data source of the feature
- Time
Window FeatureEngineering Feature Time Window - The time window in which the feature is computed
- Description string
- The description of the feature
- Filter
Condition string - The filter condition applied to the source data before aggregation
- Full
Name string - The full three-part name (catalog, schema, name) of the feature
- Function
Feature
Engineering Feature Function Args - The function by which the feature is computed
- Inputs []string
- The input columns from which the feature is computed
- Source
Feature
Engineering Feature Source Args - The data source of the feature
- Time
Window FeatureEngineering Feature Time Window Args - The time window in which the feature is computed
- Description string
- The description of the feature
- Filter
Condition string - The filter condition applied to the source data before aggregation
- full
Name String - The full three-part name (catalog, schema, name) of the feature
- function
Feature
Engineering Feature Function - The function by which the feature is computed
- inputs List<String>
- The input columns from which the feature is computed
- source
Feature
Engineering Feature Source - The data source of the feature
- time
Window FeatureEngineering Feature Time Window - The time window in which the feature is computed
- description String
- The description of the feature
- filter
Condition String - The filter condition applied to the source data before aggregation
- full
Name string - The full three-part name (catalog, schema, name) of the feature
- function
Feature
Engineering Feature Function - The function by which the feature is computed
- inputs string[]
- The input columns from which the feature is computed
- source
Feature
Engineering Feature Source - The data source of the feature
- time
Window FeatureEngineering Feature Time Window - The time window in which the feature is computed
- description string
- The description of the feature
- filter
Condition string - The filter condition applied to the source data before aggregation
- full_
name str - The full three-part name (catalog, schema, name) of the feature
- function
Feature
Engineering Feature Function Args - The function by which the feature is computed
- inputs Sequence[str]
- The input columns from which the feature is computed
- source
Feature
Engineering Feature Source Args - The data source of the feature
- time_
window FeatureEngineering Feature Time Window Args - The time window in which the feature is computed
- description str
- The description of the feature
- filter_
condition str - The filter condition applied to the source data before aggregation
- full
Name String - The full three-part name (catalog, schema, name) of the feature
- function Property Map
- The function by which the feature is computed
- inputs List<String>
- The input columns from which the feature is computed
- source Property Map
- The data source of the feature
- time
Window Property Map - The time window in which the feature is computed
- description String
- The description of the feature
- filter
Condition String - The filter condition applied to the source data before aggregation
Outputs
All input properties are implicitly available as output properties. Additionally, the FeatureEngineeringFeature resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing FeatureEngineeringFeature Resource
Get an existing FeatureEngineeringFeature resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FeatureEngineeringFeatureState, opts?: CustomResourceOptions): FeatureEngineeringFeature@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
filter_condition: Optional[str] = None,
full_name: Optional[str] = None,
function: Optional[FeatureEngineeringFeatureFunctionArgs] = None,
inputs: Optional[Sequence[str]] = None,
source: Optional[FeatureEngineeringFeatureSourceArgs] = None,
time_window: Optional[FeatureEngineeringFeatureTimeWindowArgs] = None) -> FeatureEngineeringFeaturefunc GetFeatureEngineeringFeature(ctx *Context, name string, id IDInput, state *FeatureEngineeringFeatureState, opts ...ResourceOption) (*FeatureEngineeringFeature, error)public static FeatureEngineeringFeature Get(string name, Input<string> id, FeatureEngineeringFeatureState? state, CustomResourceOptions? opts = null)public static FeatureEngineeringFeature get(String name, Output<String> id, FeatureEngineeringFeatureState state, CustomResourceOptions options)resources: _: type: databricks:FeatureEngineeringFeature get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Description string
- The description of the feature
- Filter
Condition string - The filter condition applied to the source data before aggregation
- Full
Name string - The full three-part name (catalog, schema, name) of the feature
- Function
Feature
Engineering Feature Function - The function by which the feature is computed
- Inputs List<string>
- The input columns from which the feature is computed
- Source
Feature
Engineering Feature Source - The data source of the feature
- Time
Window FeatureEngineering Feature Time Window - The time window in which the feature is computed
- Description string
- The description of the feature
- Filter
Condition string - The filter condition applied to the source data before aggregation
- Full
Name string - The full three-part name (catalog, schema, name) of the feature
- Function
Feature
Engineering Feature Function Args - The function by which the feature is computed
- Inputs []string
- The input columns from which the feature is computed
- Source
Feature
Engineering Feature Source Args - The data source of the feature
- Time
Window FeatureEngineering Feature Time Window Args - The time window in which the feature is computed
- description String
- The description of the feature
- filter
Condition String - The filter condition applied to the source data before aggregation
- full
Name String - The full three-part name (catalog, schema, name) of the feature
- function
Feature
Engineering Feature Function - The function by which the feature is computed
- inputs List<String>
- The input columns from which the feature is computed
- source
Feature
Engineering Feature Source - The data source of the feature
- time
Window FeatureEngineering Feature Time Window - The time window in which the feature is computed
- description string
- The description of the feature
- filter
Condition string - The filter condition applied to the source data before aggregation
- full
Name string - The full three-part name (catalog, schema, name) of the feature
- function
Feature
Engineering Feature Function - The function by which the feature is computed
- inputs string[]
- The input columns from which the feature is computed
- source
Feature
Engineering Feature Source - The data source of the feature
- time
Window FeatureEngineering Feature Time Window - The time window in which the feature is computed
- description str
- The description of the feature
- filter_
condition str - The filter condition applied to the source data before aggregation
- full_
name str - The full three-part name (catalog, schema, name) of the feature
- function
Feature
Engineering Feature Function Args - The function by which the feature is computed
- inputs Sequence[str]
- The input columns from which the feature is computed
- source
Feature
Engineering Feature Source Args - The data source of the feature
- time_
window FeatureEngineering Feature Time Window Args - The time window in which the feature is computed
- description String
- The description of the feature
- filter
Condition String - The filter condition applied to the source data before aggregation
- full
Name String - The full three-part name (catalog, schema, name) of the feature
- function Property Map
- The function by which the feature is computed
- inputs List<String>
- The input columns from which the feature is computed
- source Property Map
- The data source of the feature
- time
Window Property Map - The time window in which the feature is computed
Supporting Types
FeatureEngineeringFeatureFunction, FeatureEngineeringFeatureFunctionArgs
- Function
Type string - The type of the function. Possible values are:
APPROX_COUNT_DISTINCT,APPROX_PERCENTILE,AVG,COUNT,FIRST,LAST,MAX,MIN,STDDEV_POP,STDDEV_SAMP,SUM,VAR_POP,VAR_SAMP - Extra
Parameters List<FeatureEngineering Feature Function Extra Parameter> - Extra parameters for parameterized functions
- Function
Type string - The type of the function. Possible values are:
APPROX_COUNT_DISTINCT,APPROX_PERCENTILE,AVG,COUNT,FIRST,LAST,MAX,MIN,STDDEV_POP,STDDEV_SAMP,SUM,VAR_POP,VAR_SAMP - Extra
Parameters []FeatureEngineering Feature Function Extra Parameter - Extra parameters for parameterized functions
- function
Type String - The type of the function. Possible values are:
APPROX_COUNT_DISTINCT,APPROX_PERCENTILE,AVG,COUNT,FIRST,LAST,MAX,MIN,STDDEV_POP,STDDEV_SAMP,SUM,VAR_POP,VAR_SAMP - extra
Parameters List<FeatureEngineering Feature Function Extra Parameter> - Extra parameters for parameterized functions
- function
Type string - The type of the function. Possible values are:
APPROX_COUNT_DISTINCT,APPROX_PERCENTILE,AVG,COUNT,FIRST,LAST,MAX,MIN,STDDEV_POP,STDDEV_SAMP,SUM,VAR_POP,VAR_SAMP - extra
Parameters FeatureEngineering Feature Function Extra Parameter[] - Extra parameters for parameterized functions
- function_
type str - The type of the function. Possible values are:
APPROX_COUNT_DISTINCT,APPROX_PERCENTILE,AVG,COUNT,FIRST,LAST,MAX,MIN,STDDEV_POP,STDDEV_SAMP,SUM,VAR_POP,VAR_SAMP - extra_
parameters Sequence[FeatureEngineering Feature Function Extra Parameter] - Extra parameters for parameterized functions
- function
Type String - The type of the function. Possible values are:
APPROX_COUNT_DISTINCT,APPROX_PERCENTILE,AVG,COUNT,FIRST,LAST,MAX,MIN,STDDEV_POP,STDDEV_SAMP,SUM,VAR_POP,VAR_SAMP - extra
Parameters List<Property Map> - Extra parameters for parameterized functions
FeatureEngineeringFeatureFunctionExtraParameter, FeatureEngineeringFeatureFunctionExtraParameterArgs
FeatureEngineeringFeatureSource, FeatureEngineeringFeatureSourceArgs
FeatureEngineeringFeatureSourceDeltaTableSource, FeatureEngineeringFeatureSourceDeltaTableSourceArgs
- Entity
Columns List<string> - The entity columns of the Delta table
- Full
Name string - The full three-part name (catalog, schema, name) of the feature
- Timeseries
Column string - The timeseries column of the Delta table
- Entity
Columns []string - The entity columns of the Delta table
- Full
Name string - The full three-part name (catalog, schema, name) of the feature
- Timeseries
Column string - The timeseries column of the Delta table
- entity
Columns List<String> - The entity columns of the Delta table
- full
Name String - The full three-part name (catalog, schema, name) of the feature
- timeseries
Column String - The timeseries column of the Delta table
- entity
Columns string[] - The entity columns of the Delta table
- full
Name string - The full three-part name (catalog, schema, name) of the feature
- timeseries
Column string - The timeseries column of the Delta table
- entity_
columns Sequence[str] - The entity columns of the Delta table
- full_
name str - The full three-part name (catalog, schema, name) of the feature
- timeseries_
column str - The timeseries column of the Delta table
- entity
Columns List<String> - The entity columns of the Delta table
- full
Name String - The full three-part name (catalog, schema, name) of the feature
- timeseries
Column String - The timeseries column of the Delta table
FeatureEngineeringFeatureTimeWindow, FeatureEngineeringFeatureTimeWindowArgs
FeatureEngineeringFeatureTimeWindowContinuous, FeatureEngineeringFeatureTimeWindowContinuousArgs
- Window
Duration string - Offset string
- The offset of the continuous window (must be non-positive)
- Window
Duration string - Offset string
- The offset of the continuous window (must be non-positive)
- window
Duration String - offset String
- The offset of the continuous window (must be non-positive)
- window
Duration string - offset string
- The offset of the continuous window (must be non-positive)
- window_
duration str - offset str
- The offset of the continuous window (must be non-positive)
- window
Duration String - offset String
- The offset of the continuous window (must be non-positive)
FeatureEngineeringFeatureTimeWindowSliding, FeatureEngineeringFeatureTimeWindowSlidingArgs
- Slide
Duration string - The slide duration (interval by which windows advance, must be positive and less than duration)
- Window
Duration string
- Slide
Duration string - The slide duration (interval by which windows advance, must be positive and less than duration)
- Window
Duration string
- slide
Duration String - The slide duration (interval by which windows advance, must be positive and less than duration)
- window
Duration String
- slide
Duration string - The slide duration (interval by which windows advance, must be positive and less than duration)
- window
Duration string
- slide_
duration str - The slide duration (interval by which windows advance, must be positive and less than duration)
- window_
duration str
- slide
Duration String - The slide duration (interval by which windows advance, must be positive and less than duration)
- window
Duration String
FeatureEngineeringFeatureTimeWindowTumbling, FeatureEngineeringFeatureTimeWindowTumblingArgs
- Window
Duration string
- Window
Duration string
- window
Duration String
- window
Duration string
- window_
duration str
- window
Duration String
Import
As of Pulumi v1.5, resources can be imported through configuration.
hcl
import {
id = “full_name”
to = databricks_feature_engineering_feature.this
}
If you are using an older version of Pulumi, import the resource using the pulumi import command as follows:
$ pulumi import databricks:index/featureEngineeringFeature:FeatureEngineeringFeature this "full_name"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricksTerraform Provider.
