Skip to content
Permalink
Browse files
docs: Improved formatting (#688)
* docs: Improved formatting

PiperOrigin-RevId: 408569512

Source-Link: googleapis/googleapis@c7b3bd0

Source-Link: https://github.com/googleapis/googleapis-gen/commit/9aabf2fdb7612f72e2f423bd9dfdb326bb4d9460
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOWFhYmYyZmRiNzYxMmY3MmUyZjQyM2JkOWRmZGIzMjZiYjRkOTQ2MCJ9

* 🦉 Updates from OwlBot

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Nov 10, 2021
1 parent b5b893a commit 00c212f957042dfab9a355f9b2817833ed6b6667
Showing with 992 additions and 272 deletions.
  1. +47 −30 google-cloud-datacatalog/src/main/java/com/google/cloud/datacatalog/v1/DataCatalogClient.java
  2. +16 −30 google-cloud-datacatalog/src/main/java/com/google/cloud/datacatalog/v1/PolicyTagManagerClient.java
  3. +4 −4 ...atacatalog/src/main/java/com/google/cloud/datacatalog/v1/PolicyTagManagerSerializationClient.java
  4. +13 −19 google-cloud-datacatalog/src/main/java/com/google/cloud/datacatalog/v1beta1/DataCatalogClient.java
  5. +14 −26 ...-cloud-datacatalog/src/main/java/com/google/cloud/datacatalog/v1beta1/PolicyTagManagerClient.java
  6. +5 −5 ...talog/src/main/java/com/google/cloud/datacatalog/v1beta1/PolicyTagManagerSerializationClient.java
  7. +1 −1 google-cloud-datacatalog/src/main/java/com/google/cloud/datacatalog/v1beta1/package-info.java
  8. +8 −6 google-cloud-datacatalog/src/test/java/com/google/cloud/datacatalog/v1/DataCatalogClientTest.java
  9. +12 −6 ...e-cloud-datacatalog/src/test/java/com/google/cloud/datacatalog/v1/PolicyTagManagerClientTest.java
  10. +4 −4 ...atalog/src/test/java/com/google/cloud/datacatalog/v1/PolicyTagManagerSerializationClientTest.java
  11. +8 −6 ...e-cloud-datacatalog/src/test/java/com/google/cloud/datacatalog/v1beta1/DataCatalogClientTest.java
  12. +12 −6 ...ud-datacatalog/src/test/java/com/google/cloud/datacatalog/v1beta1/PolicyTagManagerClientTest.java
  13. +4 −4 ...g/src/test/java/com/google/cloud/datacatalog/v1beta1/PolicyTagManagerSerializationClientTest.java
  14. +21 −8 grpc-google-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/DataCatalogGrpc.java
  15. +1 −0 ...ogle-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/PolicyTagManagerGrpc.java
  16. +1 −0 ...tacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/PolicyTagManagerSerializationGrpc.java
  17. +1 −0 ...cloud-datacatalog-v1beta1/src/main/java/com/google/cloud/datacatalog/v1beta1/DataCatalogGrpc.java
  18. +1 −0 ...-datacatalog-v1beta1/src/main/java/com/google/cloud/datacatalog/v1beta1/PolicyTagManagerGrpc.java
  19. +1 −0 ...v1beta1/src/main/java/com/google/cloud/datacatalog/v1beta1/PolicyTagManagerSerializationGrpc.java
  20. +179 −0 ...e-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/BigQueryDateShardedSpec.java
  21. +25 −0 ...atacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/BigQueryDateShardedSpecOrBuilder.java
  22. +15 −10 proto-google-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/Common.java
  23. +7 −14 ...le-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/CreatePolicyTagRequest.java
  24. +2 −4 ...datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/CreatePolicyTagRequestOrBuilder.java
  25. +7 −14 proto-google-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/PolicyTag.java
  26. +2 −4 ...google-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/PolicyTagOrBuilder.java
  27. +7 −7 ...d-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/RenameTagTemplateFieldRequest.java
  28. +2 −2 ...alog-v1/src/main/java/com/google/cloud/datacatalog/v1/RenameTagTemplateFieldRequestOrBuilder.java
  29. +14 −11 proto-google-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/Search.java
  30. +19 −12 ...ogle-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/SearchCatalogRequest.java
  31. +4 −2 ...d-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/SearchCatalogRequestOrBuilder.java
  32. +365 −0 ...oogle-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/SearchCatalogResult.java
  33. +52 −0 ...ud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/SearchCatalogResultOrBuilder.java
  34. +12 −12 ...oogle-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/TableSpecOuterClass.java
  35. +60 −12 ...-cloud-datacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/UpdateTagTemplateRequest.java
  36. +15 −3 ...tacatalog-v1/src/main/java/com/google/cloud/datacatalog/v1/UpdateTagTemplateRequestOrBuilder.java
  37. +2 −0 proto-google-cloud-datacatalog-v1/src/main/proto/google/cloud/datacatalog/v1/common.proto
  38. +17 −6 proto-google-cloud-datacatalog-v1/src/main/proto/google/cloud/datacatalog/v1/datacatalog.proto
  39. +2 −4 proto-google-cloud-datacatalog-v1/src/main/proto/google/cloud/datacatalog/v1/policytagmanager.proto
  40. +7 −0 proto-google-cloud-datacatalog-v1/src/main/proto/google/cloud/datacatalog/v1/search.proto
  41. +3 −0 proto-google-cloud-datacatalog-v1/src/main/proto/google/cloud/datacatalog/v1/table_spec.proto
@@ -430,7 +430,7 @@ public final EntryGroup createEntryGroup(
*
* <pre>{@code
* try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
* String parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
* String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
* String entryGroupId = "entryGroupId1228924712";
* EntryGroup entryGroup = EntryGroup.newBuilder().build();
* EntryGroup response = dataCatalogClient.createEntryGroup(parent, entryGroupId, entryGroup);
@@ -493,7 +493,7 @@ public final EntryGroup createEntryGroup(
* try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
* CreateEntryGroupRequest request =
* CreateEntryGroupRequest.newBuilder()
* .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setEntryGroupId("entryGroupId1228924712")
* .setEntryGroup(EntryGroup.newBuilder().build())
* .build();
@@ -543,7 +543,7 @@ public final EntryGroup createEntryGroup(CreateEntryGroupRequest request) {
* try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
* CreateEntryGroupRequest request =
* CreateEntryGroupRequest.newBuilder()
* .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setEntryGroupId("entryGroupId1228924712")
* .setEntryGroup(EntryGroup.newBuilder().build())
* .build();
@@ -1607,6 +1607,10 @@ public final UnaryCallable<LookupEntryRequest, Entry> lookupEntryCallable() {
/**
* Lists entries.
*
* <p>Note: Currently, this method can list only custom entries. To get a list of both custom and
* automatically created entries, use
* [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
*
* <p>Sample code:
*
* <pre>{@code
@@ -1634,6 +1638,10 @@ public final ListEntriesPagedResponse listEntries(EntryGroupName parent) {
/**
* Lists entries.
*
* <p>Note: Currently, this method can list only custom entries. To get a list of both custom and
* automatically created entries, use
* [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
*
* <p>Sample code:
*
* <pre>{@code
@@ -1658,6 +1666,10 @@ public final ListEntriesPagedResponse listEntries(String parent) {
/**
* Lists entries.
*
* <p>Note: Currently, this method can list only custom entries. To get a list of both custom and
* automatically created entries, use
* [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
*
* <p>Sample code:
*
* <pre>{@code
@@ -1686,6 +1698,10 @@ public final ListEntriesPagedResponse listEntries(ListEntriesRequest request) {
/**
* Lists entries.
*
* <p>Note: Currently, this method can list only custom entries. To get a list of both custom and
* automatically created entries, use
* [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
*
* <p>Sample code:
*
* <pre>{@code
@@ -1714,6 +1730,10 @@ public final ListEntriesPagedResponse listEntries(ListEntriesRequest request) {
/**
* Lists entries.
*
* <p>Note: Currently, this method can list only custom entries. To get a list of both custom and
* automatically created entries, use
* [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
*
* <p>Sample code:
*
* <pre>{@code
@@ -1795,7 +1815,7 @@ public final TagTemplate createTagTemplate(
*
* <pre>{@code
* try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
* String parent = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString();
* String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
* String tagTemplateId = "tagTemplateId-1438776721";
* TagTemplate tagTemplate = TagTemplate.newBuilder().build();
* TagTemplate response =
@@ -1836,7 +1856,7 @@ public final TagTemplate createTagTemplate(
* try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
* CreateTagTemplateRequest request =
* CreateTagTemplateRequest.newBuilder()
* .setParent(TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setTagTemplateId("tagTemplateId-1438776721")
* .setTagTemplate(TagTemplate.newBuilder().build())
* .build();
@@ -1865,7 +1885,7 @@ public final TagTemplate createTagTemplate(CreateTagTemplateRequest request) {
* try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
* CreateTagTemplateRequest request =
* CreateTagTemplateRequest.newBuilder()
* .setParent(TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setTagTemplateId("tagTemplateId-1438776721")
* .setTagTemplate(TagTemplate.newBuilder().build())
* .build();
@@ -2021,9 +2041,12 @@ public final TagTemplate updateTagTemplate(TagTemplate tagTemplate) {
*
* @param tagTemplate Required. The template to update. The `name` field must be set.
* @param updateMask Names of fields whose values to overwrite on a tag template. Currently, only
* `display_name` can be overwritten.
* `display_name` and `is_publicly_readable` can be overwritten.
* <p>If this parameter is absent or empty, all modifiable fields are overwritten. If such
* fields are non-required and omitted in the request body, their values are emptied.
* <p>Note: Updating the `is_publicly_readable` field may require up to 12 hours to take
* effect in search results. Additionally, it also requires the `tagTemplates.getIamPolicy`
* and `tagTemplates.setIamPolicy` permissions.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplate updateTagTemplate(TagTemplate tagTemplate, FieldMask updateMask) {
@@ -2623,7 +2646,7 @@ public final TagTemplateField updateTagTemplateField(UpdateTagTemplateFieldReque
* }
* }</pre>
*
* @param name Required. The name of the tag template.
* @param name Required. The name of the tag template field.
* @param newTagTemplateFieldId Required. The new ID of this tag template field. For example,
* `my_new_field`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -2659,7 +2682,7 @@ public final TagTemplateField renameTagTemplateField(
* }
* }</pre>
*
* @param name Required. The name of the tag template.
* @param name Required. The name of the tag template field.
* @param newTagTemplateFieldId Required. The new ID of this tag template field. For example,
* `my_new_field`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -3014,9 +3037,9 @@ public final void deleteTagTemplateField(DeleteTagTemplateFieldRequest request)
*
* <ul>
* <li>An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is
* ``projects.locations.entryGroups.entries.tags.create``.
* `projects.locations.entryGroups.entries.tags.create`.
* <li>Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if the method name is
* ``projects.locations.entryGroups.tags.create``.
* `projects.locations.entryGroups.tags.create`.
* </ul>
*
* <p>Note: The project identified by the `parent` parameter for the [tag]
@@ -3058,9 +3081,9 @@ public final Tag createTag(TagName parent, Tag tag) {
*
* <ul>
* <li>An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is
* ``projects.locations.entryGroups.entries.tags.create``.
* `projects.locations.entryGroups.entries.tags.create`.
* <li>Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if the method name is
* ``projects.locations.entryGroups.tags.create``.
* `projects.locations.entryGroups.tags.create`.
* </ul>
*
* <p>Note: The project identified by the `parent` parameter for the [tag]
@@ -3099,9 +3122,9 @@ public final Tag createTag(String parent, Tag tag) {
*
* <ul>
* <li>An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is
* ``projects.locations.entryGroups.entries.tags.create``.
* `projects.locations.entryGroups.entries.tags.create`.
* <li>Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if the method name is
* ``projects.locations.entryGroups.tags.create``.
* `projects.locations.entryGroups.tags.create`.
* </ul>
*
* <p>Note: The project identified by the `parent` parameter for the [tag]
@@ -3138,9 +3161,9 @@ public final Tag createTag(CreateTagRequest request) {
*
* <ul>
* <li>An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is
* ``projects.locations.entryGroups.entries.tags.create``.
* `projects.locations.entryGroups.entries.tags.create`.
* <li>Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if the method name is
* ``projects.locations.entryGroups.tags.create``.
* `projects.locations.entryGroups.tags.create`.
* </ul>
*
* <p>Note: The project identified by the `parent` parameter for the [tag]
@@ -3295,8 +3318,7 @@ public final void deleteTag(EntryName name) {
*
* <pre>{@code
* try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
* String name =
* TagName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]", "[TAG]").toString();
* String name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
* dataCatalogClient.deleteTag(name);
* }
* }</pre>
@@ -3320,8 +3342,7 @@ public final void deleteTag(String name) {
* DeleteTagRequest request =
* DeleteTagRequest.newBuilder()
* .setName(
* TagName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]", "[TAG]")
* .toString())
* EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
* .build();
* dataCatalogClient.deleteTag(request);
* }
@@ -3345,8 +3366,7 @@ public final void deleteTag(DeleteTagRequest request) {
* DeleteTagRequest request =
* DeleteTagRequest.newBuilder()
* .setName(
* TagName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]", "[TAG]")
* .toString())
* EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
* .build();
* ApiFuture<Empty> future = dataCatalogClient.deleteTagCallable().futureCall(request);
* // Do something.
@@ -3394,7 +3414,7 @@ public final ListTagsPagedResponse listTags(EntryName parent) {
* <pre>{@code
* try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
* String parent =
* TagName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]", "[TAG]").toString();
* EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
* for (Tag element : dataCatalogClient.listTags(parent).iterateAll()) {
* // doThingsWith(element);
* }
@@ -3423,8 +3443,7 @@ public final ListTagsPagedResponse listTags(String parent) {
* ListTagsRequest request =
* ListTagsRequest.newBuilder()
* .setParent(
* TagName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]", "[TAG]")
* .toString())
* EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
@@ -3452,8 +3471,7 @@ public final ListTagsPagedResponse listTags(ListTagsRequest request) {
* ListTagsRequest request =
* ListTagsRequest.newBuilder()
* .setParent(
* TagName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]", "[TAG]")
* .toString())
* EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
@@ -3480,8 +3498,7 @@ public final UnaryCallable<ListTagsRequest, ListTagsPagedResponse> listTagsPaged
* ListTagsRequest request =
* ListTagsRequest.newBuilder()
* .setParent(
* TagName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]", "[TAG]")
* .toString())
* EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();

0 comments on commit 00c212f

Please sign in to comment.