pulumi-gcp-kotlin/com.pulumi.gcp.dataplex.kotlin/EntryTypeArgs

EntryTypeArgs

data class EntryTypeArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val entryTypeId: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val platform: Output<String>? = null, val project: Output<String>? = null, val requiredAspects: Output<List<EntryTypeRequiredAspectArgs>>? = null, val system: Output<String>? = null, val typeAliases: Output<List<String>>? = null) : ConvertibleToJava<EntryTypeArgs>

An Entry Type is a template for creating Entries.

Example Usage

Dataplex Entry Type Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const testEntryTypeBasic = new gcp.dataplex.EntryType("test_entry_type_basic", {
    entryTypeId: "entry-type-basic",
    project: "my-project-name",
    location: "us-central1",
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
test_entry_type_basic = gcp.dataplex.EntryType("test_entry_type_basic",
    entry_type_id="entry-type-basic",
    project="my-project-name",
    location="us-central1")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var testEntryTypeBasic = new Gcp.DataPlex.EntryType("test_entry_type_basic", new()
    {
        EntryTypeId = "entry-type-basic",
        Project = "my-project-name",
        Location = "us-central1",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/dataplex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataplex.NewEntryType(ctx, "test_entry_type_basic", &dataplex.EntryTypeArgs{
			EntryTypeId: pulumi.String("entry-type-basic"),
			Project:     pulumi.String("my-project-name"),
			Location:    pulumi.String("us-central1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.dataplex.EntryType;
import com.pulumi.gcp.dataplex.EntryTypeArgs;
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 testEntryTypeBasic = new EntryType("testEntryTypeBasic", EntryTypeArgs.builder()
            .entryTypeId("entry-type-basic")
            .project("my-project-name")
            .location("us-central1")
            .build());
    }
}
Content copied to clipboard
resources:
  testEntryTypeBasic:
    type: gcp:dataplex:EntryType
    name: test_entry_type_basic
    properties:
      entryTypeId: entry-type-basic
      project: my-project-name
      location: us-central1
Content copied to clipboard

Dataplex Entry Type Full

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const testEntryTypeFull = new gcp.dataplex.AspectType("test_entry_type_full", {
    aspectTypeId: "tf-test-aspect-type_91042",
    location: "us-central1",
    project: "my-project-name",
    metadataTemplate: `{
  "name": "tf-test-template",
  "type": "record",
  "recordFields": [
    {
      "name": "type",
      "type": "enum",
      "annotations": {
        "displayName": "Type",
        "description": "Specifies the type of view represented by the entry."
      },
      "index": 1,
      "constraints": {
        "required": true
      },
      "enumValues": [
        {
          "name": "VIEW",
          "index": 1
        }
      ]
    }
  ]
}
`,
});
const testEntryTypeFullEntryType = new gcp.dataplex.EntryType("test_entry_type_full", {
    entryTypeId: "entry-type-full",
    project: "my-project-name",
    location: "us-central1",
    labels: {
        tag: "test-tf",
    },
    displayName: "terraform entry type",
    description: "entry type created by Terraform",
    typeAliases: [
        "TABLE",
        "DATABASE",
    ],
    platform: "GCS",
    system: "CloudSQL",
    requiredAspects: [{
        type: testEntryTypeFull.name,
    }],
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
test_entry_type_full = gcp.dataplex.AspectType("test_entry_type_full",
    aspect_type_id="tf-test-aspect-type_91042",
    location="us-central1",
    project="my-project-name",
    metadata_template="""{
  "name": "tf-test-template",
  "type": "record",
  "recordFields": [
    {
      "name": "type",
      "type": "enum",
      "annotations": {
        "displayName": "Type",
        "description": "Specifies the type of view represented by the entry."
      },
      "index": 1,
      "constraints": {
        "required": true
      },
      "enumValues": [
        {
          "name": "VIEW",
          "index": 1
        }
      ]
    }
  ]
}
""")
test_entry_type_full_entry_type = gcp.dataplex.EntryType("test_entry_type_full",
    entry_type_id="entry-type-full",
    project="my-project-name",
    location="us-central1",
    labels={
        "tag": "test-tf",
    },
    display_name="terraform entry type",
    description="entry type created by Terraform",
    type_aliases=[
        "TABLE",
        "DATABASE",
    ],
    platform="GCS",
    system="CloudSQL",
    required_aspects=[{
        "type": test_entry_type_full.name,
    }])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var testEntryTypeFull = new Gcp.DataPlex.AspectType("test_entry_type_full", new()
    {
        AspectTypeId = "tf-test-aspect-type_91042",
        Location = "us-central1",
        Project = "my-project-name",
        MetadataTemplate = @"{
  ""name"": ""tf-test-template"",
  ""type"": ""record"",
  ""recordFields"": [
    {
      ""name"": ""type"",
      ""type"": ""enum"",
      ""annotations"": {
        ""displayName"": ""Type"",
        ""description"": ""Specifies the type of view represented by the entry.""
      },
      ""index"": 1,
      ""constraints"": {
        ""required"": true
      },
      ""enumValues"": [
        {
          ""name"": ""VIEW"",
          ""index"": 1
        }
      ]
    }
  ]
}
",
    });
    var testEntryTypeFullEntryType = new Gcp.DataPlex.EntryType("test_entry_type_full", new()
    {
        EntryTypeId = "entry-type-full",
        Project = "my-project-name",
        Location = "us-central1",
        Labels =
        {
            { "tag", "test-tf" },
        },
        DisplayName = "terraform entry type",
        Description = "entry type created by Terraform",
        TypeAliases = new[]
        {
            "TABLE",
            "DATABASE",
        },
        Platform = "GCS",
        System = "CloudSQL",
        RequiredAspects = new[]
        {
            new Gcp.DataPlex.Inputs.EntryTypeRequiredAspectArgs
            {
                Type = testEntryTypeFull.Name,
            },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/dataplex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testEntryTypeFull, err := dataplex.NewAspectType(ctx, "test_entry_type_full", &dataplex.AspectTypeArgs{
			AspectTypeId: pulumi.String("tf-test-aspect-type_91042"),
			Location:     pulumi.String("us-central1"),
			Project:      pulumi.String("my-project-name"),
			MetadataTemplate: pulumi.String(`{
  "name": "tf-test-template",
  "type": "record",
  "recordFields": [
    {
      "name": "type",
      "type": "enum",
      "annotations": {
        "displayName": "Type",
        "description": "Specifies the type of view represented by the entry."
      },
      "index": 1,
      "constraints": {
        "required": true
      },
      "enumValues": [
        {
          "name": "VIEW",
          "index": 1
        }
      ]
    }
  ]
}
`),
		})
		if err != nil {
			return err
		}
		_, err = dataplex.NewEntryType(ctx, "test_entry_type_full", &dataplex.EntryTypeArgs{
			EntryTypeId: pulumi.String("entry-type-full"),
			Project:     pulumi.String("my-project-name"),
			Location:    pulumi.String("us-central1"),
			Labels: pulumi.StringMap{
				"tag": pulumi.String("test-tf"),
			},
			DisplayName: pulumi.String("terraform entry type"),
			Description: pulumi.String("entry type created by Terraform"),
			TypeAliases: pulumi.StringArray{
				pulumi.String("TABLE"),
				pulumi.String("DATABASE"),
			},
			Platform: pulumi.String("GCS"),
			System:   pulumi.String("CloudSQL"),
			RequiredAspects: dataplex.EntryTypeRequiredAspectArray{
				&dataplex.EntryTypeRequiredAspectArgs{
					Type: testEntryTypeFull.Name,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.dataplex.AspectType;
import com.pulumi.gcp.dataplex.AspectTypeArgs;
import com.pulumi.gcp.dataplex.EntryType;
import com.pulumi.gcp.dataplex.EntryTypeArgs;
import com.pulumi.gcp.dataplex.inputs.EntryTypeRequiredAspectArgs;
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 testEntryTypeFull = new AspectType("testEntryTypeFull", AspectTypeArgs.builder()
            .aspectTypeId("tf-test-aspect-type_91042")
            .location("us-central1")
            .project("my-project-name")
            .metadataTemplate("""
{
  "name": "tf-test-template",
  "type": "record",
  "recordFields": [
    {
      "name": "type",
      "type": "enum",
      "annotations": {
        "displayName": "Type",
        "description": "Specifies the type of view represented by the entry."
      },
      "index": 1,
      "constraints": {
        "required": true
      },
      "enumValues": [
        {
          "name": "VIEW",
          "index": 1
        }
      ]
    }
  ]
}
            """)
            .build());
        var testEntryTypeFullEntryType = new EntryType("testEntryTypeFullEntryType", EntryTypeArgs.builder()
            .entryTypeId("entry-type-full")
            .project("my-project-name")
            .location("us-central1")
            .labels(Map.of("tag", "test-tf"))
            .displayName("terraform entry type")
            .description("entry type created by Terraform")
            .typeAliases(
                "TABLE",
                "DATABASE")
            .platform("GCS")
            .system("CloudSQL")
            .requiredAspects(EntryTypeRequiredAspectArgs.builder()
                .type(testEntryTypeFull.name())
                .build())
            .build());
    }
}
Content copied to clipboard
resources:
  testEntryTypeFull:
    type: gcp:dataplex:AspectType
    name: test_entry_type_full
    properties:
      aspectTypeId: tf-test-aspect-type_91042
      location: us-central1
      project: my-project-name
      metadataTemplate: |
        {
          "name": "tf-test-template",
          "type": "record",
          "recordFields": [
            {
              "name": "type",
              "type": "enum",
              "annotations": {
                "displayName": "Type",
                "description": "Specifies the type of view represented by the entry."
              },
              "index": 1,
              "constraints": {
                "required": true
              },
              "enumValues": [
                {
                  "name": "VIEW",
                  "index": 1
                }
              ]
            }
          ]
        }
  testEntryTypeFullEntryType:
    type: gcp:dataplex:EntryType
    name: test_entry_type_full
    properties:
      entryTypeId: entry-type-full
      project: my-project-name
      location: us-central1
      labels:
        tag: test-tf
      displayName: terraform entry type
      description: entry type created by Terraform
      typeAliases:
        - TABLE
        - DATABASE
      platform: GCS
      system: CloudSQL
      requiredAspects:
        - type: ${testEntryTypeFull.name}
Content copied to clipboard

Import

EntryType can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{location}}/entryTypes/{{entry_type_id}}

  • {{project}}/{{location}}/{{entry_type_id}}

  • {{location}}/{{entry_type_id}} When using the pulumi import command, EntryType can be imported using one of the formats above. For example:

$ pulumi import gcp:dataplex/entryType:EntryType default projects/{{project}}/locations/{{location}}/entryTypes/{{entry_type_id}}
Content copied to clipboard
$ pulumi import gcp:dataplex/entryType:EntryType default {{project}}/{{location}}/{{entry_type_id}}
Content copied to clipboard
$ pulumi import gcp:dataplex/entryType:EntryType default {{location}}/{{entry_type_id}}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(description: Output<String>? = null, displayName: Output<String>? = null, entryTypeId: Output<String>? = null, labels: Output<Map<String, String>>? = null, location: Output<String>? = null, platform: Output<String>? = null, project: Output<String>? = null, requiredAspects: Output<List<EntryTypeRequiredAspectArgs>>? = null, system: Output<String>? = null, typeAliases: Output<List<String>>? = null)

Properties

Link copied to clipboard
val description: Output<String>? = null

Description of the EntryType.

Link copied to clipboard
val displayName: Output<String>? = null

User friendly display name.

Link copied to clipboard
val entryTypeId: Output<String>? = null

The entry type id of the entry type.

Link copied to clipboard
val labels: Output<Map<String, String>>? = null

User-defined labels for the EntryType. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Link copied to clipboard
val location: Output<String>? = null

The location where entry type will be created in.

Link copied to clipboard
val platform: Output<String>? = null

The platform that Entries of this type belongs to.

Link copied to clipboard
val project: Output<String>? = null

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Link copied to clipboard
val requiredAspects: Output<List<EntryTypeRequiredAspectArgs>>? = null

AspectInfo for the entry type. Structure is documented below.

Link copied to clipboard
val system: Output<String>? = null

The system that Entries of this type belongs to.

Link copied to clipboard
val typeAliases: Output<List<String>>? = null

Indicates the class this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.

Functions

Link copied to clipboard
open override fun toJava(): EntryTypeArgs