datastore¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.

class pulumi_gcp.datastore.DataStoreIndex(resource_name, opts=None, ancestor=None, kind=None, project=None, properties=None, __props__=None, __name__=None, __opts__=None)¶

Describes a composite index for Cloud Datastore.

To get more information about Index, see:

• API documentation

• How-to Guides

  • Official Documentation

import pulumi
import pulumi_gcp as gcp

default = gcp.datastore.DataStoreIndex("default",
    kind="foo",
    properties=[
        {
            "direction": "ASCENDING",
            "name": "property_a",
        },
        {
            "direction": "ASCENDING",
            "name": "property_b",
        },
    ])

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• ancestor (pulumi.Input[str]) – Policy for including ancestors in the index.

• kind (pulumi.Input[str]) – The entity kind which the index applies to.

• project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

• properties (pulumi.Input[list]) – An ordered list of properties to index on. Structure is documented below.

The properties object supports the following:

• direction (pulumi.Input[str]) - The direction the index should optimize for sorting.

• name (pulumi.Input[str]) - The property name to index.

ancestor: pulumi.Output[str] = None¶

Policy for including ancestors in the index.

index_id: pulumi.Output[str] = None¶

The index id.

kind: pulumi.Output[str] = None¶

The entity kind which the index applies to.

project: pulumi.Output[str] = None¶

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

properties: pulumi.Output[list] = None¶

An ordered list of properties to index on. Structure is documented below.

• direction (str) - The direction the index should optimize for sorting.

• name (str) - The property name to index.

static get(resource_name, id, opts=None, ancestor=None, index_id=None, kind=None, project=None, properties=None)¶

Get an existing DataStoreIndex resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• ancestor (pulumi.Input[str]) – Policy for including ancestors in the index.

• index_id (pulumi.Input[str]) – The index id.

• kind (pulumi.Input[str]) – The entity kind which the index applies to.

• project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

• properties (pulumi.Input[list]) – An ordered list of properties to index on. Structure is documented below.

The properties object supports the following:

• direction (pulumi.Input[str]) - The direction the index should optimize for sorting.

• name (pulumi.Input[str]) - The property name to index.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str