Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Google Native

v0.9.0 published on Wednesday, Nov 24, 2021 by Pulumi

getIndex

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(index_id: Optional[str] = None,
              project: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetIndexResult
def get_index_output(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)
}

The following arguments are supported:

IndexId string
Project string
IndexId string
Project string
indexId string
project string

getIndex Result

The following output properties are available:

Ancestor string
The index’s ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.
IndexId string
The resource ID of the index.
Kind string
The entity kind to which this index applies.
Project string
Project ID.
Properties List<Pulumi.GoogleNative.Datastore.V1.Outputs.GoogleDatastoreAdminV1IndexedPropertyResponse>
An ordered sequence of property names and their index attributes.
State string
The state of the index.
Ancestor string
The index’s ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.
IndexId string
The resource ID of the index.
Kind string
The entity kind to which this index applies.
Project string
Project ID.
Properties []GoogleDatastoreAdminV1IndexedPropertyResponse
An ordered sequence of property names and their index attributes.
State string
The state of the index.
ancestor string
The index’s ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.
indexId string
The resource ID of the index.
kind string
The entity kind to which this index applies.
project string
Project ID.
properties GoogleDatastoreAdminV1IndexedPropertyResponse[]
An ordered sequence of property names and their index attributes.
state string
The state of the index.
ancestor str
The index’s ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.
index_id str
The resource ID of the index.
kind str
The entity kind to which this index applies.
project str
Project ID.
properties Sequence[GoogleDatastoreAdminV1IndexedPropertyResponse]
An ordered sequence of property names and their index attributes.
state str
The state of the index.

Supporting Types

GoogleDatastoreAdminV1IndexedPropertyResponse

Direction string
The indexed property’s direction. Must not be DIRECTION_UNSPECIFIED.
Name string
The property name to index.
Direction string
The indexed property’s direction. Must not be DIRECTION_UNSPECIFIED.
Name string
The property name to index.
direction string
The indexed property’s direction. Must not be DIRECTION_UNSPECIFIED.
name string
The property name to index.
direction str
The indexed property’s direction. Must not be DIRECTION_UNSPECIFIED.
name str
The property name to index.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0