import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../../types/input"; import * as outputs from "../../types/output"; import * as enums from "../../types/enums"; /** * Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). An entry group can have a maximum of 100,000 entries. * Auto-naming is currently not supported for this resource. */ export declare class Entry extends pulumi.CustomResource { /** * Get an existing Entry resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): Entry; /** * Returns true if the given object is an instance of Entry. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Entry; /** * Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). */ readonly bigqueryDateShardedSpec: pulumi.Output; /** * Specification that applies to a BigQuery table. Valid only for entries with the `TABLE` type. */ readonly bigqueryTableSpec: pulumi.Output; /** * Business Context of the entry. Not supported for BigQuery datasets */ readonly businessContext: pulumi.Output; /** * Specification that applies to Cloud Bigtable system. Only settable when `integrated_system` is equal to `CLOUD_BIGTABLE` */ readonly cloudBigtableSystemSpec: pulumi.Output; /** * Physical location of the entry. */ readonly dataSource: pulumi.Output; /** * Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. */ readonly dataSourceConnectionSpec: pulumi.Output; /** * Specification that applies to a table resource. Valid only for entries with the `TABLE` or `EXPLORE` type. */ readonly databaseTableSpec: pulumi.Output; /** * Specification that applies to a dataset. */ readonly datasetSpec: pulumi.Output; /** * Entry description that can consist of several sentences or paragraphs that describe entry contents. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string. */ readonly description: pulumi.Output; /** * Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string. */ readonly displayName: pulumi.Output; readonly entryGroupId: pulumi.Output; /** * Required. The ID of the entry to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8. */ readonly entryId: pulumi.Output; /** * Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type. */ readonly filesetSpec: pulumi.Output; /** * [Fully Qualified Name (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries. */ readonly fullyQualifiedName: pulumi.Output; /** * Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type. */ readonly gcsFilesetSpec: pulumi.Output; /** * Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. */ readonly integratedSystem: pulumi.Output; /** * Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system. */ readonly labels: pulumi.Output<{ [key: string]: string; }>; /** * The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. */ readonly linkedResource: pulumi.Output; readonly location: pulumi.Output; /** * Specification that applies to Looker sysstem. Only settable when `user_specified_system` is equal to `LOOKER` */ readonly lookerSystemSpec: pulumi.Output; /** * Model specification. */ readonly modelSpec: pulumi.Output; /** * The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. */ readonly name: pulumi.Output; /** * Additional information related to the entry. Private to the current user. */ readonly personalDetails: pulumi.Output; readonly project: pulumi.Output; /** * Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. */ readonly routineSpec: pulumi.Output; /** * Schema of the entry. An entry might not have any schema attached to it. */ readonly schema: pulumi.Output; /** * Specification that applies to a Service resource. */ readonly serviceSpec: pulumi.Output; /** * Timestamps from the underlying resource, not from the Data Catalog entry. Output only when the entry has a system listed in the `IntegratedSystem` enum. For entries with `user_specified_system`, this field is optional and defaults to an empty timestamp. */ readonly sourceSystemTimestamps: pulumi.Output; /** * Specification that applies to a relational database system. Only settable when `user_specified_system` is equal to `SQL_DATABASE` */ readonly sqlDatabaseSystemSpec: pulumi.Output; /** * The type of the entry. For details, see [`EntryType`](#entrytype). */ readonly type: pulumi.Output; /** * Resource usage statistics. */ readonly usageSignal: pulumi.Output; /** * Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The `user_specified_system` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. */ readonly userSpecifiedSystem: pulumi.Output; /** * Custom entry type that doesn't match any of the values allowed for input and listed in the `EntryType` enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, `my_special_type`. The `user_specified_type` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. */ readonly userSpecifiedType: pulumi.Output; /** * Create a Entry resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: EntryArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Entry resource. */ export interface EntryArgs { /** * Business Context of the entry. Not supported for BigQuery datasets */ businessContext?: pulumi.Input; /** * Specification that applies to Cloud Bigtable system. Only settable when `integrated_system` is equal to `CLOUD_BIGTABLE` */ cloudBigtableSystemSpec?: pulumi.Input; /** * Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. */ dataSourceConnectionSpec?: pulumi.Input; /** * Specification that applies to a table resource. Valid only for entries with the `TABLE` or `EXPLORE` type. */ databaseTableSpec?: pulumi.Input; /** * Specification that applies to a dataset. */ datasetSpec?: pulumi.Input; /** * Entry description that can consist of several sentences or paragraphs that describe entry contents. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string. */ description?: pulumi.Input; /** * Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string. */ displayName?: pulumi.Input; entryGroupId: pulumi.Input; /** * Required. The ID of the entry to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8. */ entryId: pulumi.Input; /** * Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type. */ filesetSpec?: pulumi.Input; /** * [Fully Qualified Name (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries. */ fullyQualifiedName?: pulumi.Input; /** * Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type. */ gcsFilesetSpec?: pulumi.Input; /** * Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. */ linkedResource?: pulumi.Input; location?: pulumi.Input; /** * Specification that applies to Looker sysstem. Only settable when `user_specified_system` is equal to `LOOKER` */ lookerSystemSpec?: pulumi.Input; /** * Model specification. */ modelSpec?: pulumi.Input; project?: pulumi.Input; /** * Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. */ routineSpec?: pulumi.Input; /** * Schema of the entry. An entry might not have any schema attached to it. */ schema?: pulumi.Input; /** * Specification that applies to a Service resource. */ serviceSpec?: pulumi.Input; /** * Timestamps from the underlying resource, not from the Data Catalog entry. Output only when the entry has a system listed in the `IntegratedSystem` enum. For entries with `user_specified_system`, this field is optional and defaults to an empty timestamp. */ sourceSystemTimestamps?: pulumi.Input; /** * Specification that applies to a relational database system. Only settable when `user_specified_system` is equal to `SQL_DATABASE` */ sqlDatabaseSystemSpec?: pulumi.Input; /** * The type of the entry. For details, see [`EntryType`](#entrytype). */ type?: pulumi.Input; /** * Resource usage statistics. */ usageSignal?: pulumi.Input; /** * Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The `user_specified_system` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. */ userSpecifiedSystem?: pulumi.Input; /** * Custom entry type that doesn't match any of the values allowed for input and listed in the `EntryType` enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, `my_special_type`. The `user_specified_type` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. */ userSpecifiedType?: pulumi.Input; }