Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. firestore
  5. firestore/v1beta1
  6. getIndex

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
pulumi/pulumi-google-native

google-native.firestore/v1beta1.getIndex

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets an index.

    Using getIndex

    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 getIndex(args: GetIndexArgs, opts?: InvokeOptions): Promise<GetIndexResult>
function getIndexOutput(args: GetIndexOutputArgs, opts?: InvokeOptions): Output<GetIndexResult>
    def get_index(database_id: Optional[str] = None,
              index_id: Optional[str] = None,
              project: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetIndexResult
def get_index_output(database_id: Optional[pulumi.Input[str]] = None,
              index_id: Optional[pulumi.Input[str]] = None,
              project: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetIndexResult]
    func LookupIndex(ctx *Context, args *LookupIndexArgs, opts ...InvokeOption) (*LookupIndexResult, error)
func LookupIndexOutput(ctx *Context, args *LookupIndexOutputArgs, opts ...InvokeOption) LookupIndexResultOutput

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

    public static class GetIndex 
{
    public static Task<GetIndexResult> InvokeAsync(GetIndexArgs args, InvokeOptions? opts = null)
    public static Output<GetIndexResult> Invoke(GetIndexInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIndexResult> getIndex(GetIndexArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:firestore/v1beta1:getIndex
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DatabaseId string
    IndexId string
    Project string
    DatabaseId string
    IndexId string
    Project string
    databaseId String
    indexId String
    project String
    databaseId string
    indexId string
    project string
    databaseId String
    indexId String
    project String

    getIndex Result

    The following output properties are available:

    CollectionId string
    The collection ID to which this index applies. Required.
    Fields List<Pulumi.GoogleNative.Firestore.V1Beta1.Outputs.GoogleFirestoreAdminV1beta1IndexFieldResponse>
    The fields to index.
    Name string
    The resource name of the index. Output only.
    State string
    The state of the index. Output only.
    CollectionId string
    The collection ID to which this index applies. Required.
    Fields []GoogleFirestoreAdminV1beta1IndexFieldResponse
    The fields to index.
    Name string
    The resource name of the index. Output only.
    State string
    The state of the index. Output only.
    collectionId String
    The collection ID to which this index applies. Required.
    fields List<GoogleFirestoreAdminV1beta1IndexFieldResponse>
    The fields to index.
    name String
    The resource name of the index. Output only.
    state String
    The state of the index. Output only.
    collectionId string
    The collection ID to which this index applies. Required.
    fields GoogleFirestoreAdminV1beta1IndexFieldResponse[]
    The fields to index.
    name string
    The resource name of the index. Output only.
    state string
    The state of the index. Output only.
    collection_id str
    The collection ID to which this index applies. Required.
    fields Sequence[GoogleFirestoreAdminV1beta1IndexFieldResponse]
    The fields to index.
    name str
    The resource name of the index. Output only.
    state str
    The state of the index. Output only.
    collectionId String
    The collection ID to which this index applies. Required.
    fields List<Property Map>
    The fields to index.
    name String
    The resource name of the index. Output only.
    state String
    The state of the index. Output only.

    Supporting Types

    GoogleFirestoreAdminV1beta1IndexFieldResponse

    FieldPath string
    The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path __name__ may be used by itself or at the end of a path. __type__ may be used only at the end of path.
    Mode string
    The field's mode.
    FieldPath string
    The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path __name__ may be used by itself or at the end of a path. __type__ may be used only at the end of path.
    Mode string
    The field's mode.
    fieldPath String
    The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path __name__ may be used by itself or at the end of a path. __type__ may be used only at the end of path.
    mode String
    The field's mode.
    fieldPath string
    The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path __name__ may be used by itself or at the end of a path. __type__ may be used only at the end of path.
    mode string
    The field's mode.
    field_path str
    The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path __name__ may be used by itself or at the end of a path. __type__ may be used only at the end of path.
    mode str
    The field's mode.
    fieldPath String
    The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path __name__ may be used by itself or at the end of a path. __type__ may be used only at the end of path.
    mode String
    The field's mode.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native