Create entry

Create an entry.

Code sample

Java

Before trying this sample, follow the Java setup instructions in the Dataplex quickstart using client libraries. For more information, see the Dataplex Java API reference documentation.

To authenticate to Dataplex, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.

import com.google.cloud.dataplex.v1.Aspect;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.Entry;
import com.google.cloud.dataplex.v1.EntryGroupName;
import com.google.cloud.dataplex.v1.EntrySource;
import com.google.protobuf.Struct;
import com.google.protobuf.Value;
import java.util.Map;

public class CreateEntry {

  public static void main(String[] args) throws Exception {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "MY_PROJECT_ID";
    // Available locations: https://cloud.google.com/dataplex/docs/locations
    String location = "MY_LOCATION";
    String entryGroupId = "MY_ENTRY_GROUP_ID";
    String entryId = "MY_ENTRY_ID";

    Entry createdEntry = createEntry(projectId, location, entryGroupId, entryId);
    System.out.println("Successfully created entry: " + createdEntry.getName());
  }

  // Method to create Entry located in projectId, location, entryGroupId and with entryId
  public static Entry createEntry(
      String projectId, String location, String entryGroupId, String entryId) throws Exception {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests.
    try (CatalogServiceClient client = CatalogServiceClient.create()) {
      EntryGroupName entryGroupName = EntryGroupName.of(projectId, location, entryGroupId);
      Entry entry =
          Entry.newBuilder()
              // Example of system Entry Type.
              // It is also possible to specify custom Entry Type.
              .setEntryType("projects/dataplex-types/locations/global/entryTypes/generic")
              .setEntrySource(
                  EntrySource.newBuilder().setDescription("description of the entry").build())
              .putAllAspects(
                  Map.of(
                      "dataplex-types.global.generic",
                      Aspect.newBuilder()
                          // This is required Aspect Type for "generic" Entry Type.
                          // For custom Aspect Type required Entry Type would be different.
                          .setAspectType(
                              "projects/dataplex-types/locations/global/aspectTypes/generic")
                          .setData(
                              Struct.newBuilder()
                                  // "Generic" Aspect Type have fields called "type" and "system.
                                  // The values below are a sample of possible options.
                                  .putFields(
                                      "type",
                                      Value.newBuilder().setStringValue("example value").build())
                                  .putFields(
                                      "system",
                                      Value.newBuilder().setStringValue("example system").build())
                                  .build())
                          .build()))
              .build();
      return client.createEntry(entryGroupName, entry, entryId);
    }
  }
}

Python

Before trying this sample, follow the Python setup instructions in the Dataplex quickstart using client libraries. For more information, see the Dataplex Python API reference documentation.

To authenticate to Dataplex, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.

from google.cloud import dataplex_v1
from google.protobuf import struct_pb2


def create_entry(
    project_id: str, location: str, entry_group_id: str, entry_id: str
) -> dataplex_v1.Entry:
    """Method to create Entry located in project_id, location, entry_group_id and with entry_id"""

    # Initialize client that will be used to send requests across threads. This
    # client only needs to be created once, and can be reused for multiple requests.
    # After completing all of your requests, call the "__exit__()" method to safely
    # clean up any remaining background resources. Alternatively, use the client as
    # a context manager.
    with dataplex_v1.CatalogServiceClient() as client:
        # The resource name of the Entry Group
        parent = (
            f"projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}"
        )
        entry = dataplex_v1.Entry(
            # Example of system Entry Type.
            # It is also possible to specify custom Entry Type.
            entry_type="projects/dataplex-types/locations/global/entryTypes/generic",
            entry_source=dataplex_v1.EntrySource(
                description="description of the entry"
            ),
            aspects={
                "dataplex-types.global.generic": dataplex_v1.Aspect(
                    # This is required Aspect Type for "generic" Entry Type.
                    # For custom Aspect Type required Entry Type would be different.
                    aspect_type="projects/dataplex-types/locations/global/aspectTypes/generic",
                    data=struct_pb2.Struct(
                        fields={
                            # "Generic" Aspect Type have fields called "type" and "system.
                            # The values below are a sample of possible options.
                            "type": struct_pb2.Value(string_value="example value"),
                            "system": struct_pb2.Value(string_value="example system"),
                        }
                    ),
                )
            },
        )
        return client.create_entry(parent=parent, entry=entry, entry_id=entry_id)


if __name__ == "__main__":
    # TODO(developer): Replace these variables before running the sample.
    project_id = "MY_PROJECT_ID"
    # Available locations: https://cloud.google.com/dataplex/docs/locations
    location = "MY_LOCATION"
    entry_group_id = "MY_ENTRY_GROUP_ID"
    entry_id = "MY_ENTRY_ID"

    created_entry = create_entry(project_id, location, entry_group_id, entry_id)
    print(f"Successfully created entry: {created_entry.name}")

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser.