Create tag template
Stay organized with collections
Save and categorize content based on your preferences.
Create a tag template.
Code sample
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],[],[[["\u003cp\u003eThis code sample demonstrates how to create a tag template in Google Cloud Data Catalog using the Java client library.\u003c/p\u003e\n"],["\u003cp\u003eThe process involves setting up Application Default Credentials for authentication and initializing a DataCatalogClient.\u003c/p\u003e\n"],["\u003cp\u003eUsers are required to replace placeholder variables such as project ID, location, and tag template ID with their specific values.\u003c/p\u003e\n"],["\u003cp\u003eThe tag template is created by specifying a display name, defining fields (with types), and sending a request to the Data Catalog service using the client.\u003c/p\u003e\n"],["\u003cp\u003eAfter setting up and running the sample, it then refers users to the Google cloud sample browser to search for additional code samples.\u003c/p\u003e\n"]]],[],null,["# Create tag template\n\nCreate a tag template.\n\nCode sample\n-----------\n\n### Java\n\n\nBefore trying this sample, follow the Java setup instructions in the\n[Data Catalog quickstart using\nclient libraries](/data-catalog/docs/reference/libraries).\n\n\nFor more information, see the\n[Data Catalog Java API\nreference documentation](https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/overview).\n\n\nTo authenticate to Data Catalog, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n import com.google.cloud.datacatalog.v1.https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.CreateTagTemplateRequest.html;\n import com.google.cloud.datacatalog.v1.https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.DataCatalogClient.html;\n import com.google.cloud.datacatalog.v1.https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.FieldType.html;\n import com.google.cloud.datacatalog.v1.https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.LocationName.html;\n import com.google.cloud.datacatalog.v1.https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.TagTemplate.html;\n import com.google.cloud.datacatalog.v1.https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.TagTemplateField.html;\n import java.io.IOException;\n\n // Sample to create tag template\n public class CreateTagTemplate {\n\n public static void main(String[] args) throws IOException {\n // TODO(developer): Replace these variables before running the sample.\n String projectId = \"MY_PROJECT_ID\";\n String location = \"MY_LOCATION\";\n https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.LocationName.html locationName = https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.LocationName.html.of(projectId, location);\n String tagTemplateId = \"MY_TAG_TEMPLATE_ID\";\n https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.TagTemplateField.html sourceField =\n https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.TagTemplateField.html.newBuilder()\n .setDisplayName(\"Your display name\")\n .setType(\n https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.FieldType.html.newBuilder().https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.FieldType.Builder.html#com_google_cloud_datacatalog_v1_FieldType_Builder_setPrimitiveType_com_google_cloud_datacatalog_v1_FieldType_PrimitiveType_(https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.FieldType.html.PrimitiveType.STRING).build())\n .build();\n https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.TagTemplate.html tagTemplate =\n https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.TagTemplate.html.newBuilder()\n .setDisplayName(\"Your display name\")\n .putFields(\"sourceField\", sourceField)\n .build();\n createTagTemplate(locationName, tagTemplateId, tagTemplate);\n }\n\n public static void createTagTemplate(\n https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.LocationName.html name, String tagTemplateId, https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.TagTemplate.html template) throws IOException {\n // Initialize client that will be used to send requests. This client only needs to be created\n // once, and can be reused for multiple requests. After completing all of your requests, call\n // the \"close\" method on the client to safely clean up any remaining background resources.\n try (https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.DataCatalogClient.html client = https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.DataCatalogClient.html.create()) {\n https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.CreateTagTemplateRequest.html request =\n https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.CreateTagTemplateRequest.html.newBuilder()\n .setParent(name.https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.LocationName.html#com_google_cloud_datacatalog_v1_LocationName_toString__())\n .https://cloud.google.com/java/docs/reference/google-cloud-datacatalog/latest/com.google.cloud.datacatalog.v1.CreateTagTemplateRequest.Builder.html#com_google_cloud_datacatalog_v1_CreateTagTemplateRequest_Builder_setTagTemplateId_java_lang_String_(tagTemplateId)\n .setTagTemplate(template)\n .build();\n client.createTagTemplate(request);\n System.out.println(\"Tag template created successfully\");\n }\n }\n }\n\nWhat's next\n-----------\n\n\nTo search and filter code samples for other Google Cloud products, see the\n[Google Cloud sample browser](/docs/samples?product=data_catalog)."]]