Package com.hashicorp.cdktf.providers.google.firestore_index

Class FirestoreIndex

  • All Implemented Interfaces:
    com.hashicorp.cdktf.IInterpolatingParent, com.hashicorp.cdktf.ITerraformAddressable, com.hashicorp.cdktf.ITerraformDependable, com.hashicorp.cdktf.ITerraformResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.239Z")
@Stability(Stable)
public class FirestoreIndex
extends com.hashicorp.cdktf.TerraformResource
    Represents a {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index google_firestore_index}.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FirestoreIndex.Builder
      A fluent builder for FirestoreIndex.

      • Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

        software.amazon.jsii.JsiiObject.InitializationMode

      • Nested classes/interfaces inherited from interface software.constructs.IConstruct

        software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

      • Nested classes/interfaces inherited from interface com.hashicorp.cdktf.IInterpolatingParent

        com.hashicorp.cdktf.IInterpolatingParent.Jsii$Default, com.hashicorp.cdktf.IInterpolatingParent.Jsii$Proxy

      • Nested classes/interfaces inherited from interface com.hashicorp.cdktf.ITerraformDependable

        com.hashicorp.cdktf.ITerraformDependable.Jsii$Default, com.hashicorp.cdktf.ITerraformDependable.Jsii$Proxy

      • Nested classes/interfaces inherited from interface com.hashicorp.cdktf.ITerraformResource

        com.hashicorp.cdktf.ITerraformResource.Jsii$Default, com.hashicorp.cdktf.ITerraformResource.Jsii$Proxy

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected FirestoreIndex​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)  
      protected FirestoreIndex​(software.amazon.jsii.JsiiObjectRef objRef)  
        FirestoreIndex​(software.constructs.Construct scope, String id, FirestoreIndexConfig config)
      Create a new {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index google_firestore_index} Resource.

    • Field Detail

      • TF_RESOURCE_TYPE

        @Stability(Stable)
public static final String TF_RESOURCE_TYPE

    • Constructor Detail

      • FirestoreIndex

        protected FirestoreIndex​(software.amazon.jsii.JsiiObjectRef objRef)

      • FirestoreIndex

        protected FirestoreIndex​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • FirestoreIndex

        @Stability(Stable)
public FirestoreIndex​(@NotNull
                      software.constructs.Construct scope,
                      @NotNull
                      String id,
                      @NotNull
                      FirestoreIndexConfig config)
        Create a new {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_index google_firestore_index} Resource.

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        config - This parameter is required.

    • Method Detail

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId,
                                                                             @Nullable
                                                                             com.hashicorp.cdktf.TerraformProvider provider)
        Generates CDKTF code for importing a FirestoreIndex resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the FirestoreIndex to import. This parameter is required.
        importFromId - The id of the existing FirestoreIndex that should be imported. This parameter is required.
        provider - ? Optional instance of the provider where the FirestoreIndex to import is found.

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId)
        Generates CDKTF code for importing a FirestoreIndex resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the FirestoreIndex to import. This parameter is required.
        importFromId - The id of the existing FirestoreIndex that should be imported. This parameter is required.

      • putFields

        @Stability(Stable)
public void putFields​(@NotNull
                      Object value)
        Parameters:
        value - This parameter is required.

      • putTimeouts

        @Stability(Stable)
public void putTimeouts​(@NotNull
                        FirestoreIndexTimeouts value)
        Parameters:
        value - This parameter is required.

      • resetApiScope

        @Stability(Stable)
public void resetApiScope()

      • resetDatabase

        @Stability(Stable)
public void resetDatabase()

      • resetId

        @Stability(Stable)
public void resetId()

      • resetProject

        @Stability(Stable)
public void resetProject()

      • resetQueryScope

        @Stability(Stable)
public void resetQueryScope()

      • resetTimeouts

        @Stability(Stable)
public void resetTimeouts()

      • synthesizeAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeAttributes()
        Overrides:
        synthesizeAttributes in class com.hashicorp.cdktf.TerraformResource

      • synthesizeHclAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeHclAttributes()
        Overrides:
        synthesizeHclAttributes in class com.hashicorp.cdktf.TerraformResource

      • getName

        @Stability(Stable)
@NotNull
public String getName()

      • getApiScopeInput

        @Stability(Stable)
@Nullable
public String getApiScopeInput()

      • getCollectionInput

        @Stability(Stable)
@Nullable
public String getCollectionInput()

      • getDatabaseInput

        @Stability(Stable)
@Nullable
public String getDatabaseInput()

      • getFieldsInput

        @Stability(Stable)
@Nullable
public Object getFieldsInput()

      • getIdInput

        @Stability(Stable)
@Nullable
public String getIdInput()

      • getProjectInput

        @Stability(Stable)
@Nullable
public String getProjectInput()

      • getQueryScopeInput

        @Stability(Stable)
@Nullable
public String getQueryScopeInput()

      • getTimeoutsInput

        @Stability(Stable)
@Nullable
public Object getTimeoutsInput()

      • getApiScope

        @Stability(Stable)
@NotNull
public String getApiScope()

      • setApiScope

        @Stability(Stable)
public void setApiScope​(@NotNull
                        String value)

      • getCollection

        @Stability(Stable)
@NotNull
public String getCollection()

      • setCollection

        @Stability(Stable)
public void setCollection​(@NotNull
                          String value)

      • getDatabase

        @Stability(Stable)
@NotNull
public String getDatabase()

      • setDatabase

        @Stability(Stable)
public void setDatabase​(@NotNull
                        String value)

      • getId

        @Stability(Stable)
@NotNull
public String getId()

      • setId

        @Stability(Stable)
public void setId​(@NotNull
                  String value)

      • getProject

        @Stability(Stable)
@NotNull
public String getProject()

      • setProject

        @Stability(Stable)
public void setProject​(@NotNull
                       String value)

      • getQueryScope

        @Stability(Stable)
@NotNull
public String getQueryScope()

      • setQueryScope

        @Stability(Stable)
public void setQueryScope​(@NotNull
                          String value)