Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

Commit

Permalink
docs: Improved formatting (#688)
Browse files Browse the repository at this point in the history 
* docs: Improved formatting

PiperOrigin-RevId: 408569512

Source-Link: googleapis/googleapis@c7b3bd0

Source-Link: googleapis/googleapis-gen@9aabf2f
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
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Nov 10, 2021
1 parent b5b893a commit 00c212f
Show file tree
Hide file tree
Showing 41 changed files with 992 additions and 272 deletions.
77 changes: 47 additions & 30 deletions ...le-cloud-datacatalog/src/main/java/com/google/cloud/datacatalog/v1/DataCatalogClient.java
View file
Expand Up @@ -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);
Expand Down Expand Up @@ -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();
Expand Down Expand Up @@ -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();
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 =
Expand Down Expand Up @@ -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();
Expand Down Expand Up @@ -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();
Expand Down Expand Up @@ -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) {
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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>
Expand All @@ -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);
* }
Expand All @@ -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.
Expand Down Expand Up @@ -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);
* }
Expand Down Expand Up @@ -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();
Expand Down Expand Up @@ -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();
Expand All @@ -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();
Expand Down

0 comments on commit 00c212f

Please sign in to comment.