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

google-native.aiplatform/v1.FeatureGroup

Explore with Pulumi AI

google-native logo

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

    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 string
    The unique name of the resource.
    args FeatureGroupArgs
    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 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 string
    The unique name of the resource.
    args FeatureGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FeatureGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FeatureGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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",
    });
    
    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"),
    })
    
    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());
    
    feature_group_resource = google_native.aiplatform.v1.FeatureGroup("featureGroupResource",
        feature_group_id="string",
        big_query=google_native.aiplatform.v1.GoogleCloudAiplatformV1FeatureGroupBigQueryArgs(
            big_query_source=google_native.aiplatform.v1.GoogleCloudAiplatformV1BigQuerySourceArgs(
                input_uri="string",
            ),
            entity_id_columns=["string"],
        ),
        description="string",
        etag="string",
        labels={
            "string": "string",
        },
        location="string",
        project="string")
    
    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",
    });
    
    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
    

    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

    The FeatureGroup resource accepts the following input properties:

    FeatureGroupId 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 string
    Project string
    FeatureGroupId 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 string
    Project string
    featureGroupId 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 String
    project String
    featureGroupId 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 string
    project string
    feature_group_id 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 str
    project str
    featureGroupId 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 String
    project 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 string
    BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
    InputUri string
    BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
    inputUri String
    BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
    inputUri string
    BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
    input_uri str
    BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.
    inputUri String
    BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: bq://projectId.bqDatasetId.bqTableId.

    GoogleCloudAiplatformV1BigQuerySourceResponse, GoogleCloudAiplatformV1BigQuerySourceResponseArgs

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

    GoogleCloudAiplatformV1FeatureGroupBigQuery, GoogleCloudAiplatformV1FeatureGroupBigQueryArgs

    BigQuerySource 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 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 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 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 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 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 Pulumi.GoogleNative.Aiplatform.V1.Inputs.GoogleCloudAiplatformV1BigQuerySourceResponse
    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 GoogleCloudAiplatformV1BigQuerySourceResponse
    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 GoogleCloudAiplatformV1BigQuerySourceResponse
    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 GoogleCloudAiplatformV1BigQuerySourceResponse
    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 GoogleCloudAiplatformV1BigQuerySourceResponse
    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 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.

    Package Details

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

    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