Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

getDataSource

Gets a datasource. Note: This API requires an admin account to execute.

Using getDataSource

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 getDataSource(args: GetDataSourceArgs, opts?: InvokeOptions): Promise<GetDataSourceResult>
function getDataSourceOutput(args: GetDataSourceOutputArgs, opts?: InvokeOptions): Output<GetDataSourceResult>
def get_data_source(datasource_id: Optional[str] = None,
                    debug_options_enable_debugging: Optional[bool] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDataSourceResult
def get_data_source_output(datasource_id: Optional[pulumi.Input[str]] = None,
                    debug_options_enable_debugging: Optional[pulumi.Input[bool]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDataSourceResult]
func LookupDataSource(ctx *Context, args *LookupDataSourceArgs, opts ...InvokeOption) (*LookupDataSourceResult, error)
func LookupDataSourceOutput(ctx *Context, args *LookupDataSourceOutputArgs, opts ...InvokeOption) LookupDataSourceResultOutput

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

public static class GetDataSource 
{
    public static Task<GetDataSourceResult> InvokeAsync(GetDataSourceArgs args, InvokeOptions? opts = null)
    public static Output<GetDataSourceResult> Invoke(GetDataSourceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDataSourceResult> getDataSource(GetDataSourceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: google-native:cloudsearch/v1:getDataSource
  arguments:
    # arguments dictionary

The following arguments are supported:

getDataSource Result

The following output properties are available:

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.

DisplayName string

Display name of the datasource The maximum length is 300 characters.

IndexingServiceAccounts List<string>

List of service accounts that have indexing access.

ItemsVisibility List<Pulumi.GoogleNative.CloudSearch.V1.Outputs.GSuitePrincipalResponse>

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.

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.

DisplayName string

Display name of the datasource The maximum length is 300 characters.

IndexingServiceAccounts []string

List of service accounts that have indexing access.

ItemsVisibility []GSuitePrincipalResponse

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.

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.

displayName String

Display name of the datasource The maximum length is 300 characters.

indexingServiceAccounts List<String>

List of service accounts that have indexing access.

itemsVisibility List<GSuitePrincipalResponse>

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.

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.

displayName string

Display name of the datasource The maximum length is 300 characters.

indexingServiceAccounts string[]

List of service accounts that have indexing access.

itemsVisibility GSuitePrincipalResponse[]

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.

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.

display_name str

Display name of the datasource The maximum length is 300 characters.

indexing_service_accounts Sequence[str]

List of service accounts that have indexing access.

items_visibility Sequence[GSuitePrincipalResponse]

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.

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.

displayName String

Display name of the datasource The maximum length is 300 characters.

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.

Supporting Types

GSuitePrincipalResponse

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
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0