v1beta1

package
v0.32.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 29, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// The mode is unspecified.
	GoogleFirestoreAdminV1beta1IndexFieldModeModeUnspecified = GoogleFirestoreAdminV1beta1IndexFieldMode("MODE_UNSPECIFIED")
	// The field's values are indexed so as to support sequencing in ascending order and also query by <, >, <=, >=, and =.
	GoogleFirestoreAdminV1beta1IndexFieldModeAscending = GoogleFirestoreAdminV1beta1IndexFieldMode("ASCENDING")
	// The field's values are indexed so as to support sequencing in descending order and also query by <, >, <=, >=, and =.
	GoogleFirestoreAdminV1beta1IndexFieldModeDescending = GoogleFirestoreAdminV1beta1IndexFieldMode("DESCENDING")
	// The field's array values are indexed so as to support membership using ARRAY_CONTAINS queries.
	GoogleFirestoreAdminV1beta1IndexFieldModeArrayContains = GoogleFirestoreAdminV1beta1IndexFieldMode("ARRAY_CONTAINS")
)
View Source 
const (
	// The state is unspecified.
	IndexStateEnumStateUnspecified = IndexStateEnum("STATE_UNSPECIFIED")
	// The index is being created. There is an active long-running operation for the index. The index is updated when writing a document. Some index data may exist.
	IndexStateEnumCreating = IndexStateEnum("CREATING")
	// The index is ready to be used. The index is updated when writing a document. The index is fully populated from all stored documents it applies to.
	IndexStateEnumReady = IndexStateEnum("READY")
	// The index was being created, but something went wrong. There is no active long-running operation for the index, and the most recently finished long-running operation failed. The index is not updated when writing a document. Some index data may exist.
	IndexStateEnumError = IndexStateEnum("ERROR")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type GoogleFirestoreAdminV1beta1IndexField 

type GoogleFirestoreAdminV1beta1IndexField struct {
	// The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path `__name__` may be used by itself or at the end of a path. `__type__` may be used only at the end of path.
	FieldPath *string `pulumi:"fieldPath"`
	// The field's mode.
	Mode *GoogleFirestoreAdminV1beta1IndexFieldMode `pulumi:"mode"`
}

A field of an index.

type GoogleFirestoreAdminV1beta1IndexFieldArgs 

type GoogleFirestoreAdminV1beta1IndexFieldArgs struct {
	// The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path `__name__` may be used by itself or at the end of a path. `__type__` may be used only at the end of path.
	FieldPath pulumi.StringPtrInput `pulumi:"fieldPath"`
	// The field's mode.
	Mode GoogleFirestoreAdminV1beta1IndexFieldModePtrInput `pulumi:"mode"`
}

A field of an index.

func (GoogleFirestoreAdminV1beta1IndexFieldArgs) ElementType 

func (GoogleFirestoreAdminV1beta1IndexFieldArgs) ElementType() reflect.Type

func (GoogleFirestoreAdminV1beta1IndexFieldArgs) ToGoogleFirestoreAdminV1beta1IndexFieldOutput 

func (i GoogleFirestoreAdminV1beta1IndexFieldArgs) ToGoogleFirestoreAdminV1beta1IndexFieldOutput() GoogleFirestoreAdminV1beta1IndexFieldOutput

func (GoogleFirestoreAdminV1beta1IndexFieldArgs) ToGoogleFirestoreAdminV1beta1IndexFieldOutputWithContext 

func (i GoogleFirestoreAdminV1beta1IndexFieldArgs) ToGoogleFirestoreAdminV1beta1IndexFieldOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta1IndexFieldOutput

type GoogleFirestoreAdminV1beta1IndexFieldArray 

type GoogleFirestoreAdminV1beta1IndexFieldArray []GoogleFirestoreAdminV1beta1IndexFieldInput

func (GoogleFirestoreAdminV1beta1IndexFieldArray) ElementType 

func (GoogleFirestoreAdminV1beta1IndexFieldArray) ElementType() reflect.Type

func (GoogleFirestoreAdminV1beta1IndexFieldArray) ToGoogleFirestoreAdminV1beta1IndexFieldArrayOutput 

func (i GoogleFirestoreAdminV1beta1IndexFieldArray) ToGoogleFirestoreAdminV1beta1IndexFieldArrayOutput() GoogleFirestoreAdminV1beta1IndexFieldArrayOutput

func (GoogleFirestoreAdminV1beta1IndexFieldArray) ToGoogleFirestoreAdminV1beta1IndexFieldArrayOutputWithContext 

func (i GoogleFirestoreAdminV1beta1IndexFieldArray) ToGoogleFirestoreAdminV1beta1IndexFieldArrayOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta1IndexFieldArrayOutput

type GoogleFirestoreAdminV1beta1IndexFieldArrayInput 

type GoogleFirestoreAdminV1beta1IndexFieldArrayInput interface {
	pulumi.Input

	ToGoogleFirestoreAdminV1beta1IndexFieldArrayOutput() GoogleFirestoreAdminV1beta1IndexFieldArrayOutput
	ToGoogleFirestoreAdminV1beta1IndexFieldArrayOutputWithContext(context.Context) GoogleFirestoreAdminV1beta1IndexFieldArrayOutput
}

GoogleFirestoreAdminV1beta1IndexFieldArrayInput is an input type that accepts GoogleFirestoreAdminV1beta1IndexFieldArray and GoogleFirestoreAdminV1beta1IndexFieldArrayOutput values. You can construct a concrete instance of `GoogleFirestoreAdminV1beta1IndexFieldArrayInput` via: 

GoogleFirestoreAdminV1beta1IndexFieldArray{ GoogleFirestoreAdminV1beta1IndexFieldArgs{...} }

type GoogleFirestoreAdminV1beta1IndexFieldArrayOutput 

type GoogleFirestoreAdminV1beta1IndexFieldArrayOutput struct{ *pulumi.OutputState }

func (GoogleFirestoreAdminV1beta1IndexFieldArrayOutput) ElementType 

func (GoogleFirestoreAdminV1beta1IndexFieldArrayOutput) ElementType() reflect.Type

func (GoogleFirestoreAdminV1beta1IndexFieldArrayOutput) Index 

func (o GoogleFirestoreAdminV1beta1IndexFieldArrayOutput) Index(i pulumi.IntInput) GoogleFirestoreAdminV1beta1IndexFieldOutput

func (GoogleFirestoreAdminV1beta1IndexFieldArrayOutput) ToGoogleFirestoreAdminV1beta1IndexFieldArrayOutput 

func (o GoogleFirestoreAdminV1beta1IndexFieldArrayOutput) ToGoogleFirestoreAdminV1beta1IndexFieldArrayOutput() GoogleFirestoreAdminV1beta1IndexFieldArrayOutput

func (GoogleFirestoreAdminV1beta1IndexFieldArrayOutput) ToGoogleFirestoreAdminV1beta1IndexFieldArrayOutputWithContext 

func (o GoogleFirestoreAdminV1beta1IndexFieldArrayOutput) ToGoogleFirestoreAdminV1beta1IndexFieldArrayOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta1IndexFieldArrayOutput

type GoogleFirestoreAdminV1beta1IndexFieldInput 

type GoogleFirestoreAdminV1beta1IndexFieldInput interface {
	pulumi.Input

	ToGoogleFirestoreAdminV1beta1IndexFieldOutput() GoogleFirestoreAdminV1beta1IndexFieldOutput
	ToGoogleFirestoreAdminV1beta1IndexFieldOutputWithContext(context.Context) GoogleFirestoreAdminV1beta1IndexFieldOutput
}

GoogleFirestoreAdminV1beta1IndexFieldInput is an input type that accepts GoogleFirestoreAdminV1beta1IndexFieldArgs and GoogleFirestoreAdminV1beta1IndexFieldOutput values. You can construct a concrete instance of `GoogleFirestoreAdminV1beta1IndexFieldInput` via: 

GoogleFirestoreAdminV1beta1IndexFieldArgs{...}

type GoogleFirestoreAdminV1beta1IndexFieldMode added in v0.4.0 

type GoogleFirestoreAdminV1beta1IndexFieldMode string

The field's mode.

func (GoogleFirestoreAdminV1beta1IndexFieldMode) ElementType added in v0.4.0 

func (GoogleFirestoreAdminV1beta1IndexFieldMode) ElementType() reflect.Type

func (GoogleFirestoreAdminV1beta1IndexFieldMode) ToGoogleFirestoreAdminV1beta1IndexFieldModeOutput added in v0.6.0 

func (e GoogleFirestoreAdminV1beta1IndexFieldMode) ToGoogleFirestoreAdminV1beta1IndexFieldModeOutput() GoogleFirestoreAdminV1beta1IndexFieldModeOutput

func (GoogleFirestoreAdminV1beta1IndexFieldMode) ToGoogleFirestoreAdminV1beta1IndexFieldModeOutputWithContext added in v0.6.0 

func (e GoogleFirestoreAdminV1beta1IndexFieldMode) ToGoogleFirestoreAdminV1beta1IndexFieldModeOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta1IndexFieldModeOutput

func (GoogleFirestoreAdminV1beta1IndexFieldMode) ToGoogleFirestoreAdminV1beta1IndexFieldModePtrOutput added in v0.6.0 

func (e GoogleFirestoreAdminV1beta1IndexFieldMode) ToGoogleFirestoreAdminV1beta1IndexFieldModePtrOutput() GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput

func (GoogleFirestoreAdminV1beta1IndexFieldMode) ToGoogleFirestoreAdminV1beta1IndexFieldModePtrOutputWithContext added in v0.6.0 

func (e GoogleFirestoreAdminV1beta1IndexFieldMode) ToGoogleFirestoreAdminV1beta1IndexFieldModePtrOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput

func (GoogleFirestoreAdminV1beta1IndexFieldMode) ToStringOutput added in v0.4.0 

func (e GoogleFirestoreAdminV1beta1IndexFieldMode) ToStringOutput() pulumi.StringOutput

func (GoogleFirestoreAdminV1beta1IndexFieldMode) ToStringOutputWithContext added in v0.4.0 

func (e GoogleFirestoreAdminV1beta1IndexFieldMode) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (GoogleFirestoreAdminV1beta1IndexFieldMode) ToStringPtrOutput added in v0.4.0 

func (e GoogleFirestoreAdminV1beta1IndexFieldMode) ToStringPtrOutput() pulumi.StringPtrOutput

func (GoogleFirestoreAdminV1beta1IndexFieldMode) ToStringPtrOutputWithContext added in v0.4.0 

func (e GoogleFirestoreAdminV1beta1IndexFieldMode) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type GoogleFirestoreAdminV1beta1IndexFieldModeInput added in v0.6.0 

type GoogleFirestoreAdminV1beta1IndexFieldModeInput interface {
	pulumi.Input

	ToGoogleFirestoreAdminV1beta1IndexFieldModeOutput() GoogleFirestoreAdminV1beta1IndexFieldModeOutput
	ToGoogleFirestoreAdminV1beta1IndexFieldModeOutputWithContext(context.Context) GoogleFirestoreAdminV1beta1IndexFieldModeOutput
}

GoogleFirestoreAdminV1beta1IndexFieldModeInput is an input type that accepts GoogleFirestoreAdminV1beta1IndexFieldModeArgs and GoogleFirestoreAdminV1beta1IndexFieldModeOutput values. You can construct a concrete instance of `GoogleFirestoreAdminV1beta1IndexFieldModeInput` via: 

GoogleFirestoreAdminV1beta1IndexFieldModeArgs{...}

type GoogleFirestoreAdminV1beta1IndexFieldModeOutput added in v0.6.0 

type GoogleFirestoreAdminV1beta1IndexFieldModeOutput struct{ *pulumi.OutputState }

func (GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ElementType added in v0.6.0 

func (GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ElementType() reflect.Type

func (GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToGoogleFirestoreAdminV1beta1IndexFieldModeOutput added in v0.6.0 

func (o GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToGoogleFirestoreAdminV1beta1IndexFieldModeOutput() GoogleFirestoreAdminV1beta1IndexFieldModeOutput

func (GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToGoogleFirestoreAdminV1beta1IndexFieldModeOutputWithContext added in v0.6.0 

func (o GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToGoogleFirestoreAdminV1beta1IndexFieldModeOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta1IndexFieldModeOutput

func (GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToGoogleFirestoreAdminV1beta1IndexFieldModePtrOutput added in v0.6.0 

func (o GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToGoogleFirestoreAdminV1beta1IndexFieldModePtrOutput() GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput

func (GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToGoogleFirestoreAdminV1beta1IndexFieldModePtrOutputWithContext added in v0.6.0 

func (o GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToGoogleFirestoreAdminV1beta1IndexFieldModePtrOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput

func (GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToStringOutput added in v0.6.0 

func (o GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToStringOutput() pulumi.StringOutput

func (GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToStringOutputWithContext added in v0.6.0 

func (o GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToStringPtrOutput added in v0.6.0 

func (o GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToStringPtrOutputWithContext added in v0.6.0 

func (o GoogleFirestoreAdminV1beta1IndexFieldModeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type GoogleFirestoreAdminV1beta1IndexFieldModePtrInput added in v0.6.0 

type GoogleFirestoreAdminV1beta1IndexFieldModePtrInput interface {
	pulumi.Input

	ToGoogleFirestoreAdminV1beta1IndexFieldModePtrOutput() GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput
	ToGoogleFirestoreAdminV1beta1IndexFieldModePtrOutputWithContext(context.Context) GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput
}

func GoogleFirestoreAdminV1beta1IndexFieldModePtr added in v0.6.0 

func GoogleFirestoreAdminV1beta1IndexFieldModePtr(v string) GoogleFirestoreAdminV1beta1IndexFieldModePtrInput

type GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput added in v0.6.0 

type GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput struct{ *pulumi.OutputState }

func (GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput) Elem added in v0.6.0 

func (o GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput) Elem() GoogleFirestoreAdminV1beta1IndexFieldModeOutput

func (GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput) ElementType added in v0.6.0 

func (GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput) ElementType() reflect.Type

func (GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput) ToGoogleFirestoreAdminV1beta1IndexFieldModePtrOutput added in v0.6.0 

func (o GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput) ToGoogleFirestoreAdminV1beta1IndexFieldModePtrOutput() GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput

func (GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput) ToGoogleFirestoreAdminV1beta1IndexFieldModePtrOutputWithContext added in v0.6.0 

func (o GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput) ToGoogleFirestoreAdminV1beta1IndexFieldModePtrOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput

func (GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput) ToStringPtrOutput added in v0.6.0 

func (o GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput) ToStringPtrOutputWithContext added in v0.6.0 

func (o GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type GoogleFirestoreAdminV1beta1IndexFieldOutput 

type GoogleFirestoreAdminV1beta1IndexFieldOutput struct{ *pulumi.OutputState }

A field of an index.

func (GoogleFirestoreAdminV1beta1IndexFieldOutput) ElementType 

func (GoogleFirestoreAdminV1beta1IndexFieldOutput) ElementType() reflect.Type

func (GoogleFirestoreAdminV1beta1IndexFieldOutput) FieldPath 

func (o GoogleFirestoreAdminV1beta1IndexFieldOutput) FieldPath() pulumi.StringPtrOutput

The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path `__name__` may be used by itself or at the end of a path. `__type__` may be used only at the end of path.

func (GoogleFirestoreAdminV1beta1IndexFieldOutput) Mode 

func (o GoogleFirestoreAdminV1beta1IndexFieldOutput) Mode() GoogleFirestoreAdminV1beta1IndexFieldModePtrOutput

The field's mode.

func (GoogleFirestoreAdminV1beta1IndexFieldOutput) ToGoogleFirestoreAdminV1beta1IndexFieldOutput 

func (o GoogleFirestoreAdminV1beta1IndexFieldOutput) ToGoogleFirestoreAdminV1beta1IndexFieldOutput() GoogleFirestoreAdminV1beta1IndexFieldOutput

func (GoogleFirestoreAdminV1beta1IndexFieldOutput) ToGoogleFirestoreAdminV1beta1IndexFieldOutputWithContext 

func (o GoogleFirestoreAdminV1beta1IndexFieldOutput) ToGoogleFirestoreAdminV1beta1IndexFieldOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta1IndexFieldOutput

type GoogleFirestoreAdminV1beta1IndexFieldResponse 

type GoogleFirestoreAdminV1beta1IndexFieldResponse struct {
	// The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path `__name__` may be used by itself or at the end of a path. `__type__` may be used only at the end of path.
	FieldPath string `pulumi:"fieldPath"`
	// The field's mode.
	Mode string `pulumi:"mode"`
}

A field of an index.

type GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput 

type GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput struct{ *pulumi.OutputState }

func (GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput) ElementType 

func (GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput) ElementType() reflect.Type

func (GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput) Index 

func (o GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput) Index(i pulumi.IntInput) GoogleFirestoreAdminV1beta1IndexFieldResponseOutput

func (GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput) ToGoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput 

func (o GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput) ToGoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput() GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput

func (GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput) ToGoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutputWithContext 

func (o GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput) ToGoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput

type GoogleFirestoreAdminV1beta1IndexFieldResponseOutput 

type GoogleFirestoreAdminV1beta1IndexFieldResponseOutput struct{ *pulumi.OutputState }

A field of an index.

func (GoogleFirestoreAdminV1beta1IndexFieldResponseOutput) ElementType 

func (GoogleFirestoreAdminV1beta1IndexFieldResponseOutput) ElementType() reflect.Type

func (GoogleFirestoreAdminV1beta1IndexFieldResponseOutput) FieldPath 

func (o GoogleFirestoreAdminV1beta1IndexFieldResponseOutput) FieldPath() pulumi.StringOutput

The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path `__name__` may be used by itself or at the end of a path. `__type__` may be used only at the end of path.

func (GoogleFirestoreAdminV1beta1IndexFieldResponseOutput) Mode 

func (o GoogleFirestoreAdminV1beta1IndexFieldResponseOutput) Mode() pulumi.StringOutput

The field's mode.

func (GoogleFirestoreAdminV1beta1IndexFieldResponseOutput) ToGoogleFirestoreAdminV1beta1IndexFieldResponseOutput 

func (o GoogleFirestoreAdminV1beta1IndexFieldResponseOutput) ToGoogleFirestoreAdminV1beta1IndexFieldResponseOutput() GoogleFirestoreAdminV1beta1IndexFieldResponseOutput

func (GoogleFirestoreAdminV1beta1IndexFieldResponseOutput) ToGoogleFirestoreAdminV1beta1IndexFieldResponseOutputWithContext 

func (o GoogleFirestoreAdminV1beta1IndexFieldResponseOutput) ToGoogleFirestoreAdminV1beta1IndexFieldResponseOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta1IndexFieldResponseOutput

type Index added in v0.3.0 

type Index struct {
	pulumi.CustomResourceState

	// The collection ID to which this index applies. Required.
	CollectionId pulumi.StringOutput `pulumi:"collectionId"`
	DatabaseId   pulumi.StringOutput `pulumi:"databaseId"`
	// The fields to index.
	Fields GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput `pulumi:"fields"`
	// The resource name of the index. Output only.
	Name    pulumi.StringOutput `pulumi:"name"`
	Project pulumi.StringOutput `pulumi:"project"`
	// The state of the index. Output only.
	State pulumi.StringOutput `pulumi:"state"`
}

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 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 field cannot be created.

func GetIndex added in v0.3.0 

func GetIndex(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *IndexState, opts ...pulumi.ResourceOption) (*Index, error)

GetIndex gets an existing Index resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewIndex added in v0.3.0 

func NewIndex(ctx *pulumi.Context,
	name string, args *IndexArgs, opts ...pulumi.ResourceOption) (*Index, error)

NewIndex registers a new resource with the given unique name, arguments, and options.

func (*Index) ElementType added in v0.3.0 

func (*Index) ElementType() reflect.Type

func (*Index) ToIndexOutput added in v0.3.0 

func (i *Index) ToIndexOutput() IndexOutput

func (*Index) ToIndexOutputWithContext added in v0.3.0 

func (i *Index) ToIndexOutputWithContext(ctx context.Context) IndexOutput

type IndexArgs added in v0.3.0 

type IndexArgs struct {
	// The collection ID to which this index applies. Required.
	CollectionId pulumi.StringPtrInput
	DatabaseId   pulumi.StringInput
	// The fields to index.
	Fields GoogleFirestoreAdminV1beta1IndexFieldArrayInput
	// The resource name of the index. Output only.
	Name    pulumi.StringPtrInput
	Project pulumi.StringPtrInput
	// The state of the index. Output only.
	State IndexStateEnumPtrInput
}

The set of arguments for constructing a Index resource.

func (IndexArgs) ElementType added in v0.3.0 

func (IndexArgs) ElementType() reflect.Type

type IndexInput added in v0.3.0 

type IndexInput interface {
	pulumi.Input

	ToIndexOutput() IndexOutput
	ToIndexOutputWithContext(ctx context.Context) IndexOutput
}

type IndexOutput added in v0.3.0 

type IndexOutput struct{ *pulumi.OutputState }

func (IndexOutput) CollectionId added in v0.19.0 

func (o IndexOutput) CollectionId() pulumi.StringOutput

The collection ID to which this index applies. Required.

func (IndexOutput) DatabaseId added in v0.21.0 

func (o IndexOutput) DatabaseId() pulumi.StringOutput

func (IndexOutput) ElementType added in v0.3.0 

func (IndexOutput) ElementType() reflect.Type

func (IndexOutput) Fields added in v0.19.0 

func (o IndexOutput) Fields() GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput

The fields to index.

func (IndexOutput) Name added in v0.19.0 

func (o IndexOutput) Name() pulumi.StringOutput

The resource name of the index. Output only.

func (IndexOutput) Project added in v0.21.0 

func (o IndexOutput) Project() pulumi.StringOutput

func (IndexOutput) State added in v0.19.0 

func (o IndexOutput) State() pulumi.StringOutput

The state of the index. Output only.

func (IndexOutput) ToIndexOutput added in v0.3.0 

func (o IndexOutput) ToIndexOutput() IndexOutput

func (IndexOutput) ToIndexOutputWithContext added in v0.3.0 

func (o IndexOutput) ToIndexOutputWithContext(ctx context.Context) IndexOutput

type IndexState added in v0.3.0 

type IndexState struct {
}

func (IndexState) ElementType added in v0.3.0 

func (IndexState) ElementType() reflect.Type

type IndexStateEnum added in v0.4.0 

type IndexStateEnum string

The state of the index. Output only.

func (IndexStateEnum) ElementType added in v0.4.0 

func (IndexStateEnum) ElementType() reflect.Type

func (IndexStateEnum) ToIndexStateEnumOutput added in v0.6.0 

func (e IndexStateEnum) ToIndexStateEnumOutput() IndexStateEnumOutput

func (IndexStateEnum) ToIndexStateEnumOutputWithContext added in v0.6.0 

func (e IndexStateEnum) ToIndexStateEnumOutputWithContext(ctx context.Context) IndexStateEnumOutput

func (IndexStateEnum) ToIndexStateEnumPtrOutput added in v0.6.0 

func (e IndexStateEnum) ToIndexStateEnumPtrOutput() IndexStateEnumPtrOutput

func (IndexStateEnum) ToIndexStateEnumPtrOutputWithContext added in v0.6.0 

func (e IndexStateEnum) ToIndexStateEnumPtrOutputWithContext(ctx context.Context) IndexStateEnumPtrOutput

func (IndexStateEnum) ToStringOutput added in v0.4.0 

func (e IndexStateEnum) ToStringOutput() pulumi.StringOutput

func (IndexStateEnum) ToStringOutputWithContext added in v0.4.0 

func (e IndexStateEnum) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (IndexStateEnum) ToStringPtrOutput added in v0.4.0 

func (e IndexStateEnum) ToStringPtrOutput() pulumi.StringPtrOutput

func (IndexStateEnum) ToStringPtrOutputWithContext added in v0.4.0 

func (e IndexStateEnum) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type IndexStateEnumInput added in v0.6.0 

type IndexStateEnumInput interface {
	pulumi.Input

	ToIndexStateEnumOutput() IndexStateEnumOutput
	ToIndexStateEnumOutputWithContext(context.Context) IndexStateEnumOutput
}

IndexStateEnumInput is an input type that accepts IndexStateEnumArgs and IndexStateEnumOutput values. You can construct a concrete instance of `IndexStateEnumInput` via: 

IndexStateEnumArgs{...}

type IndexStateEnumOutput added in v0.6.0 

type IndexStateEnumOutput struct{ *pulumi.OutputState }

func (IndexStateEnumOutput) ElementType added in v0.6.0 

func (IndexStateEnumOutput) ElementType() reflect.Type

func (IndexStateEnumOutput) ToIndexStateEnumOutput added in v0.6.0 

func (o IndexStateEnumOutput) ToIndexStateEnumOutput() IndexStateEnumOutput

func (IndexStateEnumOutput) ToIndexStateEnumOutputWithContext added in v0.6.0 

func (o IndexStateEnumOutput) ToIndexStateEnumOutputWithContext(ctx context.Context) IndexStateEnumOutput

func (IndexStateEnumOutput) ToIndexStateEnumPtrOutput added in v0.6.0 

func (o IndexStateEnumOutput) ToIndexStateEnumPtrOutput() IndexStateEnumPtrOutput

func (IndexStateEnumOutput) ToIndexStateEnumPtrOutputWithContext added in v0.6.0 

func (o IndexStateEnumOutput) ToIndexStateEnumPtrOutputWithContext(ctx context.Context) IndexStateEnumPtrOutput

func (IndexStateEnumOutput) ToStringOutput added in v0.6.0 

func (o IndexStateEnumOutput) ToStringOutput() pulumi.StringOutput

func (IndexStateEnumOutput) ToStringOutputWithContext added in v0.6.0 

func (o IndexStateEnumOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (IndexStateEnumOutput) ToStringPtrOutput added in v0.6.0 

func (o IndexStateEnumOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (IndexStateEnumOutput) ToStringPtrOutputWithContext added in v0.6.0 

func (o IndexStateEnumOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type IndexStateEnumPtrInput added in v0.6.0 

type IndexStateEnumPtrInput interface {
	pulumi.Input

	ToIndexStateEnumPtrOutput() IndexStateEnumPtrOutput
	ToIndexStateEnumPtrOutputWithContext(context.Context) IndexStateEnumPtrOutput
}

func IndexStateEnumPtr added in v0.6.0 

func IndexStateEnumPtr(v string) IndexStateEnumPtrInput

type IndexStateEnumPtrOutput added in v0.6.0 

type IndexStateEnumPtrOutput struct{ *pulumi.OutputState }

func (IndexStateEnumPtrOutput) Elem added in v0.6.0 

func (o IndexStateEnumPtrOutput) Elem() IndexStateEnumOutput

func (IndexStateEnumPtrOutput) ElementType added in v0.6.0 

func (IndexStateEnumPtrOutput) ElementType() reflect.Type

func (IndexStateEnumPtrOutput) ToIndexStateEnumPtrOutput added in v0.6.0 

func (o IndexStateEnumPtrOutput) ToIndexStateEnumPtrOutput() IndexStateEnumPtrOutput

func (IndexStateEnumPtrOutput) ToIndexStateEnumPtrOutputWithContext added in v0.6.0 

func (o IndexStateEnumPtrOutput) ToIndexStateEnumPtrOutputWithContext(ctx context.Context) IndexStateEnumPtrOutput

func (IndexStateEnumPtrOutput) ToStringPtrOutput added in v0.6.0 

func (o IndexStateEnumPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (IndexStateEnumPtrOutput) ToStringPtrOutputWithContext added in v0.6.0 

func (o IndexStateEnumPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type LookupIndexArgs added in v0.4.0 

type LookupIndexArgs struct {
	DatabaseId string  `pulumi:"databaseId"`
	IndexId    string  `pulumi:"indexId"`
	Project    *string `pulumi:"project"`
}

type LookupIndexOutputArgs added in v0.8.0 

type LookupIndexOutputArgs struct {
	DatabaseId pulumi.StringInput    `pulumi:"databaseId"`
	IndexId    pulumi.StringInput    `pulumi:"indexId"`
	Project    pulumi.StringPtrInput `pulumi:"project"`
}

func (LookupIndexOutputArgs) ElementType added in v0.8.0 

func (LookupIndexOutputArgs) ElementType() reflect.Type

type LookupIndexResult added in v0.4.0 

type LookupIndexResult struct {
	// The collection ID to which this index applies. Required.
	CollectionId string `pulumi:"collectionId"`
	// The fields to index.
	Fields []GoogleFirestoreAdminV1beta1IndexFieldResponse `pulumi:"fields"`
	// The resource name of the index. Output only.
	Name string `pulumi:"name"`
	// The state of the index. Output only.
	State string `pulumi:"state"`
}

func LookupIndex added in v0.4.0 

func LookupIndex(ctx *pulumi.Context, args *LookupIndexArgs, opts ...pulumi.InvokeOption) (*LookupIndexResult, error)

Gets an index.

type LookupIndexResultOutput added in v0.8.0 

type LookupIndexResultOutput struct{ *pulumi.OutputState }

func LookupIndexOutput added in v0.8.0 

func LookupIndexOutput(ctx *pulumi.Context, args LookupIndexOutputArgs, opts ...pulumi.InvokeOption) LookupIndexResultOutput

func (LookupIndexResultOutput) CollectionId added in v0.8.0 

func (o LookupIndexResultOutput) CollectionId() pulumi.StringOutput

The collection ID to which this index applies. Required.

func (LookupIndexResultOutput) ElementType added in v0.8.0 

func (LookupIndexResultOutput) ElementType() reflect.Type

func (LookupIndexResultOutput) Fields added in v0.8.0 

func (o LookupIndexResultOutput) Fields() GoogleFirestoreAdminV1beta1IndexFieldResponseArrayOutput

The fields to index.

func (LookupIndexResultOutput) Name added in v0.8.0 

func (o LookupIndexResultOutput) Name() pulumi.StringOutput

The resource name of the index. Output only.

func (LookupIndexResultOutput) State added in v0.8.0 

func (o LookupIndexResultOutput) State() pulumi.StringOutput

The state of the index. Output only.

func (LookupIndexResultOutput) ToLookupIndexResultOutput added in v0.8.0 

func (o LookupIndexResultOutput) ToLookupIndexResultOutput() LookupIndexResultOutput

func (LookupIndexResultOutput) ToLookupIndexResultOutputWithContext added in v0.8.0 

func (o LookupIndexResultOutput) ToLookupIndexResultOutputWithContext(ctx context.Context) LookupIndexResultOutput

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.