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

Interface DataCatalogEntryConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    DataCatalogEntryConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:19.318Z")
@Stability(Stable)
public interface DataCatalogEntryConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getEntryGroup

        @Stability(Stable)
@NotNull
String getEntryGroup()
        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}

      • getEntryId

        @Stability(Stable)
@NotNull
String getEntryId()
        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}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        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}

      • getDisplayName

        @Stability(Stable)
@Nullable
default String getDisplayName()
        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}

      • getGcsFilesetSpec

        @Stability(Stable)
@Nullable
default DataCatalogEntryGcsFilesetSpec getGcsFilesetSpec()
        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}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        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.

      • getLinkedResource

        @Stability(Stable)
@Nullable
default String getLinkedResource()
        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}

      • getSchema

        @Stability(Stable)
@Nullable
default String getSchema()
        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}

      • getTimeouts

        @Stability(Stable)
@Nullable
default DataCatalogEntryTimeouts getTimeouts()
        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}

      • getType

        @Stability(Stable)
@Nullable
default String getType()
        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}

      • getUserSpecifiedSystem

        @Stability(Stable)
@Nullable
default String getUserSpecifiedSystem()
        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}

      • getUserSpecifiedType

        @Stability(Stable)
@Nullable
default String getUserSpecifiedType()
        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}