v1beta2

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 index does not support additional array queries.
	GoogleFirestoreAdminV1beta2IndexFieldArrayConfigArrayConfigUnspecified = GoogleFirestoreAdminV1beta2IndexFieldArrayConfig("ARRAY_CONFIG_UNSPECIFIED")
	// The index supports array containment queries.
	GoogleFirestoreAdminV1beta2IndexFieldArrayConfigContains = GoogleFirestoreAdminV1beta2IndexFieldArrayConfig("CONTAINS")
)
View Source
const (
	// The ordering is unspecified. Not a valid option.
	GoogleFirestoreAdminV1beta2IndexFieldOrderOrderUnspecified = GoogleFirestoreAdminV1beta2IndexFieldOrder("ORDER_UNSPECIFIED")
	// The field is ordered by ascending field value.
	GoogleFirestoreAdminV1beta2IndexFieldOrderAscending = GoogleFirestoreAdminV1beta2IndexFieldOrder("ASCENDING")
	// The field is ordered by descending field value.
	GoogleFirestoreAdminV1beta2IndexFieldOrderDescending = GoogleFirestoreAdminV1beta2IndexFieldOrder("DESCENDING")
)
View Source
const (
	// The query scope is unspecified. Not a valid option.
	IndexQueryScopeQueryScopeUnspecified = IndexQueryScope("QUERY_SCOPE_UNSPECIFIED")
	// 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 collection id specified by the index.
	IndexQueryScopeCollection = IndexQueryScope("COLLECTION")
	// Indexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index.
	IndexQueryScopeCollectionGroup = IndexQueryScope("COLLECTION_GROUP")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type GoogleFirestoreAdminV1beta2IndexField

type GoogleFirestoreAdminV1beta2IndexField struct {
	// Indicates that this field supports operations on `array_value`s.
	ArrayConfig *GoogleFirestoreAdminV1beta2IndexFieldArrayConfig `pulumi:"arrayConfig"`
	// Can be __name__. For single field indexes, this must match the name of the field or may be omitted.
	FieldPath *string `pulumi:"fieldPath"`
	// Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
	Order *GoogleFirestoreAdminV1beta2IndexFieldOrder `pulumi:"order"`
}

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

type GoogleFirestoreAdminV1beta2IndexFieldArgs

type GoogleFirestoreAdminV1beta2IndexFieldArgs struct {
	// Indicates that this field supports operations on `array_value`s.
	ArrayConfig GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrInput `pulumi:"arrayConfig"`
	// Can be __name__. For single field indexes, this must match the name of the field or may be omitted.
	FieldPath pulumi.StringPtrInput `pulumi:"fieldPath"`
	// Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
	Order GoogleFirestoreAdminV1beta2IndexFieldOrderPtrInput `pulumi:"order"`
}

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

func (GoogleFirestoreAdminV1beta2IndexFieldArgs) ElementType

func (GoogleFirestoreAdminV1beta2IndexFieldArgs) ToGoogleFirestoreAdminV1beta2IndexFieldOutput

func (i GoogleFirestoreAdminV1beta2IndexFieldArgs) ToGoogleFirestoreAdminV1beta2IndexFieldOutput() GoogleFirestoreAdminV1beta2IndexFieldOutput

func (GoogleFirestoreAdminV1beta2IndexFieldArgs) ToGoogleFirestoreAdminV1beta2IndexFieldOutputWithContext

func (i GoogleFirestoreAdminV1beta2IndexFieldArgs) ToGoogleFirestoreAdminV1beta2IndexFieldOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldOutput

type GoogleFirestoreAdminV1beta2IndexFieldArray

type GoogleFirestoreAdminV1beta2IndexFieldArray []GoogleFirestoreAdminV1beta2IndexFieldInput

func (GoogleFirestoreAdminV1beta2IndexFieldArray) ElementType

func (GoogleFirestoreAdminV1beta2IndexFieldArray) ToGoogleFirestoreAdminV1beta2IndexFieldArrayOutput

func (i GoogleFirestoreAdminV1beta2IndexFieldArray) ToGoogleFirestoreAdminV1beta2IndexFieldArrayOutput() GoogleFirestoreAdminV1beta2IndexFieldArrayOutput

func (GoogleFirestoreAdminV1beta2IndexFieldArray) ToGoogleFirestoreAdminV1beta2IndexFieldArrayOutputWithContext

func (i GoogleFirestoreAdminV1beta2IndexFieldArray) ToGoogleFirestoreAdminV1beta2IndexFieldArrayOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldArrayOutput

type GoogleFirestoreAdminV1beta2IndexFieldArrayConfig added in v0.4.0

type GoogleFirestoreAdminV1beta2IndexFieldArrayConfig string

Indicates that this field supports operations on `array_value`s.

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfig) ElementType added in v0.4.0

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfig) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput added in v0.6.0

func (e GoogleFirestoreAdminV1beta2IndexFieldArrayConfig) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput() GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfig) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutputWithContext added in v0.6.0

func (e GoogleFirestoreAdminV1beta2IndexFieldArrayConfig) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfig) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput added in v0.6.0

func (e GoogleFirestoreAdminV1beta2IndexFieldArrayConfig) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput() GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfig) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutputWithContext added in v0.6.0

func (e GoogleFirestoreAdminV1beta2IndexFieldArrayConfig) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfig) ToStringOutput added in v0.4.0

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfig) ToStringOutputWithContext added in v0.4.0

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfig) ToStringPtrOutput added in v0.4.0

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfig) ToStringPtrOutputWithContext added in v0.4.0

type GoogleFirestoreAdminV1beta2IndexFieldArrayConfigInput added in v0.6.0

type GoogleFirestoreAdminV1beta2IndexFieldArrayConfigInput interface {
	pulumi.Input

	ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput() GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput
	ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutputWithContext(context.Context) GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput
}

GoogleFirestoreAdminV1beta2IndexFieldArrayConfigInput is an input type that accepts GoogleFirestoreAdminV1beta2IndexFieldArrayConfigArgs and GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput values. You can construct a concrete instance of `GoogleFirestoreAdminV1beta2IndexFieldArrayConfigInput` via:

GoogleFirestoreAdminV1beta2IndexFieldArrayConfigArgs{...}

type GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput added in v0.6.0

type GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput struct{ *pulumi.OutputState }

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput) ElementType added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutputWithContext added in v0.6.0

func (o GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput added in v0.6.0

func (o GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput() GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutputWithContext added in v0.6.0

func (o GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput) ToStringOutput added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput) ToStringOutputWithContext added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput) ToStringPtrOutput added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigOutput) ToStringPtrOutputWithContext added in v0.6.0

type GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrInput added in v0.6.0

type GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrInput interface {
	pulumi.Input

	ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput() GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput
	ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutputWithContext(context.Context) GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput
}

func GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtr added in v0.6.0

func GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtr(v string) GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrInput

type GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput added in v0.6.0

type GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput struct{ *pulumi.OutputState }

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput) Elem added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput) ElementType added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutputWithContext added in v0.6.0

func (o GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput) ToGoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput) ToStringPtrOutput added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldArrayConfigPtrOutput) ToStringPtrOutputWithContext added in v0.6.0

type GoogleFirestoreAdminV1beta2IndexFieldArrayInput

type GoogleFirestoreAdminV1beta2IndexFieldArrayInput interface {
	pulumi.Input

	ToGoogleFirestoreAdminV1beta2IndexFieldArrayOutput() GoogleFirestoreAdminV1beta2IndexFieldArrayOutput
	ToGoogleFirestoreAdminV1beta2IndexFieldArrayOutputWithContext(context.Context) GoogleFirestoreAdminV1beta2IndexFieldArrayOutput
}

GoogleFirestoreAdminV1beta2IndexFieldArrayInput is an input type that accepts GoogleFirestoreAdminV1beta2IndexFieldArray and GoogleFirestoreAdminV1beta2IndexFieldArrayOutput values. You can construct a concrete instance of `GoogleFirestoreAdminV1beta2IndexFieldArrayInput` via:

GoogleFirestoreAdminV1beta2IndexFieldArray{ GoogleFirestoreAdminV1beta2IndexFieldArgs{...} }

type GoogleFirestoreAdminV1beta2IndexFieldArrayOutput

type GoogleFirestoreAdminV1beta2IndexFieldArrayOutput struct{ *pulumi.OutputState }

func (GoogleFirestoreAdminV1beta2IndexFieldArrayOutput) ElementType

func (GoogleFirestoreAdminV1beta2IndexFieldArrayOutput) Index

func (GoogleFirestoreAdminV1beta2IndexFieldArrayOutput) ToGoogleFirestoreAdminV1beta2IndexFieldArrayOutput

func (o GoogleFirestoreAdminV1beta2IndexFieldArrayOutput) ToGoogleFirestoreAdminV1beta2IndexFieldArrayOutput() GoogleFirestoreAdminV1beta2IndexFieldArrayOutput

func (GoogleFirestoreAdminV1beta2IndexFieldArrayOutput) ToGoogleFirestoreAdminV1beta2IndexFieldArrayOutputWithContext

func (o GoogleFirestoreAdminV1beta2IndexFieldArrayOutput) ToGoogleFirestoreAdminV1beta2IndexFieldArrayOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldArrayOutput

type GoogleFirestoreAdminV1beta2IndexFieldInput

type GoogleFirestoreAdminV1beta2IndexFieldInput interface {
	pulumi.Input

	ToGoogleFirestoreAdminV1beta2IndexFieldOutput() GoogleFirestoreAdminV1beta2IndexFieldOutput
	ToGoogleFirestoreAdminV1beta2IndexFieldOutputWithContext(context.Context) GoogleFirestoreAdminV1beta2IndexFieldOutput
}

GoogleFirestoreAdminV1beta2IndexFieldInput is an input type that accepts GoogleFirestoreAdminV1beta2IndexFieldArgs and GoogleFirestoreAdminV1beta2IndexFieldOutput values. You can construct a concrete instance of `GoogleFirestoreAdminV1beta2IndexFieldInput` via:

GoogleFirestoreAdminV1beta2IndexFieldArgs{...}

type GoogleFirestoreAdminV1beta2IndexFieldOrder added in v0.4.0

type GoogleFirestoreAdminV1beta2IndexFieldOrder string

Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.

func (GoogleFirestoreAdminV1beta2IndexFieldOrder) ElementType added in v0.4.0

func (GoogleFirestoreAdminV1beta2IndexFieldOrder) ToGoogleFirestoreAdminV1beta2IndexFieldOrderOutput added in v0.6.0

func (e GoogleFirestoreAdminV1beta2IndexFieldOrder) ToGoogleFirestoreAdminV1beta2IndexFieldOrderOutput() GoogleFirestoreAdminV1beta2IndexFieldOrderOutput

func (GoogleFirestoreAdminV1beta2IndexFieldOrder) ToGoogleFirestoreAdminV1beta2IndexFieldOrderOutputWithContext added in v0.6.0

func (e GoogleFirestoreAdminV1beta2IndexFieldOrder) ToGoogleFirestoreAdminV1beta2IndexFieldOrderOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldOrderOutput

func (GoogleFirestoreAdminV1beta2IndexFieldOrder) ToGoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput added in v0.6.0

func (e GoogleFirestoreAdminV1beta2IndexFieldOrder) ToGoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput() GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput

func (GoogleFirestoreAdminV1beta2IndexFieldOrder) ToGoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutputWithContext added in v0.6.0

func (e GoogleFirestoreAdminV1beta2IndexFieldOrder) ToGoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput

func (GoogleFirestoreAdminV1beta2IndexFieldOrder) ToStringOutput added in v0.4.0

func (GoogleFirestoreAdminV1beta2IndexFieldOrder) ToStringOutputWithContext added in v0.4.0

func (GoogleFirestoreAdminV1beta2IndexFieldOrder) ToStringPtrOutput added in v0.4.0

func (GoogleFirestoreAdminV1beta2IndexFieldOrder) ToStringPtrOutputWithContext added in v0.4.0

type GoogleFirestoreAdminV1beta2IndexFieldOrderInput added in v0.6.0

type GoogleFirestoreAdminV1beta2IndexFieldOrderInput interface {
	pulumi.Input

	ToGoogleFirestoreAdminV1beta2IndexFieldOrderOutput() GoogleFirestoreAdminV1beta2IndexFieldOrderOutput
	ToGoogleFirestoreAdminV1beta2IndexFieldOrderOutputWithContext(context.Context) GoogleFirestoreAdminV1beta2IndexFieldOrderOutput
}

GoogleFirestoreAdminV1beta2IndexFieldOrderInput is an input type that accepts GoogleFirestoreAdminV1beta2IndexFieldOrderArgs and GoogleFirestoreAdminV1beta2IndexFieldOrderOutput values. You can construct a concrete instance of `GoogleFirestoreAdminV1beta2IndexFieldOrderInput` via:

GoogleFirestoreAdminV1beta2IndexFieldOrderArgs{...}

type GoogleFirestoreAdminV1beta2IndexFieldOrderOutput added in v0.6.0

type GoogleFirestoreAdminV1beta2IndexFieldOrderOutput struct{ *pulumi.OutputState }

func (GoogleFirestoreAdminV1beta2IndexFieldOrderOutput) ElementType added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldOrderOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOrderOutput added in v0.6.0

func (o GoogleFirestoreAdminV1beta2IndexFieldOrderOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOrderOutput() GoogleFirestoreAdminV1beta2IndexFieldOrderOutput

func (GoogleFirestoreAdminV1beta2IndexFieldOrderOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOrderOutputWithContext added in v0.6.0

func (o GoogleFirestoreAdminV1beta2IndexFieldOrderOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOrderOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldOrderOutput

func (GoogleFirestoreAdminV1beta2IndexFieldOrderOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput added in v0.6.0

func (o GoogleFirestoreAdminV1beta2IndexFieldOrderOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput() GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput

func (GoogleFirestoreAdminV1beta2IndexFieldOrderOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutputWithContext added in v0.6.0

func (o GoogleFirestoreAdminV1beta2IndexFieldOrderOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput

func (GoogleFirestoreAdminV1beta2IndexFieldOrderOutput) ToStringOutput added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldOrderOutput) ToStringOutputWithContext added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldOrderOutput) ToStringPtrOutput added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldOrderOutput) ToStringPtrOutputWithContext added in v0.6.0

type GoogleFirestoreAdminV1beta2IndexFieldOrderPtrInput added in v0.6.0

type GoogleFirestoreAdminV1beta2IndexFieldOrderPtrInput interface {
	pulumi.Input

	ToGoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput() GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput
	ToGoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutputWithContext(context.Context) GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput
}

func GoogleFirestoreAdminV1beta2IndexFieldOrderPtr added in v0.6.0

func GoogleFirestoreAdminV1beta2IndexFieldOrderPtr(v string) GoogleFirestoreAdminV1beta2IndexFieldOrderPtrInput

type GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput added in v0.6.0

type GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput struct{ *pulumi.OutputState }

func (GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput) Elem added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput) ElementType added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput added in v0.6.0

func (o GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput() GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput

func (GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutputWithContext added in v0.6.0

func (o GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput

func (GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput) ToStringPtrOutput added in v0.6.0

func (GoogleFirestoreAdminV1beta2IndexFieldOrderPtrOutput) ToStringPtrOutputWithContext added in v0.6.0

type GoogleFirestoreAdminV1beta2IndexFieldOutput

type GoogleFirestoreAdminV1beta2IndexFieldOutput struct{ *pulumi.OutputState }

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

func (GoogleFirestoreAdminV1beta2IndexFieldOutput) ArrayConfig

Indicates that this field supports operations on `array_value`s.

func (GoogleFirestoreAdminV1beta2IndexFieldOutput) ElementType

func (GoogleFirestoreAdminV1beta2IndexFieldOutput) FieldPath

Can be __name__. For single field indexes, this must match the name of the field or may be omitted.

func (GoogleFirestoreAdminV1beta2IndexFieldOutput) Order

Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.

func (GoogleFirestoreAdminV1beta2IndexFieldOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOutput

func (o GoogleFirestoreAdminV1beta2IndexFieldOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOutput() GoogleFirestoreAdminV1beta2IndexFieldOutput

func (GoogleFirestoreAdminV1beta2IndexFieldOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOutputWithContext

func (o GoogleFirestoreAdminV1beta2IndexFieldOutput) ToGoogleFirestoreAdminV1beta2IndexFieldOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldOutput

type GoogleFirestoreAdminV1beta2IndexFieldResponse

type GoogleFirestoreAdminV1beta2IndexFieldResponse struct {
	// Indicates that this field supports operations on `array_value`s.
	ArrayConfig string `pulumi:"arrayConfig"`
	// Can be __name__. For single field indexes, this must match the name of the field or may be omitted.
	FieldPath string `pulumi:"fieldPath"`
	// Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
	Order string `pulumi:"order"`
}

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

type GoogleFirestoreAdminV1beta2IndexFieldResponseArrayOutput

type GoogleFirestoreAdminV1beta2IndexFieldResponseArrayOutput struct{ *pulumi.OutputState }

func (GoogleFirestoreAdminV1beta2IndexFieldResponseArrayOutput) ElementType

func (GoogleFirestoreAdminV1beta2IndexFieldResponseArrayOutput) Index

func (GoogleFirestoreAdminV1beta2IndexFieldResponseArrayOutput) ToGoogleFirestoreAdminV1beta2IndexFieldResponseArrayOutput

func (GoogleFirestoreAdminV1beta2IndexFieldResponseArrayOutput) ToGoogleFirestoreAdminV1beta2IndexFieldResponseArrayOutputWithContext

func (o GoogleFirestoreAdminV1beta2IndexFieldResponseArrayOutput) ToGoogleFirestoreAdminV1beta2IndexFieldResponseArrayOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldResponseArrayOutput

type GoogleFirestoreAdminV1beta2IndexFieldResponseOutput

type GoogleFirestoreAdminV1beta2IndexFieldResponseOutput struct{ *pulumi.OutputState }

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

func (GoogleFirestoreAdminV1beta2IndexFieldResponseOutput) ArrayConfig

Indicates that this field supports operations on `array_value`s.

func (GoogleFirestoreAdminV1beta2IndexFieldResponseOutput) ElementType

func (GoogleFirestoreAdminV1beta2IndexFieldResponseOutput) FieldPath

Can be __name__. For single field indexes, this must match the name of the field or may be omitted.

func (GoogleFirestoreAdminV1beta2IndexFieldResponseOutput) Order

Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.

func (GoogleFirestoreAdminV1beta2IndexFieldResponseOutput) ToGoogleFirestoreAdminV1beta2IndexFieldResponseOutput

func (o GoogleFirestoreAdminV1beta2IndexFieldResponseOutput) ToGoogleFirestoreAdminV1beta2IndexFieldResponseOutput() GoogleFirestoreAdminV1beta2IndexFieldResponseOutput

func (GoogleFirestoreAdminV1beta2IndexFieldResponseOutput) ToGoogleFirestoreAdminV1beta2IndexFieldResponseOutputWithContext

func (o GoogleFirestoreAdminV1beta2IndexFieldResponseOutput) ToGoogleFirestoreAdminV1beta2IndexFieldResponseOutputWithContext(ctx context.Context) GoogleFirestoreAdminV1beta2IndexFieldResponseOutput

type Index added in v0.3.0

type Index struct {
	pulumi.CustomResourceState

	CollectionGroupId pulumi.StringOutput `pulumi:"collectionGroupId"`
	DatabaseId        pulumi.StringOutput `pulumi:"databaseId"`
	// The fields supported by this index. For composite indexes, this is always 2 or more 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.
	Fields GoogleFirestoreAdminV1beta2IndexFieldResponseArrayOutput `pulumi:"fields"`
	// 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.
	Name    pulumi.StringOutput `pulumi:"name"`
	Project pulumi.StringOutput `pulumi:"project"`
	// 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.
	QueryScope pulumi.StringOutput `pulumi:"queryScope"`
	// The serving state of the index.
	State pulumi.StringOutput `pulumi:"state"`
}

Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata. Auto-naming is currently not supported for this resource.

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 {
	CollectionGroupId pulumi.StringInput
	DatabaseId        pulumi.StringInput
	// The fields supported by this index. For composite indexes, this is always 2 or more 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.
	Fields  GoogleFirestoreAdminV1beta2IndexFieldArrayInput
	Project pulumi.StringPtrInput
	// 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.
	QueryScope IndexQueryScopePtrInput
}

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) CollectionGroupId added in v0.21.0

func (o IndexOutput) CollectionGroupId() pulumi.StringOutput

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

The fields supported by this index. For composite indexes, this is always 2 or more 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.

func (IndexOutput) Name added in v0.19.0

func (o IndexOutput) Name() pulumi.StringOutput

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.

func (IndexOutput) Project added in v0.21.0

func (o IndexOutput) Project() pulumi.StringOutput

func (IndexOutput) QueryScope added in v0.19.0

func (o IndexOutput) QueryScope() pulumi.StringOutput

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.

func (IndexOutput) State added in v0.19.0

func (o IndexOutput) State() pulumi.StringOutput

The serving state of the index.

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 IndexQueryScope added in v0.4.0

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

func (IndexQueryScope) ElementType added in v0.4.0

func (IndexQueryScope) ElementType() reflect.Type

func (IndexQueryScope) ToIndexQueryScopeOutput added in v0.6.0

func (e IndexQueryScope) ToIndexQueryScopeOutput() IndexQueryScopeOutput

func (IndexQueryScope) ToIndexQueryScopeOutputWithContext added in v0.6.0

func (e IndexQueryScope) ToIndexQueryScopeOutputWithContext(ctx context.Context) IndexQueryScopeOutput

func (IndexQueryScope) ToIndexQueryScopePtrOutput added in v0.6.0

func (e IndexQueryScope) ToIndexQueryScopePtrOutput() IndexQueryScopePtrOutput

func (IndexQueryScope) ToIndexQueryScopePtrOutputWithContext added in v0.6.0

func (e IndexQueryScope) ToIndexQueryScopePtrOutputWithContext(ctx context.Context) IndexQueryScopePtrOutput

func (IndexQueryScope) ToStringOutput added in v0.4.0

func (e IndexQueryScope) ToStringOutput() pulumi.StringOutput

func (IndexQueryScope) ToStringOutputWithContext added in v0.4.0

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

func (IndexQueryScope) ToStringPtrOutput added in v0.4.0

func (e IndexQueryScope) ToStringPtrOutput() pulumi.StringPtrOutput

func (IndexQueryScope) ToStringPtrOutputWithContext added in v0.4.0

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

type IndexQueryScopeInput added in v0.6.0

type IndexQueryScopeInput interface {
	pulumi.Input

	ToIndexQueryScopeOutput() IndexQueryScopeOutput
	ToIndexQueryScopeOutputWithContext(context.Context) IndexQueryScopeOutput
}

IndexQueryScopeInput is an input type that accepts IndexQueryScopeArgs and IndexQueryScopeOutput values. You can construct a concrete instance of `IndexQueryScopeInput` via:

IndexQueryScopeArgs{...}

type IndexQueryScopeOutput added in v0.6.0

type IndexQueryScopeOutput struct{ *pulumi.OutputState }

func (IndexQueryScopeOutput) ElementType added in v0.6.0

func (IndexQueryScopeOutput) ElementType() reflect.Type

func (IndexQueryScopeOutput) ToIndexQueryScopeOutput added in v0.6.0

func (o IndexQueryScopeOutput) ToIndexQueryScopeOutput() IndexQueryScopeOutput

func (IndexQueryScopeOutput) ToIndexQueryScopeOutputWithContext added in v0.6.0

func (o IndexQueryScopeOutput) ToIndexQueryScopeOutputWithContext(ctx context.Context) IndexQueryScopeOutput

func (IndexQueryScopeOutput) ToIndexQueryScopePtrOutput added in v0.6.0

func (o IndexQueryScopeOutput) ToIndexQueryScopePtrOutput() IndexQueryScopePtrOutput

func (IndexQueryScopeOutput) ToIndexQueryScopePtrOutputWithContext added in v0.6.0

func (o IndexQueryScopeOutput) ToIndexQueryScopePtrOutputWithContext(ctx context.Context) IndexQueryScopePtrOutput

func (IndexQueryScopeOutput) ToStringOutput added in v0.6.0

func (o IndexQueryScopeOutput) ToStringOutput() pulumi.StringOutput

func (IndexQueryScopeOutput) ToStringOutputWithContext added in v0.6.0

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

func (IndexQueryScopeOutput) ToStringPtrOutput added in v0.6.0

func (o IndexQueryScopeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (IndexQueryScopeOutput) ToStringPtrOutputWithContext added in v0.6.0

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

type IndexQueryScopePtrInput added in v0.6.0

type IndexQueryScopePtrInput interface {
	pulumi.Input

	ToIndexQueryScopePtrOutput() IndexQueryScopePtrOutput
	ToIndexQueryScopePtrOutputWithContext(context.Context) IndexQueryScopePtrOutput
}

func IndexQueryScopePtr added in v0.6.0

func IndexQueryScopePtr(v string) IndexQueryScopePtrInput

type IndexQueryScopePtrOutput added in v0.6.0

type IndexQueryScopePtrOutput struct{ *pulumi.OutputState }

func (IndexQueryScopePtrOutput) Elem added in v0.6.0

func (IndexQueryScopePtrOutput) ElementType added in v0.6.0

func (IndexQueryScopePtrOutput) ElementType() reflect.Type

func (IndexQueryScopePtrOutput) ToIndexQueryScopePtrOutput added in v0.6.0

func (o IndexQueryScopePtrOutput) ToIndexQueryScopePtrOutput() IndexQueryScopePtrOutput

func (IndexQueryScopePtrOutput) ToIndexQueryScopePtrOutputWithContext added in v0.6.0

func (o IndexQueryScopePtrOutput) ToIndexQueryScopePtrOutputWithContext(ctx context.Context) IndexQueryScopePtrOutput

func (IndexQueryScopePtrOutput) ToStringPtrOutput added in v0.6.0

func (o IndexQueryScopePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (IndexQueryScopePtrOutput) ToStringPtrOutputWithContext added in v0.6.0

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

type IndexState added in v0.3.0

type IndexState struct {
}

func (IndexState) ElementType added in v0.3.0

func (IndexState) ElementType() reflect.Type

type LookupIndexArgs added in v0.4.0

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

type LookupIndexOutputArgs added in v0.8.0

type LookupIndexOutputArgs struct {
	CollectionGroupId pulumi.StringInput    `pulumi:"collectionGroupId"`
	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 fields supported by this index. For composite indexes, this is always 2 or more 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.
	Fields []GoogleFirestoreAdminV1beta2IndexFieldResponse `pulumi:"fields"`
	// 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.
	Name string `pulumi:"name"`
	// 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.
	QueryScope string `pulumi:"queryScope"`
	// The serving state of the index.
	State string `pulumi:"state"`
}

func LookupIndex added in v0.4.0

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

Gets a composite 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) ElementType added in v0.8.0

func (LookupIndexResultOutput) ElementType() reflect.Type

func (LookupIndexResultOutput) Fields added in v0.8.0

The fields supported by this index. For composite indexes, this is always 2 or more 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.

func (LookupIndexResultOutput) Name added in v0.8.0

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.

func (LookupIndexResultOutput) QueryScope added in v0.8.0

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.

func (LookupIndexResultOutput) State added in v0.8.0

The serving state of the index.

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL