Google Cloud Native v0.28.0, Feb 2 23

google-native.firestore/v1.getIndex

Gets a composite 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(collection_group_id: Optional[str] = None,
              database_id: Optional[str] = None,
              index_id: Optional[str] = None,
              project: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetIndexResult
def get_index_output(collection_group_id: Optional[pulumi.Input[str]] = None,
              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/v1:getIndex
  arguments:
    # arguments dictionary

The following arguments are supported:

CollectionGroupId string
DatabaseId string
IndexId string
Project string

CollectionGroupId string
DatabaseId string
IndexId string
Project string

collectionGroupId String
databaseId String
indexId String
project String

collectionGroupId string
databaseId string
indexId string
project string

collection_group_id str
database_id str
index_id str
project str

collectionGroupId String
databaseId String
indexId String
project String

getIndex Result

The following output properties are available:

ApiScope string: The API scope supported by this index.
Fields List<Pulumi.GoogleNative.Firestore.V1.Outputs.GoogleFirestoreAdminV1IndexFieldResponse>: The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path __name__. If, on creation, __name__ was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the __name__ will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
Name string: A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.
QueryScope string: Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
State string: The serving state of the index.

ApiScope string: The API scope supported by this index.
Fields []GoogleFirestoreAdminV1IndexFieldResponse: The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path __name__. If, on creation, __name__ was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the __name__ will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
Name string: A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.
QueryScope string: Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
State string: The serving state of the index.

apiScope String: The API scope supported by this index.
fields List<GoogleFirestoreAdminV1IndexFieldResponse>: The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path __name__. If, on creation, __name__ was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the __name__ will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
name String: A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.
queryScope String: Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
state String: The serving state of the index.

apiScope string: The API scope supported by this index.
fields GoogleFirestoreAdminV1IndexFieldResponse[]: The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path __name__. If, on creation, __name__ was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the __name__ will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
name string: A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.
queryScope string: Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
state string: The serving state of the index.

api_scope str: The API scope supported by this index.
fields Sequence[GoogleFirestoreAdminV1IndexFieldResponse]: The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path __name__. If, on creation, __name__ was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the __name__ will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
name str: A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.
query_scope str: Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
state str: The serving state of the index.

apiScope String: The API scope supported by this index.
fields List<Property Map>: The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path __name__. If, on creation, __name__ was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the __name__ will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
name String: A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.
queryScope String: Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
state String: The serving state of the index.

Supporting Types

GoogleFirestoreAdminV1IndexFieldResponse

ArrayConfig string: Indicates that this field supports operations on array_values.
FieldPath string: Can be name. For single field indexes, this must match the name of the field or may be omitted.
Order string: Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

ArrayConfig string: Indicates that this field supports operations on array_values.
FieldPath string: Can be name. For single field indexes, this must match the name of the field or may be omitted.
Order string: Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

arrayConfig String: Indicates that this field supports operations on array_values.
fieldPath String: Can be name. For single field indexes, this must match the name of the field or may be omitted.
order String: Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

arrayConfig string: Indicates that this field supports operations on array_values.
fieldPath string: Can be name. For single field indexes, this must match the name of the field or may be omitted.
order string: Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

array_config str: Indicates that this field supports operations on array_values.
field_path str: Can be name. For single field indexes, this must match the name of the field or may be omitted.
order str: Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

arrayConfig String: Indicates that this field supports operations on array_values.
fieldPath String: Can be name. For single field indexes, this must match the name of the field or may be omitted.
order String: Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

Package Details

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