Skip to content

Commit

Permalink
docs: Improved formatting (#313)
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[bot] and gcf-owl-bot[bot] authored Nov 10, 2021
1 parent 5ed6e02 commit 11afb1b
Show file tree
Hide file tree
Showing 102 changed files with 7,748 additions and 2,357 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ syntax = "proto3";

package google.cloud.datacatalog.v1;

import "google/protobuf/timestamp.proto";

option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,10 @@ service DataCatalog {
}

// Lists entries.
//
// 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].
rpc ListEntries(ListEntriesRequest) returns (ListEntriesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/entryGroups/*}/entries"
Expand Down Expand Up @@ -355,9 +359,9 @@ service DataCatalog {
// Creates a tag and assigns it to:
//
// * An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is
// ``projects.locations.entryGroups.entries.tags.create``.
// `projects.locations.entryGroups.entries.tags.create`.
// * Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if the method
// name is ``projects.locations.entryGroups.tags.create``.
// name is `projects.locations.entryGroups.tags.create`.
//
// Note: The project identified by the `parent` parameter for the [tag]
// (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
Expand Down Expand Up @@ -551,7 +555,7 @@ message SearchCatalogRequest {
// explicit permissions on them to view them. For example, if you are the
// owner.
//
// Other scope fields, for example, ``include_org_ids``,
// Other scope fields, for example, `include_org_ids`,
// still restrict the returned public tag templates and at least one of
// them is required.
bool include_public_tag_templates = 19 [(google.api.field_behavior) = OPTIONAL];
Expand All @@ -566,7 +570,8 @@ message SearchCatalogRequest {

// Optional. The query string with a minimum of 3 characters and specific syntax.
// For more information, see
// [Data Catalog search syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).
// [Data Catalog search
// syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).
//
// An empty query string returns all data assets (in the specified scope)
// that you have access to.
Expand Down Expand Up @@ -917,6 +922,7 @@ message Entry {
// and read-only afterwards. Can be used for search and lookup of the entries.
//
//
//
// FQNs take two forms:
//
// * For non-regionalized resources:
Expand Down Expand Up @@ -1224,11 +1230,16 @@ message UpdateTagTemplateRequest {
TagTemplate tag_template = 1 [(google.api.field_behavior) = REQUIRED];

// Names of fields whose values to overwrite on a tag template. Currently,
// only `display_name` can be overwritten.
// only `display_name` and `is_publicly_readable` can be overwritten.
//
// 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.
//
// 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.
google.protobuf.FieldMask update_mask = 2;
}

Expand Down Expand Up @@ -1359,7 +1370,7 @@ message UpdateTagTemplateFieldRequest {
// Request message for
// [RenameTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateField].
message RenameTagTemplateFieldRequest {
// Required. The name of the tag template.
// Required. The name of the tag template field.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -269,8 +269,7 @@ message PolicyTag {

// Output only. Resource name of this policy tag in the URL format.
//
// The policy tag manager generates unique taxonomy IDs and policy tag IDs.<br
// /><br />
// The policy tag manager generates unique taxonomy IDs and policy tag IDs.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

// Required. User-defined name of this policy tag.
Expand Down Expand Up @@ -391,8 +390,7 @@ message GetTaxonomyRequest {
// Request message for
// [CreatePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.CreatePolicyTag].
message CreatePolicyTagRequest {
// Required. Resource name of the taxonomy that the policy tag will belong to.<br /><br
// />
// Required. Resource name of the taxonomy that the policy tag will belong to.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,13 @@ message SearchCatalogResult {
//
// `dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID`
string fully_qualified_name = 10;

// The display name of the result.
string display_name = 12;

// Entry description that can consist of several sentences or paragraphs that
// describe entry contents.
string description = 13;
}

// The resource types that can be returned in search results.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,7 @@ message BigQueryDateShardedSpec {

// Output only. Total number of shards.
int64 shard_count = 3 [(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. BigQuery resource name of the latest shard.
string latest_shard_resource = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}
18 changes: 18 additions & 0 deletions packages/google-cloud-datacatalog/protos/protos.d.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

66 changes: 66 additions & 0 deletions packages/google-cloud-datacatalog/protos/protos.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 15 additions & 0 deletions packages/google-cloud-datacatalog/protos/protos.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 11afb1b

Please sign in to comment.