Update entry type

Update an entry type.

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.CatalogServiceClient;
import com.google.cloud.dataplex.v1.EntryType;
import com.google.cloud.dataplex.v1.EntryTypeName;
import com.google.protobuf.FieldMask;

public class UpdateEntryType {

  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 entryTypeId = "MY_ENTRY_TYPE_ID";

    EntryType updatedEntryType = updateEntryType(projectId, location, entryTypeId);
    System.out.println("Successfully updated entry type: " + updatedEntryType.getName());
  }

  // Method to update Entry Type located in projectId, location and with entryTypeId
  public static EntryType updateEntryType(String projectId, String location, String entryTypeId)
      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()) {
      EntryType entryType =
          EntryType.newBuilder()
              .setName(EntryTypeName.of(projectId, location, entryTypeId).toString())
              .setDescription("updated description of the entry type")
              .build();

      // Update mask specifies which fields will be updated.
      // For more information on update masks, see: https://google.aip.dev/161
      FieldMask updateMask = FieldMask.newBuilder().addPaths("description").build();
      return client.updateEntryTypeAsync(entryType, updateMask).get();
    }
  }
}

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


def update_entry_type(
    project_id: str, location: str, entry_type_id: str
) -> dataplex_v1.EntryType:
    """Method to update Entry Type located in project_id, location and with entry_type_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 Type
        name = f"projects/{project_id}/locations/{location}/entryTypes/{entry_type_id}"
        entry_type = dataplex_v1.EntryType(
            name=name, description="updated description of the entry type"
        )

        # Update mask specifies which fields will be updated.
        # For more information on update masks, see: https://google.aip.dev/161
        update_mask = {"paths": ["description"]}
        update_operation = client.update_entry_type(
            entry_type=entry_type, update_mask=update_mask
        )
        return update_operation.result(60)


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_type_id = "MY_ENTRY_TYPE_ID"

    updated_entry_type = update_entry_type(project_id, location, entry_type_id)
    print(f"Successfully updated entry type: {updated_entry_type.name}")

What's next

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