Package com.hashicorp.cdktf.providers.google.vertex_ai_index

Class VertexAiIndex

  • 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:22.976Z")
@Stability(Stable)
public class VertexAiIndex
extends com.hashicorp.cdktf.TerraformResource
    Represents a {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index google_vertex_ai_index}.

    • Field Detail

      • TF_RESOURCE_TYPE

        @Stability(Stable)
public static final String TF_RESOURCE_TYPE

    • Constructor Detail

      • VertexAiIndex

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

      • VertexAiIndex

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

      • VertexAiIndex

        @Stability(Stable)
public VertexAiIndex​(@NotNull
                     software.constructs.Construct scope,
                     @NotNull
                     String id,
                     @NotNull
                     VertexAiIndexConfig config)
        Create a new {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index google_vertex_ai_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 VertexAiIndex 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 VertexAiIndex to import. This parameter is required.
        importFromId - The id of the existing VertexAiIndex that should be imported. This parameter is required.
        provider - ? Optional instance of the provider where the VertexAiIndex 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 VertexAiIndex 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 VertexAiIndex to import. This parameter is required.
        importFromId - The id of the existing VertexAiIndex that should be imported. This parameter is required.

      • putMetadata

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

      • putTimeouts

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

      • resetDescription

        @Stability(Stable)
public void resetDescription()

      • resetId

        @Stability(Stable)
public void resetId()

      • resetIndexUpdateMethod

        @Stability(Stable)
public void resetIndexUpdateMethod()

      • resetLabels

        @Stability(Stable)
public void resetLabels()

      • resetMetadata

        @Stability(Stable)
public void resetMetadata()

      • resetProject

        @Stability(Stable)
public void resetProject()

      • resetRegion

        @Stability(Stable)
public void resetRegion()

      • 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

      • getCreateTime

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

      • getEffectiveLabels

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getEffectiveLabels()

      • getEtag

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

      • getMetadataSchemaUri

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

      • getName

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

      • getTerraformLabels

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getTerraformLabels()

      • getUpdateTime

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

      • getDescriptionInput

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

      • getDisplayNameInput

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

      • getIdInput

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

      • getIndexUpdateMethodInput

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

      • getLabelsInput

        @Stability(Stable)
@Nullable
public Map<String,​String> getLabelsInput()

      • getProjectInput

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

      • getRegionInput

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

      • getTimeoutsInput

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

      • getDescription

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

      • setDescription

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

      • getDisplayName

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

      • setDisplayName

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

      • getId

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

      • setId

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

      • getIndexUpdateMethod

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

      • setIndexUpdateMethod

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

      • getLabels

        @Stability(Stable)
@NotNull
public Map<String,​String> getLabels()

      • setLabels

        @Stability(Stable)
public void setLabels​(@NotNull
                      Map<String,​String> value)

      • getProject

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

      • setProject

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

      • getRegion

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

      • setRegion

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