Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.discoveryengine/v1alpha.DataStore
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
Create DataStore Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DataStore(name: string, args: DataStoreArgs, opts?: CustomResourceOptions);@overload
def DataStore(resource_name: str,
              args: DataStoreArgs,
              opts: Optional[ResourceOptions] = None)
@overload
def DataStore(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              collection_id: Optional[str] = None,
              data_store_id: Optional[str] = None,
              display_name: Optional[str] = None,
              content_config: Optional[DataStoreContentConfig] = None,
              create_advanced_site_search: Optional[bool] = None,
              industry_vertical: Optional[DataStoreIndustryVertical] = None,
              location: Optional[str] = None,
              name: Optional[str] = None,
              project: Optional[str] = None,
              solution_types: Optional[Sequence[DataStoreSolutionTypesItem]] = None)func NewDataStore(ctx *Context, name string, args DataStoreArgs, opts ...ResourceOption) (*DataStore, error)public DataStore(string name, DataStoreArgs args, CustomResourceOptions? opts = null)
public DataStore(String name, DataStoreArgs args)
public DataStore(String name, DataStoreArgs args, CustomResourceOptions options)
type: google-native:discoveryengine/v1alpha:DataStore
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 DataStoreArgs
- 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 DataStoreArgs
- 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 DataStoreArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DataStoreArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DataStoreArgs
- 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 dataStoreResource = new GoogleNative.DiscoveryEngine.V1Alpha.DataStore("dataStoreResource", new()
{
    CollectionId = "string",
    DataStoreId = "string",
    DisplayName = "string",
    ContentConfig = GoogleNative.DiscoveryEngine.V1Alpha.DataStoreContentConfig.ContentConfigUnspecified,
    CreateAdvancedSiteSearch = false,
    IndustryVertical = GoogleNative.DiscoveryEngine.V1Alpha.DataStoreIndustryVertical.IndustryVerticalUnspecified,
    Location = "string",
    Name = "string",
    Project = "string",
    SolutionTypes = new[]
    {
        GoogleNative.DiscoveryEngine.V1Alpha.DataStoreSolutionTypesItem.SolutionTypeUnspecified,
    },
});
example, err := discoveryengine.NewDataStore(ctx, "dataStoreResource", &discoveryengine.DataStoreArgs{
	CollectionId:             pulumi.String("string"),
	DataStoreId:              pulumi.String("string"),
	DisplayName:              pulumi.String("string"),
	ContentConfig:            discoveryengine.DataStoreContentConfigContentConfigUnspecified,
	CreateAdvancedSiteSearch: pulumi.Bool(false),
	IndustryVertical:         discoveryengine.DataStoreIndustryVerticalIndustryVerticalUnspecified,
	Location:                 pulumi.String("string"),
	Name:                     pulumi.String("string"),
	Project:                  pulumi.String("string"),
	SolutionTypes: discoveryengine.DataStoreSolutionTypesItemArray{
		discoveryengine.DataStoreSolutionTypesItemSolutionTypeUnspecified,
	},
})
var dataStoreResource = new DataStore("dataStoreResource", DataStoreArgs.builder()
    .collectionId("string")
    .dataStoreId("string")
    .displayName("string")
    .contentConfig("CONTENT_CONFIG_UNSPECIFIED")
    .createAdvancedSiteSearch(false)
    .industryVertical("INDUSTRY_VERTICAL_UNSPECIFIED")
    .location("string")
    .name("string")
    .project("string")
    .solutionTypes("SOLUTION_TYPE_UNSPECIFIED")
    .build());
data_store_resource = google_native.discoveryengine.v1alpha.DataStore("dataStoreResource",
    collection_id="string",
    data_store_id="string",
    display_name="string",
    content_config=google_native.discoveryengine.v1alpha.DataStoreContentConfig.CONTENT_CONFIG_UNSPECIFIED,
    create_advanced_site_search=False,
    industry_vertical=google_native.discoveryengine.v1alpha.DataStoreIndustryVertical.INDUSTRY_VERTICAL_UNSPECIFIED,
    location="string",
    name="string",
    project="string",
    solution_types=[google_native.discoveryengine.v1alpha.DataStoreSolutionTypesItem.SOLUTION_TYPE_UNSPECIFIED])
const dataStoreResource = new google_native.discoveryengine.v1alpha.DataStore("dataStoreResource", {
    collectionId: "string",
    dataStoreId: "string",
    displayName: "string",
    contentConfig: google_native.discoveryengine.v1alpha.DataStoreContentConfig.ContentConfigUnspecified,
    createAdvancedSiteSearch: false,
    industryVertical: google_native.discoveryengine.v1alpha.DataStoreIndustryVertical.IndustryVerticalUnspecified,
    location: "string",
    name: "string",
    project: "string",
    solutionTypes: [google_native.discoveryengine.v1alpha.DataStoreSolutionTypesItem.SolutionTypeUnspecified],
});
type: google-native:discoveryengine/v1alpha:DataStore
properties:
    collectionId: string
    contentConfig: CONTENT_CONFIG_UNSPECIFIED
    createAdvancedSiteSearch: false
    dataStoreId: string
    displayName: string
    industryVertical: INDUSTRY_VERTICAL_UNSPECIFIED
    location: string
    name: string
    project: string
    solutionTypes:
        - SOLUTION_TYPE_UNSPECIFIED
DataStore 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 DataStore resource accepts the following input properties:
- CollectionId string
- DataStore stringId 
- Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
- DisplayName string
- The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
- ContentConfig Pulumi.Google Native. Discovery Engine. V1Alpha. Data Store Content Config 
- Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
- CreateAdvanced boolSite Search 
- A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
- IndustryVertical Pulumi.Google Native. Discovery Engine. V1Alpha. Data Store Industry Vertical 
- Immutable. The industry vertical that the data store registers.
- Location string
- Name string
- Immutable. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- Project string
- SolutionTypes List<Pulumi.Google Native. Discovery Engine. V1Alpha. Data Store Solution Types Item> 
- The solutions that the data store enrolls. Available solutions for each industry_vertical: * MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH. *SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
- CollectionId string
- DataStore stringId 
- Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
- DisplayName string
- The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
- ContentConfig DataStore Content Config 
- Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
- CreateAdvanced boolSite Search 
- A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
- IndustryVertical DataStore Industry Vertical 
- Immutable. The industry vertical that the data store registers.
- Location string
- Name string
- Immutable. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- Project string
- SolutionTypes []DataStore Solution Types Item 
- The solutions that the data store enrolls. Available solutions for each industry_vertical: * MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH. *SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
- collectionId String
- dataStore StringId 
- Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
- displayName String
- The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
- contentConfig DataStore Content Config 
- Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
- createAdvanced BooleanSite Search 
- A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
- industryVertical DataStore Industry Vertical 
- Immutable. The industry vertical that the data store registers.
- location String
- name String
- Immutable. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- project String
- solutionTypes List<DataStore Solution Types Item> 
- The solutions that the data store enrolls. Available solutions for each industry_vertical: * MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH. *SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
- collectionId string
- dataStore stringId 
- Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
- displayName string
- The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
- contentConfig DataStore Content Config 
- Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
- createAdvanced booleanSite Search 
- A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
- industryVertical DataStore Industry Vertical 
- Immutable. The industry vertical that the data store registers.
- location string
- name string
- Immutable. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- project string
- solutionTypes DataStore Solution Types Item[] 
- The solutions that the data store enrolls. Available solutions for each industry_vertical: * MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH. *SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
- collection_id str
- data_store_ strid 
- Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
- display_name str
- The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
- content_config DataStore Content Config 
- Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
- create_advanced_ boolsite_ search 
- A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
- industry_vertical DataStore Industry Vertical 
- Immutable. The industry vertical that the data store registers.
- location str
- name str
- Immutable. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- project str
- solution_types Sequence[DataStore Solution Types Item] 
- The solutions that the data store enrolls. Available solutions for each industry_vertical: * MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH. *SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
- collectionId String
- dataStore StringId 
- Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
- displayName String
- The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
- contentConfig "CONTENT_CONFIG_UNSPECIFIED" | "NO_CONTENT" | "CONTENT_REQUIRED" | "PUBLIC_WEBSITE"
- Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
- createAdvanced BooleanSite Search 
- A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
- industryVertical "INDUSTRY_VERTICAL_UNSPECIFIED" | "GENERIC" | "MEDIA"
- Immutable. The industry vertical that the data store registers.
- location String
- name String
- Immutable. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- project String
- solutionTypes List<"SOLUTION_TYPE_UNSPECIFIED" | "SOLUTION_TYPE_RECOMMENDATION" | "SOLUTION_TYPE_SEARCH" | "SOLUTION_TYPE_CHAT">
- The solutions that the data store enrolls. Available solutions for each industry_vertical: * MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH. *SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
Outputs
All input properties are implicitly available as output properties. Additionally, the DataStore resource produces the following output properties:
- CreateTime string
- Timestamp the DataStore was created at.
- DefaultSchema stringId 
- The id of the default Schema asscociated to this data store.
- Id string
- The provider-assigned unique ID for this managed resource.
- CreateTime string
- Timestamp the DataStore was created at.
- DefaultSchema stringId 
- The id of the default Schema asscociated to this data store.
- Id string
- The provider-assigned unique ID for this managed resource.
- createTime String
- Timestamp the DataStore was created at.
- defaultSchema StringId 
- The id of the default Schema asscociated to this data store.
- id String
- The provider-assigned unique ID for this managed resource.
- createTime string
- Timestamp the DataStore was created at.
- defaultSchema stringId 
- The id of the default Schema asscociated to this data store.
- id string
- The provider-assigned unique ID for this managed resource.
- create_time str
- Timestamp the DataStore was created at.
- default_schema_ strid 
- The id of the default Schema asscociated to this data store.
- id str
- The provider-assigned unique ID for this managed resource.
- createTime String
- Timestamp the DataStore was created at.
- defaultSchema StringId 
- The id of the default Schema asscociated to this data store.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
DataStoreContentConfig, DataStoreContentConfigArgs        
- ContentConfig Unspecified 
- CONTENT_CONFIG_UNSPECIFIEDDefault value.
- NoContent 
- NO_CONTENTOnly contains documents without any Document.content.
- ContentRequired 
- CONTENT_REQUIREDOnly contains documents with Document.content.
- PublicWebsite 
- PUBLIC_WEBSITEThe data store is used for public website search.
- DataStore Content Config Content Config Unspecified 
- CONTENT_CONFIG_UNSPECIFIEDDefault value.
- DataStore Content Config No Content 
- NO_CONTENTOnly contains documents without any Document.content.
- DataStore Content Config Content Required 
- CONTENT_REQUIREDOnly contains documents with Document.content.
- DataStore Content Config Public Website 
- PUBLIC_WEBSITEThe data store is used for public website search.
- ContentConfig Unspecified 
- CONTENT_CONFIG_UNSPECIFIEDDefault value.
- NoContent 
- NO_CONTENTOnly contains documents without any Document.content.
- ContentRequired 
- CONTENT_REQUIREDOnly contains documents with Document.content.
- PublicWebsite 
- PUBLIC_WEBSITEThe data store is used for public website search.
- ContentConfig Unspecified 
- CONTENT_CONFIG_UNSPECIFIEDDefault value.
- NoContent 
- NO_CONTENTOnly contains documents without any Document.content.
- ContentRequired 
- CONTENT_REQUIREDOnly contains documents with Document.content.
- PublicWebsite 
- PUBLIC_WEBSITEThe data store is used for public website search.
- CONTENT_CONFIG_UNSPECIFIED
- CONTENT_CONFIG_UNSPECIFIEDDefault value.
- NO_CONTENT
- NO_CONTENTOnly contains documents without any Document.content.
- CONTENT_REQUIRED
- CONTENT_REQUIREDOnly contains documents with Document.content.
- PUBLIC_WEBSITE
- PUBLIC_WEBSITEThe data store is used for public website search.
- "CONTENT_CONFIG_UNSPECIFIED"
- CONTENT_CONFIG_UNSPECIFIEDDefault value.
- "NO_CONTENT"
- NO_CONTENTOnly contains documents without any Document.content.
- "CONTENT_REQUIRED"
- CONTENT_REQUIREDOnly contains documents with Document.content.
- "PUBLIC_WEBSITE"
- PUBLIC_WEBSITEThe data store is used for public website search.
DataStoreIndustryVertical, DataStoreIndustryVerticalArgs        
- IndustryVertical Unspecified 
- INDUSTRY_VERTICAL_UNSPECIFIEDValue used when unset.
- Generic
- GENERICThe generic vertical for documents that are not specific to any industry vertical.
- Media
- MEDIAThe media industry vertical.
- DataStore Industry Vertical Industry Vertical Unspecified 
- INDUSTRY_VERTICAL_UNSPECIFIEDValue used when unset.
- DataStore Industry Vertical Generic 
- GENERICThe generic vertical for documents that are not specific to any industry vertical.
- DataStore Industry Vertical Media 
- MEDIAThe media industry vertical.
- IndustryVertical Unspecified 
- INDUSTRY_VERTICAL_UNSPECIFIEDValue used when unset.
- Generic
- GENERICThe generic vertical for documents that are not specific to any industry vertical.
- Media
- MEDIAThe media industry vertical.
- IndustryVertical Unspecified 
- INDUSTRY_VERTICAL_UNSPECIFIEDValue used when unset.
- Generic
- GENERICThe generic vertical for documents that are not specific to any industry vertical.
- Media
- MEDIAThe media industry vertical.
- INDUSTRY_VERTICAL_UNSPECIFIED
- INDUSTRY_VERTICAL_UNSPECIFIEDValue used when unset.
- GENERIC
- GENERICThe generic vertical for documents that are not specific to any industry vertical.
- MEDIA
- MEDIAThe media industry vertical.
- "INDUSTRY_VERTICAL_UNSPECIFIED"
- INDUSTRY_VERTICAL_UNSPECIFIEDValue used when unset.
- "GENERIC"
- GENERICThe generic vertical for documents that are not specific to any industry vertical.
- "MEDIA"
- MEDIAThe media industry vertical.
DataStoreSolutionTypesItem, DataStoreSolutionTypesItemArgs          
- SolutionType Unspecified 
- SOLUTION_TYPE_UNSPECIFIEDDefault value.
- SolutionType Recommendation 
- SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
- SolutionType Search 
- SOLUTION_TYPE_SEARCHUsed for Discovery Search.
- SolutionType Chat 
- SOLUTION_TYPE_CHATUsed for use cases related to the Generative AI agent.
- DataStore Solution Types Item Solution Type Unspecified 
- SOLUTION_TYPE_UNSPECIFIEDDefault value.
- DataStore Solution Types Item Solution Type Recommendation 
- SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
- DataStore Solution Types Item Solution Type Search 
- SOLUTION_TYPE_SEARCHUsed for Discovery Search.
- DataStore Solution Types Item Solution Type Chat 
- SOLUTION_TYPE_CHATUsed for use cases related to the Generative AI agent.
- SolutionType Unspecified 
- SOLUTION_TYPE_UNSPECIFIEDDefault value.
- SolutionType Recommendation 
- SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
- SolutionType Search 
- SOLUTION_TYPE_SEARCHUsed for Discovery Search.
- SolutionType Chat 
- SOLUTION_TYPE_CHATUsed for use cases related to the Generative AI agent.
- SolutionType Unspecified 
- SOLUTION_TYPE_UNSPECIFIEDDefault value.
- SolutionType Recommendation 
- SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
- SolutionType Search 
- SOLUTION_TYPE_SEARCHUsed for Discovery Search.
- SolutionType Chat 
- SOLUTION_TYPE_CHATUsed for use cases related to the Generative AI agent.
- SOLUTION_TYPE_UNSPECIFIED
- SOLUTION_TYPE_UNSPECIFIEDDefault value.
- SOLUTION_TYPE_RECOMMENDATION
- SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
- SOLUTION_TYPE_SEARCH
- SOLUTION_TYPE_SEARCHUsed for Discovery Search.
- SOLUTION_TYPE_CHAT
- SOLUTION_TYPE_CHATUsed for use cases related to the Generative AI agent.
- "SOLUTION_TYPE_UNSPECIFIED"
- SOLUTION_TYPE_UNSPECIFIEDDefault value.
- "SOLUTION_TYPE_RECOMMENDATION"
- SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
- "SOLUTION_TYPE_SEARCH"
- SOLUTION_TYPE_SEARCHUsed for Discovery Search.
- "SOLUTION_TYPE_CHAT"
- SOLUTION_TYPE_CHATUsed for use cases related to the Generative AI agent.
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.