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

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

Explore with Pulumi AI

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

Gets the specified search application. Note: This API requires an admin account to execute.

Using getSearchApplication

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 getSearchApplication(args: GetSearchApplicationArgs, opts?: InvokeOptions): Promise<GetSearchApplicationResult>
function getSearchApplicationOutput(args: GetSearchApplicationOutputArgs, opts?: InvokeOptions): Output<GetSearchApplicationResult>
Copy
def get_search_application(debug_options_enable_debugging: Optional[bool] = None,
                           searchapplication_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSearchApplicationResult
def get_search_application_output(debug_options_enable_debugging: Optional[pulumi.Input[bool]] = None,
                           searchapplication_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSearchApplicationResult]
Copy
func LookupSearchApplication(ctx *Context, args *LookupSearchApplicationArgs, opts ...InvokeOption) (*LookupSearchApplicationResult, error)
func LookupSearchApplicationOutput(ctx *Context, args *LookupSearchApplicationOutputArgs, opts ...InvokeOption) LookupSearchApplicationResultOutput
Copy

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

public static class GetSearchApplication 
{
    public static Task<GetSearchApplicationResult> InvokeAsync(GetSearchApplicationArgs args, InvokeOptions? opts = null)
    public static Output<GetSearchApplicationResult> Invoke(GetSearchApplicationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSearchApplicationResult> getSearchApplication(GetSearchApplicationArgs args, InvokeOptions options)
public static Output<GetSearchApplicationResult> getSearchApplication(GetSearchApplicationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:cloudsearch/v1:getSearchApplication
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

SearchapplicationId This property is required. string
DebugOptionsEnableDebugging bool
SearchapplicationId This property is required. string
DebugOptionsEnableDebugging bool
searchapplicationId This property is required. String
debugOptionsEnableDebugging Boolean
searchapplicationId This property is required. string
debugOptionsEnableDebugging boolean
searchapplication_id This property is required. str
debug_options_enable_debugging bool
searchapplicationId This property is required. String
debugOptionsEnableDebugging Boolean

getSearchApplication Result

The following output properties are available:

DataSourceRestrictions List<Pulumi.GoogleNative.CloudSearch.V1.Outputs.DataSourceRestrictionResponse>
Retrictions applied to the configurations. The maximum number of elements is 10.
DefaultFacetOptions List<Pulumi.GoogleNative.CloudSearch.V1.Outputs.FacetOptionsResponse>
The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
DefaultSortOptions Pulumi.GoogleNative.CloudSearch.V1.Outputs.SortOptionsResponse
The default options for sorting the search results
DisplayName string
Display name of the Search Application. The maximum length is 300 characters.
EnableAuditLog bool
Indicates whether audit logging is on/off for requests made for the search application in query APIs.
Name string
The name of the Search Application. Format: searchapplications/{application_id}.
OperationIds List<string>
IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
QueryInterpretationConfig Pulumi.GoogleNative.CloudSearch.V1.Outputs.QueryInterpretationConfigResponse
The default options for query interpretation
ReturnResultThumbnailUrls bool
With each result we should return the URI for its thumbnail (when applicable)
ScoringConfig Pulumi.GoogleNative.CloudSearch.V1.Outputs.ScoringConfigResponse
Configuration for ranking results.
SourceConfig List<Pulumi.GoogleNative.CloudSearch.V1.Outputs.SourceConfigResponse>
Configuration for a sources specified in data_source_restrictions.
DataSourceRestrictions []DataSourceRestrictionResponse
Retrictions applied to the configurations. The maximum number of elements is 10.
DefaultFacetOptions []FacetOptionsResponse
The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
DefaultSortOptions SortOptionsResponse
The default options for sorting the search results
DisplayName string
Display name of the Search Application. The maximum length is 300 characters.
EnableAuditLog bool
Indicates whether audit logging is on/off for requests made for the search application in query APIs.
Name string
The name of the Search Application. Format: searchapplications/{application_id}.
OperationIds []string
IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
QueryInterpretationConfig QueryInterpretationConfigResponse
The default options for query interpretation
ReturnResultThumbnailUrls bool
With each result we should return the URI for its thumbnail (when applicable)
ScoringConfig ScoringConfigResponse
Configuration for ranking results.
SourceConfig []SourceConfigResponse
Configuration for a sources specified in data_source_restrictions.
dataSourceRestrictions List<DataSourceRestrictionResponse>
Retrictions applied to the configurations. The maximum number of elements is 10.
defaultFacetOptions List<FacetOptionsResponse>
The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
defaultSortOptions SortOptionsResponse
The default options for sorting the search results
displayName String
Display name of the Search Application. The maximum length is 300 characters.
enableAuditLog Boolean
Indicates whether audit logging is on/off for requests made for the search application in query APIs.
name String
The name of the Search Application. Format: searchapplications/{application_id}.
operationIds List<String>
IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
queryInterpretationConfig QueryInterpretationConfigResponse
The default options for query interpretation
returnResultThumbnailUrls Boolean
With each result we should return the URI for its thumbnail (when applicable)
scoringConfig ScoringConfigResponse
Configuration for ranking results.
sourceConfig List<SourceConfigResponse>
Configuration for a sources specified in data_source_restrictions.
dataSourceRestrictions DataSourceRestrictionResponse[]
Retrictions applied to the configurations. The maximum number of elements is 10.
defaultFacetOptions FacetOptionsResponse[]
The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
defaultSortOptions SortOptionsResponse
The default options for sorting the search results
displayName string
Display name of the Search Application. The maximum length is 300 characters.
enableAuditLog boolean
Indicates whether audit logging is on/off for requests made for the search application in query APIs.
name string
The name of the Search Application. Format: searchapplications/{application_id}.
operationIds string[]
IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
queryInterpretationConfig QueryInterpretationConfigResponse
The default options for query interpretation
returnResultThumbnailUrls boolean
With each result we should return the URI for its thumbnail (when applicable)
scoringConfig ScoringConfigResponse
Configuration for ranking results.
sourceConfig SourceConfigResponse[]
Configuration for a sources specified in data_source_restrictions.
data_source_restrictions Sequence[DataSourceRestrictionResponse]
Retrictions applied to the configurations. The maximum number of elements is 10.
default_facet_options Sequence[FacetOptionsResponse]
The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
default_sort_options SortOptionsResponse
The default options for sorting the search results
display_name str
Display name of the Search Application. The maximum length is 300 characters.
enable_audit_log bool
Indicates whether audit logging is on/off for requests made for the search application in query APIs.
name str
The name of the Search Application. Format: searchapplications/{application_id}.
operation_ids Sequence[str]
IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
query_interpretation_config QueryInterpretationConfigResponse
The default options for query interpretation
return_result_thumbnail_urls bool
With each result we should return the URI for its thumbnail (when applicable)
scoring_config ScoringConfigResponse
Configuration for ranking results.
source_config Sequence[SourceConfigResponse]
Configuration for a sources specified in data_source_restrictions.
dataSourceRestrictions List<Property Map>
Retrictions applied to the configurations. The maximum number of elements is 10.
defaultFacetOptions List<Property Map>
The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
defaultSortOptions Property Map
The default options for sorting the search results
displayName String
Display name of the Search Application. The maximum length is 300 characters.
enableAuditLog Boolean
Indicates whether audit logging is on/off for requests made for the search application in query APIs.
name String
The name of the Search Application. Format: searchapplications/{application_id}.
operationIds List<String>
IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
queryInterpretationConfig Property Map
The default options for query interpretation
returnResultThumbnailUrls Boolean
With each result we should return the URI for its thumbnail (when applicable)
scoringConfig Property Map
Configuration for ranking results.
sourceConfig List<Property Map>
Configuration for a sources specified in data_source_restrictions.

Supporting Types

CompositeFilterResponse

LogicOperator This property is required. string
The logic operator of the sub filter.
SubFilters This property is required. List<Pulumi.GoogleNative.CloudSearch.V1.Inputs.FilterResponse>
Sub filters.
LogicOperator This property is required. string
The logic operator of the sub filter.
SubFilters This property is required. []FilterResponse
Sub filters.
logicOperator This property is required. String
The logic operator of the sub filter.
subFilters This property is required. List<FilterResponse>
Sub filters.
logicOperator This property is required. string
The logic operator of the sub filter.
subFilters This property is required. FilterResponse[]
Sub filters.
logic_operator This property is required. str
The logic operator of the sub filter.
sub_filters This property is required. Sequence[FilterResponse]
Sub filters.
logicOperator This property is required. String
The logic operator of the sub filter.
subFilters This property is required. List<Property Map>
Sub filters.

DataSourceRestrictionResponse

FilterOptions This property is required. List<Pulumi.GoogleNative.CloudSearch.V1.Inputs.FilterOptionsResponse>
Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
Source This property is required. Pulumi.GoogleNative.CloudSearch.V1.Inputs.SourceResponse
The source of restriction.
FilterOptions This property is required. []FilterOptionsResponse
Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
Source This property is required. SourceResponse
The source of restriction.
filterOptions This property is required. List<FilterOptionsResponse>
Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
source This property is required. SourceResponse
The source of restriction.
filterOptions This property is required. FilterOptionsResponse[]
Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
source This property is required. SourceResponse
The source of restriction.
filter_options This property is required. Sequence[FilterOptionsResponse]
Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
source This property is required. SourceResponse
The source of restriction.
filterOptions This property is required. List<Property Map>
Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
source This property is required. Property Map
The source of restriction.

DateResponse

Day This property is required. int
Day of month. Must be from 1 to 31 and valid for the year and month.
Month This property is required. int
Month of date. Must be from 1 to 12.
Year This property is required. int
Year of date. Must be from 1 to 9999.
Day This property is required. int
Day of month. Must be from 1 to 31 and valid for the year and month.
Month This property is required. int
Month of date. Must be from 1 to 12.
Year This property is required. int
Year of date. Must be from 1 to 9999.
day This property is required. Integer
Day of month. Must be from 1 to 31 and valid for the year and month.
month This property is required. Integer
Month of date. Must be from 1 to 12.
year This property is required. Integer
Year of date. Must be from 1 to 9999.
day This property is required. number
Day of month. Must be from 1 to 31 and valid for the year and month.
month This property is required. number
Month of date. Must be from 1 to 12.
year This property is required. number
Year of date. Must be from 1 to 9999.
day This property is required. int
Day of month. Must be from 1 to 31 and valid for the year and month.
month This property is required. int
Month of date. Must be from 1 to 12.
year This property is required. int
Year of date. Must be from 1 to 9999.
day This property is required. Number
Day of month. Must be from 1 to 31 and valid for the year and month.
month This property is required. Number
Month of date. Must be from 1 to 12.
year This property is required. Number
Year of date. Must be from 1 to 9999.

FacetOptionsResponse

IntegerFacetingOptions This property is required. Pulumi.GoogleNative.CloudSearch.V1.Inputs.IntegerFacetingOptionsResponse
If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets.
NumFacetBuckets This property is required. int
Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
ObjectType This property is required. string
If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
OperatorName This property is required. string
The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
SourceName This property is required. string
Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
IntegerFacetingOptions This property is required. IntegerFacetingOptionsResponse
If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets.
NumFacetBuckets This property is required. int
Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
ObjectType This property is required. string
If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
OperatorName This property is required. string
The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
SourceName This property is required. string
Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
integerFacetingOptions This property is required. IntegerFacetingOptionsResponse
If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets.
numFacetBuckets This property is required. Integer
Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
objectType This property is required. String
If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
operatorName This property is required. String
The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
sourceName This property is required. String
Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
integerFacetingOptions This property is required. IntegerFacetingOptionsResponse
If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets.
numFacetBuckets This property is required. number
Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
objectType This property is required. string
If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
operatorName This property is required. string
The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
sourceName This property is required. string
Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
integer_faceting_options This property is required. IntegerFacetingOptionsResponse
If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets.
num_facet_buckets This property is required. int
Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
object_type This property is required. str
If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
operator_name This property is required. str
The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
source_name This property is required. str
Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
integerFacetingOptions This property is required. Property Map
If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets.
numFacetBuckets This property is required. Number
Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
objectType This property is required. String
If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
operatorName This property is required. String
The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
sourceName This property is required. String
Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.

FilterOptionsResponse

Filter This property is required. Pulumi.GoogleNative.CloudSearch.V1.Inputs.FilterResponse
Generic filter to restrict the search, such as lang:en, site:xyz.
ObjectType This property is required. string
If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
Filter This property is required. FilterResponse
Generic filter to restrict the search, such as lang:en, site:xyz.
ObjectType This property is required. string
If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
filter This property is required. FilterResponse
Generic filter to restrict the search, such as lang:en, site:xyz.
objectType This property is required. String
If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
filter This property is required. FilterResponse
Generic filter to restrict the search, such as lang:en, site:xyz.
objectType This property is required. string
If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
filter This property is required. FilterResponse
Generic filter to restrict the search, such as lang:en, site:xyz.
object_type This property is required. str
If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
filter This property is required. Property Map
Generic filter to restrict the search, such as lang:en, site:xyz.
objectType This property is required. String
If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.

FilterResponse

CompositeFilter This property is required. CompositeFilterResponse
ValueFilter This property is required. ValueFilterResponse
compositeFilter This property is required. CompositeFilterResponse
valueFilter This property is required. ValueFilterResponse
compositeFilter This property is required. CompositeFilterResponse
valueFilter This property is required. ValueFilterResponse
composite_filter This property is required. CompositeFilterResponse
value_filter This property is required. ValueFilterResponse
compositeFilter This property is required. Property Map
valueFilter This property is required. Property Map

IntegerFacetingOptionsResponse

IntegerBuckets This property is required. List<string>
Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.
IntegerBuckets This property is required. []string
Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.
integerBuckets This property is required. List<String>
Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.
integerBuckets This property is required. string[]
Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.
integer_buckets This property is required. Sequence[str]
Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.
integerBuckets This property is required. List<String>
Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.

QueryInterpretationConfigResponse

ForceDisableSupplementalResults This property is required. bool
Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
ForceVerbatimMode This property is required. bool
Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
ForceDisableSupplementalResults This property is required. bool
Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
ForceVerbatimMode This property is required. bool
Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
forceDisableSupplementalResults This property is required. Boolean
Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
forceVerbatimMode This property is required. Boolean
Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
forceDisableSupplementalResults This property is required. boolean
Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
forceVerbatimMode This property is required. boolean
Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
force_disable_supplemental_results This property is required. bool
Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
force_verbatim_mode This property is required. bool
Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
forceDisableSupplementalResults This property is required. Boolean
Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
forceVerbatimMode This property is required. Boolean
Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.

ScoringConfigResponse

DisableFreshness This property is required. bool
Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
DisablePersonalization This property is required. bool
Whether to personalize the results. By default, personal signals will be used to boost results.
DisableFreshness This property is required. bool
Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
DisablePersonalization This property is required. bool
Whether to personalize the results. By default, personal signals will be used to boost results.
disableFreshness This property is required. Boolean
Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
disablePersonalization This property is required. Boolean
Whether to personalize the results. By default, personal signals will be used to boost results.
disableFreshness This property is required. boolean
Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
disablePersonalization This property is required. boolean
Whether to personalize the results. By default, personal signals will be used to boost results.
disable_freshness This property is required. bool
Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
disable_personalization This property is required. bool
Whether to personalize the results. By default, personal signals will be used to boost results.
disableFreshness This property is required. Boolean
Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
disablePersonalization This property is required. Boolean
Whether to personalize the results. By default, personal signals will be used to boost results.

SortOptionsResponse

OperatorName This property is required. string
The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
SortOrder This property is required. string
Ascending is the default sort order
OperatorName This property is required. string
The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
SortOrder This property is required. string
Ascending is the default sort order
operatorName This property is required. String
The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
sortOrder This property is required. String
Ascending is the default sort order
operatorName This property is required. string
The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
sortOrder This property is required. string
Ascending is the default sort order
operator_name This property is required. str
The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
sort_order This property is required. str
Ascending is the default sort order
operatorName This property is required. String
The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
sortOrder This property is required. String
Ascending is the default sort order

SourceConfigResponse

CrowdingConfig This property is required. Pulumi.GoogleNative.CloudSearch.V1.Inputs.SourceCrowdingConfigResponse
The crowding configuration for the source.
ScoringConfig This property is required. Pulumi.GoogleNative.CloudSearch.V1.Inputs.SourceScoringConfigResponse
The scoring configuration for the source.
Source This property is required. Pulumi.GoogleNative.CloudSearch.V1.Inputs.SourceResponse
The source for which this configuration is to be used.
CrowdingConfig This property is required. SourceCrowdingConfigResponse
The crowding configuration for the source.
ScoringConfig This property is required. SourceScoringConfigResponse
The scoring configuration for the source.
Source This property is required. SourceResponse
The source for which this configuration is to be used.
crowdingConfig This property is required. SourceCrowdingConfigResponse
The crowding configuration for the source.
scoringConfig This property is required. SourceScoringConfigResponse
The scoring configuration for the source.
source This property is required. SourceResponse
The source for which this configuration is to be used.
crowdingConfig This property is required. SourceCrowdingConfigResponse
The crowding configuration for the source.
scoringConfig This property is required. SourceScoringConfigResponse
The scoring configuration for the source.
source This property is required. SourceResponse
The source for which this configuration is to be used.
crowding_config This property is required. SourceCrowdingConfigResponse
The crowding configuration for the source.
scoring_config This property is required. SourceScoringConfigResponse
The scoring configuration for the source.
source This property is required. SourceResponse
The source for which this configuration is to be used.
crowdingConfig This property is required. Property Map
The crowding configuration for the source.
scoringConfig This property is required. Property Map
The scoring configuration for the source.
source This property is required. Property Map
The source for which this configuration is to be used.

SourceCrowdingConfigResponse

NumResults This property is required. int
Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.
NumSuggestions This property is required. int
Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
NumResults This property is required. int
Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.
NumSuggestions This property is required. int
Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
numResults This property is required. Integer
Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.
numSuggestions This property is required. Integer
Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
numResults This property is required. number
Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.
numSuggestions This property is required. number
Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
num_results This property is required. int
Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.
num_suggestions This property is required. int
Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
numResults This property is required. Number
Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.
numSuggestions This property is required. Number
Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.

SourceResponse

Name This property is required. string
Source name for content indexed by the Indexing API.
PredefinedSource This property is required. string
Predefined content source for Google Apps.
Name This property is required. string
Source name for content indexed by the Indexing API.
PredefinedSource This property is required. string
Predefined content source for Google Apps.
name This property is required. String
Source name for content indexed by the Indexing API.
predefinedSource This property is required. String
Predefined content source for Google Apps.
name This property is required. string
Source name for content indexed by the Indexing API.
predefinedSource This property is required. string
Predefined content source for Google Apps.
name This property is required. str
Source name for content indexed by the Indexing API.
predefined_source This property is required. str
Predefined content source for Google Apps.
name This property is required. String
Source name for content indexed by the Indexing API.
predefinedSource This property is required. String
Predefined content source for Google Apps.

SourceScoringConfigResponse

SourceImportance This property is required. string
Importance of the source.
SourceImportance This property is required. string
Importance of the source.
sourceImportance This property is required. String
Importance of the source.
sourceImportance This property is required. string
Importance of the source.
source_importance This property is required. str
Importance of the source.
sourceImportance This property is required. String
Importance of the source.

ValueFilterResponse

OperatorName This property is required. string
The operator_name applied to the query, such as price_greater_than. The filter can work against both types of filters defined in the schema for your data source: 1. operator_name, where the query filters results by the property that matches the value. 2. greater_than_operator_name or less_than_operator_name in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
Value This property is required. Pulumi.GoogleNative.CloudSearch.V1.Inputs.ValueResponse
The value to be compared with.
OperatorName This property is required. string
The operator_name applied to the query, such as price_greater_than. The filter can work against both types of filters defined in the schema for your data source: 1. operator_name, where the query filters results by the property that matches the value. 2. greater_than_operator_name or less_than_operator_name in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
Value This property is required. ValueResponse
The value to be compared with.
operatorName This property is required. String
The operator_name applied to the query, such as price_greater_than. The filter can work against both types of filters defined in the schema for your data source: 1. operator_name, where the query filters results by the property that matches the value. 2. greater_than_operator_name or less_than_operator_name in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
value This property is required. ValueResponse
The value to be compared with.
operatorName This property is required. string
The operator_name applied to the query, such as price_greater_than. The filter can work against both types of filters defined in the schema for your data source: 1. operator_name, where the query filters results by the property that matches the value. 2. greater_than_operator_name or less_than_operator_name in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
value This property is required. ValueResponse
The value to be compared with.
operator_name This property is required. str
The operator_name applied to the query, such as price_greater_than. The filter can work against both types of filters defined in the schema for your data source: 1. operator_name, where the query filters results by the property that matches the value. 2. greater_than_operator_name or less_than_operator_name in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
value This property is required. ValueResponse
The value to be compared with.
operatorName This property is required. String
The operator_name applied to the query, such as price_greater_than. The filter can work against both types of filters defined in the schema for your data source: 1. operator_name, where the query filters results by the property that matches the value. 2. greater_than_operator_name or less_than_operator_name in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
value This property is required. Property Map
The value to be compared with.

ValueResponse

BooleanValue This property is required. bool
DateValue This property is required. Pulumi.GoogleNative.CloudSearch.V1.Inputs.DateResponse
DoubleValue This property is required. double
IntegerValue This property is required. string
StringValue This property is required. string
TimestampValue This property is required. string
BooleanValue This property is required. bool
DateValue This property is required. DateResponse
DoubleValue This property is required. float64
IntegerValue This property is required. string
StringValue This property is required. string
TimestampValue This property is required. string
booleanValue This property is required. Boolean
dateValue This property is required. DateResponse
doubleValue This property is required. Double
integerValue This property is required. String
stringValue This property is required. String
timestampValue This property is required. String
booleanValue This property is required. boolean
dateValue This property is required. DateResponse
doubleValue This property is required. number
integerValue This property is required. string
stringValue This property is required. string
timestampValue This property is required. string
boolean_value This property is required. bool
date_value This property is required. DateResponse
double_value This property is required. float
integer_value This property is required. str
string_value This property is required. str
timestamp_value This property is required. str
booleanValue This property is required. Boolean
dateValue This property is required. Property Map
doubleValue This property is required. Number
integerValue This property is required. String
stringValue This property is required. String
timestampValue This property is required. String

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.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi