Google Native

v0.26.0 published on Friday, Sep 16, 2022 by Pulumi

Index

Creates the specified index. A newly created index’s initial state is CREATING. On completion of the returned google.longrunning.Operation, the state will be READY. If the index already exists, the call will return an ALREADY_EXISTS status. During index creation, the process could result in an error, in which case the index will move to the ERROR state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single property cannot be created. Auto-naming is currently not supported for this resource.

Create a Index Resource

new Index(name: string, args: IndexArgs, opts?: CustomResourceOptions);
@overload
def Index(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          ancestor: Optional[IndexAncestor] = None,
          kind: Optional[str] = None,
          project: Optional[str] = None,
          properties: Optional[Sequence[GoogleDatastoreAdminV1IndexedPropertyArgs]] = None)
@overload
def Index(resource_name: str,
          args: IndexArgs,
          opts: Optional[ResourceOptions] = None)
func NewIndex(ctx *Context, name string, args IndexArgs, opts ...ResourceOption) (*Index, error)
public Index(string name, IndexArgs args, CustomResourceOptions? opts = null)
public Index(String name, IndexArgs args)
public Index(String name, IndexArgs args, CustomResourceOptions options)
type: google-native:datastore/v1:Index
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args IndexArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args IndexArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args IndexArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args IndexArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args IndexArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Index Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Index resource accepts the following input properties:

Ancestor Pulumi.GoogleNative.Datastore.V1.IndexAncestor

The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

Kind string

The entity kind to which this index applies.

Properties List<Pulumi.GoogleNative.Datastore.V1.Inputs.GoogleDatastoreAdminV1IndexedPropertyArgs>

An ordered sequence of property names and their index attributes. Requires: * A maximum of 100 properties.

Project string
Ancestor IndexAncestor

The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

Kind string

The entity kind to which this index applies.

Properties []GoogleDatastoreAdminV1IndexedPropertyArgs

An ordered sequence of property names and their index attributes. Requires: * A maximum of 100 properties.

Project string
ancestor IndexAncestor

The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

kind String

The entity kind to which this index applies.

properties List<GoogleDatastoreAdminV1IndexedPropertyArgs>

An ordered sequence of property names and their index attributes. Requires: * A maximum of 100 properties.

project String
ancestor IndexAncestor

The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

kind string

The entity kind to which this index applies.

properties GoogleDatastoreAdminV1IndexedPropertyArgs[]

An ordered sequence of property names and their index attributes. Requires: * A maximum of 100 properties.

project string
ancestor IndexAncestor

The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

kind str

The entity kind to which this index applies.

properties Sequence[GoogleDatastoreAdminV1IndexedPropertyArgs]

An ordered sequence of property names and their index attributes. Requires: * A maximum of 100 properties.

project str
ancestor "ANCESTOR_MODE_UNSPECIFIED" | "NONE" | "ALL_ANCESTORS"

The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

kind String

The entity kind to which this index applies.

properties List<Property Map>

An ordered sequence of property names and their index attributes. Requires: * A maximum of 100 properties.

project String

Outputs

All input properties are implicitly available as output properties. Additionally, the Index resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

IndexId string

The resource ID of the index.

State string

The state of the index.

Id string

The provider-assigned unique ID for this managed resource.

IndexId string

The resource ID of the index.

State string

The state of the index.

id String

The provider-assigned unique ID for this managed resource.

indexId String

The resource ID of the index.

state String

The state of the index.

id string

The provider-assigned unique ID for this managed resource.

indexId string

The resource ID of the index.

state string

The state of the index.

id str

The provider-assigned unique ID for this managed resource.

index_id str

The resource ID of the index.

state str

The state of the index.

id String

The provider-assigned unique ID for this managed resource.

indexId String

The resource ID of the index.

state String

The state of the index.

Supporting Types

GoogleDatastoreAdminV1IndexedProperty

Direction Pulumi.GoogleNative.Datastore.V1.GoogleDatastoreAdminV1IndexedPropertyDirection

The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.

Name string

The property name to index.

Direction GoogleDatastoreAdminV1IndexedPropertyDirection

The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.

Name string

The property name to index.

direction GoogleDatastoreAdminV1IndexedPropertyDirection

The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.

name String

The property name to index.

direction GoogleDatastoreAdminV1IndexedPropertyDirection

The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.

name string

The property name to index.

direction GoogleDatastoreAdminV1IndexedPropertyDirection

The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.

name str

The property name to index.

direction "DIRECTION_UNSPECIFIED" | "ASCENDING" | "DESCENDING"

The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.

name String

The property name to index.

GoogleDatastoreAdminV1IndexedPropertyDirection

DirectionUnspecified
DIRECTION_UNSPECIFIED

The direction is unspecified.

Ascending
ASCENDING

The property's values are indexed so as to support sequencing in ascending order and also query by <, >, <=, >=, and =.

Descending
DESCENDING

The property's values are indexed so as to support sequencing in descending order and also query by <, >, <=, >=, and =.

GoogleDatastoreAdminV1IndexedPropertyDirectionDirectionUnspecified
DIRECTION_UNSPECIFIED

The direction is unspecified.

GoogleDatastoreAdminV1IndexedPropertyDirectionAscending
ASCENDING

The property's values are indexed so as to support sequencing in ascending order and also query by <, >, <=, >=, and =.

GoogleDatastoreAdminV1IndexedPropertyDirectionDescending
DESCENDING

The property's values are indexed so as to support sequencing in descending order and also query by <, >, <=, >=, and =.

DirectionUnspecified
DIRECTION_UNSPECIFIED

The direction is unspecified.

Ascending
ASCENDING

The property's values are indexed so as to support sequencing in ascending order and also query by <, >, <=, >=, and =.

Descending
DESCENDING

The property's values are indexed so as to support sequencing in descending order and also query by <, >, <=, >=, and =.

DirectionUnspecified
DIRECTION_UNSPECIFIED

The direction is unspecified.

Ascending
ASCENDING

The property's values are indexed so as to support sequencing in ascending order and also query by <, >, <=, >=, and =.

Descending
DESCENDING

The property's values are indexed so as to support sequencing in descending order and also query by <, >, <=, >=, and =.

DIRECTION_UNSPECIFIED
DIRECTION_UNSPECIFIED

The direction is unspecified.

ASCENDING
ASCENDING

The property's values are indexed so as to support sequencing in ascending order and also query by <, >, <=, >=, and =.

DESCENDING
DESCENDING

The property's values are indexed so as to support sequencing in descending order and also query by <, >, <=, >=, and =.

"DIRECTION_UNSPECIFIED"
DIRECTION_UNSPECIFIED

The direction is unspecified.

"ASCENDING"
ASCENDING

The property's values are indexed so as to support sequencing in ascending order and also query by <, >, <=, >=, and =.

"DESCENDING"
DESCENDING

The property's values are indexed so as to support sequencing in descending order and also query by <, >, <=, >=, and =.

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 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.

direction String

The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.

name String

The property name to index.

IndexAncestor

AncestorModeUnspecified
ANCESTOR_MODE_UNSPECIFIED

The ancestor mode is unspecified.

None
NONE

Do not include the entity's ancestors in the index.

AllAncestors
ALL_ANCESTORS

Include all the entity's ancestors in the index.

IndexAncestorAncestorModeUnspecified
ANCESTOR_MODE_UNSPECIFIED

The ancestor mode is unspecified.

IndexAncestorNone
NONE

Do not include the entity's ancestors in the index.

IndexAncestorAllAncestors
ALL_ANCESTORS

Include all the entity's ancestors in the index.

AncestorModeUnspecified
ANCESTOR_MODE_UNSPECIFIED

The ancestor mode is unspecified.

None
NONE

Do not include the entity's ancestors in the index.

AllAncestors
ALL_ANCESTORS

Include all the entity's ancestors in the index.

AncestorModeUnspecified
ANCESTOR_MODE_UNSPECIFIED

The ancestor mode is unspecified.

None
NONE

Do not include the entity's ancestors in the index.

AllAncestors
ALL_ANCESTORS

Include all the entity's ancestors in the index.

ANCESTOR_MODE_UNSPECIFIED
ANCESTOR_MODE_UNSPECIFIED

The ancestor mode is unspecified.

NONE
NONE

Do not include the entity's ancestors in the index.

ALL_ANCESTORS
ALL_ANCESTORS

Include all the entity's ancestors in the index.

"ANCESTOR_MODE_UNSPECIFIED"
ANCESTOR_MODE_UNSPECIFIED

The ancestor mode is unspecified.

"NONE"
NONE

Do not include the entity's ancestors in the index.

"ALL_ANCESTORS"
ALL_ANCESTORS

Include all the entity's ancestors in the index.

Package Details

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