`googleFirestoreIndex` Submodule

Constructs

GoogleFirestoreIndex

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index google_firestore_index}.

Initializers

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

new googleFirestoreIndex.GoogleFirestoreIndex(scope: Construct, id: string, config: GoogleFirestoreIndexConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`GoogleFirestoreIndexConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: GoogleFirestoreIndexConfig

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`putFields`	No description.
`putTimeouts`	No description.
`resetApiScope`	No description.
`resetDatabase`	No description.
`resetId`	No description.
`resetProject`	No description.
`resetQueryScope`	No description.
`resetTimeouts`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`moveToId`

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`putFields`

public putFields(value: IResolvable | GoogleFirestoreIndexFields[]): void

`value`^Required

Type: cdktf.IResolvable | GoogleFirestoreIndexFields[]

`putTimeouts`

public putTimeouts(value: GoogleFirestoreIndexTimeouts): void

`value`^Required

Type: GoogleFirestoreIndexTimeouts

`resetApiScope`

public resetApiScope(): void

`resetDatabase`

public resetDatabase(): void

`resetId`

public resetId(): void

`resetProject`

public resetProject(): void

`resetQueryScope`

public resetQueryScope(): void

`resetTimeouts`

public resetTimeouts(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a GoogleFirestoreIndex resource upon running "cdktf plan ".

`isConstruct`

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

googleFirestoreIndex.GoogleFirestoreIndex.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

googleFirestoreIndex.GoogleFirestoreIndex.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

googleFirestoreIndex.GoogleFirestoreIndex.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

googleFirestoreIndex.GoogleFirestoreIndex.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a GoogleFirestoreIndex resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

The construct id used in the generated config for the GoogleFirestoreIndex to import.

`importFromId`^Required

Type: string

The id of the existing GoogleFirestoreIndex that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the GoogleFirestoreIndex to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`fields`	`GoogleFirestoreIndexFieldsList`	No description.
`name`	`string`	No description.
`timeouts`	`GoogleFirestoreIndexTimeoutsOutputReference`	No description.
`apiScopeInput`	`string`	No description.
`collectionInput`	`string`	No description.
`databaseInput`	`string`	No description.
`fieldsInput`	`cdktf.IResolvable \| GoogleFirestoreIndexFields[]`	No description.
`idInput`	`string`	No description.
`projectInput`	`string`	No description.
`queryScopeInput`	`string`	No description.
`timeoutsInput`	`cdktf.IResolvable \| GoogleFirestoreIndexTimeouts`	No description.
`apiScope`	`string`	No description.
`collection`	`string`	No description.
`database`	`string`	No description.
`id`	`string`	No description.
`project`	`string`	No description.
`queryScope`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`fields`^Required

public readonly fields: GoogleFirestoreIndexFieldsList;

Type: GoogleFirestoreIndexFieldsList

`name`^Required

public readonly name: string;

Type: string

`timeouts`^Required

public readonly timeouts: GoogleFirestoreIndexTimeoutsOutputReference;

Type: GoogleFirestoreIndexTimeoutsOutputReference

`apiScopeInput`^Optional

public readonly apiScopeInput: string;

Type: string

`collectionInput`^Optional

public readonly collectionInput: string;

Type: string

`databaseInput`^Optional

public readonly databaseInput: string;

Type: string

`fieldsInput`^Optional

public readonly fieldsInput: IResolvable | GoogleFirestoreIndexFields[];

Type: cdktf.IResolvable | GoogleFirestoreIndexFields[]

`idInput`^Optional

public readonly idInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`queryScopeInput`^Optional

public readonly queryScopeInput: string;

Type: string

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | GoogleFirestoreIndexTimeouts;

Type: cdktf.IResolvable | GoogleFirestoreIndexTimeouts

`apiScope`^Required

public readonly apiScope: string;

Type: string

`collection`^Required

public readonly collection: string;

Type: string

`database`^Required

public readonly database: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`project`^Required

public readonly project: string;

Type: string

`queryScope`^Required

public readonly queryScope: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

GoogleFirestoreIndexConfig

Initializer

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

const googleFirestoreIndexConfig: googleFirestoreIndex.GoogleFirestoreIndexConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`collection`	`string`	The collection being indexed.
`fields`	`cdktf.IResolvable \| GoogleFirestoreIndexFields[]`	fields block.
`apiScope`	`string`	The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API"].
`database`	`string`	The Firestore database id. Defaults to '"(default)"'.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#id GoogleFirestoreIndex#id}.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#project GoogleFirestoreIndex#project}.
`queryScope`	`string`	The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP", "COLLECTION_RECURSIVE"].
`timeouts`	`GoogleFirestoreIndexTimeouts`	timeouts block.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`collection`^Required

public readonly collection: string;

Type: string

The collection being indexed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#collection GoogleFirestoreIndex#collection}

`fields`^Required

public readonly fields: IResolvable | GoogleFirestoreIndexFields[];

Type: cdktf.IResolvable | GoogleFirestoreIndexFields[]

fields block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#fields GoogleFirestoreIndex#fields}

`apiScope`^Optional

public readonly apiScope: string;

Type: string

The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#api_scope GoogleFirestoreIndex#api_scope}

`database`^Optional

public readonly database: string;

Type: string

The Firestore database id. Defaults to '"(default)"'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#database GoogleFirestoreIndex#database}

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#id GoogleFirestoreIndex#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`project`^Optional

public readonly project: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#project GoogleFirestoreIndex#project}.

`queryScope`^Optional

public readonly queryScope: string;

Type: string

The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP", "COLLECTION_RECURSIVE"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#query_scope GoogleFirestoreIndex#query_scope}

`timeouts`^Optional

public readonly timeouts: GoogleFirestoreIndexTimeouts;

Type: GoogleFirestoreIndexTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#timeouts GoogleFirestoreIndex#timeouts}

GoogleFirestoreIndexFields

Initializer

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

const googleFirestoreIndexFields: googleFirestoreIndex.GoogleFirestoreIndexFields = { ... }

Properties

Name	Type	Description
`arrayConfig`	`string`	Indicates that this field supports operations on arrayValues.
`fieldPath`	`string`	Name of the field.
`order`	`string`	Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
`vectorConfig`	`GoogleFirestoreIndexFieldsVectorConfig`	vector_config block.

`arrayConfig`^Optional

public readonly arrayConfig: string;

Type: string

Indicates that this field supports operations on arrayValues.

Only one of 'order', 'arrayConfig', and 'vectorConfig' can be specified. Possible values: ["CONTAINS"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#array_config GoogleFirestoreIndex#array_config}

`fieldPath`^Optional

public readonly fieldPath: string;

Type: string

Name of the field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#field_path GoogleFirestoreIndex#field_path}

`order`^Optional

public readonly order: string;

Type: string

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

Only one of 'order', 'arrayConfig', and 'vectorConfig' can be specified. Possible values: ["ASCENDING", "DESCENDING"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#order GoogleFirestoreIndex#order}

`vectorConfig`^Optional

public readonly vectorConfig: GoogleFirestoreIndexFieldsVectorConfig;

Type: GoogleFirestoreIndexFieldsVectorConfig

vector_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#vector_config GoogleFirestoreIndex#vector_config}

GoogleFirestoreIndexFieldsVectorConfig

Initializer

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

const googleFirestoreIndexFieldsVectorConfig: googleFirestoreIndex.GoogleFirestoreIndexFieldsVectorConfig = { ... }

Properties

Name	Type	Description
`dimension`	`number`	The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.
`flat`	`GoogleFirestoreIndexFieldsVectorConfigFlat`	flat block.

`dimension`^Optional

public readonly dimension: number;

Type: number

The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#dimension GoogleFirestoreIndex#dimension}

`flat`^Optional

public readonly flat: GoogleFirestoreIndexFieldsVectorConfigFlat;

Type: GoogleFirestoreIndexFieldsVectorConfigFlat

flat block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#flat GoogleFirestoreIndex#flat}

GoogleFirestoreIndexFieldsVectorConfigFlat

Initializer

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

const googleFirestoreIndexFieldsVectorConfigFlat: googleFirestoreIndex.GoogleFirestoreIndexFieldsVectorConfigFlat = { ... }

GoogleFirestoreIndexTimeouts

Initializer

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

const googleFirestoreIndexTimeouts: googleFirestoreIndex.GoogleFirestoreIndexTimeouts = { ... }

Properties

Name	Type	Description
`create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#create GoogleFirestoreIndex#create}.
`delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#delete GoogleFirestoreIndex#delete}.

`create`^Optional

public readonly create: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#create GoogleFirestoreIndex#create}.

`delete`^Optional

public readonly delete: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_firestore_index#delete GoogleFirestoreIndex#delete}.

Classes

GoogleFirestoreIndexFieldsList

Initializers

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

new googleFirestoreIndex.GoogleFirestoreIndexFieldsList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`allWithMapKey`	Creating an iterator for this complex list.
`computeFqn`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`get`	No description.

`allWithMapKey`

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

public get(index: number): GoogleFirestoreIndexFieldsOutputReference

`index`^Required

Type: number

the index of the item to return.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleFirestoreIndexFields[]`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleFirestoreIndexFields[];

Type: cdktf.IResolvable | GoogleFirestoreIndexFields[]

GoogleFirestoreIndexFieldsOutputReference

Initializers

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

new googleFirestoreIndex.GoogleFirestoreIndexFieldsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`number`	the index of this item in the list.
`complexObjectIsFromSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`putVectorConfig`	No description.
`resetArrayConfig`	No description.
`resetFieldPath`	No description.
`resetOrder`	No description.
`resetVectorConfig`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`putVectorConfig`

public putVectorConfig(value: GoogleFirestoreIndexFieldsVectorConfig): void

`value`^Required

Type: GoogleFirestoreIndexFieldsVectorConfig

`resetArrayConfig`

public resetArrayConfig(): void

`resetFieldPath`

public resetFieldPath(): void

`resetOrder`

public resetOrder(): void

`resetVectorConfig`

public resetVectorConfig(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`vectorConfig`	`GoogleFirestoreIndexFieldsVectorConfigOutputReference`	No description.
`arrayConfigInput`	`string`	No description.
`fieldPathInput`	`string`	No description.
`orderInput`	`string`	No description.
`vectorConfigInput`	`GoogleFirestoreIndexFieldsVectorConfig`	No description.
`arrayConfig`	`string`	No description.
`fieldPath`	`string`	No description.
`order`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleFirestoreIndexFields`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`vectorConfig`^Required

public readonly vectorConfig: GoogleFirestoreIndexFieldsVectorConfigOutputReference;

Type: GoogleFirestoreIndexFieldsVectorConfigOutputReference

`arrayConfigInput`^Optional

public readonly arrayConfigInput: string;

Type: string

`fieldPathInput`^Optional

public readonly fieldPathInput: string;

Type: string

`orderInput`^Optional

public readonly orderInput: string;

Type: string

`vectorConfigInput`^Optional

public readonly vectorConfigInput: GoogleFirestoreIndexFieldsVectorConfig;

Type: GoogleFirestoreIndexFieldsVectorConfig

`arrayConfig`^Required

public readonly arrayConfig: string;

Type: string

`fieldPath`^Required

public readonly fieldPath: string;

Type: string

`order`^Required

public readonly order: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleFirestoreIndexFields;

Type: cdktf.IResolvable | GoogleFirestoreIndexFields

GoogleFirestoreIndexFieldsVectorConfigFlatOutputReference

Initializers

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

new googleFirestoreIndex.GoogleFirestoreIndexFieldsVectorConfigFlatOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`internalValue`	`GoogleFirestoreIndexFieldsVectorConfigFlat`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`internalValue`^Optional

public readonly internalValue: GoogleFirestoreIndexFieldsVectorConfigFlat;

Type: GoogleFirestoreIndexFieldsVectorConfigFlat

GoogleFirestoreIndexFieldsVectorConfigOutputReference

Initializers

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

new googleFirestoreIndex.GoogleFirestoreIndexFieldsVectorConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`putFlat`	No description.
`resetDimension`	No description.
`resetFlat`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`putFlat`

public putFlat(value: GoogleFirestoreIndexFieldsVectorConfigFlat): void

`value`^Required

Type: GoogleFirestoreIndexFieldsVectorConfigFlat

`resetDimension`

public resetDimension(): void

`resetFlat`

public resetFlat(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`flat`	`GoogleFirestoreIndexFieldsVectorConfigFlatOutputReference`	No description.
`dimensionInput`	`number`	No description.
`flatInput`	`GoogleFirestoreIndexFieldsVectorConfigFlat`	No description.
`dimension`	`number`	No description.
`internalValue`	`GoogleFirestoreIndexFieldsVectorConfig`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`flat`^Required

public readonly flat: GoogleFirestoreIndexFieldsVectorConfigFlatOutputReference;

Type: GoogleFirestoreIndexFieldsVectorConfigFlatOutputReference

`dimensionInput`^Optional

public readonly dimensionInput: number;

Type: number

`flatInput`^Optional

public readonly flatInput: GoogleFirestoreIndexFieldsVectorConfigFlat;

Type: GoogleFirestoreIndexFieldsVectorConfigFlat

`dimension`^Required

public readonly dimension: number;

Type: number

`internalValue`^Optional

public readonly internalValue: GoogleFirestoreIndexFieldsVectorConfig;

Type: GoogleFirestoreIndexFieldsVectorConfig

GoogleFirestoreIndexTimeoutsOutputReference

Initializers

import { googleFirestoreIndex } from '@cdktf/provider-google-beta'

new googleFirestoreIndex.GoogleFirestoreIndexTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetCreate`	No description.
`resetDelete`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetCreate`

public resetCreate(): void

`resetDelete`

public resetDelete(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`createInput`	`string`	No description.
`deleteInput`	`string`	No description.
`create`	`string`	No description.
`delete`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleFirestoreIndexTimeouts`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`createInput`^Optional

public readonly createInput: string;

Type: string

`deleteInput`^Optional

public readonly deleteInput: string;

Type: string

`create`^Required

public readonly create: string;

Type: string

`delete`^Required

public readonly delete: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleFirestoreIndexTimeouts;

Type: cdktf.IResolvable | GoogleFirestoreIndexTimeouts

Files

googleFirestoreIndex.typescript.md

Latest commit

History

googleFirestoreIndex.typescript.md

File metadata and controls

googleFirestoreIndex Submodule

Constructs