Class DataStoreIndex

Describes a composite index for Cloud Datastore.

To get more information about Index, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage - Datastore Index

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var @default = new Gcp.Datastore.DataStoreIndex("default", new Gcp.Datastore.DataStoreIndexArgs
    {
        Kind = "foo",
        Properties = 
        {
            new Gcp.Datastore.Inputs.DataStoreIndexPropertyArgs
            {
                Direction = "ASCENDING",
                Name = "property_a",
            },
            new Gcp.Datastore.Inputs.DataStoreIndexPropertyArgs
            {
                Direction = "ASCENDING",
                Name = "property_b",
            },
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

DataStoreIndex

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Datastore

Assembly: Pulumi.Gcp.dll

Syntax

public class DataStoreIndex : CustomResource

Constructors

DataStoreIndex(String, DataStoreIndexArgs, CustomResourceOptions)

Create a DataStoreIndex resource with the given unique name, arguments, and options.

Declaration

public DataStoreIndex(string name, DataStoreIndexArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
DataStoreIndexArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Ancestor

Policy for including ancestors in the index.

Declaration

public Output<string> Ancestor { get; }

Property Value

Type	Description
Output<System.String>

IndexId

The index id.

Declaration

public Output<string> IndexId { get; }

Property Value

Type	Description
Output<System.String>

Kind

The entity kind which the index applies to.

Declaration

public Output<string> Kind { get; }

Property Value

Type	Description
Output<System.String>

Project

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

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

Properties

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

Declaration

public Output<ImmutableArray<DataStoreIndexProperty>> Properties { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<DataStoreIndexProperty>>

Methods

Get(String, Input<String>, DataStoreIndexState, CustomResourceOptions)

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

Declaration

public static DataStoreIndex Get(string name, Input<string> id, DataStoreIndexState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
DataStoreIndexState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
DataStoreIndex