EntryType class

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",
});

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")

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",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_dataplex_entrytype" "test_entry_type_basic" {
  entry_type_id = "entry-type-basic"
  project       = "my-project-name"
  location      = "us-central1"
}

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.ArrayList;
import java.util.Arrays;
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());

    }
}

resources:
  testEntryTypeBasic:
    type: gcp:dataplex:EntryType
    name: test_entry_type_basic
    properties:
      entryTypeId: entry-type-basic
      project: my-project-name
      location: us-central1

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_44339",
    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,
    }],
});

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_44339",
    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,
    }])

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_44339",
        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,
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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_44339"),
			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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_dataplex_aspecttype" "test_entry_type_full" {
  aspect_type_id    = "tf-test-aspect-type_44339"
  location          = "us-central1"
  project           = "my-project-name"
  metadata_template = "{\n  \\\"name\\\": \\\"tf-test-template\\\",\n  \\\"type\\\": \\\"record\\\",\n  \\\"recordFields\\\": [\n    {\n      \\\"name\\\": \\\"type\\\",\n      \\\"type\\\": \\\"enum\\\",\n      \\\"annotations\\\": {\n        \\\"displayName\\\": \\\"Type\\\",\n        \\\"description\\\": \\\"Specifies the type of view represented by the entry.\\\"\n      },\n      \\\"index\\\": 1,\n      \\\"constraints\\\": {\n        \\\"required\\\": true\n      },\n      \\\"enumValues\\\": [\n        {\n          \\\"name\\\": \\\"VIEW\\\",\n          \\\"index\\\": 1\n        }\n      ]\n    }\n  ]\n}\n"
}
resource "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 = gcp_dataplex_aspecttype.test_entry_type_full.name
  }
}

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.ArrayList;
import java.util.Arrays;
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_44339")
            .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());

    }
}

resources:
  testEntryTypeFull:
    type: gcp:dataplex:AspectType
    name: test_entry_type_full
    properties:
      aspectTypeId: tf-test-aspect-type_44339
      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}

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}}
$ pulumi import gcp:dataplex/entryType:EntryType default {{project}}/{{location}}/{{entry_type_id}}
$ pulumi import gcp:dataplex/entryType:EntryType default {{location}}/{{entry_type_id}}

Constructors

EntryType(String name, {EntryTypeArgs? args, CustomResourceOptions? options})

Creates a new EntryType. name The Pulumi resource name. args Arguments used to configure this EntryType. The set of arguments for EntryType. options Resource options controlling this resource's behavior.

EntryType.reference(String urn)

Creates a typed reference to an existing EntryType resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The time when the EntryType was created.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

description ↔ Output<String?>

Description of the EntryType.

late, final

displayName ↔ Output<String?>

User friendly display name.

late, final

effectiveLabels ↔ Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

late, final

entryTypeId ↔ Output<String?>

The entry type id of the entry type.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>?>

User-defined labels for the EntryType.

late, final

location ↔ Output<String?>

The location where entry type will be created in.

late, final

name ↔ Output<String>

The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}

late, final

platform ↔ Output<String?>

The platform that Entries of this type belongs to.

late, final

project ↔ Output<String>

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

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

requiredAspects ↔ Output<List<EntryTypeRequiredAspect>?>

AspectInfo for the entry type. Structure is documented below.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

system ↔ Output<String?>

The system that Entries of this type belongs to.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

typeAliases ↔ Output<List<String>?>

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

late, final

uid ↔ Output<String>

System generated globally unique ID for the EntryType. This ID will be different if the EntryType is deleted and re-created with the same name.

late, final

updateTime ↔ Output<String>

The time when the EntryType was last updated.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {EntryTypeState? state, CustomResourceOptions? options}) → EntryType

Gets an existing EntryType resource's state with the given name and id.