1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. datacatalog
  5. Entry
Google Cloud Classic v7.16.0 published on Wednesday, Mar 27, 2024 by Pulumi

gcp.datacatalog.Entry

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.16.0 published on Wednesday, Mar 27, 2024 by Pulumi

    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:

    Example Usage

    Data Catalog Entry Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const entryGroup = new gcp.datacatalog.EntryGroup("entry_group", {entryGroupId: "my_group"});
    const basicEntry = new gcp.datacatalog.Entry("basic_entry", {
        entryGroup: entryGroup.id,
        entryId: "my_entry",
        userSpecifiedType: "my_custom_type",
        userSpecifiedSystem: "SomethingExternal",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    entry_group = gcp.datacatalog.EntryGroup("entry_group", entry_group_id="my_group")
    basic_entry = gcp.datacatalog.Entry("basic_entry",
        entry_group=entry_group.id,
        entry_id="my_entry",
        user_specified_type="my_custom_type",
        user_specified_system="SomethingExternal")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/datacatalog"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		entryGroup, err := datacatalog.NewEntryGroup(ctx, "entry_group", &datacatalog.EntryGroupArgs{
    			EntryGroupId: pulumi.String("my_group"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datacatalog.NewEntry(ctx, "basic_entry", &datacatalog.EntryArgs{
    			EntryGroup:          entryGroup.ID(),
    			EntryId:             pulumi.String("my_entry"),
    			UserSpecifiedType:   pulumi.String("my_custom_type"),
    			UserSpecifiedSystem: pulumi.String("SomethingExternal"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var entryGroup = new Gcp.DataCatalog.EntryGroup("entry_group", new()
        {
            EntryGroupId = "my_group",
        });
    
        var basicEntry = new Gcp.DataCatalog.Entry("basic_entry", new()
        {
            EntryGroup = entryGroup.Id,
            EntryId = "my_entry",
            UserSpecifiedType = "my_custom_type",
            UserSpecifiedSystem = "SomethingExternal",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.datacatalog.EntryGroup;
    import com.pulumi.gcp.datacatalog.EntryGroupArgs;
    import com.pulumi.gcp.datacatalog.Entry;
    import com.pulumi.gcp.datacatalog.EntryArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var entryGroup = new EntryGroup("entryGroup", EntryGroupArgs.builder()        
                .entryGroupId("my_group")
                .build());
    
            var basicEntry = new Entry("basicEntry", EntryArgs.builder()        
                .entryGroup(entryGroup.id())
                .entryId("my_entry")
                .userSpecifiedType("my_custom_type")
                .userSpecifiedSystem("SomethingExternal")
                .build());
    
        }
    }
    
    resources:
      basicEntry:
        type: gcp:datacatalog:Entry
        name: basic_entry
        properties:
          entryGroup: ${entryGroup.id}
          entryId: my_entry
          userSpecifiedType: my_custom_type
          userSpecifiedSystem: SomethingExternal
      entryGroup:
        type: gcp:datacatalog:EntryGroup
        name: entry_group
        properties:
          entryGroupId: my_group
    

    Data Catalog Entry Fileset

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const entryGroup = new gcp.datacatalog.EntryGroup("entry_group", {entryGroupId: "my_group"});
    const basicEntry = new gcp.datacatalog.Entry("basic_entry", {
        entryGroup: entryGroup.id,
        entryId: "my_entry",
        type: "FILESET",
        gcsFilesetSpec: {
            filePatterns: ["gs://fake_bucket/dir/*"],
        },
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    entry_group = gcp.datacatalog.EntryGroup("entry_group", entry_group_id="my_group")
    basic_entry = gcp.datacatalog.Entry("basic_entry",
        entry_group=entry_group.id,
        entry_id="my_entry",
        type="FILESET",
        gcs_fileset_spec=gcp.datacatalog.EntryGcsFilesetSpecArgs(
            file_patterns=["gs://fake_bucket/dir/*"],
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/datacatalog"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		entryGroup, err := datacatalog.NewEntryGroup(ctx, "entry_group", &datacatalog.EntryGroupArgs{
    			EntryGroupId: pulumi.String("my_group"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datacatalog.NewEntry(ctx, "basic_entry", &datacatalog.EntryArgs{
    			EntryGroup: entryGroup.ID(),
    			EntryId:    pulumi.String("my_entry"),
    			Type:       pulumi.String("FILESET"),
    			GcsFilesetSpec: &datacatalog.EntryGcsFilesetSpecArgs{
    				FilePatterns: pulumi.StringArray{
    					pulumi.String("gs://fake_bucket/dir/*"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var entryGroup = new Gcp.DataCatalog.EntryGroup("entry_group", new()
        {
            EntryGroupId = "my_group",
        });
    
        var basicEntry = new Gcp.DataCatalog.Entry("basic_entry", new()
        {
            EntryGroup = entryGroup.Id,
            EntryId = "my_entry",
            Type = "FILESET",
            GcsFilesetSpec = new Gcp.DataCatalog.Inputs.EntryGcsFilesetSpecArgs
            {
                FilePatterns = new[]
                {
                    "gs://fake_bucket/dir/*",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.datacatalog.EntryGroup;
    import com.pulumi.gcp.datacatalog.EntryGroupArgs;
    import com.pulumi.gcp.datacatalog.Entry;
    import com.pulumi.gcp.datacatalog.EntryArgs;
    import com.pulumi.gcp.datacatalog.inputs.EntryGcsFilesetSpecArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var entryGroup = new EntryGroup("entryGroup", EntryGroupArgs.builder()        
                .entryGroupId("my_group")
                .build());
    
            var basicEntry = new Entry("basicEntry", EntryArgs.builder()        
                .entryGroup(entryGroup.id())
                .entryId("my_entry")
                .type("FILESET")
                .gcsFilesetSpec(EntryGcsFilesetSpecArgs.builder()
                    .filePatterns("gs://fake_bucket/dir/*")
                    .build())
                .build());
    
        }
    }
    
    resources:
      basicEntry:
        type: gcp:datacatalog:Entry
        name: basic_entry
        properties:
          entryGroup: ${entryGroup.id}
          entryId: my_entry
          type: FILESET
          gcsFilesetSpec:
            filePatterns:
              - gs://fake_bucket/dir/*
      entryGroup:
        type: gcp:datacatalog:EntryGroup
        name: entry_group
        properties:
          entryGroupId: my_group
    

    Data Catalog Entry Full

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const entryGroup = new gcp.datacatalog.EntryGroup("entry_group", {entryGroupId: "my_group"});
    const basicEntry = new gcp.datacatalog.Entry("basic_entry", {
        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"
        }
      ]
    }
    `,
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    entry_group = gcp.datacatalog.EntryGroup("entry_group", entry_group_id="my_group")
    basic_entry = gcp.datacatalog.Entry("basic_entry",
        entry_group=entry_group.id,
        entry_id="my_entry",
        user_specified_type="my_user_specified_type",
        user_specified_system="Something_custom",
        linked_resource="my/linked/resource",
        display_name="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"
        }
      ]
    }
    """)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/datacatalog"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		entryGroup, err := datacatalog.NewEntryGroup(ctx, "entry_group", &datacatalog.EntryGroupArgs{
    			EntryGroupId: pulumi.String("my_group"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datacatalog.NewEntry(ctx, "basic_entry", &datacatalog.EntryArgs{
    			EntryGroup:          entryGroup.ID(),
    			EntryId:             pulumi.String("my_entry"),
    			UserSpecifiedType:   pulumi.String("my_user_specified_type"),
    			UserSpecifiedSystem: pulumi.String("Something_custom"),
    			LinkedResource:      pulumi.String("my/linked/resource"),
    			DisplayName:         pulumi.String("my custom type entry"),
    			Description:         pulumi.String("a custom type entry for a user specified system"),
    			Schema: pulumi.String(`{
      "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"
        }
      ]
    }
    `),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var entryGroup = new Gcp.DataCatalog.EntryGroup("entry_group", new()
        {
            EntryGroupId = "my_group",
        });
    
        var basicEntry = new Gcp.DataCatalog.Entry("basic_entry", new()
        {
            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""
        }
      ]
    }
    ",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.datacatalog.EntryGroup;
    import com.pulumi.gcp.datacatalog.EntryGroupArgs;
    import com.pulumi.gcp.datacatalog.Entry;
    import com.pulumi.gcp.datacatalog.EntryArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var entryGroup = new EntryGroup("entryGroup", EntryGroupArgs.builder()        
                .entryGroupId("my_group")
                .build());
    
            var basicEntry = new Entry("basicEntry", EntryArgs.builder()        
                .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"
        }
      ]
    }
                """)
                .build());
    
        }
    }
    
    resources:
      basicEntry:
        type: gcp:datacatalog:Entry
        name: basic_entry
        properties:
          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"
                }
              ]
            }        
      entryGroup:
        type: gcp:datacatalog:EntryGroup
        name: entry_group
        properties:
          entryGroupId: my_group
    

    Create Entry Resource

    new Entry(name: string, args: EntryArgs, opts?: CustomResourceOptions);
    @overload
    def Entry(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              description: Optional[str] = None,
              display_name: Optional[str] = None,
              entry_group: Optional[str] = None,
              entry_id: Optional[str] = None,
              gcs_fileset_spec: Optional[EntryGcsFilesetSpecArgs] = None,
              linked_resource: Optional[str] = None,
              schema: Optional[str] = None,
              type: Optional[str] = None,
              user_specified_system: Optional[str] = None,
              user_specified_type: Optional[str] = None)
    @overload
    def Entry(resource_name: str,
              args: EntryArgs,
              opts: Optional[ResourceOptions] = None)
    func NewEntry(ctx *Context, name string, args EntryArgs, opts ...ResourceOption) (*Entry, error)
    public Entry(string name, EntryArgs args, CustomResourceOptions? opts = null)
    public Entry(String name, EntryArgs args)
    public Entry(String name, EntryArgs args, CustomResourceOptions options)
    
    type: gcp:datacatalog:Entry
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args EntryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EntryArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EntryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EntryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EntryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Entry Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Entry resource accepts the following input properties:

    EntryGroup string
    The name of the entry group this entry is in.
    EntryId string
    The id of the entry to create.


    Description string
    Entry description, which can consist of several sentences or paragraphs that describe entry contents.
    DisplayName string
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011".
    GcsFilesetSpec EntryGcsFilesetSpec
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.
    LinkedResource string
    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.
    Schema string
    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.
    Type string
    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 are: FILESET.
    UserSpecifiedSystem string
    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.
    UserSpecifiedType string
    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.
    EntryGroup string
    The name of the entry group this entry is in.
    EntryId string
    The id of the entry to create.


    Description string
    Entry description, which can consist of several sentences or paragraphs that describe entry contents.
    DisplayName string
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011".
    GcsFilesetSpec EntryGcsFilesetSpecArgs
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.
    LinkedResource string
    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.
    Schema string
    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.
    Type string
    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 are: FILESET.
    UserSpecifiedSystem string
    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.
    UserSpecifiedType string
    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.
    entryGroup String
    The name of the entry group this entry is in.
    entryId String
    The id of the entry to create.


    description String
    Entry description, which can consist of several sentences or paragraphs that describe entry contents.
    displayName String
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011".
    gcsFilesetSpec EntryGcsFilesetSpec
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.
    linkedResource String
    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.
    schema String
    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.
    type String
    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 are: FILESET.
    userSpecifiedSystem String
    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.
    userSpecifiedType String
    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.
    entryGroup string
    The name of the entry group this entry is in.
    entryId string
    The id of the entry to create.


    description string
    Entry description, which can consist of several sentences or paragraphs that describe entry contents.
    displayName string
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011".
    gcsFilesetSpec EntryGcsFilesetSpec
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.
    linkedResource string
    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.
    schema string
    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.
    type string
    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 are: FILESET.
    userSpecifiedSystem string
    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.
    userSpecifiedType string
    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.
    entry_group str
    The name of the entry group this entry is in.
    entry_id str
    The id of the entry to create.


    description str
    Entry description, which can consist of several sentences or paragraphs that describe entry contents.
    display_name str
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011".
    gcs_fileset_spec EntryGcsFilesetSpecArgs
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.
    linked_resource str
    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.
    schema str
    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.
    type str
    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 are: FILESET.
    user_specified_system str
    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.
    user_specified_type str
    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.
    entryGroup String
    The name of the entry group this entry is in.
    entryId String
    The id of the entry to create.


    description String
    Entry description, which can consist of several sentences or paragraphs that describe entry contents.
    displayName String
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011".
    gcsFilesetSpec Property Map
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.
    linkedResource String
    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.
    schema String
    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.
    type String
    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 are: FILESET.
    userSpecifiedSystem String
    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.
    userSpecifiedType String
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Entry resource produces the following output properties:

    BigqueryDateShardedSpecs List<EntryBigqueryDateShardedSpec>
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding. Structure is documented below.
    BigqueryTableSpecs List<EntryBigqueryTableSpec>
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE. Structure is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    IntegratedSystem string
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    Name string
    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.
    BigqueryDateShardedSpecs []EntryBigqueryDateShardedSpec
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding. Structure is documented below.
    BigqueryTableSpecs []EntryBigqueryTableSpec
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE. Structure is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    IntegratedSystem string
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    Name string
    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.
    bigqueryDateShardedSpecs List<EntryBigqueryDateShardedSpec>
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding. Structure is documented below.
    bigqueryTableSpecs List<EntryBigqueryTableSpec>
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE. Structure is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    integratedSystem String
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    name String
    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.
    bigqueryDateShardedSpecs EntryBigqueryDateShardedSpec[]
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding. Structure is documented below.
    bigqueryTableSpecs EntryBigqueryTableSpec[]
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE. Structure is documented below.
    id string
    The provider-assigned unique ID for this managed resource.
    integratedSystem string
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    name string
    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.
    bigquery_date_sharded_specs Sequence[EntryBigqueryDateShardedSpec]
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding. Structure is documented below.
    bigquery_table_specs Sequence[EntryBigqueryTableSpec]
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE. Structure is documented below.
    id str
    The provider-assigned unique ID for this managed resource.
    integrated_system str
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    name str
    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.
    bigqueryDateShardedSpecs List<Property Map>
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding. Structure is documented below.
    bigqueryTableSpecs List<Property Map>
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE. Structure is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    integratedSystem String
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    name String
    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.

    Look up Existing Entry Resource

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

    public static get(name: string, id: Input<ID>, state?: EntryState, opts?: CustomResourceOptions): Entry
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bigquery_date_sharded_specs: Optional[Sequence[EntryBigqueryDateShardedSpecArgs]] = None,
            bigquery_table_specs: Optional[Sequence[EntryBigqueryTableSpecArgs]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            entry_group: Optional[str] = None,
            entry_id: Optional[str] = None,
            gcs_fileset_spec: Optional[EntryGcsFilesetSpecArgs] = None,
            integrated_system: Optional[str] = None,
            linked_resource: Optional[str] = None,
            name: Optional[str] = None,
            schema: Optional[str] = None,
            type: Optional[str] = None,
            user_specified_system: Optional[str] = None,
            user_specified_type: Optional[str] = None) -> Entry
    func GetEntry(ctx *Context, name string, id IDInput, state *EntryState, opts ...ResourceOption) (*Entry, error)
    public static Entry Get(string name, Input<string> id, EntryState? state, CustomResourceOptions? opts = null)
    public static Entry get(String name, Output<String> id, EntryState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BigqueryDateShardedSpecs List<EntryBigqueryDateShardedSpec>
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding. Structure is documented below.
    BigqueryTableSpecs List<EntryBigqueryTableSpec>
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE. Structure is documented below.
    Description string
    Entry description, which can consist of several sentences or paragraphs that describe entry contents.
    DisplayName string
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011".
    EntryGroup string
    The name of the entry group this entry is in.
    EntryId string
    The id of the entry to create.


    GcsFilesetSpec EntryGcsFilesetSpec
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.
    IntegratedSystem string
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    LinkedResource string
    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.
    Name string
    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.
    Schema string
    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.
    Type string
    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 are: FILESET.
    UserSpecifiedSystem string
    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.
    UserSpecifiedType string
    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.
    BigqueryDateShardedSpecs []EntryBigqueryDateShardedSpecArgs
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding. Structure is documented below.
    BigqueryTableSpecs []EntryBigqueryTableSpecArgs
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE. Structure is documented below.
    Description string
    Entry description, which can consist of several sentences or paragraphs that describe entry contents.
    DisplayName string
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011".
    EntryGroup string
    The name of the entry group this entry is in.
    EntryId string
    The id of the entry to create.


    GcsFilesetSpec EntryGcsFilesetSpecArgs
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.
    IntegratedSystem string
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    LinkedResource string
    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.
    Name string
    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.
    Schema string
    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.
    Type string
    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 are: FILESET.
    UserSpecifiedSystem string
    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.
    UserSpecifiedType string
    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.
    bigqueryDateShardedSpecs List<EntryBigqueryDateShardedSpec>
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding. Structure is documented below.
    bigqueryTableSpecs List<EntryBigqueryTableSpec>
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE. Structure is documented below.
    description String
    Entry description, which can consist of several sentences or paragraphs that describe entry contents.
    displayName String
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011".
    entryGroup String
    The name of the entry group this entry is in.
    entryId String
    The id of the entry to create.


    gcsFilesetSpec EntryGcsFilesetSpec
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.
    integratedSystem String
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    linkedResource String
    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.
    name String
    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.
    schema String
    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.
    type String
    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 are: FILESET.
    userSpecifiedSystem String
    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.
    userSpecifiedType String
    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.
    bigqueryDateShardedSpecs EntryBigqueryDateShardedSpec[]
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding. Structure is documented below.
    bigqueryTableSpecs EntryBigqueryTableSpec[]
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE. Structure is documented below.
    description string
    Entry description, which can consist of several sentences or paragraphs that describe entry contents.
    displayName string
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011".
    entryGroup string
    The name of the entry group this entry is in.
    entryId string
    The id of the entry to create.


    gcsFilesetSpec EntryGcsFilesetSpec
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.
    integratedSystem string
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    linkedResource string
    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.
    name string
    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.
    schema string
    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.
    type string
    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 are: FILESET.
    userSpecifiedSystem string
    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.
    userSpecifiedType string
    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.
    bigquery_date_sharded_specs Sequence[EntryBigqueryDateShardedSpecArgs]
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding. Structure is documented below.
    bigquery_table_specs Sequence[EntryBigqueryTableSpecArgs]
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE. Structure is documented below.
    description str
    Entry description, which can consist of several sentences or paragraphs that describe entry contents.
    display_name str
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011".
    entry_group str
    The name of the entry group this entry is in.
    entry_id str
    The id of the entry to create.


    gcs_fileset_spec EntryGcsFilesetSpecArgs
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.
    integrated_system str
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    linked_resource str
    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.
    name str
    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.
    schema str
    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.
    type str
    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 are: FILESET.
    user_specified_system str
    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.
    user_specified_type str
    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.
    bigqueryDateShardedSpecs List<Property Map>
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding. Structure is documented below.
    bigqueryTableSpecs List<Property Map>
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE. Structure is documented below.
    description String
    Entry description, which can consist of several sentences or paragraphs that describe entry contents.
    displayName String
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011".
    entryGroup String
    The name of the entry group this entry is in.
    entryId String
    The id of the entry to create.


    gcsFilesetSpec Property Map
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.
    integratedSystem String
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    linkedResource String
    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.
    name String
    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.
    schema String
    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.
    type String
    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 are: FILESET.
    userSpecifiedSystem String
    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.
    userSpecifiedType String
    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.

    Supporting Types

    EntryBigqueryDateShardedSpec, EntryBigqueryDateShardedSpecArgs

    Dataset string
    (Output) The Data Catalog resource name of the dataset entry the current table belongs to, for example, projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}
    ShardCount int
    (Output) Total number of shards.
    TablePrefix string
    (Output) The table name prefix of the shards. The name of any given shard is [tablePrefix]YYYYMMDD, for example, for shard MyTable20180101, the tablePrefix is MyTable.
    Dataset string
    (Output) The Data Catalog resource name of the dataset entry the current table belongs to, for example, projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}
    ShardCount int
    (Output) Total number of shards.
    TablePrefix string
    (Output) The table name prefix of the shards. The name of any given shard is [tablePrefix]YYYYMMDD, for example, for shard MyTable20180101, the tablePrefix is MyTable.
    dataset String
    (Output) The Data Catalog resource name of the dataset entry the current table belongs to, for example, projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}
    shardCount Integer
    (Output) Total number of shards.
    tablePrefix String
    (Output) The table name prefix of the shards. The name of any given shard is [tablePrefix]YYYYMMDD, for example, for shard MyTable20180101, the tablePrefix is MyTable.
    dataset string
    (Output) The Data Catalog resource name of the dataset entry the current table belongs to, for example, projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}
    shardCount number
    (Output) Total number of shards.
    tablePrefix string
    (Output) The table name prefix of the shards. The name of any given shard is [tablePrefix]YYYYMMDD, for example, for shard MyTable20180101, the tablePrefix is MyTable.
    dataset str
    (Output) The Data Catalog resource name of the dataset entry the current table belongs to, for example, projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}
    shard_count int
    (Output) Total number of shards.
    table_prefix str
    (Output) The table name prefix of the shards. The name of any given shard is [tablePrefix]YYYYMMDD, for example, for shard MyTable20180101, the tablePrefix is MyTable.
    dataset String
    (Output) The Data Catalog resource name of the dataset entry the current table belongs to, for example, projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}
    shardCount Number
    (Output) Total number of shards.
    tablePrefix String
    (Output) The table name prefix of the shards. The name of any given shard is [tablePrefix]YYYYMMDD, for example, for shard MyTable20180101, the tablePrefix is MyTable.

    EntryBigqueryTableSpec, EntryBigqueryTableSpecArgs

    TableSourceType string
    (Output) The table source type.
    TableSpecs List<EntryBigqueryTableSpecTableSpec>
    (Output) Spec of a BigQuery table. This field should only be populated if tableSourceType is BIGQUERY_TABLE. Structure is documented below.
    ViewSpecs List<EntryBigqueryTableSpecViewSpec>
    (Output) Table view specification. This field should only be populated if tableSourceType is BIGQUERY_VIEW. Structure is documented below.
    TableSourceType string
    (Output) The table source type.
    TableSpecs []EntryBigqueryTableSpecTableSpec
    (Output) Spec of a BigQuery table. This field should only be populated if tableSourceType is BIGQUERY_TABLE. Structure is documented below.
    ViewSpecs []EntryBigqueryTableSpecViewSpec
    (Output) Table view specification. This field should only be populated if tableSourceType is BIGQUERY_VIEW. Structure is documented below.
    tableSourceType String
    (Output) The table source type.
    tableSpecs List<EntryBigqueryTableSpecTableSpec>
    (Output) Spec of a BigQuery table. This field should only be populated if tableSourceType is BIGQUERY_TABLE. Structure is documented below.
    viewSpecs List<EntryBigqueryTableSpecViewSpec>
    (Output) Table view specification. This field should only be populated if tableSourceType is BIGQUERY_VIEW. Structure is documented below.
    tableSourceType string
    (Output) The table source type.
    tableSpecs EntryBigqueryTableSpecTableSpec[]
    (Output) Spec of a BigQuery table. This field should only be populated if tableSourceType is BIGQUERY_TABLE. Structure is documented below.
    viewSpecs EntryBigqueryTableSpecViewSpec[]
    (Output) Table view specification. This field should only be populated if tableSourceType is BIGQUERY_VIEW. Structure is documented below.
    table_source_type str
    (Output) The table source type.
    table_specs Sequence[EntryBigqueryTableSpecTableSpec]
    (Output) Spec of a BigQuery table. This field should only be populated if tableSourceType is BIGQUERY_TABLE. Structure is documented below.
    view_specs Sequence[EntryBigqueryTableSpecViewSpec]
    (Output) Table view specification. This field should only be populated if tableSourceType is BIGQUERY_VIEW. Structure is documented below.
    tableSourceType String
    (Output) The table source type.
    tableSpecs List<Property Map>
    (Output) Spec of a BigQuery table. This field should only be populated if tableSourceType is BIGQUERY_TABLE. Structure is documented below.
    viewSpecs List<Property Map>
    (Output) Table view specification. This field should only be populated if tableSourceType is BIGQUERY_VIEW. Structure is documented below.

    EntryBigqueryTableSpecTableSpec, EntryBigqueryTableSpecTableSpecArgs

    GroupedEntry string
    (Output) If the table is a dated shard, i.e., with name pattern [prefix]YYYYMMDD, groupedEntry is the Data Catalog resource name of the date sharded grouped entry, for example, projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}. Otherwise, groupedEntry is empty.
    GroupedEntry string
    (Output) If the table is a dated shard, i.e., with name pattern [prefix]YYYYMMDD, groupedEntry is the Data Catalog resource name of the date sharded grouped entry, for example, projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}. Otherwise, groupedEntry is empty.
    groupedEntry String
    (Output) If the table is a dated shard, i.e., with name pattern [prefix]YYYYMMDD, groupedEntry is the Data Catalog resource name of the date sharded grouped entry, for example, projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}. Otherwise, groupedEntry is empty.
    groupedEntry string
    (Output) If the table is a dated shard, i.e., with name pattern [prefix]YYYYMMDD, groupedEntry is the Data Catalog resource name of the date sharded grouped entry, for example, projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}. Otherwise, groupedEntry is empty.
    grouped_entry str
    (Output) If the table is a dated shard, i.e., with name pattern [prefix]YYYYMMDD, groupedEntry is the Data Catalog resource name of the date sharded grouped entry, for example, projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}. Otherwise, groupedEntry is empty.
    groupedEntry String
    (Output) If the table is a dated shard, i.e., with name pattern [prefix]YYYYMMDD, groupedEntry is the Data Catalog resource name of the date sharded grouped entry, for example, projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}. Otherwise, groupedEntry is empty.

    EntryBigqueryTableSpecViewSpec, EntryBigqueryTableSpecViewSpecArgs

    ViewQuery string
    (Output) The query that defines the table view.
    ViewQuery string
    (Output) The query that defines the table view.
    viewQuery String
    (Output) The query that defines the table view.
    viewQuery string
    (Output) The query that defines the table view.
    view_query str
    (Output) The query that defines the table view.
    viewQuery String
    (Output) The query that defines the table view.

    EntryGcsFilesetSpec, EntryGcsFilesetSpecArgs

    FilePatterns List<string>
    Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid filePatterns:

    • gs://bucket_name/dir/*: matches all files within bucket_name/dir directory.
    • gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories.
    • gs://bucket_name/file*: matches files prefixed by file in bucket_name
    • gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name
    • gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name
    • gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name
    • gs://bucket_name/a//b: matches all files in bucket_name that match a//b pattern, such as a/c/b, a/d/b
    • gs://another_bucket/a.txt: matches gs://another_bucket/a.txt
    SampleGcsFileSpecs List<EntryGcsFilesetSpecSampleGcsFileSpec>

    (Output) Sample files contained in this fileset, not all files contained in this fileset are represented here. Structure is documented below.

    The sample_gcs_file_specs block contains:

    FilePatterns []string
    Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid filePatterns:

    • gs://bucket_name/dir/*: matches all files within bucket_name/dir directory.
    • gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories.
    • gs://bucket_name/file*: matches files prefixed by file in bucket_name
    • gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name
    • gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name
    • gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name
    • gs://bucket_name/a//b: matches all files in bucket_name that match a//b pattern, such as a/c/b, a/d/b
    • gs://another_bucket/a.txt: matches gs://another_bucket/a.txt
    SampleGcsFileSpecs []EntryGcsFilesetSpecSampleGcsFileSpec

    (Output) Sample files contained in this fileset, not all files contained in this fileset are represented here. Structure is documented below.

    The sample_gcs_file_specs block contains:

    filePatterns List<String>
    Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid filePatterns:

    • gs://bucket_name/dir/*: matches all files within bucket_name/dir directory.
    • gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories.
    • gs://bucket_name/file*: matches files prefixed by file in bucket_name
    • gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name
    • gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name
    • gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name
    • gs://bucket_name/a//b: matches all files in bucket_name that match a//b pattern, such as a/c/b, a/d/b
    • gs://another_bucket/a.txt: matches gs://another_bucket/a.txt
    sampleGcsFileSpecs List<EntryGcsFilesetSpecSampleGcsFileSpec>

    (Output) Sample files contained in this fileset, not all files contained in this fileset are represented here. Structure is documented below.

    The sample_gcs_file_specs block contains:

    filePatterns string[]
    Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid filePatterns:

    • gs://bucket_name/dir/*: matches all files within bucket_name/dir directory.
    • gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories.
    • gs://bucket_name/file*: matches files prefixed by file in bucket_name
    • gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name
    • gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name
    • gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name
    • gs://bucket_name/a//b: matches all files in bucket_name that match a//b pattern, such as a/c/b, a/d/b
    • gs://another_bucket/a.txt: matches gs://another_bucket/a.txt
    sampleGcsFileSpecs EntryGcsFilesetSpecSampleGcsFileSpec[]

    (Output) Sample files contained in this fileset, not all files contained in this fileset are represented here. Structure is documented below.

    The sample_gcs_file_specs block contains:

    file_patterns Sequence[str]
    Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid filePatterns:

    • gs://bucket_name/dir/*: matches all files within bucket_name/dir directory.
    • gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories.
    • gs://bucket_name/file*: matches files prefixed by file in bucket_name
    • gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name
    • gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name
    • gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name
    • gs://bucket_name/a//b: matches all files in bucket_name that match a//b pattern, such as a/c/b, a/d/b
    • gs://another_bucket/a.txt: matches gs://another_bucket/a.txt
    sample_gcs_file_specs Sequence[EntryGcsFilesetSpecSampleGcsFileSpec]

    (Output) Sample files contained in this fileset, not all files contained in this fileset are represented here. Structure is documented below.

    The sample_gcs_file_specs block contains:

    filePatterns List<String>
    Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid filePatterns:

    • gs://bucket_name/dir/*: matches all files within bucket_name/dir directory.
    • gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories.
    • gs://bucket_name/file*: matches files prefixed by file in bucket_name
    • gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name
    • gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name
    • gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name
    • gs://bucket_name/a//b: matches all files in bucket_name that match a//b pattern, such as a/c/b, a/d/b
    • gs://another_bucket/a.txt: matches gs://another_bucket/a.txt
    sampleGcsFileSpecs List<Property Map>

    (Output) Sample files contained in this fileset, not all files contained in this fileset are represented here. Structure is documented below.

    The sample_gcs_file_specs block contains:

    EntryGcsFilesetSpecSampleGcsFileSpec, EntryGcsFilesetSpecSampleGcsFileSpecArgs

    FilePath string
    (Output) The full file path
    SizeBytes int
    (Output) The size of the file, in bytes.
    FilePath string
    (Output) The full file path
    SizeBytes int
    (Output) The size of the file, in bytes.
    filePath String
    (Output) The full file path
    sizeBytes Integer
    (Output) The size of the file, in bytes.
    filePath string
    (Output) The full file path
    sizeBytes number
    (Output) The size of the file, in bytes.
    file_path str
    (Output) The full file path
    size_bytes int
    (Output) The size of the file, in bytes.
    filePath String
    (Output) The full file path
    sizeBytes Number
    (Output) The size of the file, in bytes.

    Import

    Entry can be imported using any of these accepted formats:

    • {{name}}

    When using the pulumi import command, Entry can be imported using one of the formats above. For example:

    $ pulumi import gcp:datacatalog/entry:Entry default {{name}}
    

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.16.0 published on Wednesday, Mar 27, 2024 by Pulumi