Package com.hashicorp.cdktf.providers.google.data_catalog_entry

Class DataCatalogEntry.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static DataCatalogEntry.Builder create​(software.constructs.Construct scope,
                                              String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of DataCatalogEntry.Builder.

      • connection

        @Stability(Experimental)
public DataCatalogEntry.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public DataCatalogEntry.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public DataCatalogEntry.Builder count​(Number count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public DataCatalogEntry.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public DataCatalogEntry.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public DataCatalogEntry.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public DataCatalogEntry.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public DataCatalogEntry.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public DataCatalogEntry.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • entryGroup

        @Stability(Stable)
public DataCatalogEntry.Builder entryGroup​(String entryGroup)
        The name of the entry group this entry is in.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_catalog_entry#entry_group DataCatalogEntry#entry_group}

        Parameters:
        entryGroup - The name of the entry group this entry is in. This parameter is required.
        Returns:
        this

      • entryId

        @Stability(Stable)
public DataCatalogEntry.Builder entryId​(String entryId)
        The id of the entry to create.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_catalog_entry#entry_id DataCatalogEntry#entry_id}

        Parameters:
        entryId - The id of the entry to create. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public DataCatalogEntry.Builder description​(String description)
        Entry description, which can consist of several sentences or paragraphs that describe entry contents.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_catalog_entry#description DataCatalogEntry#description}

        Parameters:
        description - Entry description, which can consist of several sentences or paragraphs that describe entry contents. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public DataCatalogEntry.Builder displayName​(String displayName)
        Display information such as title and description.

        A short name to identify the entry, for example, "Analytics Data - Jan 2011". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_catalog_entry#display_name DataCatalogEntry#display_name}

        Parameters:
        displayName - Display information such as title and description. This parameter is required.
        Returns:
        this

      • gcsFilesetSpec

        @Stability(Stable)
public DataCatalogEntry.Builder gcsFilesetSpec​(DataCatalogEntryGcsFilesetSpec gcsFilesetSpec)
        gcs_fileset_spec block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_catalog_entry#gcs_fileset_spec DataCatalogEntry#gcs_fileset_spec}

        Parameters:
        gcsFilesetSpec - gcs_fileset_spec block. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public DataCatalogEntry.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_catalog_entry#id DataCatalogEntry#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.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_catalog_entry#id DataCatalogEntry#id}. This parameter is required.
        Returns:
        this

      • linkedResource

        @Stability(Stable)
public DataCatalogEntry.Builder linkedResource​(String linkedResource)
        The resource this metadata entry refers to.

        For Google Cloud Platform resources, linkedResource is the full name of the resource. For example, the linkedResource for a table resource from BigQuery is: //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId Output only when Entry is of type in the EntryType enum. For entries with userSpecifiedType, this field is optional and defaults to an empty string. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_catalog_entry#linked_resource DataCatalogEntry#linked_resource}

        Parameters:
        linkedResource - The resource this metadata entry refers to. This parameter is required.
        Returns:
        this

      • schema

        @Stability(Stable)
public DataCatalogEntry.Builder schema​(String schema)
        Schema of the entry (e.g. BigQuery, GoogleSQL, Avro schema), as a json string. An entry might not have any schema attached to it. See https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#schema for what fields this schema can contain.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_catalog_entry#schema DataCatalogEntry#schema}

        Parameters:
        schema - Schema of the entry (e.g. BigQuery, GoogleSQL, Avro schema), as a json string. An entry might not have any schema attached to it. See https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#schema for what fields this schema can contain. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public DataCatalogEntry.Builder timeouts​(DataCatalogEntryTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_catalog_entry#timeouts DataCatalogEntry#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this

      • type

        @Stability(Stable)
public DataCatalogEntry.Builder type​(String type)
        The type of the entry.

        Only used for Entries with types in the EntryType enum. Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use userSpecifiedType. Possible values: ["FILESET"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_catalog_entry#type DataCatalogEntry#type}

        Parameters:
        type - The type of the entry. This parameter is required.
        Returns:
        this

      • userSpecifiedSystem

        @Stability(Stable)
public DataCatalogEntry.Builder userSpecifiedSystem​(String userSpecifiedSystem)
        This field indicates the entry's source system that Data Catalog does not integrate with.

        userSpecifiedSystem strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_catalog_entry#user_specified_system DataCatalogEntry#user_specified_system}

        Parameters:
        userSpecifiedSystem - This field indicates the entry's source system that Data Catalog does not integrate with. This parameter is required.
        Returns:
        this

      • userSpecifiedType

        @Stability(Stable)
public DataCatalogEntry.Builder userSpecifiedType​(String userSpecifiedType)
        Entry type if it does not fit any of the input-allowed values listed in EntryType enum above.

        When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". userSpecifiedType strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_catalog_entry#user_specified_type DataCatalogEntry#user_specified_type}

        Parameters:
        userSpecifiedType - Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. This parameter is required.
        Returns:
        this