Skip to content
Permalink
Browse files
docs(samples): adds samples from documentation with correct region ta…
…gs (#392)

* docs(samples): adds samples from documentation with correct region tags

* docs(samples): modified samples and add ITs

* Fix IT failure

* Fix IT

* Update CreateEntryTests.java

* Update Quickstart.java

* Update Quickstart.java

* Update Quickstart.java

* Update Quickstart.java

* Update Quickstart.java

Co-authored-by: steffnay <steffannbrown@gmail.com>
Co-authored-by: Stephanie Wang <stephaniewang526@users.noreply.github.com>
  • Loading branch information
3 people committed Jul 15, 2021
1 parent 753bf2d commit eff2228a09fc16d5b682740727f425d4290e1058
@@ -0,0 +1,109 @@
/*
* Copyright 2020 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.example.datacatalog;

// [START data_catalog_create_custom_entry]
import com.google.cloud.datacatalog.v1.ColumnSchema;
import com.google.cloud.datacatalog.v1.CreateEntryGroupRequest;
import com.google.cloud.datacatalog.v1.CreateEntryRequest;
import com.google.cloud.datacatalog.v1.DataCatalogClient;
import com.google.cloud.datacatalog.v1.Entry;
import com.google.cloud.datacatalog.v1.EntryGroup;
import com.google.cloud.datacatalog.v1.LocationName;
import com.google.cloud.datacatalog.v1.Schema;
import java.io.IOException;

// Sample to create custom entry
public class CreateCustomEntry {

public static void main(String[] args) throws IOException {
// TODO(developer): Replace these variables before running the sample.
String projectId = "my-project";
String entryGroupId = "onprem_entry_group";
String entryId = "onprem_entry_id";
createCustomEntry(projectId, entryGroupId, entryId);
}

public static void createCustomEntry(String projectId, String entryGroupId, String entryId)
throws IOException {
// Currently, Data Catalog stores metadata in the us-central1 region.
String location = "us-central1";

// Initialize client that will be used to send requests. This client only needs to be created
// once, and can be reused for multiple requests. After completing all of your requests, call
// the "close" method on the client to safely clean up any remaining background resources.
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
// Construct the EntryGroup for the EntryGroup request.
EntryGroup entryGroup =
EntryGroup.newBuilder()
.setDisplayName("My awesome Entry Group")
.setDescription("This Entry Group represents an external system")
.build();

// Construct the EntryGroup request to be sent by the client.
CreateEntryGroupRequest entryGroupRequest =
CreateEntryGroupRequest.newBuilder()
.setParent(LocationName.of(projectId, location).toString())
.setEntryGroupId(entryGroupId)
.setEntryGroup(entryGroup)
.build();

// Use the client to send the API request.
EntryGroup createdEntryGroup = dataCatalogClient.createEntryGroup(entryGroupRequest);

// Construct the Entry for the Entry request.
Entry entry =
Entry.newBuilder()
.setUserSpecifiedSystem("onprem_data_system")
.setUserSpecifiedType("onprem_data_asset")
.setDisplayName("My awesome data asset")
.setDescription("This data asset is managed by an external system.")
.setLinkedResource("//my-onprem-server.com/dataAssets/my-awesome-data-asset")
.setSchema(
Schema.newBuilder()
.addColumns(
ColumnSchema.newBuilder()
.setColumn("first_column")
.setDescription("This columns consists of ....")
.setMode("NULLABLE")
.setType("DOUBLE")
.build())
.addColumns(
ColumnSchema.newBuilder()
.setColumn("second_column")
.setDescription("This columns consists of ....")
.setMode("REQUIRED")
.setType("STRING")
.build())
.build())
.build();

// Construct the Entry request to be sent by the client.
CreateEntryRequest entryRequest =
CreateEntryRequest.newBuilder()
.setParent(createdEntryGroup.getName())
.setEntryId(entryId)
.setEntry(entry)
.build();

// Use the client to send the API request.
Entry createdEntry = dataCatalogClient.createEntry(entryRequest);
System.out.printf("Custom entry created with name: %s", createdEntry.getName());
}
}
}
// [END data_catalog_create_custom_entry]
@@ -16,9 +16,7 @@

package com.example.datacatalog;

// [START datacatalog_create_fileset_tag]

import com.google.api.gax.rpc.AlreadyExistsException;
// [START data_catalog_create_fileset]
import com.google.cloud.datacatalog.v1.ColumnSchema;
import com.google.cloud.datacatalog.v1.CreateEntryRequest;
import com.google.cloud.datacatalog.v1.DataCatalogClient;
@@ -29,18 +27,20 @@
import com.google.cloud.datacatalog.v1.Schema;
import java.io.IOException;

// Sample to create file set entry
public class CreateFilesetEntry {

public static void createEntry() {
public static void main(String[] args) throws IOException {
// TODO(developer): Replace these variables before running the sample.
String projectId = "my-project-id";
String entryGroupId = "fileset_entry_group";
String entryId = "fileset_entry_id";
createEntry(projectId, entryGroupId, entryId);
createFilesetEntry(projectId, entryGroupId, entryId);
}

// Create Fileset Entry.
public static void createEntry(String projectId, String entryGroupId, String entryId) {
public static void createFilesetEntry(String projectId, String entryGroupId, String entryId)
throws IOException {
// Currently, Data Catalog stores metadata in the us-central1 region.
String location = "us-central1";

@@ -105,14 +105,9 @@ public static void createEntry(String projectId, String entryGroupId, String ent
.build();

// Use the client to send the API request.
Entry entryResponse = dataCatalogClient.createEntry(entryRequest);
System.out.printf("\nEntry created with name: %s\n", entryResponse.getName());
} catch (AlreadyExistsException | IOException e) {
// AlreadyExistsException's are thrown if EntryGroup or Entry already exists.
// IOException's are thrown when unable to create the DataCatalogClient,
// for example an invalid Service Account path.
System.out.println("Error in create entry process:\n" + e.toString());
Entry entryCreated = dataCatalogClient.createEntry(entryRequest);
System.out.printf("Entry created with name: %s", entryCreated.getName());
}
}
}
// [END datacatalog_create_fileset_tag]
// [END data_catalog_create_fileset]
@@ -0,0 +1,78 @@
/*
* Copyright 2020 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.example.datacatalog;

// [START data_catalog_grant_tag_template_user_role]
import com.google.cloud.datacatalog.v1.DataCatalogClient;
import com.google.cloud.datacatalog.v1.TagTemplateName;
import com.google.iam.v1.Binding;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import java.io.IOException;

// Sample to grant tag access on template
public class GrantTagTemplateUserRole {

public static void main(String[] args) throws IOException {
// TODO(developer): Replace these variables before running the sample.
String projectId = "my-project";
String tagTemplateId = "my_tag_template";
grantTagTemplateUserRole(projectId, tagTemplateId);
}

public static void grantTagTemplateUserRole(String projectId, String templateId)
throws IOException {
// Currently, Data Catalog stores metadata in the us-central1 region.
String location = "us-central1";

// Format the Template name.
String templateName =
TagTemplateName.newBuilder()
.setProject(projectId)
.setLocation(location)
.setTagTemplate(templateId)
.build()
.toString();

// Initialize client that will be used to send requests. This client only needs to be created
// once, and can be reused for multiple requests. After completing all of your requests, call
// the "close" method on the client to safely clean up any remaining background resources.
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {

// Create a Binding to add the Tag Template User role and member to the policy.
Binding binding =
Binding.newBuilder()
.setRole("roles/datacatalog.tagTemplateUser")
.addMembers("group:example-analyst-group@google.com")
.build();

// Create a Policy object to update Template's IAM policy by adding the new binding.
Policy policyUpdate = Policy.newBuilder().addBindings(binding).build();

SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setPolicy(policyUpdate)
.setResource(templateName)
.build();

// Update Template's policy.
dataCatalogClient.setIamPolicy(request);
System.out.println("Role successfully granted");
}
}
}
// [END data_catalog_grant_tag_template_user_role]

0 comments on commit eff2228

Please sign in to comment.