1. Packages
  2. Google Cloud Native
  3. API Docs
  4. cloudsearch
  5. cloudsearch/v1
  6. DataSource

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.cloudsearch/v1.DataSource

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 datasource. Note: This API requires an admin account to execute.

    Create DataSource Resource

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

    Constructor syntax

    new DataSource(name: string, args: DataSourceArgs, opts?: CustomResourceOptions);
    @overload
    def DataSource(resource_name: str,
                   args: DataSourceArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def DataSource(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   display_name: Optional[str] = None,
                   disable_modifications: Optional[bool] = None,
                   disable_serving: Optional[bool] = None,
                   indexing_service_accounts: Optional[Sequence[str]] = None,
                   items_visibility: Optional[Sequence[GSuitePrincipalArgs]] = None,
                   name: Optional[str] = None,
                   operation_ids: Optional[Sequence[str]] = None,
                   return_thumbnail_urls: Optional[bool] = None,
                   short_name: Optional[str] = None)
    func NewDataSource(ctx *Context, name string, args DataSourceArgs, opts ...ResourceOption) (*DataSource, error)
    public DataSource(string name, DataSourceArgs args, CustomResourceOptions? opts = null)
    public DataSource(String name, DataSourceArgs args)
    public DataSource(String name, DataSourceArgs args, CustomResourceOptions options)
    
    type: google-native:cloudsearch/v1:DataSource
    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 DataSourceArgs
    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 DataSourceArgs
    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 DataSourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataSourceArgs
    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 dataSourceResource = new GoogleNative.CloudSearch.V1.DataSource("dataSourceResource", new()
    {
        DisplayName = "string",
        DisableModifications = false,
        DisableServing = false,
        IndexingServiceAccounts = new[]
        {
            "string",
        },
        ItemsVisibility = new[]
        {
            new GoogleNative.CloudSearch.V1.Inputs.GSuitePrincipalArgs
            {
                GsuiteDomain = false,
                GsuiteGroupEmail = "string",
                GsuiteUserEmail = "string",
            },
        },
        Name = "string",
        OperationIds = new[]
        {
            "string",
        },
        ReturnThumbnailUrls = false,
        ShortName = "string",
    });
    
    example, err := cloudsearch.NewDataSource(ctx, "dataSourceResource", &cloudsearch.DataSourceArgs{
    DisplayName: pulumi.String("string"),
    DisableModifications: pulumi.Bool(false),
    DisableServing: pulumi.Bool(false),
    IndexingServiceAccounts: pulumi.StringArray{
    pulumi.String("string"),
    },
    ItemsVisibility: cloudsearch.GSuitePrincipalArray{
    &cloudsearch.GSuitePrincipalArgs{
    GsuiteDomain: pulumi.Bool(false),
    GsuiteGroupEmail: pulumi.String("string"),
    GsuiteUserEmail: pulumi.String("string"),
    },
    },
    Name: pulumi.String("string"),
    OperationIds: pulumi.StringArray{
    pulumi.String("string"),
    },
    ReturnThumbnailUrls: pulumi.Bool(false),
    ShortName: pulumi.String("string"),
    })
    
    var dataSourceResource = new DataSource("dataSourceResource", DataSourceArgs.builder()
        .displayName("string")
        .disableModifications(false)
        .disableServing(false)
        .indexingServiceAccounts("string")
        .itemsVisibility(GSuitePrincipalArgs.builder()
            .gsuiteDomain(false)
            .gsuiteGroupEmail("string")
            .gsuiteUserEmail("string")
            .build())
        .name("string")
        .operationIds("string")
        .returnThumbnailUrls(false)
        .shortName("string")
        .build());
    
    data_source_resource = google_native.cloudsearch.v1.DataSource("dataSourceResource",
        display_name="string",
        disable_modifications=False,
        disable_serving=False,
        indexing_service_accounts=["string"],
        items_visibility=[google_native.cloudsearch.v1.GSuitePrincipalArgs(
            gsuite_domain=False,
            gsuite_group_email="string",
            gsuite_user_email="string",
        )],
        name="string",
        operation_ids=["string"],
        return_thumbnail_urls=False,
        short_name="string")
    
    const dataSourceResource = new google_native.cloudsearch.v1.DataSource("dataSourceResource", {
        displayName: "string",
        disableModifications: false,
        disableServing: false,
        indexingServiceAccounts: ["string"],
        itemsVisibility: [{
            gsuiteDomain: false,
            gsuiteGroupEmail: "string",
            gsuiteUserEmail: "string",
        }],
        name: "string",
        operationIds: ["string"],
        returnThumbnailUrls: false,
        shortName: "string",
    });
    
    type: google-native:cloudsearch/v1:DataSource
    properties:
        disableModifications: false
        disableServing: false
        displayName: string
        indexingServiceAccounts:
            - string
        itemsVisibility:
            - gsuiteDomain: false
              gsuiteGroupEmail: string
              gsuiteUserEmail: string
        name: string
        operationIds:
            - string
        returnThumbnailUrls: false
        shortName: string
    

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

    DisplayName string
    Display name of the datasource The maximum length is 300 characters.
    DisableModifications bool
    If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.
    DisableServing bool
    Disable serving any search or assist results.
    IndexingServiceAccounts List<string>
    List of service accounts that have indexing access.
    ItemsVisibility List<Pulumi.GoogleNative.CloudSearch.V1.Inputs.GSuitePrincipal>
    This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
    Name string
    The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
    OperationIds List<string>
    IDs of the Long Running Operations (LROs) currently running for this schema.
    ReturnThumbnailUrls bool
    Can a user request to get thumbnail URI for Items indexed in this data source.
    ShortName string
    A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is then queries like source: will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
    DisplayName string
    Display name of the datasource The maximum length is 300 characters.
    DisableModifications bool
    If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.
    DisableServing bool
    Disable serving any search or assist results.
    IndexingServiceAccounts []string
    List of service accounts that have indexing access.
    ItemsVisibility []GSuitePrincipalArgs
    This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
    Name string
    The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
    OperationIds []string
    IDs of the Long Running Operations (LROs) currently running for this schema.
    ReturnThumbnailUrls bool
    Can a user request to get thumbnail URI for Items indexed in this data source.
    ShortName string
    A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is then queries like source: will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
    displayName String
    Display name of the datasource The maximum length is 300 characters.
    disableModifications Boolean
    If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.
    disableServing Boolean
    Disable serving any search or assist results.
    indexingServiceAccounts List<String>
    List of service accounts that have indexing access.
    itemsVisibility List<GSuitePrincipal>
    This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
    name String
    The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
    operationIds List<String>
    IDs of the Long Running Operations (LROs) currently running for this schema.
    returnThumbnailUrls Boolean
    Can a user request to get thumbnail URI for Items indexed in this data source.
    shortName String
    A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is then queries like source: will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
    displayName string
    Display name of the datasource The maximum length is 300 characters.
    disableModifications boolean
    If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.
    disableServing boolean
    Disable serving any search or assist results.
    indexingServiceAccounts string[]
    List of service accounts that have indexing access.
    itemsVisibility GSuitePrincipal[]
    This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
    name string
    The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
    operationIds string[]
    IDs of the Long Running Operations (LROs) currently running for this schema.
    returnThumbnailUrls boolean
    Can a user request to get thumbnail URI for Items indexed in this data source.
    shortName string
    A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is then queries like source: will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
    display_name str
    Display name of the datasource The maximum length is 300 characters.
    disable_modifications bool
    If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.
    disable_serving bool
    Disable serving any search or assist results.
    indexing_service_accounts Sequence[str]
    List of service accounts that have indexing access.
    items_visibility Sequence[GSuitePrincipalArgs]
    This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
    name str
    The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
    operation_ids Sequence[str]
    IDs of the Long Running Operations (LROs) currently running for this schema.
    return_thumbnail_urls bool
    Can a user request to get thumbnail URI for Items indexed in this data source.
    short_name str
    A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is then queries like source: will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
    displayName String
    Display name of the datasource The maximum length is 300 characters.
    disableModifications Boolean
    If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.
    disableServing Boolean
    Disable serving any search or assist results.
    indexingServiceAccounts List<String>
    List of service accounts that have indexing access.
    itemsVisibility List<Property Map>
    This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
    name String
    The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
    operationIds List<String>
    IDs of the Long Running Operations (LROs) currently running for this schema.
    returnThumbnailUrls Boolean
    Can a user request to get thumbnail URI for Items indexed in this data source.
    shortName String
    A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is then queries like source: will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GSuitePrincipal, GSuitePrincipalArgs

    GsuiteDomain bool
    This principal represents all users of the Google Workspace domain of the customer.
    GsuiteGroupEmail string
    This principal references a Google Workspace group name.
    GsuiteUserEmail string
    This principal references a Google Workspace user account.
    GsuiteDomain bool
    This principal represents all users of the Google Workspace domain of the customer.
    GsuiteGroupEmail string
    This principal references a Google Workspace group name.
    GsuiteUserEmail string
    This principal references a Google Workspace user account.
    gsuiteDomain Boolean
    This principal represents all users of the Google Workspace domain of the customer.
    gsuiteGroupEmail String
    This principal references a Google Workspace group name.
    gsuiteUserEmail String
    This principal references a Google Workspace user account.
    gsuiteDomain boolean
    This principal represents all users of the Google Workspace domain of the customer.
    gsuiteGroupEmail string
    This principal references a Google Workspace group name.
    gsuiteUserEmail string
    This principal references a Google Workspace user account.
    gsuite_domain bool
    This principal represents all users of the Google Workspace domain of the customer.
    gsuite_group_email str
    This principal references a Google Workspace group name.
    gsuite_user_email str
    This principal references a Google Workspace user account.
    gsuiteDomain Boolean
    This principal represents all users of the Google Workspace domain of the customer.
    gsuiteGroupEmail String
    This principal references a Google Workspace group name.
    gsuiteUserEmail String
    This principal references a Google Workspace user account.

    GSuitePrincipalResponse, GSuitePrincipalResponseArgs

    GsuiteDomain bool
    This principal represents all users of the Google Workspace domain of the customer.
    GsuiteGroupEmail string
    This principal references a Google Workspace group name.
    GsuiteUserEmail string
    This principal references a Google Workspace user account.
    GsuiteDomain bool
    This principal represents all users of the Google Workspace domain of the customer.
    GsuiteGroupEmail string
    This principal references a Google Workspace group name.
    GsuiteUserEmail string
    This principal references a Google Workspace user account.
    gsuiteDomain Boolean
    This principal represents all users of the Google Workspace domain of the customer.
    gsuiteGroupEmail String
    This principal references a Google Workspace group name.
    gsuiteUserEmail String
    This principal references a Google Workspace user account.
    gsuiteDomain boolean
    This principal represents all users of the Google Workspace domain of the customer.
    gsuiteGroupEmail string
    This principal references a Google Workspace group name.
    gsuiteUserEmail string
    This principal references a Google Workspace user account.
    gsuite_domain bool
    This principal represents all users of the Google Workspace domain of the customer.
    gsuite_group_email str
    This principal references a Google Workspace group name.
    gsuite_user_email str
    This principal references a Google Workspace user account.
    gsuiteDomain Boolean
    This principal represents all users of the Google Workspace domain of the customer.
    gsuiteGroupEmail String
    This principal references a Google Workspace group name.
    gsuiteUserEmail String
    This principal references a Google Workspace user account.

    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