algolia.getVirtualIndex

Explore with Pulumi AI

algolia 0.6.0 published on Monday, Apr 14, 2025 by k-yomo

Example Usage

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

const example = algolia.getVirtualIndex({
    name: "example_virtual_replica",
});

import pulumi
import pulumi_algolia as algolia

example = algolia.get_virtual_index(name="example_virtual_replica")

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
	})
}

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",
    });

});

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());

    }
}

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

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>

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]

func LookupVirtualIndex(ctx *Context, args *LookupVirtualIndexArgs, opts ...InvokeOption) (*LookupVirtualIndexResult, error)
func LookupVirtualIndexOutput(ctx *Context, args *LookupVirtualIndexOutputArgs, opts ...InvokeOption) LookupVirtualIndexResultOutput

> 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)
}

public static CompletableFuture<GetVirtualIndexResult> getVirtualIndex(GetVirtualIndexArgs args, InvokeOptions options)
public static Output<GetVirtualIndexResult> getVirtualIndex(GetVirtualIndexArgs args, InvokeOptions options)

fn::invoke:
  function: algolia:index/getVirtualIndex:getVirtualIndex
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name of the index.
Id string: The ID of this resource.
PaginationConfigs List<GetVirtualIndexPaginationConfig>: The configuration for pagination in index setting.

Name string: Name of the index.
Id string: The ID of this resource.
PaginationConfigs []GetVirtualIndexPaginationConfig: The configuration for pagination in index setting.

name String: Name of the index.
id String: The ID of this resource.
paginationConfigs List<GetVirtualIndexPaginationConfig>: The configuration for pagination in index setting.

name string: Name of the index.
id string: The ID of this resource.
paginationConfigs GetVirtualIndexPaginationConfig[]: The configuration for pagination in index setting.

name str: Name of the index.
id str: The ID of this resource.
pagination_configs Sequence[GetVirtualIndexPaginationConfig]: The configuration for pagination in index setting.

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