Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1
  6. getFeaturestore

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.getFeaturestore

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
pulumi/pulumi-google-native

    Gets details of a single Featurestore.

    Using getFeaturestore

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFeaturestore(args: GetFeaturestoreArgs, opts?: InvokeOptions): Promise<GetFeaturestoreResult>
function getFeaturestoreOutput(args: GetFeaturestoreOutputArgs, opts?: InvokeOptions): Output<GetFeaturestoreResult>
    def get_featurestore(featurestore_id: Optional[str] = None,
                     location: Optional[str] = None,
                     project: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetFeaturestoreResult
def get_featurestore_output(featurestore_id: Optional[pulumi.Input[str]] = None,
                     location: Optional[pulumi.Input[str]] = None,
                     project: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetFeaturestoreResult]
    func LookupFeaturestore(ctx *Context, args *LookupFeaturestoreArgs, opts ...InvokeOption) (*LookupFeaturestoreResult, error)
func LookupFeaturestoreOutput(ctx *Context, args *LookupFeaturestoreOutputArgs, opts ...InvokeOption) LookupFeaturestoreResultOutput

    > Note: This function is named LookupFeaturestore in the Go SDK.

    public static class GetFeaturestore 
{
    public static Task<GetFeaturestoreResult> InvokeAsync(GetFeaturestoreArgs args, InvokeOptions? opts = null)
    public static Output<GetFeaturestoreResult> Invoke(GetFeaturestoreInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFeaturestoreResult> getFeaturestore(GetFeaturestoreArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:aiplatform/v1:getFeaturestore
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FeaturestoreId string
    Location string
    Project string
    FeaturestoreId string
    Location string
    Project string
    featurestoreId String
    location String
    project String
    featurestoreId string
    location string
    project string
    featurestoreId String
    location String
    project String

    getFeaturestore Result

    The following output properties are available:

    CreateTime string
    Timestamp when this Featurestore was created.
    EncryptionSpec Pulumi.GoogleNative.Aiplatform.V1.Outputs.GoogleCloudAiplatformV1EncryptionSpecResponse
    Optional. Customer-managed encryption key spec for data storage. If set, both of the online and offline data storage will be secured by this key.
    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 Featurestore. 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 Featurestore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
    Name string
    Name of the Featurestore. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
    OnlineServingConfig Pulumi.GoogleNative.Aiplatform.V1.Outputs.GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigResponse
    Optional. Config for online storage resources. The field should not co-exist with the field of OnlineStoreReplicationConfig. If both of it and OnlineStoreReplicationConfig are unset, the feature store will not have an online store and cannot be used for online serving.
    OnlineStorageTtlDays int
    Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than online_storage_ttl_days since the feature generation time. Note that online_storage_ttl_days should be less than or equal to offline_storage_ttl_days for each EntityType under a featurestore. If not set, default to 4000 days
    State string
    State of the featurestore.
    UpdateTime string
    Timestamp when this Featurestore was last updated.
    CreateTime string
    Timestamp when this Featurestore was created.
    EncryptionSpec GoogleCloudAiplatformV1EncryptionSpecResponse
    Optional. Customer-managed encryption key spec for data storage. If set, both of the online and offline data storage will be secured by this key.
    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 Featurestore. 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 Featurestore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
    Name string
    Name of the Featurestore. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
    OnlineServingConfig GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigResponse
    Optional. Config for online storage resources. The field should not co-exist with the field of OnlineStoreReplicationConfig. If both of it and OnlineStoreReplicationConfig are unset, the feature store will not have an online store and cannot be used for online serving.
    OnlineStorageTtlDays int
    Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than online_storage_ttl_days since the feature generation time. Note that online_storage_ttl_days should be less than or equal to offline_storage_ttl_days for each EntityType under a featurestore. If not set, default to 4000 days
    State string
    State of the featurestore.
    UpdateTime string
    Timestamp when this Featurestore was last updated.
    createTime String
    Timestamp when this Featurestore was created.
    encryptionSpec GoogleCloudAiplatformV1EncryptionSpecResponse
    Optional. Customer-managed encryption key spec for data storage. If set, both of the online and offline data storage will be secured by this key.
    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 Featurestore. 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 Featurestore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
    name String
    Name of the Featurestore. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
    onlineServingConfig GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigResponse
    Optional. Config for online storage resources. The field should not co-exist with the field of OnlineStoreReplicationConfig. If both of it and OnlineStoreReplicationConfig are unset, the feature store will not have an online store and cannot be used for online serving.
    onlineStorageTtlDays Integer
    Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than online_storage_ttl_days since the feature generation time. Note that online_storage_ttl_days should be less than or equal to offline_storage_ttl_days for each EntityType under a featurestore. If not set, default to 4000 days
    state String
    State of the featurestore.
    updateTime String
    Timestamp when this Featurestore was last updated.
    createTime string
    Timestamp when this Featurestore was created.
    encryptionSpec GoogleCloudAiplatformV1EncryptionSpecResponse
    Optional. Customer-managed encryption key spec for data storage. If set, both of the online and offline data storage will be secured by this key.
    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 Featurestore. 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 Featurestore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
    name string
    Name of the Featurestore. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
    onlineServingConfig GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigResponse
    Optional. Config for online storage resources. The field should not co-exist with the field of OnlineStoreReplicationConfig. If both of it and OnlineStoreReplicationConfig are unset, the feature store will not have an online store and cannot be used for online serving.
    onlineStorageTtlDays number
    Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than online_storage_ttl_days since the feature generation time. Note that online_storage_ttl_days should be less than or equal to offline_storage_ttl_days for each EntityType under a featurestore. If not set, default to 4000 days
    state string
    State of the featurestore.
    updateTime string
    Timestamp when this Featurestore was last updated.
    create_time str
    Timestamp when this Featurestore was created.
    encryption_spec GoogleCloudAiplatformV1EncryptionSpecResponse
    Optional. Customer-managed encryption key spec for data storage. If set, both of the online and offline data storage will be secured by this key.
    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 Featurestore. 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 Featurestore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
    name str
    Name of the Featurestore. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
    online_serving_config GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigResponse
    Optional. Config for online storage resources. The field should not co-exist with the field of OnlineStoreReplicationConfig. If both of it and OnlineStoreReplicationConfig are unset, the feature store will not have an online store and cannot be used for online serving.
    online_storage_ttl_days int
    Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than online_storage_ttl_days since the feature generation time. Note that online_storage_ttl_days should be less than or equal to offline_storage_ttl_days for each EntityType under a featurestore. If not set, default to 4000 days
    state str
    State of the featurestore.
    update_time str
    Timestamp when this Featurestore was last updated.
    createTime String
    Timestamp when this Featurestore was created.
    encryptionSpec Property Map
    Optional. Customer-managed encryption key spec for data storage. If set, both of the online and offline data storage will be secured by this key.
    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 Featurestore. 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 Featurestore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
    name String
    Name of the Featurestore. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
    onlineServingConfig Property Map
    Optional. Config for online storage resources. The field should not co-exist with the field of OnlineStoreReplicationConfig. If both of it and OnlineStoreReplicationConfig are unset, the feature store will not have an online store and cannot be used for online serving.
    onlineStorageTtlDays Number
    Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than online_storage_ttl_days since the feature generation time. Note that online_storage_ttl_days should be less than or equal to offline_storage_ttl_days for each EntityType under a featurestore. If not set, default to 4000 days
    state String
    State of the featurestore.
    updateTime String
    Timestamp when this Featurestore was last updated.

    Supporting Types

    GoogleCloudAiplatformV1EncryptionSpecResponse

    KmsKeyName string
    The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
    KmsKeyName string
    The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
    kmsKeyName String
    The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
    kmsKeyName string
    The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
    kms_key_name str
    The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
    kmsKeyName String
    The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.

    GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigResponse

    FixedNodeCount int
    The number of nodes for the online store. The number of nodes doesn't scale automatically, but you can manually update the number of nodes. If set to 0, the featurestore will not have an online store and cannot be used for online serving.
    Scaling Pulumi.GoogleNative.Aiplatform.V1.Inputs.GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScalingResponse
    Online serving scaling configuration. Only one of fixed_node_count and scaling can be set. Setting one will reset the other.
    FixedNodeCount int
    The number of nodes for the online store. The number of nodes doesn't scale automatically, but you can manually update the number of nodes. If set to 0, the featurestore will not have an online store and cannot be used for online serving.
    Scaling GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScalingResponse
    Online serving scaling configuration. Only one of fixed_node_count and scaling can be set. Setting one will reset the other.
    fixedNodeCount Integer
    The number of nodes for the online store. The number of nodes doesn't scale automatically, but you can manually update the number of nodes. If set to 0, the featurestore will not have an online store and cannot be used for online serving.
    scaling GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScalingResponse
    Online serving scaling configuration. Only one of fixed_node_count and scaling can be set. Setting one will reset the other.
    fixedNodeCount number
    The number of nodes for the online store. The number of nodes doesn't scale automatically, but you can manually update the number of nodes. If set to 0, the featurestore will not have an online store and cannot be used for online serving.
    scaling GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScalingResponse
    Online serving scaling configuration. Only one of fixed_node_count and scaling can be set. Setting one will reset the other.
    fixed_node_count int
    The number of nodes for the online store. The number of nodes doesn't scale automatically, but you can manually update the number of nodes. If set to 0, the featurestore will not have an online store and cannot be used for online serving.
    scaling GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScalingResponse
    Online serving scaling configuration. Only one of fixed_node_count and scaling can be set. Setting one will reset the other.
    fixedNodeCount Number
    The number of nodes for the online store. The number of nodes doesn't scale automatically, but you can manually update the number of nodes. If set to 0, the featurestore will not have an online store and cannot be used for online serving.
    scaling Property Map
    Online serving scaling configuration. Only one of fixed_node_count and scaling can be set. Setting one will reset the other.

    GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScalingResponse

    CpuUtilizationTarget int
    Optional. The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization), and is limited between 10 and 80. When a cluster's CPU utilization exceeds the target that you have set, Bigtable immediately adds nodes to the cluster. When CPU utilization is substantially lower than the target, Bigtable removes nodes. If not set or set to 0, default to 50.
    MaxNodeCount int
    The maximum number of nodes to scale up to. Must be greater than min_node_count, and less than or equal to 10 times of 'min_node_count'.
    MinNodeCount int
    The minimum number of nodes to scale down to. Must be greater than or equal to 1.
    CpuUtilizationTarget int
    Optional. The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization), and is limited between 10 and 80. When a cluster's CPU utilization exceeds the target that you have set, Bigtable immediately adds nodes to the cluster. When CPU utilization is substantially lower than the target, Bigtable removes nodes. If not set or set to 0, default to 50.
    MaxNodeCount int
    The maximum number of nodes to scale up to. Must be greater than min_node_count, and less than or equal to 10 times of 'min_node_count'.
    MinNodeCount int
    The minimum number of nodes to scale down to. Must be greater than or equal to 1.
    cpuUtilizationTarget Integer
    Optional. The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization), and is limited between 10 and 80. When a cluster's CPU utilization exceeds the target that you have set, Bigtable immediately adds nodes to the cluster. When CPU utilization is substantially lower than the target, Bigtable removes nodes. If not set or set to 0, default to 50.
    maxNodeCount Integer
    The maximum number of nodes to scale up to. Must be greater than min_node_count, and less than or equal to 10 times of 'min_node_count'.
    minNodeCount Integer
    The minimum number of nodes to scale down to. Must be greater than or equal to 1.
    cpuUtilizationTarget number
    Optional. The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization), and is limited between 10 and 80. When a cluster's CPU utilization exceeds the target that you have set, Bigtable immediately adds nodes to the cluster. When CPU utilization is substantially lower than the target, Bigtable removes nodes. If not set or set to 0, default to 50.
    maxNodeCount number
    The maximum number of nodes to scale up to. Must be greater than min_node_count, and less than or equal to 10 times of 'min_node_count'.
    minNodeCount number
    The minimum number of nodes to scale down to. Must be greater than or equal to 1.
    cpu_utilization_target int
    Optional. The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization), and is limited between 10 and 80. When a cluster's CPU utilization exceeds the target that you have set, Bigtable immediately adds nodes to the cluster. When CPU utilization is substantially lower than the target, Bigtable removes nodes. If not set or set to 0, default to 50.
    max_node_count int
    The maximum number of nodes to scale up to. Must be greater than min_node_count, and less than or equal to 10 times of 'min_node_count'.
    min_node_count int
    The minimum number of nodes to scale down to. Must be greater than or equal to 1.
    cpuUtilizationTarget Number
    Optional. The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization), and is limited between 10 and 80. When a cluster's CPU utilization exceeds the target that you have set, Bigtable immediately adds nodes to the cluster. When CPU utilization is substantially lower than the target, Bigtable removes nodes. If not set or set to 0, default to 50.
    maxNodeCount Number
    The maximum number of nodes to scale up to. Must be greater than min_node_count, and less than or equal to 10 times of 'min_node_count'.
    minNodeCount Number
    The minimum number of nodes to scale down to. Must be greater than or equal to 1.

    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
    pulumi/pulumi-google-native