Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/google-cloud-datacatalog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
1. [Select or create a Cloud Platform project][projects].
1. [Enable billing for your project][billing].
1. [Enable the Data Catalog API][enable_api].
1. [Set up authentication][auth] so you can access the
1. [Set up authentication with a service account][auth] so you can access the
API from your local workstation.

### Installing the client library
Expand Down Expand Up @@ -383,4 +383,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
[projects]: https://console.cloud.google.com/project
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=datacatalog.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
[auth]: https://cloud.google.com/docs/authentication/getting-started
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,12 @@ option (google.api.resource_definition) = {
pattern: "projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name}"
};

// Deprecated: Please use Dataplex Catalog instead.
//
// Data Catalog API service allows clients to discover, understand, and manage
// their data.
service DataCatalog {
option deprecated = true;
option (google.api.default_host) = "datacatalog.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
Expand All @@ -68,6 +71,7 @@ service DataCatalog {
// Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
// for more information.
rpc SearchCatalog(SearchCatalogRequest) returns (SearchCatalogResponse) {
option deprecated = true;
option (google.api.http) = {
post: "/v1beta1/catalog:search"
body: "*"
Expand All @@ -83,6 +87,7 @@ service DataCatalog {
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
// more information).
rpc CreateEntryGroup(CreateEntryGroupRequest) returns (EntryGroup) {
option deprecated = true;
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/entryGroups"
body: "entry_group"
Expand All @@ -96,6 +101,7 @@ service DataCatalog {
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
// more information).
rpc UpdateEntryGroup(UpdateEntryGroupRequest) returns (EntryGroup) {
option deprecated = true;
option (google.api.http) = {
patch: "/v1beta1/{entry_group.name=projects/*/locations/*/entryGroups/*}"
body: "entry_group"
Expand All @@ -106,6 +112,7 @@ service DataCatalog {

// Gets an EntryGroup.
rpc GetEntryGroup(GetEntryGroupRequest) returns (EntryGroup) {
option deprecated = true;
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/entryGroups/*}"
};
Expand All @@ -120,6 +127,7 @@ service DataCatalog {
// more information).
rpc DeleteEntryGroup(DeleteEntryGroupRequest)
returns (google.protobuf.Empty) {
option deprecated = true;
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/entryGroups/*}"
};
Expand All @@ -129,6 +137,7 @@ service DataCatalog {
// Lists entry groups.
rpc ListEntryGroups(ListEntryGroupsRequest)
returns (ListEntryGroupsResponse) {
option deprecated = true;
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/entryGroups"
};
Expand All @@ -145,6 +154,7 @@ service DataCatalog {
//
// A maximum of 100,000 entries may be created per entry group.
rpc CreateEntry(CreateEntryRequest) returns (Entry) {
option deprecated = true;
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/entryGroups/*}/entries"
body: "entry"
Expand All @@ -158,6 +168,7 @@ service DataCatalog {
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
// more information).
rpc UpdateEntry(UpdateEntryRequest) returns (Entry) {
option deprecated = true;
option (google.api.http) = {
patch: "/v1beta1/{entry.name=projects/*/locations/*/entryGroups/*/entries/*}"
body: "entry"
Expand All @@ -174,6 +185,7 @@ service DataCatalog {
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
// more information).
rpc DeleteEntry(DeleteEntryRequest) returns (google.protobuf.Empty) {
option deprecated = true;
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/entryGroups/*/entries/*}"
};
Expand All @@ -182,6 +194,7 @@ service DataCatalog {

// Gets an entry.
rpc GetEntry(GetEntryRequest) returns (Entry) {
option deprecated = true;
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/entryGroups/*/entries/*}"
};
Expand All @@ -192,13 +205,15 @@ service DataCatalog {
// the resource name from the source Google Cloud Platform service to get the
// Data Catalog Entry.
rpc LookupEntry(LookupEntryRequest) returns (Entry) {
option deprecated = true;
option (google.api.http) = {
get: "/v1beta1/entries:lookup"
};
}

// Lists entries.
rpc ListEntries(ListEntriesRequest) returns (ListEntriesResponse) {
option deprecated = true;
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/entryGroups/*}/entries"
};
Expand All @@ -211,6 +226,7 @@ service DataCatalog {
// Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
// for more information).
rpc CreateTagTemplate(CreateTagTemplateRequest) returns (TagTemplate) {
option deprecated = true;
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/tagTemplates"
body: "tag_template"
Expand All @@ -221,6 +237,7 @@ service DataCatalog {

// Gets a tag template.
rpc GetTagTemplate(GetTagTemplateRequest) returns (TagTemplate) {
option deprecated = true;
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/tagTemplates/*}"
};
Expand All @@ -235,6 +252,7 @@ service DataCatalog {
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
// more information).
rpc UpdateTagTemplate(UpdateTagTemplateRequest) returns (TagTemplate) {
option deprecated = true;
option (google.api.http) = {
patch: "/v1beta1/{tag_template.name=projects/*/locations/*/tagTemplates/*}"
body: "tag_template"
Expand All @@ -250,6 +268,7 @@ service DataCatalog {
// more information).
rpc DeleteTagTemplate(DeleteTagTemplateRequest)
returns (google.protobuf.Empty) {
option deprecated = true;
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/tagTemplates/*}"
};
Expand All @@ -263,6 +282,7 @@ service DataCatalog {
// for more information).
rpc CreateTagTemplateField(CreateTagTemplateFieldRequest)
returns (TagTemplateField) {
option deprecated = true;
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/tagTemplates/*}/fields"
body: "tag_template_field"
Expand All @@ -278,6 +298,7 @@ service DataCatalog {
// more information).
rpc UpdateTagTemplateField(UpdateTagTemplateFieldRequest)
returns (TagTemplateField) {
option deprecated = true;
option (google.api.http) = {
patch: "/v1beta1/{name=projects/*/locations/*/tagTemplates/*/fields/*}"
body: "tag_template_field"
Expand All @@ -294,6 +315,7 @@ service DataCatalog {
// for more information).
rpc RenameTagTemplateField(RenameTagTemplateFieldRequest)
returns (TagTemplateField) {
option deprecated = true;
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/tagTemplates/*/fields/*}:rename"
body: "*"
Expand All @@ -306,6 +328,7 @@ service DataCatalog {
// used in any other enum value within the same enum field.
rpc RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest)
returns (TagTemplateField) {
option deprecated = true;
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/tagTemplates/*/fields/*/enumValues/*}:rename"
body: "*"
Expand All @@ -320,6 +343,7 @@ service DataCatalog {
// more information).
rpc DeleteTagTemplateField(DeleteTagTemplateFieldRequest)
returns (google.protobuf.Empty) {
option deprecated = true;
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/tagTemplates/*/fields/*}"
};
Expand All @@ -334,6 +358,7 @@ service DataCatalog {
// template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters)
// used to create the tag must be from the same organization.
rpc CreateTag(CreateTagRequest) returns (Tag) {
option deprecated = true;
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/entryGroups/*/entries/*}/tags"
body: "tag"
Expand All @@ -347,6 +372,7 @@ service DataCatalog {

// Updates an existing tag.
rpc UpdateTag(UpdateTagRequest) returns (Tag) {
option deprecated = true;
option (google.api.http) = {
patch: "/v1beta1/{tag.name=projects/*/locations/*/entryGroups/*/entries/*/tags/*}"
body: "tag"
Expand All @@ -361,6 +387,7 @@ service DataCatalog {

// Deletes a tag.
rpc DeleteTag(DeleteTagRequest) returns (google.protobuf.Empty) {
option deprecated = true;
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/entryGroups/*/entries/*/tags/*}"
additional_bindings {
Expand All @@ -374,6 +401,7 @@ service DataCatalog {
// The [columns][google.cloud.datacatalog.v1beta1.Tag.column] in the response
// are lowercased.
rpc ListTags(ListTagsRequest) returns (ListTagsResponse) {
option deprecated = true;
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/entryGroups/*/entries/*}/tags"
additional_bindings {
Expand All @@ -399,6 +427,7 @@ service DataCatalog {
// - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest)
returns (google.iam.v1.Policy) {
option deprecated = true;
option (google.api.http) = {
post: "/v1beta1/{resource=projects/*/locations/*/tagTemplates/*}:setIamPolicy"
body: "*"
Expand Down Expand Up @@ -428,6 +457,7 @@ service DataCatalog {
// - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest)
returns (google.iam.v1.Policy) {
option deprecated = true;
option (google.api.http) = {
post: "/v1beta1/{resource=projects/*/locations/*/tagTemplates/*}:getIamPolicy"
body: "*"
Expand Down Expand Up @@ -458,6 +488,7 @@ service DataCatalog {
// request.
rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest)
returns (google.iam.v1.TestIamPermissionsResponse) {
option deprecated = true;
option (google.api.http) = {
post: "/v1beta1/{resource=projects/*/locations/*/tagTemplates/*}:testIamPermissions"
body: "*"
Expand Down
Loading