/
entry.go
456 lines (399 loc) · 34.9 KB
/
entry.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
// Code generated by the Pulumi SDK Generator DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
package v1
import (
"context"
"reflect"
"errors"
"github.com/pulumi/pulumi-google-native/sdk/go/google/internal"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
// 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.
type Entry struct {
pulumi.CustomResourceState
// 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).
BigqueryDateShardedSpec GoogleCloudDatacatalogV1BigQueryDateShardedSpecResponseOutput `pulumi:"bigqueryDateShardedSpec"`
// Specification that applies to a BigQuery table. Valid only for entries with the `TABLE` type.
BigqueryTableSpec GoogleCloudDatacatalogV1BigQueryTableSpecResponseOutput `pulumi:"bigqueryTableSpec"`
// Business Context of the entry. Not supported for BigQuery datasets
BusinessContext GoogleCloudDatacatalogV1BusinessContextResponseOutput `pulumi:"businessContext"`
// Specification that applies to Cloud Bigtable system. Only settable when `integrated_system` is equal to `CLOUD_BIGTABLE`
CloudBigtableSystemSpec GoogleCloudDatacatalogV1CloudBigtableSystemSpecResponseOutput `pulumi:"cloudBigtableSystemSpec"`
// Physical location of the entry.
DataSource GoogleCloudDatacatalogV1DataSourceResponseOutput `pulumi:"dataSource"`
// Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type.
DataSourceConnectionSpec GoogleCloudDatacatalogV1DataSourceConnectionSpecResponseOutput `pulumi:"dataSourceConnectionSpec"`
// Specification that applies to a table resource. Valid only for entries with the `TABLE` or `EXPLORE` type.
DatabaseTableSpec GoogleCloudDatacatalogV1DatabaseTableSpecResponseOutput `pulumi:"databaseTableSpec"`
// Specification that applies to a dataset.
DatasetSpec GoogleCloudDatacatalogV1DatasetSpecResponseOutput `pulumi:"datasetSpec"`
// 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.StringOutput `pulumi:"description"`
// Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.
DisplayName pulumi.StringOutput `pulumi:"displayName"`
EntryGroupId pulumi.StringOutput `pulumi:"entryGroupId"`
// 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.StringOutput `pulumi:"entryId"`
// Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type.
FilesetSpec GoogleCloudDatacatalogV1FilesetSpecResponseOutput `pulumi:"filesetSpec"`
// [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.StringOutput `pulumi:"fullyQualifiedName"`
// Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type.
GcsFilesetSpec GoogleCloudDatacatalogV1GcsFilesetSpecResponseOutput `pulumi:"gcsFilesetSpec"`
// Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.
IntegratedSystem pulumi.StringOutput `pulumi:"integratedSystem"`
// 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.StringMapOutput `pulumi:"labels"`
// 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.StringOutput `pulumi:"linkedResource"`
Location pulumi.StringOutput `pulumi:"location"`
// Specification that applies to Looker sysstem. Only settable when `user_specified_system` is equal to `LOOKER`
LookerSystemSpec GoogleCloudDatacatalogV1LookerSystemSpecResponseOutput `pulumi:"lookerSystemSpec"`
// Model specification.
ModelSpec GoogleCloudDatacatalogV1ModelSpecResponseOutput `pulumi:"modelSpec"`
// 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.
Name pulumi.StringOutput `pulumi:"name"`
// Additional information related to the entry. Private to the current user.
PersonalDetails GoogleCloudDatacatalogV1PersonalDetailsResponseOutput `pulumi:"personalDetails"`
Project pulumi.StringOutput `pulumi:"project"`
// Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type.
RoutineSpec GoogleCloudDatacatalogV1RoutineSpecResponseOutput `pulumi:"routineSpec"`
// Schema of the entry. An entry might not have any schema attached to it.
Schema GoogleCloudDatacatalogV1SchemaResponseOutput `pulumi:"schema"`
// Specification that applies to a Service resource.
ServiceSpec GoogleCloudDatacatalogV1ServiceSpecResponseOutput `pulumi:"serviceSpec"`
// 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 GoogleCloudDatacatalogV1SystemTimestampsResponseOutput `pulumi:"sourceSystemTimestamps"`
// Specification that applies to a relational database system. Only settable when `user_specified_system` is equal to `SQL_DATABASE`
SqlDatabaseSystemSpec GoogleCloudDatacatalogV1SqlDatabaseSystemSpecResponseOutput `pulumi:"sqlDatabaseSystemSpec"`
// The type of the entry. For details, see [`EntryType`](#entrytype).
Type pulumi.StringOutput `pulumi:"type"`
// Resource usage statistics.
UsageSignal GoogleCloudDatacatalogV1UsageSignalResponseOutput `pulumi:"usageSignal"`
// 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.StringOutput `pulumi:"userSpecifiedSystem"`
// 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.StringOutput `pulumi:"userSpecifiedType"`
}
// NewEntry registers a new resource with the given unique name, arguments, and options.
func NewEntry(ctx *pulumi.Context,
name string, args *EntryArgs, opts ...pulumi.ResourceOption) (*Entry, error) {
if args == nil {
return nil, errors.New("missing one or more required arguments")
}
if args.EntryGroupId == nil {
return nil, errors.New("invalid value for required argument 'EntryGroupId'")
}
if args.EntryId == nil {
return nil, errors.New("invalid value for required argument 'EntryId'")
}
replaceOnChanges := pulumi.ReplaceOnChanges([]string{
"entryGroupId",
"entryId",
"location",
"project",
})
opts = append(opts, replaceOnChanges)
opts = internal.PkgResourceDefaultOpts(opts)
var resource Entry
err := ctx.RegisterResource("google-native:datacatalog/v1:Entry", name, args, &resource, opts...)
if err != nil {
return nil, err
}
return &resource, nil
}
// GetEntry gets an existing Entry resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetEntry(ctx *pulumi.Context,
name string, id pulumi.IDInput, state *EntryState, opts ...pulumi.ResourceOption) (*Entry, error) {
var resource Entry
err := ctx.ReadResource("google-native:datacatalog/v1:Entry", name, id, state, &resource, opts...)
if err != nil {
return nil, err
}
return &resource, nil
}
// Input properties used for looking up and filtering Entry resources.
type entryState struct {
}
type EntryState struct {
}
func (EntryState) ElementType() reflect.Type {
return reflect.TypeOf((*entryState)(nil)).Elem()
}
type entryArgs struct {
// Business Context of the entry. Not supported for BigQuery datasets
BusinessContext *GoogleCloudDatacatalogV1BusinessContext `pulumi:"businessContext"`
// Specification that applies to Cloud Bigtable system. Only settable when `integrated_system` is equal to `CLOUD_BIGTABLE`
CloudBigtableSystemSpec *GoogleCloudDatacatalogV1CloudBigtableSystemSpec `pulumi:"cloudBigtableSystemSpec"`
// Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type.
DataSourceConnectionSpec *GoogleCloudDatacatalogV1DataSourceConnectionSpec `pulumi:"dataSourceConnectionSpec"`
// Specification that applies to a table resource. Valid only for entries with the `TABLE` or `EXPLORE` type.
DatabaseTableSpec *GoogleCloudDatacatalogV1DatabaseTableSpec `pulumi:"databaseTableSpec"`
// Specification that applies to a dataset.
DatasetSpec *GoogleCloudDatacatalogV1DatasetSpec `pulumi:"datasetSpec"`
// 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 *string `pulumi:"description"`
// Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.
DisplayName *string `pulumi:"displayName"`
EntryGroupId string `pulumi:"entryGroupId"`
// 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 string `pulumi:"entryId"`
// Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type.
FilesetSpec *GoogleCloudDatacatalogV1FilesetSpec `pulumi:"filesetSpec"`
// [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 *string `pulumi:"fullyQualifiedName"`
// Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type.
GcsFilesetSpec *GoogleCloudDatacatalogV1GcsFilesetSpec `pulumi:"gcsFilesetSpec"`
// 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 map[string]string `pulumi:"labels"`
// 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 *string `pulumi:"linkedResource"`
Location *string `pulumi:"location"`
// Specification that applies to Looker sysstem. Only settable when `user_specified_system` is equal to `LOOKER`
LookerSystemSpec *GoogleCloudDatacatalogV1LookerSystemSpec `pulumi:"lookerSystemSpec"`
// Model specification.
ModelSpec *GoogleCloudDatacatalogV1ModelSpec `pulumi:"modelSpec"`
Project *string `pulumi:"project"`
// Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type.
RoutineSpec *GoogleCloudDatacatalogV1RoutineSpec `pulumi:"routineSpec"`
// Schema of the entry. An entry might not have any schema attached to it.
Schema *GoogleCloudDatacatalogV1Schema `pulumi:"schema"`
// Specification that applies to a Service resource.
ServiceSpec *GoogleCloudDatacatalogV1ServiceSpec `pulumi:"serviceSpec"`
// 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 *GoogleCloudDatacatalogV1SystemTimestamps `pulumi:"sourceSystemTimestamps"`
// Specification that applies to a relational database system. Only settable when `user_specified_system` is equal to `SQL_DATABASE`
SqlDatabaseSystemSpec *GoogleCloudDatacatalogV1SqlDatabaseSystemSpec `pulumi:"sqlDatabaseSystemSpec"`
// The type of the entry. For details, see [`EntryType`](#entrytype).
Type *EntryType `pulumi:"type"`
// Resource usage statistics.
UsageSignal *GoogleCloudDatacatalogV1UsageSignal `pulumi:"usageSignal"`
// 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 *string `pulumi:"userSpecifiedSystem"`
// 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 *string `pulumi:"userSpecifiedType"`
}
// The set of arguments for constructing a Entry resource.
type EntryArgs struct {
// Business Context of the entry. Not supported for BigQuery datasets
BusinessContext GoogleCloudDatacatalogV1BusinessContextPtrInput
// Specification that applies to Cloud Bigtable system. Only settable when `integrated_system` is equal to `CLOUD_BIGTABLE`
CloudBigtableSystemSpec GoogleCloudDatacatalogV1CloudBigtableSystemSpecPtrInput
// Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type.
DataSourceConnectionSpec GoogleCloudDatacatalogV1DataSourceConnectionSpecPtrInput
// Specification that applies to a table resource. Valid only for entries with the `TABLE` or `EXPLORE` type.
DatabaseTableSpec GoogleCloudDatacatalogV1DatabaseTableSpecPtrInput
// Specification that applies to a dataset.
DatasetSpec GoogleCloudDatacatalogV1DatasetSpecPtrInput
// 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.StringPtrInput
// Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.
DisplayName pulumi.StringPtrInput
EntryGroupId pulumi.StringInput
// 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.StringInput
// Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type.
FilesetSpec GoogleCloudDatacatalogV1FilesetSpecPtrInput
// [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.StringPtrInput
// Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type.
GcsFilesetSpec GoogleCloudDatacatalogV1GcsFilesetSpecPtrInput
// 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.StringMapInput
// 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.StringPtrInput
Location pulumi.StringPtrInput
// Specification that applies to Looker sysstem. Only settable when `user_specified_system` is equal to `LOOKER`
LookerSystemSpec GoogleCloudDatacatalogV1LookerSystemSpecPtrInput
// Model specification.
ModelSpec GoogleCloudDatacatalogV1ModelSpecPtrInput
Project pulumi.StringPtrInput
// Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type.
RoutineSpec GoogleCloudDatacatalogV1RoutineSpecPtrInput
// Schema of the entry. An entry might not have any schema attached to it.
Schema GoogleCloudDatacatalogV1SchemaPtrInput
// Specification that applies to a Service resource.
ServiceSpec GoogleCloudDatacatalogV1ServiceSpecPtrInput
// 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 GoogleCloudDatacatalogV1SystemTimestampsPtrInput
// Specification that applies to a relational database system. Only settable when `user_specified_system` is equal to `SQL_DATABASE`
SqlDatabaseSystemSpec GoogleCloudDatacatalogV1SqlDatabaseSystemSpecPtrInput
// The type of the entry. For details, see [`EntryType`](#entrytype).
Type EntryTypePtrInput
// Resource usage statistics.
UsageSignal GoogleCloudDatacatalogV1UsageSignalPtrInput
// 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.StringPtrInput
// 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.StringPtrInput
}
func (EntryArgs) ElementType() reflect.Type {
return reflect.TypeOf((*entryArgs)(nil)).Elem()
}
type EntryInput interface {
pulumi.Input
ToEntryOutput() EntryOutput
ToEntryOutputWithContext(ctx context.Context) EntryOutput
}
func (*Entry) ElementType() reflect.Type {
return reflect.TypeOf((**Entry)(nil)).Elem()
}
func (i *Entry) ToEntryOutput() EntryOutput {
return i.ToEntryOutputWithContext(context.Background())
}
func (i *Entry) ToEntryOutputWithContext(ctx context.Context) EntryOutput {
return pulumi.ToOutputWithContext(ctx, i).(EntryOutput)
}
type EntryOutput struct{ *pulumi.OutputState }
func (EntryOutput) ElementType() reflect.Type {
return reflect.TypeOf((**Entry)(nil)).Elem()
}
func (o EntryOutput) ToEntryOutput() EntryOutput {
return o
}
func (o EntryOutput) ToEntryOutputWithContext(ctx context.Context) EntryOutput {
return o
}
// 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).
func (o EntryOutput) BigqueryDateShardedSpec() GoogleCloudDatacatalogV1BigQueryDateShardedSpecResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1BigQueryDateShardedSpecResponseOutput {
return v.BigqueryDateShardedSpec
}).(GoogleCloudDatacatalogV1BigQueryDateShardedSpecResponseOutput)
}
// Specification that applies to a BigQuery table. Valid only for entries with the `TABLE` type.
func (o EntryOutput) BigqueryTableSpec() GoogleCloudDatacatalogV1BigQueryTableSpecResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1BigQueryTableSpecResponseOutput { return v.BigqueryTableSpec }).(GoogleCloudDatacatalogV1BigQueryTableSpecResponseOutput)
}
// Business Context of the entry. Not supported for BigQuery datasets
func (o EntryOutput) BusinessContext() GoogleCloudDatacatalogV1BusinessContextResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1BusinessContextResponseOutput { return v.BusinessContext }).(GoogleCloudDatacatalogV1BusinessContextResponseOutput)
}
// Specification that applies to Cloud Bigtable system. Only settable when `integrated_system` is equal to `CLOUD_BIGTABLE`
func (o EntryOutput) CloudBigtableSystemSpec() GoogleCloudDatacatalogV1CloudBigtableSystemSpecResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1CloudBigtableSystemSpecResponseOutput {
return v.CloudBigtableSystemSpec
}).(GoogleCloudDatacatalogV1CloudBigtableSystemSpecResponseOutput)
}
// Physical location of the entry.
func (o EntryOutput) DataSource() GoogleCloudDatacatalogV1DataSourceResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1DataSourceResponseOutput { return v.DataSource }).(GoogleCloudDatacatalogV1DataSourceResponseOutput)
}
// Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type.
func (o EntryOutput) DataSourceConnectionSpec() GoogleCloudDatacatalogV1DataSourceConnectionSpecResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1DataSourceConnectionSpecResponseOutput {
return v.DataSourceConnectionSpec
}).(GoogleCloudDatacatalogV1DataSourceConnectionSpecResponseOutput)
}
// Specification that applies to a table resource. Valid only for entries with the `TABLE` or `EXPLORE` type.
func (o EntryOutput) DatabaseTableSpec() GoogleCloudDatacatalogV1DatabaseTableSpecResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1DatabaseTableSpecResponseOutput { return v.DatabaseTableSpec }).(GoogleCloudDatacatalogV1DatabaseTableSpecResponseOutput)
}
// Specification that applies to a dataset.
func (o EntryOutput) DatasetSpec() GoogleCloudDatacatalogV1DatasetSpecResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1DatasetSpecResponseOutput { return v.DatasetSpec }).(GoogleCloudDatacatalogV1DatasetSpecResponseOutput)
}
// 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.
func (o EntryOutput) Description() pulumi.StringOutput {
return o.ApplyT(func(v *Entry) pulumi.StringOutput { return v.Description }).(pulumi.StringOutput)
}
// Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.
func (o EntryOutput) DisplayName() pulumi.StringOutput {
return o.ApplyT(func(v *Entry) pulumi.StringOutput { return v.DisplayName }).(pulumi.StringOutput)
}
func (o EntryOutput) EntryGroupId() pulumi.StringOutput {
return o.ApplyT(func(v *Entry) pulumi.StringOutput { return v.EntryGroupId }).(pulumi.StringOutput)
}
// 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.
func (o EntryOutput) EntryId() pulumi.StringOutput {
return o.ApplyT(func(v *Entry) pulumi.StringOutput { return v.EntryId }).(pulumi.StringOutput)
}
// Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type.
func (o EntryOutput) FilesetSpec() GoogleCloudDatacatalogV1FilesetSpecResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1FilesetSpecResponseOutput { return v.FilesetSpec }).(GoogleCloudDatacatalogV1FilesetSpecResponseOutput)
}
// [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.
func (o EntryOutput) FullyQualifiedName() pulumi.StringOutput {
return o.ApplyT(func(v *Entry) pulumi.StringOutput { return v.FullyQualifiedName }).(pulumi.StringOutput)
}
// Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type.
func (o EntryOutput) GcsFilesetSpec() GoogleCloudDatacatalogV1GcsFilesetSpecResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1GcsFilesetSpecResponseOutput { return v.GcsFilesetSpec }).(GoogleCloudDatacatalogV1GcsFilesetSpecResponseOutput)
}
// Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.
func (o EntryOutput) IntegratedSystem() pulumi.StringOutput {
return o.ApplyT(func(v *Entry) pulumi.StringOutput { return v.IntegratedSystem }).(pulumi.StringOutput)
}
// 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.
func (o EntryOutput) Labels() pulumi.StringMapOutput {
return o.ApplyT(func(v *Entry) pulumi.StringMapOutput { return v.Labels }).(pulumi.StringMapOutput)
}
// 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.
func (o EntryOutput) LinkedResource() pulumi.StringOutput {
return o.ApplyT(func(v *Entry) pulumi.StringOutput { return v.LinkedResource }).(pulumi.StringOutput)
}
func (o EntryOutput) Location() pulumi.StringOutput {
return o.ApplyT(func(v *Entry) pulumi.StringOutput { return v.Location }).(pulumi.StringOutput)
}
// Specification that applies to Looker sysstem. Only settable when `user_specified_system` is equal to `LOOKER`
func (o EntryOutput) LookerSystemSpec() GoogleCloudDatacatalogV1LookerSystemSpecResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1LookerSystemSpecResponseOutput { return v.LookerSystemSpec }).(GoogleCloudDatacatalogV1LookerSystemSpecResponseOutput)
}
// Model specification.
func (o EntryOutput) ModelSpec() GoogleCloudDatacatalogV1ModelSpecResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1ModelSpecResponseOutput { return v.ModelSpec }).(GoogleCloudDatacatalogV1ModelSpecResponseOutput)
}
// 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.
func (o EntryOutput) Name() pulumi.StringOutput {
return o.ApplyT(func(v *Entry) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}
// Additional information related to the entry. Private to the current user.
func (o EntryOutput) PersonalDetails() GoogleCloudDatacatalogV1PersonalDetailsResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1PersonalDetailsResponseOutput { return v.PersonalDetails }).(GoogleCloudDatacatalogV1PersonalDetailsResponseOutput)
}
func (o EntryOutput) Project() pulumi.StringOutput {
return o.ApplyT(func(v *Entry) pulumi.StringOutput { return v.Project }).(pulumi.StringOutput)
}
// Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type.
func (o EntryOutput) RoutineSpec() GoogleCloudDatacatalogV1RoutineSpecResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1RoutineSpecResponseOutput { return v.RoutineSpec }).(GoogleCloudDatacatalogV1RoutineSpecResponseOutput)
}
// Schema of the entry. An entry might not have any schema attached to it.
func (o EntryOutput) Schema() GoogleCloudDatacatalogV1SchemaResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1SchemaResponseOutput { return v.Schema }).(GoogleCloudDatacatalogV1SchemaResponseOutput)
}
// Specification that applies to a Service resource.
func (o EntryOutput) ServiceSpec() GoogleCloudDatacatalogV1ServiceSpecResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1ServiceSpecResponseOutput { return v.ServiceSpec }).(GoogleCloudDatacatalogV1ServiceSpecResponseOutput)
}
// 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.
func (o EntryOutput) SourceSystemTimestamps() GoogleCloudDatacatalogV1SystemTimestampsResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1SystemTimestampsResponseOutput { return v.SourceSystemTimestamps }).(GoogleCloudDatacatalogV1SystemTimestampsResponseOutput)
}
// Specification that applies to a relational database system. Only settable when `user_specified_system` is equal to `SQL_DATABASE`
func (o EntryOutput) SqlDatabaseSystemSpec() GoogleCloudDatacatalogV1SqlDatabaseSystemSpecResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1SqlDatabaseSystemSpecResponseOutput {
return v.SqlDatabaseSystemSpec
}).(GoogleCloudDatacatalogV1SqlDatabaseSystemSpecResponseOutput)
}
// The type of the entry. For details, see [`EntryType`](#entrytype).
func (o EntryOutput) Type() pulumi.StringOutput {
return o.ApplyT(func(v *Entry) pulumi.StringOutput { return v.Type }).(pulumi.StringOutput)
}
// Resource usage statistics.
func (o EntryOutput) UsageSignal() GoogleCloudDatacatalogV1UsageSignalResponseOutput {
return o.ApplyT(func(v *Entry) GoogleCloudDatacatalogV1UsageSignalResponseOutput { return v.UsageSignal }).(GoogleCloudDatacatalogV1UsageSignalResponseOutput)
}
// 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.
func (o EntryOutput) UserSpecifiedSystem() pulumi.StringOutput {
return o.ApplyT(func(v *Entry) pulumi.StringOutput { return v.UserSpecifiedSystem }).(pulumi.StringOutput)
}
// 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.
func (o EntryOutput) UserSpecifiedType() pulumi.StringOutput {
return o.ApplyT(func(v *Entry) pulumi.StringOutput { return v.UserSpecifiedType }).(pulumi.StringOutput)
}
func init() {
pulumi.RegisterInputType(reflect.TypeOf((*EntryInput)(nil)).Elem(), &Entry{})
pulumi.RegisterOutputType(EntryOutput{})
}