Entry class
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. An entry group can have a maximum of 100,000 entries.
Auto-naming is currently not supported for this resource.
Constructors
Properties
-
bigqueryDateShardedSpec
↔ Output<
GoogleCloudDatacatalogV1BigQueryDateShardedSpecResponse> -
Specification for a group of BigQuery tables with the
[prefix]YYYYMMDDname pattern. For more information, seeIntroduction to partitioned tables(https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).latefinal -
bigqueryTableSpec
↔ Output<
GoogleCloudDatacatalogV1BigQueryTableSpecResponse> -
Specification that applies to a BigQuery table. Valid only for entries with the
TABLEtype.latefinal -
businessContext
↔ Output<
GoogleCloudDatacatalogV1BusinessContextResponse> -
Business Context of the entry. Not supported for BigQuery datasets
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
cloudBigtableSystemSpec
↔ Output<
GoogleCloudDatacatalogV1CloudBigtableSystemSpecResponse> -
Specification that applies to Cloud Bigtable system. Only settable when
integrated_systemis equal toCLOUD_BIGTABLElatefinal -
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
databaseTableSpec
↔ Output<
GoogleCloudDatacatalogV1DatabaseTableSpecResponse> -
Specification that applies to a table resource. Valid only for entries with the
TABLEorEXPLOREtype.latefinal -
datasetSpec
↔ Output<
GoogleCloudDatacatalogV1DatasetSpecResponse> -
Specification that applies to a dataset.
latefinal
-
dataSource
↔ Output<
GoogleCloudDatacatalogV1DataSourceResponse> -
Physical location of the entry.
latefinal
-
dataSourceConnectionSpec
↔ Output<
GoogleCloudDatacatalogV1DataSourceConnectionSpecResponse> -
Specification that applies to a data source connection. Valid only for entries with the
DATA_SOURCE_CONNECTIONtype.latefinal -
description
↔ Output<
String> -
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.
latefinal
-
displayName
↔ Output<
String> -
Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.
latefinal
-
entryGroupId
↔ Output<
String> -
latefinal
-
entryId
↔ Output<
String> -
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.
latefinal
-
filesetSpec
↔ Output<
GoogleCloudDatacatalogV1FilesetSpecResponse> -
Specification that applies to a fileset resource. Valid only for entries with the
FILESETtype.latefinal -
fullyQualifiedName
↔ Output<
String> -
Fully Qualified Name (FQN) 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.
latefinal
-
gcsFilesetSpec
↔ Output<
GoogleCloudDatacatalogV1GcsFilesetSpecResponse> -
Specification that applies to a Cloud Storage fileset. Valid only for entries with the
FILESETtype.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
integratedSystem
↔ Output<
String> -
Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
labels
↔ Output<
Map< String, String> > -
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.
latefinal
-
linkedResource
↔ Output<
String> -
The resource this metadata entry refers to. For Google Cloud Platform resources,
linked_resourceis theFull Resource Name(https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, thelinked_resourcefor 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 theEntryTypeenum. For entries with auser_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.latefinal -
location
↔ Output<
String> -
latefinal
-
lookerSystemSpec
↔ Output<
GoogleCloudDatacatalogV1LookerSystemSpecResponse> -
Specification that applies to Looker sysstem. Only settable when
user_specified_systemis equal toLOOKERlatefinal -
modelSpec
↔ Output<
GoogleCloudDatacatalogV1ModelSpecResponse> -
Model specification.
latefinal
-
name
↔ Output<
String> -
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.
latefinal
-
personalDetails
↔ Output<
GoogleCloudDatacatalogV1PersonalDetailsResponse> -
Additional information related to the entry. Private to the current user.
latefinal
-
project
↔ Output<
String> -
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
routineSpec
↔ Output<
GoogleCloudDatacatalogV1RoutineSpecResponse> -
Specification that applies to a user-defined function or procedure. Valid only for entries with the
ROUTINEtype.latefinal - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
schema
↔ Output<
GoogleCloudDatacatalogV1SchemaResponse> -
Schema of the entry. An entry might not have any schema attached to it.
latefinal
-
serviceSpec
↔ Output<
GoogleCloudDatacatalogV1ServiceSpecResponse> -
Specification that applies to a Service resource.
latefinal
-
sourceSystemTimestamps
↔ Output<
GoogleCloudDatacatalogV1SystemTimestampsResponse> -
Timestamps from the underlying resource, not from the Data Catalog entry. Output only when the entry has a system listed in the
IntegratedSystemenum. For entries withuser_specified_system, this field is optional and defaults to an empty timestamp.latefinal -
sqlDatabaseSystemSpec
↔ Output<
GoogleCloudDatacatalogV1SqlDatabaseSystemSpecResponse> -
Specification that applies to a relational database system. Only settable when
user_specified_systemis equal toSQL_DATABASElatefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
type
↔ Output<
String> -
The type of the entry. For details, see
EntryType.latefinal -
urn
↔ Output<
String> -
latefinalinherited
-
usageSignal
↔ Output<
GoogleCloudDatacatalogV1UsageSignalResponse> -
Resource usage statistics.
latefinal
-
userSpecifiedSystem
↔ Output<
String> -
Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The
user_specified_systemstring 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.latefinal -
userSpecifiedType
↔ Output<
String> -
Custom entry type that doesn't match any of the values allowed for input and listed in the
EntryTypeenum. 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. Theuser_specified_typestring 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.latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited