Fixed documentation links.

PiperOrigin-RevId: 306445213
5 years ago · 04eff65937
parent 26523a9679
commit 04eff65937
3 changed files with 91 additions and 34 deletions
--- a/google/cloud/datacatalog/v1/datacatalog.proto
+++ b/google/cloud/datacatalog/v1/datacatalog.proto
@ -60,7 +60,8 @@ service DataCatalog {
  // across repeated search queries.
  //
  // See [Data Catalog Search
-  // Syntax](/data-catalog/docs/how-to/search-reference) for more information.
+  // Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
+  // for more information.
  rpc SearchCatalog(SearchCatalogRequest) returns (SearchCatalogResponse) {
    option (google.api.http) = {
      post: "/v1/catalog:search"
@ -86,7 +87,8 @@ service DataCatalog {
  //
  // Users should enable the Data Catalog API in the project identified by
  // the `parent` parameter (see [Data Catalog Resource Project]
-  // (/data-catalog/docs/concepts/resource-project) for more information).
+  // (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
+  // more information).
  rpc CreateEntryGroup(CreateEntryGroupRequest) returns (EntryGroup) {
    option (google.api.http) = {
      post: "/v1/{parent=projects/*/locations/*}/entryGroups"
@ -106,8 +108,9 @@ service DataCatalog {

  // Updates an EntryGroup. The user should enable the Data Catalog API in the
  // project identified by the `entry_group.name` parameter (see [Data Catalog
-  // Resource Project] (/data-catalog/docs/concepts/resource-project) for more
-  // information).
+  // Resource Project]
+  // (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
+  // more information).
  rpc UpdateEntryGroup(UpdateEntryGroupRequest) returns (EntryGroup) {
    option (google.api.http) = {
      patch: "/v1/{entry_group.name=projects/*/locations/*/entryGroups/*}"
@ -120,7 +123,8 @@ service DataCatalog {
  // Deletes an EntryGroup. Only entry groups that do not contain entries can be
  // deleted. Users should enable the Data Catalog API in the project
  // identified by the `name` parameter (see [Data Catalog Resource Project]
-  // (/data-catalog/docs/concepts/resource-project) for more information).
+  // (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
+  // more information).
  rpc DeleteEntryGroup(DeleteEntryGroupRequest) returns (google.protobuf.Empty) {
    option (google.api.http) = {
      delete: "/v1/{name=projects/*/locations/*/entryGroups/*}"
@ -141,7 +145,8 @@ service DataCatalog {
  //
  // Users should enable the Data Catalog API in the project identified by
  // the `parent` parameter (see [Data Catalog Resource Project]
-  // (/data-catalog/docs/concepts/resource-project) for more information).
+  // (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
+  // more information).
  //
  // A maximum of 100,000 entries may be created per entry group.
  rpc CreateEntry(CreateEntryRequest) returns (Entry) {
@ -155,7 +160,8 @@ service DataCatalog {
  // Updates an existing entry.
  // Users should enable the Data Catalog API in the project identified by
  // the `entry.name` parameter (see [Data Catalog Resource Project]
-  // (/data-catalog/docs/concepts/resource-project) for more information).
+  // (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
+  // more information).
  rpc UpdateEntry(UpdateEntryRequest) returns (Entry) {
    option (google.api.http) = {
      patch: "/v1/{entry.name=projects/*/locations/*/entryGroups/*/entries/*}"
@ -170,7 +176,8 @@ service DataCatalog {
  // method can be deleted.
  // Users should enable the Data Catalog API in the project identified by
  // the `name` parameter (see [Data Catalog Resource Project]
-  // (/data-catalog/docs/concepts/resource-project) for more information).
+  // (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
+  // more information).
  rpc DeleteEntry(DeleteEntryRequest) returns (google.protobuf.Empty) {
    option (google.api.http) = {
      delete: "/v1/{name=projects/*/locations/*/entryGroups/*/entries/*}"
@ -205,8 +212,9 @@ service DataCatalog {

  // Creates a tag template. The user should enable the Data Catalog API in
  // the project identified by the `parent` parameter (see [Data Catalog
-  // Resource Project](/data-catalog/docs/concepts/resource-project) for more
-  // information).
+  // Resource
+  // Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
+  // for more information).
  rpc CreateTagTemplate(CreateTagTemplateRequest) returns (TagTemplate) {
    option (google.api.http) = {
      post: "/v1/{parent=projects/*/locations/*}/tagTemplates"
@ -228,7 +236,8 @@ service DataCatalog {
  // and should be updated using their own create/update/delete methods.
  // Users should enable the Data Catalog API in the project identified by
  // the `tag_template.name` parameter (see [Data Catalog Resource Project]
-  // (/data-catalog/docs/concepts/resource-project) for more information).
+  // (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
+  // more information).
  rpc UpdateTagTemplate(UpdateTagTemplateRequest) returns (TagTemplate) {
    option (google.api.http) = {
      patch: "/v1/{tag_template.name=projects/*/locations/*/tagTemplates/*}"
@ -241,7 +250,8 @@ service DataCatalog {
  // Deletes a tag template and all tags using the template.
  // Users should enable the Data Catalog API in the project identified by
  // the `name` parameter (see [Data Catalog Resource Project]
-  // (/data-catalog/docs/concepts/resource-project) for more information).
+  // (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
+  // more information).
  rpc DeleteTagTemplate(DeleteTagTemplateRequest) returns (google.protobuf.Empty) {
    option (google.api.http) = {
      delete: "/v1/{name=projects/*/locations/*/tagTemplates/*}"
@ -252,8 +262,8 @@ service DataCatalog {
  // Creates a field in a tag template. The user should enable the Data Catalog
  // API in the project identified by the `parent` parameter (see
  // [Data Catalog Resource
-  // Project](/data-catalog/docs/concepts/resource-project) for more
-  // information).
+  // Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
+  // for more information).
  rpc CreateTagTemplateField(CreateTagTemplateFieldRequest) returns (TagTemplateField) {
    option (google.api.http) = {
      post: "/v1/{parent=projects/*/locations/*/tagTemplates/*}/fields"
@ -265,7 +275,8 @@ service DataCatalog {
  // Updates a field in a tag template. This method cannot be used to update the
  // field type. Users should enable the Data Catalog API in the project
  // identified by the `name` parameter (see [Data Catalog Resource Project]
-  // (/data-catalog/docs/concepts/resource-project) for more information).
+  // (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
+  // more information).
  rpc UpdateTagTemplateField(UpdateTagTemplateFieldRequest) returns (TagTemplateField) {
    option (google.api.http) = {
      patch: "/v1/{name=projects/*/locations/*/tagTemplates/*/fields/*}"
@ -277,8 +288,9 @@ service DataCatalog {

  // Renames a field in a tag template. The user should enable the Data Catalog
  // API in the project identified by the `name` parameter (see [Data Catalog
-  // Resource Project](/data-catalog/docs/concepts/resource-project) for more
-  // information).
+  // Resource
+  // Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
+  // for more information).
  rpc RenameTagTemplateField(RenameTagTemplateFieldRequest) returns (TagTemplateField) {
    option (google.api.http) = {
      post: "/v1/{name=projects/*/locations/*/tagTemplates/*/fields/*}:rename"
@ -290,7 +302,8 @@ service DataCatalog {
  // Deletes a field in a tag template and all uses of that field.
  // Users should enable the Data Catalog API in the project identified by
  // the `name` parameter (see [Data Catalog Resource Project]
-  // (/data-catalog/docs/concepts/resource-project) for more information).
+  // (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
+  // more information).
  rpc DeleteTagTemplateField(DeleteTagTemplateFieldRequest) returns (google.protobuf.Empty) {
    option (google.api.http) = {
      delete: "/v1/{name=projects/*/locations/*/tagTemplates/*/fields/*}"
@ -300,10 +313,10 @@ service DataCatalog {

  // Creates a tag on an [Entry][google.cloud.datacatalog.v1.Entry].
  // Note: The project identified by the `parent` parameter for the
-  // [tag](/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
+  // [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
  // and the
  // [tag
-  // template](/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
+  // template](https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
  // used to create the tag must be from the same organization.
  rpc CreateTag(CreateTagRequest) returns (Tag) {
    option (google.api.http) = {
@ -458,6 +471,42 @@ message SearchCatalogRequest {
    // https://cloud.google.com/public-datasets/. By default, GCP public
    // datasets are excluded.
    bool include_gcp_public_datasets = 7;
+
+    // Optional. The list of locations to search within.
+    // 1. If empty, search will be performed in all locations;
+    // 2. If any of the locations are NOT in the valid locations list, error
+    // will be returned;
+    // 3. Otherwise, search only the given locations for matching results.
+    // Typical usage is to leave this field empty. When a location is
+    // unreachable as returned in the `SearchCatalogResponse.unreachable` field,
+    // users can repeat the search request with this parameter set to get
+    // additional information on the error.
+    //
+    // Valid locations:
+    //  * asia-east1
+    //  * asia-east2
+    //  * asia-northeast1
+    //  * asia-northeast2
+    //  * asia-south1
+    //  * asia-southeast1
+    //  * australia-southeast1
+    //  * eu
+    //  * europe-north1
+    //  * europe-west1
+    //  * europe-west2
+    //  * europe-west3
+    //  * europe-west4
+    //  * europe-west6
+    //  * global
+    //  * northamerica-northeast1
+    //  * southamerica-east1
+    //  * us
+    //  * us-central1
+    //  * us-east1
+    //  * us-east4
+    //  * us-west1
+    //  * us-west2
+    repeated string restricted_locations = 16 [(google.api.field_behavior) = OPTIONAL];
  }

  // Required. The scope of this search request. A `scope` that has empty
@ -476,7 +525,8 @@ message SearchCatalogRequest {
  //
  // Note: Query tokens need to have a minimum of 3 characters for substring
  // matching to work correctly. See [Data Catalog Search
-  // Syntax](/data-catalog/docs/how-to/search-reference) for more information.
+  // Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
+  // for more information.
  string query = 1 [(google.api.field_behavior) = REQUIRED];

  // Number of results in the search page. If <=0 then defaults to 10. Max limit
@ -510,6 +560,12 @@ message SearchCatalogResponse {

  // The token that can be used to retrieve the next page of results.
  string next_page_token = 3;
+
+  // Unreachable locations. Search result does not include data from those
+  // locations. Users can get additional information on the error by repeating
+  // the search request with a more restrictive parameter -- setting the value
+  // for `SearchDataCatalogRequest.scope.include_locations`.
+  repeated string unreachable = 6;
 }

 // Request message for
@ -715,7 +771,7 @@ message LookupEntryRequest {
    //
    // Examples:
    //
-    //   * `cloud_pubsub.project_id.topic_id`
+    //   * `pubsub.project_id.topic_id`
    //   * ``pubsub.project_id.`topic.id.with.dots` ``
    //   * `bigquery.table.project_id.dataset_id.table_id`
    //   * `bigquery.dataset.project_id.dataset_id`
@ -869,8 +925,7 @@ message EntryGroup {
 // [CreateTagTemplate][google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplate].
 message CreateTagTemplateRequest {
  // Required. The name of the project and the template location
-  // [region](/compute/docs/regions-zones/#available).
-  // NOTE: Currently, only the `us-central1 region` is supported.
+  // [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
  //
  // Example:
  //
@ -988,8 +1043,7 @@ message DeleteTagRequest {
 // [CreateTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplateField].
 message CreateTagTemplateFieldRequest {
  // Required. The name of the project and the template location
-  // [region](/compute/docs/regions-zones/#available).
-  // NOTE: Currently, only the `us-central1 region` is supported.
+  // [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
  //
  // Example:
  //
--- a/google/cloud/datacatalog/v1/datacatalog_v1.yaml
+++ b/google/cloud/datacatalog/v1/datacatalog_v1.yaml
@ -26,14 +26,14 @@ documentation:
      Sets the access control policy on the specified resource. Replaces
      any existing policy.

-      Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and
-      PERMISSION_DENIED
+      Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
+      errors.

  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
    description: |-
      Returns permissions that a caller has on the specified resource. If the
      resource does not exist, this will return an empty set of
-      permissions, not a NOT_FOUND error.
+      permissions, not a `NOT_FOUND` error.

      Note: This operation is designed to be used for building
      permission-aware UIs and command-line tools, not for authorization
--- a/google/cloud/datacatalog/v1/tags.proto
+++ b/google/cloud/datacatalog/v1/tags.proto
@ -31,8 +31,9 @@ option ruby_package = "Google::Cloud::DataCatalog::V1";
 // Tags are used to attach custom metadata to Data Catalog resources. Tags
 // conform to the specifications within their tag template.
 //
-// See [Data Catalog IAM](/data-catalog/docs/concepts/iam) for information on
-// the permissions needed to create or view tags.
+// See [Data Catalog
+// IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information
+// on the permissions needed to create or view tags.
 message Tag {
  option (google.api.resource) = {
    type: "datacatalog.googleapis.com/Tag"
@ -119,10 +120,12 @@ message TagField {

 // A tag template defines a tag, which can have one or more typed fields.
 // The template is used to create and attach the tag to GCP resources.
-// [Tag template roles](/iam/docs/understanding-roles#data-catalog-roles)
+// [Tag template
+// roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles)
 // provide permissions to create, edit, and use the template. See, for example,
-// the [TagTemplate User](/data-catalog/docs/how-to/template-user) role, which
-// includes permission to use the tag template to tag resources.
+// the [TagTemplate
+// User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role,
+// which includes permission to use the tag template to tag resources.
 message TagTemplate {
  option (google.api.resource) = {
    type: "datacatalog.googleapis.com/TagTemplate"