Skip to content

Latest commit

 

History

History
2935 lines (1816 loc) · 146 KB

googleFirestoreIndex.java.md

File metadata and controls

2935 lines (1816 loc) · 146 KB
Raw

googleFirestoreIndex Submodule

Constructs

GoogleFirestoreIndex

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

Initializers 

import com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndex;

GoogleFirestoreIndex.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .collection(java.lang.String)
    .fields(IResolvable)
    .fields(java.util.List<GoogleFirestoreIndexFields>)
//  .apiScope(java.lang.String)
//  .database(java.lang.String)
//  .id(java.lang.String)
//  .project(java.lang.String)
//  .queryScope(java.lang.String)
//  .timeouts(GoogleFirestoreIndexTimeouts)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
collection java.lang.String The collection being indexed.
fields com.hashicorp.cdktf.IResolvable OR java.util.List<GoogleFirestoreIndexFields> fields block.
apiScope java.lang.String The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API"].
database java.lang.String The Firestore database id. Defaults to '"(default)"'.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_index#id GoogleFirestoreIndex#id}.
project java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_index#project GoogleFirestoreIndex#project}.
queryScope java.lang.String The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP", "COLLECTION_RECURSIVE"].
timeouts GoogleFirestoreIndexTimeouts timeouts block.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
collectionRequired
  • Type: java.lang.String

The collection being indexed.

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

fieldsRequired

fields block.

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

apiScopeOptional
  • Type: java.lang.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.14.1/docs/resources/google_firestore_index#api_scope GoogleFirestoreIndex#api_scope}

databaseOptional
  • Type: java.lang.String

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

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

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/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.

projectOptional
  • Type: java.lang.String

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

queryScopeOptional
  • Type: java.lang.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.14.1/docs/resources/google_firestore_index#query_scope GoogleFirestoreIndex#query_scope}

timeoutsOptional

timeouts block.

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

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 java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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.

idRequired
  • Type: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

putFields 
public void putFields(IResolvable OR java.util.List<GoogleFirestoreIndexFields> value)
valueRequired
putTimeouts 
public void putTimeouts(GoogleFirestoreIndexTimeouts value)
valueRequired
resetApiScope 
public void resetApiScope()
resetDatabase 
public void resetDatabase()
resetId 
public void resetId()
resetProject 
public void resetProject()
resetQueryScope 
public void resetQueryScope()
resetTimeouts 
public void resetTimeouts()

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 com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndex;

GoogleFirestoreIndex.isConstruct(java.lang.Object x)

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.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndex;

GoogleFirestoreIndex.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndex;

GoogleFirestoreIndex.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndex;

GoogleFirestoreIndex.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),GoogleFirestoreIndex.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing GoogleFirestoreIndex that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
fields GoogleFirestoreIndexFieldsList No description.
name java.lang.String No description.
timeouts GoogleFirestoreIndexTimeoutsOutputReference No description.
apiScopeInput java.lang.String No description.
collectionInput java.lang.String No description.
databaseInput java.lang.String No description.
fieldsInput com.hashicorp.cdktf.IResolvable OR java.util.List<GoogleFirestoreIndexFields> No description.
idInput java.lang.String No description.
projectInput java.lang.String No description.
queryScopeInput java.lang.String No description.
timeoutsInput com.hashicorp.cdktf.IResolvable OR GoogleFirestoreIndexTimeouts No description.
apiScope java.lang.String No description.
collection java.lang.String No description.
database java.lang.String No description.
id java.lang.String No description.
project java.lang.String No description.
queryScope java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
fieldsRequired 
public GoogleFirestoreIndexFieldsList getFields();
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
timeoutsRequired 
public GoogleFirestoreIndexTimeoutsOutputReference getTimeouts();
apiScopeInputOptional 
public java.lang.String getApiScopeInput();
  • Type: java.lang.String
collectionInputOptional 
public java.lang.String getCollectionInput();
  • Type: java.lang.String
databaseInputOptional 
public java.lang.String getDatabaseInput();
  • Type: java.lang.String
fieldsInputOptional 
public java.lang.Object getFieldsInput();
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
projectInputOptional 
public java.lang.String getProjectInput();
  • Type: java.lang.String
queryScopeInputOptional 
public java.lang.String getQueryScopeInput();
  • Type: java.lang.String
timeoutsInputOptional 
public java.lang.Object getTimeoutsInput();
apiScopeRequired 
public java.lang.String getApiScope();
  • Type: java.lang.String
collectionRequired 
public java.lang.String getCollection();
  • Type: java.lang.String
databaseRequired 
public java.lang.String getDatabase();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
projectRequired 
public java.lang.String getProject();
  • Type: java.lang.String
queryScopeRequired 
public java.lang.String getQueryScope();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

GoogleFirestoreIndexConfig

Initializer 

import com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndexConfig;

GoogleFirestoreIndexConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .collection(java.lang.String)
    .fields(IResolvable)
    .fields(java.util.List<GoogleFirestoreIndexFields>)
//  .apiScope(java.lang.String)
//  .database(java.lang.String)
//  .id(java.lang.String)
//  .project(java.lang.String)
//  .queryScope(java.lang.String)
//  .timeouts(GoogleFirestoreIndexTimeouts)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
collection java.lang.String The collection being indexed.
fields com.hashicorp.cdktf.IResolvable OR java.util.List<GoogleFirestoreIndexFields> fields block.
apiScope java.lang.String The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API"].
database java.lang.String The Firestore database id. Defaults to '"(default)"'.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_index#id GoogleFirestoreIndex#id}.
project java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_index#project GoogleFirestoreIndex#project}.
queryScope java.lang.String The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP", "COLLECTION_RECURSIVE"].
timeouts GoogleFirestoreIndexTimeouts timeouts block.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
collectionRequired 
public java.lang.String getCollection();
  • Type: java.lang.String

The collection being indexed.

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

fieldsRequired 
public java.lang.Object getFields();

fields block.

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

apiScopeOptional 
public java.lang.String getApiScope();
  • Type: java.lang.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.14.1/docs/resources/google_firestore_index#api_scope GoogleFirestoreIndex#api_scope}

databaseOptional 
public java.lang.String getDatabase();
  • Type: java.lang.String

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

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

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/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.

projectOptional 
public java.lang.String getProject();
  • Type: java.lang.String

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

queryScopeOptional 
public java.lang.String getQueryScope();
  • Type: java.lang.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.14.1/docs/resources/google_firestore_index#query_scope GoogleFirestoreIndex#query_scope}

timeoutsOptional 
public GoogleFirestoreIndexTimeouts getTimeouts();

timeouts block.

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

GoogleFirestoreIndexFields

Initializer 

import com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndexFields;

GoogleFirestoreIndexFields.builder()
//  .arrayConfig(java.lang.String)
//  .fieldPath(java.lang.String)
//  .order(java.lang.String)
//  .vectorConfig(GoogleFirestoreIndexFieldsVectorConfig)
    .build();

Properties

Name Type Description
arrayConfig java.lang.String Indicates that this field supports operations on arrayValues.
fieldPath java.lang.String Name of the field.
order java.lang.String Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
vectorConfig GoogleFirestoreIndexFieldsVectorConfig vector_config block.
arrayConfigOptional 
public java.lang.String getArrayConfig();
  • Type: java.lang.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.14.1/docs/resources/google_firestore_index#array_config GoogleFirestoreIndex#array_config}

fieldPathOptional 
public java.lang.String getFieldPath();
  • Type: java.lang.String

Name of the field.

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

orderOptional 
public java.lang.String getOrder();
  • Type: java.lang.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.14.1/docs/resources/google_firestore_index#order GoogleFirestoreIndex#order}

vectorConfigOptional 
public GoogleFirestoreIndexFieldsVectorConfig getVectorConfig();

vector_config block.

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

GoogleFirestoreIndexFieldsVectorConfig

Initializer 

import com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndexFieldsVectorConfig;

GoogleFirestoreIndexFieldsVectorConfig.builder()
//  .dimension(java.lang.Number)
//  .flat(GoogleFirestoreIndexFieldsVectorConfigFlat)
    .build();

Properties

Name Type Description
dimension java.lang.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.
dimensionOptional 
public java.lang.Number getDimension();
  • Type: java.lang.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.14.1/docs/resources/google_firestore_index#dimension GoogleFirestoreIndex#dimension}

flatOptional 
public GoogleFirestoreIndexFieldsVectorConfigFlat getFlat();

flat block.

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

GoogleFirestoreIndexFieldsVectorConfigFlat

Initializer 

import com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndexFieldsVectorConfigFlat;

GoogleFirestoreIndexFieldsVectorConfigFlat.builder()
    .build();

GoogleFirestoreIndexTimeouts

Initializer 

import com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndexTimeouts;

GoogleFirestoreIndexTimeouts.builder()
//  .create(java.lang.String)
//  .delete(java.lang.String)
    .build();

Properties

Name Type Description
create java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_index#create GoogleFirestoreIndex#create}.
delete java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_index#delete GoogleFirestoreIndex#delete}.
createOptional 
public java.lang.String getCreate();
  • Type: java.lang.String

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

deleteOptional 
public java.lang.String getDelete();
  • Type: java.lang.String

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

Classes

GoogleFirestoreIndexFieldsList

Initializers 

import com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndexFieldsList;

new GoogleFirestoreIndexFieldsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
wrapsSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: java.lang.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 DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName)

Creating an iterator for this complex list.

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

mapKeyAttributeNameRequired
  • Type: java.lang.String
computeFqn 
public java.lang.String computeFqn()
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public GoogleFirestoreIndexFieldsOutputReference get(java.lang.Number index)
indexRequired
  • Type: java.lang.Number

the index of the item to return.

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR java.util.List<GoogleFirestoreIndexFields> No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();

GoogleFirestoreIndexFieldsOutputReference

Initializers 

import com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndexFieldsOutputReference;

new GoogleFirestoreIndexFieldsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
complexObjectIndex java.lang.Number the index of this item in the list.
complexObjectIsFromSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: java.lang.Number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: java.lang.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 java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

putVectorConfig 
public void putVectorConfig(GoogleFirestoreIndexFieldsVectorConfig value)
valueRequired
resetArrayConfig 
public void resetArrayConfig()
resetFieldPath 
public void resetFieldPath()
resetOrder 
public void resetOrder()
resetVectorConfig 
public void resetVectorConfig()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
vectorConfig GoogleFirestoreIndexFieldsVectorConfigOutputReference No description.
arrayConfigInput java.lang.String No description.
fieldPathInput java.lang.String No description.
orderInput java.lang.String No description.
vectorConfigInput GoogleFirestoreIndexFieldsVectorConfig No description.
arrayConfig java.lang.String No description.
fieldPath java.lang.String No description.
order java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR GoogleFirestoreIndexFields No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
vectorConfigRequired 
public GoogleFirestoreIndexFieldsVectorConfigOutputReference getVectorConfig();
arrayConfigInputOptional 
public java.lang.String getArrayConfigInput();
  • Type: java.lang.String
fieldPathInputOptional 
public java.lang.String getFieldPathInput();
  • Type: java.lang.String
orderInputOptional 
public java.lang.String getOrderInput();
  • Type: java.lang.String
vectorConfigInputOptional 
public GoogleFirestoreIndexFieldsVectorConfig getVectorConfigInput();
arrayConfigRequired 
public java.lang.String getArrayConfig();
  • Type: java.lang.String
fieldPathRequired 
public java.lang.String getFieldPath();
  • Type: java.lang.String
orderRequired 
public java.lang.String getOrder();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();

GoogleFirestoreIndexFieldsVectorConfigFlatOutputReference

Initializers 

import com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndexFieldsVectorConfigFlatOutputReference;

new GoogleFirestoreIndexFieldsVectorConfigFlatOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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 java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
internalValue GoogleFirestoreIndexFieldsVectorConfigFlat No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
internalValueOptional 
public GoogleFirestoreIndexFieldsVectorConfigFlat getInternalValue();

GoogleFirestoreIndexFieldsVectorConfigOutputReference

Initializers 

import com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndexFieldsVectorConfigOutputReference;

new GoogleFirestoreIndexFieldsVectorConfigOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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 java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

putFlat 
public void putFlat(GoogleFirestoreIndexFieldsVectorConfigFlat value)
valueRequired
resetDimension 
public void resetDimension()
resetFlat 
public void resetFlat()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
flat GoogleFirestoreIndexFieldsVectorConfigFlatOutputReference No description.
dimensionInput java.lang.Number No description.
flatInput GoogleFirestoreIndexFieldsVectorConfigFlat No description.
dimension java.lang.Number No description.
internalValue GoogleFirestoreIndexFieldsVectorConfig No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
flatRequired 
public GoogleFirestoreIndexFieldsVectorConfigFlatOutputReference getFlat();
dimensionInputOptional 
public java.lang.Number getDimensionInput();
  • Type: java.lang.Number
flatInputOptional 
public GoogleFirestoreIndexFieldsVectorConfigFlat getFlatInput();
dimensionRequired 
public java.lang.Number getDimension();
  • Type: java.lang.Number
internalValueOptional 
public GoogleFirestoreIndexFieldsVectorConfig getInternalValue();

GoogleFirestoreIndexTimeoutsOutputReference

Initializers 

import com.hashicorp.cdktf.providers.google_beta.google_firestore_index.GoogleFirestoreIndexTimeoutsOutputReference;

new GoogleFirestoreIndexTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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 java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate 
public void resetCreate()
resetDelete 
public void resetDelete()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
createInput java.lang.String No description.
deleteInput java.lang.String No description.
create java.lang.String No description.
delete java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR GoogleFirestoreIndexTimeouts No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
createInputOptional 
public java.lang.String getCreateInput();
  • Type: java.lang.String
deleteInputOptional 
public java.lang.String getDeleteInput();
  • Type: java.lang.String
createRequired 
public java.lang.String getCreate();
  • Type: java.lang.String
deleteRequired 
public java.lang.String getDelete();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();