1. Packages
  2. Algolia Provider
  3. API Docs
  4. getVirtualIndex
algolia 0.6.0 published on Monday, Apr 14, 2025 by k-yomo

algolia.getVirtualIndex

Explore with Pulumi AI

Data source for a virtual index.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as algolia from "@pulumi/algolia";

const example = algolia.getVirtualIndex({
    name: "example_virtual_replica",
});
Copy
import pulumi
import pulumi_algolia as algolia

example = algolia.get_virtual_index(name="example_virtual_replica")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/algolia/algolia"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := algolia.LookupVirtualIndex(ctx, &algolia.LookupVirtualIndexArgs{
			Name: "example_virtual_replica",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Algolia = Pulumi.Algolia;

return await Deployment.RunAsync(() => 
{
    var example = Algolia.GetVirtualIndex.Invoke(new()
    {
        Name = "example_virtual_replica",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.algolia.AlgoliaFunctions;
import com.pulumi.algolia.inputs.GetVirtualIndexArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = AlgoliaFunctions.getVirtualIndex(GetVirtualIndexArgs.builder()
            .name("example_virtual_replica")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: algolia:getVirtualIndex
      arguments:
        name: example_virtual_replica
Copy

Using getVirtualIndex

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 getVirtualIndex(args: GetVirtualIndexArgs, opts?: InvokeOptions): Promise<GetVirtualIndexResult>
function getVirtualIndexOutput(args: GetVirtualIndexOutputArgs, opts?: InvokeOptions): Output<GetVirtualIndexResult>
Copy
def get_virtual_index(id: Optional[str] = None,
                      name: Optional[str] = None,
                      pagination_configs: Optional[Sequence[GetVirtualIndexPaginationConfig]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetVirtualIndexResult
def get_virtual_index_output(id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      pagination_configs: Optional[pulumi.Input[Sequence[pulumi.Input[GetVirtualIndexPaginationConfigArgs]]]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetVirtualIndexResult]
Copy
func LookupVirtualIndex(ctx *Context, args *LookupVirtualIndexArgs, opts ...InvokeOption) (*LookupVirtualIndexResult, error)
func LookupVirtualIndexOutput(ctx *Context, args *LookupVirtualIndexOutputArgs, opts ...InvokeOption) LookupVirtualIndexResultOutput
Copy

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

public static class GetVirtualIndex 
{
    public static Task<GetVirtualIndexResult> InvokeAsync(GetVirtualIndexArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualIndexResult> Invoke(GetVirtualIndexInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVirtualIndexResult> getVirtualIndex(GetVirtualIndexArgs args, InvokeOptions options)
public static Output<GetVirtualIndexResult> getVirtualIndex(GetVirtualIndexArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: algolia:index/getVirtualIndex:getVirtualIndex
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Name of the index.
Id string
The ID of this resource.
PaginationConfigs List<GetVirtualIndexPaginationConfig>
The configuration for pagination in index setting.
Name This property is required. string
Name of the index.
Id string
The ID of this resource.
PaginationConfigs []GetVirtualIndexPaginationConfig
The configuration for pagination in index setting.
name This property is required. String
Name of the index.
id String
The ID of this resource.
paginationConfigs List<GetVirtualIndexPaginationConfig>
The configuration for pagination in index setting.
name This property is required. string
Name of the index.
id string
The ID of this resource.
paginationConfigs GetVirtualIndexPaginationConfig[]
The configuration for pagination in index setting.
name This property is required. str
Name of the index.
id str
The ID of this resource.
pagination_configs Sequence[GetVirtualIndexPaginationConfig]
The configuration for pagination in index setting.
name This property is required. String
Name of the index.
id String
The ID of this resource.
paginationConfigs List<Property Map>
The configuration for pagination in index setting.

getVirtualIndex Result

The following output properties are available:

AdvancedConfigs List<GetVirtualIndexAdvancedConfig>
The configuration for advanced features in index setting.
AttributesConfigs List<GetVirtualIndexAttributesConfig>
The configuration for attributes.
EnablePersonalization bool
Whether to enable the Personalization feature.
EnableRules bool
Whether Rules should be globally enabled.
FacetingConfigs List<GetVirtualIndexFacetingConfig>
The configuration for faceting.
HighlightAndSnippetConfigs List<GetVirtualIndexHighlightAndSnippetConfig>
The configuration for highlight / snippet in index setting.
Id string
The ID of this resource.
LanguagesConfigs List<GetVirtualIndexLanguagesConfig>
The configuration for languages in index setting.
Name string
Name of the index.
PerformanceConfigs List<GetVirtualIndexPerformanceConfig>
The configuration for performance in index setting.
PrimaryIndexName string
The name of the existing primary index name. This field is filled when the index is a replica index.
QueryStrategyConfigs List<GetVirtualIndexQueryStrategyConfig>
The configuration for query strategy in index setting.
RankingConfigs List<GetVirtualIndexRankingConfig>
The configuration for ranking.
TyposConfigs List<GetVirtualIndexTyposConfig>
The configuration for typos in index setting.
PaginationConfigs List<GetVirtualIndexPaginationConfig>
The configuration for pagination in index setting.
AdvancedConfigs []GetVirtualIndexAdvancedConfig
The configuration for advanced features in index setting.
AttributesConfigs []GetVirtualIndexAttributesConfig
The configuration for attributes.
EnablePersonalization bool
Whether to enable the Personalization feature.
EnableRules bool
Whether Rules should be globally enabled.
FacetingConfigs []GetVirtualIndexFacetingConfig
The configuration for faceting.
HighlightAndSnippetConfigs []GetVirtualIndexHighlightAndSnippetConfig
The configuration for highlight / snippet in index setting.
Id string
The ID of this resource.
LanguagesConfigs []GetVirtualIndexLanguagesConfig
The configuration for languages in index setting.
Name string
Name of the index.
PerformanceConfigs []GetVirtualIndexPerformanceConfig
The configuration for performance in index setting.
PrimaryIndexName string
The name of the existing primary index name. This field is filled when the index is a replica index.
QueryStrategyConfigs []GetVirtualIndexQueryStrategyConfig
The configuration for query strategy in index setting.
RankingConfigs []GetVirtualIndexRankingConfig
The configuration for ranking.
TyposConfigs []GetVirtualIndexTyposConfig
The configuration for typos in index setting.
PaginationConfigs []GetVirtualIndexPaginationConfig
The configuration for pagination in index setting.
advancedConfigs List<GetVirtualIndexAdvancedConfig>
The configuration for advanced features in index setting.
attributesConfigs List<GetVirtualIndexAttributesConfig>
The configuration for attributes.
enablePersonalization Boolean
Whether to enable the Personalization feature.
enableRules Boolean
Whether Rules should be globally enabled.
facetingConfigs List<GetVirtualIndexFacetingConfig>
The configuration for faceting.
highlightAndSnippetConfigs List<GetVirtualIndexHighlightAndSnippetConfig>
The configuration for highlight / snippet in index setting.
id String
The ID of this resource.
languagesConfigs List<GetVirtualIndexLanguagesConfig>
The configuration for languages in index setting.
name String
Name of the index.
performanceConfigs List<GetVirtualIndexPerformanceConfig>
The configuration for performance in index setting.
primaryIndexName String
The name of the existing primary index name. This field is filled when the index is a replica index.
queryStrategyConfigs List<GetVirtualIndexQueryStrategyConfig>
The configuration for query strategy in index setting.
rankingConfigs List<GetVirtualIndexRankingConfig>
The configuration for ranking.
typosConfigs List<GetVirtualIndexTyposConfig>
The configuration for typos in index setting.
paginationConfigs List<GetVirtualIndexPaginationConfig>
The configuration for pagination in index setting.
advancedConfigs GetVirtualIndexAdvancedConfig[]
The configuration for advanced features in index setting.
attributesConfigs GetVirtualIndexAttributesConfig[]
The configuration for attributes.
enablePersonalization boolean
Whether to enable the Personalization feature.
enableRules boolean
Whether Rules should be globally enabled.
facetingConfigs GetVirtualIndexFacetingConfig[]
The configuration for faceting.
highlightAndSnippetConfigs GetVirtualIndexHighlightAndSnippetConfig[]
The configuration for highlight / snippet in index setting.
id string
The ID of this resource.
languagesConfigs GetVirtualIndexLanguagesConfig[]
The configuration for languages in index setting.
name string
Name of the index.
performanceConfigs GetVirtualIndexPerformanceConfig[]
The configuration for performance in index setting.
primaryIndexName string
The name of the existing primary index name. This field is filled when the index is a replica index.
queryStrategyConfigs GetVirtualIndexQueryStrategyConfig[]
The configuration for query strategy in index setting.
rankingConfigs GetVirtualIndexRankingConfig[]
The configuration for ranking.
typosConfigs GetVirtualIndexTyposConfig[]
The configuration for typos in index setting.
paginationConfigs GetVirtualIndexPaginationConfig[]
The configuration for pagination in index setting.
advanced_configs Sequence[GetVirtualIndexAdvancedConfig]
The configuration for advanced features in index setting.
attributes_configs Sequence[GetVirtualIndexAttributesConfig]
The configuration for attributes.
enable_personalization bool
Whether to enable the Personalization feature.
enable_rules bool
Whether Rules should be globally enabled.
faceting_configs Sequence[GetVirtualIndexFacetingConfig]
The configuration for faceting.
highlight_and_snippet_configs Sequence[GetVirtualIndexHighlightAndSnippetConfig]
The configuration for highlight / snippet in index setting.
id str
The ID of this resource.
languages_configs Sequence[GetVirtualIndexLanguagesConfig]
The configuration for languages in index setting.
name str
Name of the index.
performance_configs Sequence[GetVirtualIndexPerformanceConfig]
The configuration for performance in index setting.
primary_index_name str
The name of the existing primary index name. This field is filled when the index is a replica index.
query_strategy_configs Sequence[GetVirtualIndexQueryStrategyConfig]
The configuration for query strategy in index setting.
ranking_configs Sequence[GetVirtualIndexRankingConfig]
The configuration for ranking.
typos_configs Sequence[GetVirtualIndexTyposConfig]
The configuration for typos in index setting.
pagination_configs Sequence[GetVirtualIndexPaginationConfig]
The configuration for pagination in index setting.
advancedConfigs List<Property Map>
The configuration for advanced features in index setting.
attributesConfigs List<Property Map>
The configuration for attributes.
enablePersonalization Boolean
Whether to enable the Personalization feature.
enableRules Boolean
Whether Rules should be globally enabled.
facetingConfigs List<Property Map>
The configuration for faceting.
highlightAndSnippetConfigs List<Property Map>
The configuration for highlight / snippet in index setting.
id String
The ID of this resource.
languagesConfigs List<Property Map>
The configuration for languages in index setting.
name String
Name of the index.
performanceConfigs List<Property Map>
The configuration for performance in index setting.
primaryIndexName String
The name of the existing primary index name. This field is filled when the index is a replica index.
queryStrategyConfigs List<Property Map>
The configuration for query strategy in index setting.
rankingConfigs List<Property Map>
The configuration for ranking.
typosConfigs List<Property Map>
The configuration for typos in index setting.
paginationConfigs List<Property Map>
The configuration for pagination in index setting.

Supporting Types

GetVirtualIndexAdvancedConfig

AttributeCriteriaComputedByMinProximity This property is required. bool
AttributeForDistinct This property is required. string
Distinct This property is required. double
MaxFacetHits This property is required. double
MinProximity This property is required. double
ReplaceSynonymsInHighlight This property is required. bool
ResponseFields This property is required. List<string>
AttributeCriteriaComputedByMinProximity This property is required. bool
AttributeForDistinct This property is required. string
Distinct This property is required. float64
MaxFacetHits This property is required. float64
MinProximity This property is required. float64
ReplaceSynonymsInHighlight This property is required. bool
ResponseFields This property is required. []string
attributeCriteriaComputedByMinProximity This property is required. Boolean
attributeForDistinct This property is required. String
distinct This property is required. Double
maxFacetHits This property is required. Double
minProximity This property is required. Double
replaceSynonymsInHighlight This property is required. Boolean
responseFields This property is required. List<String>
attributeCriteriaComputedByMinProximity This property is required. boolean
attributeForDistinct This property is required. string
distinct This property is required. number
maxFacetHits This property is required. number
minProximity This property is required. number
replaceSynonymsInHighlight This property is required. boolean
responseFields This property is required. string[]
attribute_criteria_computed_by_min_proximity This property is required. bool
attribute_for_distinct This property is required. str
distinct This property is required. float
max_facet_hits This property is required. float
min_proximity This property is required. float
replace_synonyms_in_highlight This property is required. bool
response_fields This property is required. Sequence[str]
attributeCriteriaComputedByMinProximity This property is required. Boolean
attributeForDistinct This property is required. String
distinct This property is required. Number
maxFacetHits This property is required. Number
minProximity This property is required. Number
replaceSynonymsInHighlight This property is required. Boolean
responseFields This property is required. List<String>

GetVirtualIndexAttributesConfig

AttributesForFacetings This property is required. List<string>
AttributesToRetrieves This property is required. List<string>
SearchableAttributes This property is required. List<string>
UnretrievableAttributes This property is required. List<string>
AttributesForFacetings This property is required. []string
AttributesToRetrieves This property is required. []string
SearchableAttributes This property is required. []string
UnretrievableAttributes This property is required. []string
attributesForFacetings This property is required. List<String>
attributesToRetrieves This property is required. List<String>
searchableAttributes This property is required. List<String>
unretrievableAttributes This property is required. List<String>
attributesForFacetings This property is required. string[]
attributesToRetrieves This property is required. string[]
searchableAttributes This property is required. string[]
unretrievableAttributes This property is required. string[]
attributes_for_facetings This property is required. Sequence[str]
attributes_to_retrieves This property is required. Sequence[str]
searchable_attributes This property is required. Sequence[str]
unretrievable_attributes This property is required. Sequence[str]
attributesForFacetings This property is required. List<String>
attributesToRetrieves This property is required. List<String>
searchableAttributes This property is required. List<String>
unretrievableAttributes This property is required. List<String>

GetVirtualIndexFacetingConfig

MaxValuesPerFacet This property is required. double
SortFacetValuesBy This property is required. string
MaxValuesPerFacet This property is required. float64
SortFacetValuesBy This property is required. string
maxValuesPerFacet This property is required. Double
sortFacetValuesBy This property is required. String
maxValuesPerFacet This property is required. number
sortFacetValuesBy This property is required. string
max_values_per_facet This property is required. float
sort_facet_values_by This property is required. str
maxValuesPerFacet This property is required. Number
sortFacetValuesBy This property is required. String

GetVirtualIndexHighlightAndSnippetConfig

AttributesToHighlights This property is required. List<string>
AttributesToSnippets This property is required. List<string>
HighlightPostTag This property is required. string
HighlightPreTag This property is required. string
RestrictHighlightAndSnippetArrays This property is required. bool
SnippetEllipsisText This property is required. string
AttributesToHighlights This property is required. []string
AttributesToSnippets This property is required. []string
HighlightPostTag This property is required. string
HighlightPreTag This property is required. string
RestrictHighlightAndSnippetArrays This property is required. bool
SnippetEllipsisText This property is required. string
attributesToHighlights This property is required. List<String>
attributesToSnippets This property is required. List<String>
highlightPostTag This property is required. String
highlightPreTag This property is required. String
restrictHighlightAndSnippetArrays This property is required. Boolean
snippetEllipsisText This property is required. String
attributesToHighlights This property is required. string[]
attributesToSnippets This property is required. string[]
highlightPostTag This property is required. string
highlightPreTag This property is required. string
restrictHighlightAndSnippetArrays This property is required. boolean
snippetEllipsisText This property is required. string
attributes_to_highlights This property is required. Sequence[str]
attributes_to_snippets This property is required. Sequence[str]
highlight_post_tag This property is required. str
highlight_pre_tag This property is required. str
restrict_highlight_and_snippet_arrays This property is required. bool
snippet_ellipsis_text This property is required. str
attributesToHighlights This property is required. List<String>
attributesToSnippets This property is required. List<String>
highlightPostTag This property is required. String
highlightPreTag This property is required. String
restrictHighlightAndSnippetArrays This property is required. Boolean
snippetEllipsisText This property is required. String

GetVirtualIndexLanguagesConfig

AttributesToTransliterates This property is required. List<string>
CamelCaseAttributes This property is required. List<string>
CustomNormalization This property is required. Dictionary<string, string>
DecompoundQuery This property is required. bool
DecompoundedAttributes This property is required. List<GetVirtualIndexLanguagesConfigDecompoundedAttribute>
IgnorePlurals This property is required. bool
IgnorePluralsFors This property is required. List<string>
IndexLanguages This property is required. List<string>
KeepDiacriticsOnCharacters This property is required. string
QueryLanguages This property is required. List<string>
RemoveStopWords This property is required. bool
RemoveStopWordsFors This property is required. List<string>
AttributesToTransliterates This property is required. []string
CamelCaseAttributes This property is required. []string
CustomNormalization This property is required. map[string]string
DecompoundQuery This property is required. bool
DecompoundedAttributes This property is required. []GetVirtualIndexLanguagesConfigDecompoundedAttribute
IgnorePlurals This property is required. bool
IgnorePluralsFors This property is required. []string
IndexLanguages This property is required. []string
KeepDiacriticsOnCharacters This property is required. string
QueryLanguages This property is required. []string
RemoveStopWords This property is required. bool
RemoveStopWordsFors This property is required. []string
attributesToTransliterates This property is required. List<String>
camelCaseAttributes This property is required. List<String>
customNormalization This property is required. Map<String,String>
decompoundQuery This property is required. Boolean
decompoundedAttributes This property is required. List<GetVirtualIndexLanguagesConfigDecompoundedAttribute>
ignorePlurals This property is required. Boolean
ignorePluralsFors This property is required. List<String>
indexLanguages This property is required. List<String>
keepDiacriticsOnCharacters This property is required. String
queryLanguages This property is required. List<String>
removeStopWords This property is required. Boolean
removeStopWordsFors This property is required. List<String>
attributesToTransliterates This property is required. string[]
camelCaseAttributes This property is required. string[]
customNormalization This property is required. {[key: string]: string}
decompoundQuery This property is required. boolean
decompoundedAttributes This property is required. GetVirtualIndexLanguagesConfigDecompoundedAttribute[]
ignorePlurals This property is required. boolean
ignorePluralsFors This property is required. string[]
indexLanguages This property is required. string[]
keepDiacriticsOnCharacters This property is required. string
queryLanguages This property is required. string[]
removeStopWords This property is required. boolean
removeStopWordsFors This property is required. string[]
attributes_to_transliterates This property is required. Sequence[str]
camel_case_attributes This property is required. Sequence[str]
custom_normalization This property is required. Mapping[str, str]
decompound_query This property is required. bool
decompounded_attributes This property is required. Sequence[GetVirtualIndexLanguagesConfigDecompoundedAttribute]
ignore_plurals This property is required. bool
ignore_plurals_fors This property is required. Sequence[str]
index_languages This property is required. Sequence[str]
keep_diacritics_on_characters This property is required. str
query_languages This property is required. Sequence[str]
remove_stop_words This property is required. bool
remove_stop_words_fors This property is required. Sequence[str]
attributesToTransliterates This property is required. List<String>
camelCaseAttributes This property is required. List<String>
customNormalization This property is required. Map<String>
decompoundQuery This property is required. Boolean
decompoundedAttributes This property is required. List<Property Map>
ignorePlurals This property is required. Boolean
ignorePluralsFors This property is required. List<String>
indexLanguages This property is required. List<String>
keepDiacriticsOnCharacters This property is required. String
queryLanguages This property is required. List<String>
removeStopWords This property is required. Boolean
removeStopWordsFors This property is required. List<String>

GetVirtualIndexLanguagesConfigDecompoundedAttribute

Attributes This property is required. List<string>
Language This property is required. string
Attributes This property is required. []string
Language This property is required. string
attributes This property is required. List<String>
language This property is required. String
attributes This property is required. string[]
language This property is required. string
attributes This property is required. Sequence[str]
language This property is required. str
attributes This property is required. List<String>
language This property is required. String

GetVirtualIndexPaginationConfig

HitsPerPage This property is required. double
The number of hits per page.
PaginationLimitedTo This property is required. double
The maximum number of hits accessible via pagination
HitsPerPage This property is required. float64
The number of hits per page.
PaginationLimitedTo This property is required. float64
The maximum number of hits accessible via pagination
hitsPerPage This property is required. Double
The number of hits per page.
paginationLimitedTo This property is required. Double
The maximum number of hits accessible via pagination
hitsPerPage This property is required. number
The number of hits per page.
paginationLimitedTo This property is required. number
The maximum number of hits accessible via pagination
hits_per_page This property is required. float
The number of hits per page.
pagination_limited_to This property is required. float
The maximum number of hits accessible via pagination
hitsPerPage This property is required. Number
The number of hits per page.
paginationLimitedTo This property is required. Number
The maximum number of hits accessible via pagination

GetVirtualIndexPerformanceConfig

AllowCompressionOfIntegerArray This property is required. bool
NumericAttributesForFilterings This property is required. List<string>
AllowCompressionOfIntegerArray This property is required. bool
NumericAttributesForFilterings This property is required. []string
allowCompressionOfIntegerArray This property is required. Boolean
numericAttributesForFilterings This property is required. List<String>
allowCompressionOfIntegerArray This property is required. boolean
numericAttributesForFilterings This property is required. string[]
allow_compression_of_integer_array This property is required. bool
numeric_attributes_for_filterings This property is required. Sequence[str]
allowCompressionOfIntegerArray This property is required. Boolean
numericAttributesForFilterings This property is required. List<String>

GetVirtualIndexQueryStrategyConfig

AdvancedSyntax This property is required. bool
AdvancedSyntaxFeatures This property is required. List<string>
AlternativesAsExacts This property is required. List<string>
DisableExactOnAttributes This property is required. List<string>
DisablePrefixOnAttributes This property is required. List<string>
ExactOnSingleWordQuery This property is required. string
OptionalWords This property is required. List<string>
QueryType This property is required. string
RemoveWordsIfNoResults This property is required. string
AdvancedSyntax This property is required. bool
AdvancedSyntaxFeatures This property is required. []string
AlternativesAsExacts This property is required. []string
DisableExactOnAttributes This property is required. []string
DisablePrefixOnAttributes This property is required. []string
ExactOnSingleWordQuery This property is required. string
OptionalWords This property is required. []string
QueryType This property is required. string
RemoveWordsIfNoResults This property is required. string
advancedSyntax This property is required. Boolean
advancedSyntaxFeatures This property is required. List<String>
alternativesAsExacts This property is required. List<String>
disableExactOnAttributes This property is required. List<String>
disablePrefixOnAttributes This property is required. List<String>
exactOnSingleWordQuery This property is required. String
optionalWords This property is required. List<String>
queryType This property is required. String
removeWordsIfNoResults This property is required. String
advancedSyntax This property is required. boolean
advancedSyntaxFeatures This property is required. string[]
alternativesAsExacts This property is required. string[]
disableExactOnAttributes This property is required. string[]
disablePrefixOnAttributes This property is required. string[]
exactOnSingleWordQuery This property is required. string
optionalWords This property is required. string[]
queryType This property is required. string
removeWordsIfNoResults This property is required. string
advanced_syntax This property is required. bool
advanced_syntax_features This property is required. Sequence[str]
alternatives_as_exacts This property is required. Sequence[str]
disable_exact_on_attributes This property is required. Sequence[str]
disable_prefix_on_attributes This property is required. Sequence[str]
exact_on_single_word_query This property is required. str
optional_words This property is required. Sequence[str]
query_type This property is required. str
remove_words_if_no_results This property is required. str
advancedSyntax This property is required. Boolean
advancedSyntaxFeatures This property is required. List<String>
alternativesAsExacts This property is required. List<String>
disableExactOnAttributes This property is required. List<String>
disablePrefixOnAttributes This property is required. List<String>
exactOnSingleWordQuery This property is required. String
optionalWords This property is required. List<String>
queryType This property is required. String
removeWordsIfNoResults This property is required. String

GetVirtualIndexRankingConfig

CustomRankings This property is required. List<string>
Rankings This property is required. List<string>
RelevancyStrictness This property is required. double
CustomRankings This property is required. []string
Rankings This property is required. []string
RelevancyStrictness This property is required. float64
customRankings This property is required. List<String>
rankings This property is required. List<String>
relevancyStrictness This property is required. Double
customRankings This property is required. string[]
rankings This property is required. string[]
relevancyStrictness This property is required. number
custom_rankings This property is required. Sequence[str]
rankings This property is required. Sequence[str]
relevancy_strictness This property is required. float
customRankings This property is required. List<String>
rankings This property is required. List<String>
relevancyStrictness This property is required. Number

GetVirtualIndexTyposConfig

AllowTyposOnNumericTokens This property is required. bool
DisableTypoToleranceOnAttributes This property is required. List<string>
DisableTypoToleranceOnWords This property is required. List<string>
MinWordSizeFor1Typo This property is required. double
MinWordSizeFor2Typos This property is required. double
SeparatorsToIndex This property is required. string
TypoTolerance This property is required. string
AllowTyposOnNumericTokens This property is required. bool
DisableTypoToleranceOnAttributes This property is required. []string
DisableTypoToleranceOnWords This property is required. []string
MinWordSizeFor1Typo This property is required. float64
MinWordSizeFor2Typos This property is required. float64
SeparatorsToIndex This property is required. string
TypoTolerance This property is required. string
allowTyposOnNumericTokens This property is required. Boolean
disableTypoToleranceOnAttributes This property is required. List<String>
disableTypoToleranceOnWords This property is required. List<String>
minWordSizeFor1Typo This property is required. Double
minWordSizeFor2Typos This property is required. Double
separatorsToIndex This property is required. String
typoTolerance This property is required. String
allowTyposOnNumericTokens This property is required. boolean
disableTypoToleranceOnAttributes This property is required. string[]
disableTypoToleranceOnWords This property is required. string[]
minWordSizeFor1Typo This property is required. number
minWordSizeFor2Typos This property is required. number
separatorsToIndex This property is required. string
typoTolerance This property is required. string
allow_typos_on_numeric_tokens This property is required. bool
disable_typo_tolerance_on_attributes This property is required. Sequence[str]
disable_typo_tolerance_on_words This property is required. Sequence[str]
min_word_size_for1_typo This property is required. float
min_word_size_for2_typos This property is required. float
separators_to_index This property is required. str
typo_tolerance This property is required. str
allowTyposOnNumericTokens This property is required. Boolean
disableTypoToleranceOnAttributes This property is required. List<String>
disableTypoToleranceOnWords This property is required. List<String>
minWordSizeFor1Typo This property is required. Number
minWordSizeFor2Typos This property is required. Number
separatorsToIndex This property is required. String
typoTolerance This property is required. String

Package Details

Repository
algolia k-yomo/terraform-provider-algolia
License
Notes
This Pulumi package is based on the algolia Terraform Provider.