Class Entry

Entry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of Google Cloud Platform. Clients can use the linkedResource field in the Entry resource to refer to the original resource ID of the source system.

An Entry resource contains resource details, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag.

To get more information about Entry, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage - Data Catalog Entry Basic

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var entryGroup = new Gcp.DataCatalog.EntryGroup("entryGroup", new Gcp.DataCatalog.EntryGroupArgs
    {
        EntryGroupId = "my_group",
    });
    var basicEntry = new Gcp.DataCatalog.Entry("basicEntry", new Gcp.DataCatalog.EntryArgs
    {
        EntryGroup = entryGroup.Id,
        EntryId = "my_entry",
        UserSpecifiedType = "my_custom_type",
        UserSpecifiedSystem = "SomethingExternal",
    });
}

}

Example Usage - Data Catalog Entry Full

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var entryGroup = new Gcp.DataCatalog.EntryGroup("entryGroup", new Gcp.DataCatalog.EntryGroupArgs
    {
        EntryGroupId = "my_group",
    });
    var basicEntry = new Gcp.DataCatalog.Entry("basicEntry", new Gcp.DataCatalog.EntryArgs
    {
        EntryGroup = entryGroup.Id,
        EntryId = "my_entry",
        UserSpecifiedType = "my_user_specified_type",
        UserSpecifiedSystem = "Something_custom",
        LinkedResource = "my/linked/resource",
        DisplayName = "my custom type entry",
        Description = "a custom type entry for a user specified system",
        Schema = @"{
""columns"": [
{
  ""column"": ""first_name"",
  ""description"": ""First name"",
  ""mode"": ""REQUIRED"",
  ""type"": ""STRING""
},
{
  ""column"": ""last_name"",
  ""description"": ""Last name"",
  ""mode"": ""REQUIRED"",
  ""type"": ""STRING""
},
{
  ""column"": ""address"",
  ""description"": ""Address"",
  ""mode"": ""REPEATED"",
  ""subcolumns"": [
    {
      ""column"": ""city"",
      ""description"": ""City"",
      ""mode"": ""NULLABLE"",
      ""type"": ""STRING""
    },
    {
      ""column"": ""state"",
      ""description"": ""State"",
      ""mode"": ""NULLABLE"",
      ""type"": ""STRING""
    }
  ],
  ""type"": ""RECORD""
}
]
}
",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Entry

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.DataCatalog

Assembly: Pulumi.Gcp.dll

Syntax

public class Entry : CustomResource

Constructors

Entry(String, EntryArgs, CustomResourceOptions)

Create a Entry resource with the given unique name, arguments, and options.

Declaration

public Entry(string name, EntryArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
EntryArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

BigqueryDateShardedSpec

Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.

Declaration

public Output<EntryBigqueryDateShardedSpec> BigqueryDateShardedSpec { get; }

Property Value

Type	Description
Output<EntryBigqueryDateShardedSpec>

BigqueryTableSpec

Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

Declaration

public Output<EntryBigqueryTableSpec> BigqueryTableSpec { get; }

Property Value

Type	Description
Output<EntryBigqueryTableSpec>

Description

Entry description, which can consist of several sentences or paragraphs that describe entry contents.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

DisplayName

Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011".

Declaration

public Output<string> DisplayName { get; }

Property Value

Type	Description
Output<System.String>

EntryGroup

The name of the entry group this entry is in.

Declaration

public Output<string> EntryGroup { get; }

Property Value

Type	Description
Output<System.String>

EntryId

The id of the entry to create.

Declaration

public Output<string> EntryId { get; }

Property Value

Type	Description
Output<System.String>

GcsFilesetSpec

Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.

Declaration

public Output<EntryGcsFilesetSpec> GcsFilesetSpec { get; }

Property Value

Type	Description
Output<EntryGcsFilesetSpec>

IntegratedSystem

This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.

Declaration

public Output<string> IntegratedSystem { get; }

Property Value

Type	Description
Output<System.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.

Declaration

public Output<string> LinkedResource { get; }

Property Value

Type	Description
Output<System.String>

Name

The Data Catalog resource name of the entry in URL format. Example: projects/{project_id}/locations/{location}/entryGroups/{entryGroupId}/entries/{entryId}. Note that this Entry and its child resources may not actually be stored in the location in this name.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.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.

Declaration

public Output<string> Schema { get; }

Property Value

Type	Description
Output<System.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.

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.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.

Declaration

public Output<string> UserSpecifiedSystem { get; }

Property Value

Type	Description
Output<System.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.

Declaration

public Output<string> UserSpecifiedType { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, EntryState, CustomResourceOptions)

Get an existing Entry resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Entry Get(string name, Input<string> id, EntryState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
EntryState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Entry