Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1
  6. FeatureGroup

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.aiplatform/v1.FeatureGroup

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a new FeatureGroup in a given project and location. Auto-naming is currently not supported for this resource.

Create FeatureGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new FeatureGroup(name: string, args: FeatureGroupArgs, opts?: CustomResourceOptions);
@overload
def FeatureGroup(resource_name: str,
                 args: FeatureGroupArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def FeatureGroup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 feature_group_id: Optional[str] = None,
                 big_query: Optional[GoogleCloudAiplatformV1FeatureGroupBigQueryArgs] = None,
                 description: Optional[str] = None,
                 etag: Optional[str] = None,
                 labels: Optional[Mapping[str, str]] = None,
                 location: Optional[str] = None,
                 project: Optional[str] = None)
func NewFeatureGroup(ctx *Context, name string, args FeatureGroupArgs, opts ...ResourceOption) (*FeatureGroup, error)
public FeatureGroup(string name, FeatureGroupArgs args, CustomResourceOptions? opts = null)
public FeatureGroup(String name, FeatureGroupArgs args)
public FeatureGroup(String name, FeatureGroupArgs args, CustomResourceOptions options)

type: google-native:aiplatform/v1:FeatureGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FeatureGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. FeatureGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. FeatureGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FeatureGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FeatureGroupArgs
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 featureGroupResource = new GoogleNative.Aiplatform.V1.FeatureGroup("featureGroupResource", new()
{
    FeatureGroupId = "string",
    BigQuery = new GoogleNative.Aiplatform.V1.Inputs.GoogleCloudAiplatformV1FeatureGroupBigQueryArgs
    {
        BigQuerySource = new GoogleNative.Aiplatform.V1.Inputs.GoogleCloudAiplatformV1BigQuerySourceArgs
        {
            InputUri = "string",
        },
        EntityIdColumns = new[]
        {
            "string",
        },
    },
    Description = "string",
    Etag = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Project = "string",
});
Copy
example, err := aiplatform.NewFeatureGroup(ctx, "featureGroupResource", &aiplatform.FeatureGroupArgs{
	FeatureGroupId: pulumi.String("string"),
	BigQuery: &aiplatform.GoogleCloudAiplatformV1FeatureGroupBigQueryArgs{
		BigQuerySource: &aiplatform.GoogleCloudAiplatformV1BigQuerySourceArgs{
			InputUri: pulumi.String("string"),
		},
		EntityIdColumns: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Etag:        pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Project:  pulumi.String("string"),
})
Copy
var featureGroupResource = new FeatureGroup("featureGroupResource", FeatureGroupArgs.builder()
    .featureGroupId("string")
    .bigQuery(GoogleCloudAiplatformV1FeatureGroupBigQueryArgs.builder()
        .bigQuerySource(GoogleCloudAiplatformV1BigQuerySourceArgs.builder()
            .inputUri("string")
            .build())
        .entityIdColumns("string")
        .build())
    .description("string")
    .etag("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .project("string")
    .build());
Copy
feature_group_resource = google_native.aiplatform.v1.FeatureGroup("featureGroupResource",
    feature_group_id="string",
    big_query={
        "big_query_source": {
            "input_uri": "string",
        },
        "entity_id_columns": ["string"],
    },
    description="string",
    etag="string",
    labels={
        "string": "string",
    },
    location="string",
    project="string")
Copy
const featureGroupResource = new google_native.aiplatform.v1.FeatureGroup("featureGroupResource", {
    featureGroupId: "string",
    bigQuery: {
        bigQuerySource: {
            inputUri: "string",
        },
        entityIdColumns: ["string"],
    },
    description: "string",
    etag: "string",
    labels: {
        string: "string",
    },
    location: "string",
    project: "string",
});
Copy
type: google-native:aiplatform/v1:FeatureGroup
properties:
    bigQuery:
        bigQuerySource:
            inputUri: string
        entityIdColumns:
            - string
    description: string
    etag: string
    featureGroupId: string
    labels:
        string: string
    location: string
    project: string
Copy

FeatureGroup 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 FeatureGroup resource accepts the following input properties:

FeatureGroupId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number. The value must be unique within the project and location.
BigQuery Pulumi.GoogleNative.Aiplatform.V1.Inputs.GoogleCloudAiplatformV1FeatureGroupBigQuery
Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source, which is required to have an entity_id and a feature_timestamp column in the source.
Description string
Optional. Description of the FeatureGroup.
Etag string
Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Labels Dictionary<string, string>
Optional. The labels with user-defined metadata to organize your FeatureGroup. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
Location Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. string
FeatureGroupId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number. The value must be unique within the project and location.
BigQuery GoogleCloudAiplatformV1FeatureGroupBigQueryArgs
Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source, which is required to have an entity_id and a feature_timestamp column in the source.
Description string
Optional. Description of the FeatureGroup.
Etag string
Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Labels map[string]string
Optional. The labels with user-defined metadata to organize your FeatureGroup. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
Location Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. string
featureGroupId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number. The value must be unique within the project and location.
bigQuery GoogleCloudAiplatformV1FeatureGroupBigQuery
Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source, which is required to have an entity_id and a feature_timestamp column in the source.
description String
Optional. Description of the FeatureGroup.
etag String
Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels Map<String,String>
Optional. The labels with user-defined metadata to organize your FeatureGroup. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
location Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. String
featureGroupId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number. The value must be unique within the project and location.
bigQuery GoogleCloudAiplatformV1FeatureGroupBigQuery
Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source, which is required to have an entity_id and a feature_timestamp column in the source.
description string
Optional. Description of the FeatureGroup.
etag string
Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels {[key: string]: string}
Optional. The labels with user-defined metadata to organize your FeatureGroup. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
location Changes to this property will trigger replacement. string
project Changes to this property will trigger replacement. string
feature_group_id
This property is required.
Changes to this property will trigger replacement.
str
Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number. The value must be unique within the project and location.
big_query GoogleCloudAiplatformV1FeatureGroupBigQueryArgs
Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source, which is required to have an entity_id and a feature_timestamp column in the source.
description str
Optional. Description of the FeatureGroup.
etag str
Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels Mapping[str, str]
Optional. The labels with user-defined metadata to organize your FeatureGroup. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
location Changes to this property will trigger replacement. str
project Changes to this property will trigger replacement. str
featureGroupId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number. The value must be unique within the project and location.
bigQuery Property Map
Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source, which is required to have an entity_id and a feature_timestamp column in the source.
description String
Optional. Description of the FeatureGroup.
etag String
Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels Map<String>
Optional. The labels with user-defined metadata to organize your FeatureGroup. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
location Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. String

Outputs

All input properties are implicitly available as output properties. Additionally, the FeatureGroup resource produces the following output properties:

CreateTime string
Timestamp when this FeatureGroup was created.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Name of the FeatureGroup. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}
UpdateTime string
Timestamp when this FeatureGroup was last updated.
CreateTime string
Timestamp when this FeatureGroup was created.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Name of the FeatureGroup. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}
UpdateTime string
Timestamp when this FeatureGroup was last updated.
createTime String
Timestamp when this FeatureGroup was created.
id String
The provider-assigned unique ID for this managed resource.
name String
Name of the FeatureGroup. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}
updateTime String
Timestamp when this FeatureGroup was last updated.
createTime string
Timestamp when this FeatureGroup was created.
id string
The provider-assigned unique ID for this managed resource.
name string
Name of the FeatureGroup. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}
updateTime string
Timestamp when this FeatureGroup was last updated.
create_time str
Timestamp when this FeatureGroup was created.
id str
The provider-assigned unique ID for this managed resource.
name str
Name of the FeatureGroup. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}
update_time str
Timestamp when this FeatureGroup was last updated.
createTime String
Timestamp when this FeatureGroup was created.
id String
The provider-assigned unique ID for this managed resource.
name String
Name of the FeatureGroup. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}
updateTime String
Timestamp when this FeatureGroup was last updated.

Supporting Types

GoogleCloudAiplatformV1BigQuerySource
, GoogleCloudAiplatformV1BigQuerySourceArgs

InputUri This property is required. string
BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
InputUri This property is required. string
BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
inputUri This property is required. String
BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
inputUri This property is required. string
BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
input_uri This property is required. str
BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
inputUri This property is required. String
BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.

GoogleCloudAiplatformV1BigQuerySourceResponse
, GoogleCloudAiplatformV1BigQuerySourceResponseArgs

InputUri This property is required. string
BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
InputUri This property is required. string
BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
inputUri This property is required. String
BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
inputUri This property is required. string
BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
input_uri This property is required. str
BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
inputUri This property is required. String
BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.

GoogleCloudAiplatformV1FeatureGroupBigQuery
, GoogleCloudAiplatformV1FeatureGroupBigQueryArgs

BigQuerySource This property is required. Pulumi.GoogleNative.Aiplatform.V1.Inputs.GoogleCloudAiplatformV1BigQuerySource
Immutable. The BigQuery source URI that points to either a BigQuery Table or View.
EntityIdColumns List<string>
Optional. Columns to construct entity_id / row keys. Currently only supports 1 entity_id_column. If not provided defaults to entity_id.
BigQuerySource This property is required. GoogleCloudAiplatformV1BigQuerySource
Immutable. The BigQuery source URI that points to either a BigQuery Table or View.
EntityIdColumns []string
Optional. Columns to construct entity_id / row keys. Currently only supports 1 entity_id_column. If not provided defaults to entity_id.
bigQuerySource This property is required. GoogleCloudAiplatformV1BigQuerySource
Immutable. The BigQuery source URI that points to either a BigQuery Table or View.
entityIdColumns List<String>
Optional. Columns to construct entity_id / row keys. Currently only supports 1 entity_id_column. If not provided defaults to entity_id.
bigQuerySource This property is required. GoogleCloudAiplatformV1BigQuerySource
Immutable. The BigQuery source URI that points to either a BigQuery Table or View.
entityIdColumns string[]
Optional. Columns to construct entity_id / row keys. Currently only supports 1 entity_id_column. If not provided defaults to entity_id.
big_query_source This property is required. GoogleCloudAiplatformV1BigQuerySource
Immutable. The BigQuery source URI that points to either a BigQuery Table or View.
entity_id_columns Sequence[str]
Optional. Columns to construct entity_id / row keys. Currently only supports 1 entity_id_column. If not provided defaults to entity_id.
bigQuerySource This property is required. Property Map
Immutable. The BigQuery source URI that points to either a BigQuery Table or View.
entityIdColumns List<String>
Optional. Columns to construct entity_id / row keys. Currently only supports 1 entity_id_column. If not provided defaults to entity_id.

GoogleCloudAiplatformV1FeatureGroupBigQueryResponse
, GoogleCloudAiplatformV1FeatureGroupBigQueryResponseArgs

BigQuerySource This property is required. Pulumi.GoogleNative.Aiplatform.V1.Inputs.GoogleCloudAiplatformV1BigQuerySourceResponse
Immutable. The BigQuery source URI that points to either a BigQuery Table or View.
EntityIdColumns This property is required. List<string>
Optional. Columns to construct entity_id / row keys. Currently only supports 1 entity_id_column. If not provided defaults to entity_id.
BigQuerySource This property is required. GoogleCloudAiplatformV1BigQuerySourceResponse
Immutable. The BigQuery source URI that points to either a BigQuery Table or View.
EntityIdColumns This property is required. []string
Optional. Columns to construct entity_id / row keys. Currently only supports 1 entity_id_column. If not provided defaults to entity_id.
bigQuerySource This property is required. GoogleCloudAiplatformV1BigQuerySourceResponse
Immutable. The BigQuery source URI that points to either a BigQuery Table or View.
entityIdColumns This property is required. List<String>
Optional. Columns to construct entity_id / row keys. Currently only supports 1 entity_id_column. If not provided defaults to entity_id.
bigQuerySource This property is required. GoogleCloudAiplatformV1BigQuerySourceResponse
Immutable. The BigQuery source URI that points to either a BigQuery Table or View.
entityIdColumns This property is required. string[]
Optional. Columns to construct entity_id / row keys. Currently only supports 1 entity_id_column. If not provided defaults to entity_id.
big_query_source This property is required. GoogleCloudAiplatformV1BigQuerySourceResponse
Immutable. The BigQuery source URI that points to either a BigQuery Table or View.
entity_id_columns This property is required. Sequence[str]
Optional. Columns to construct entity_id / row keys. Currently only supports 1 entity_id_column. If not provided defaults to entity_id.
bigQuerySource This property is required. Property Map
Immutable. The BigQuery source URI that points to either a BigQuery Table or View.
entityIdColumns This property is required. List<String>
Optional. Columns to construct entity_id / row keys. Currently only supports 1 entity_id_column. If not provided defaults to entity_id.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native