Skip to content

Commit

Permalink
feat(datacatalog): update the api
Browse files Browse the repository at this point in the history
#### datacatalog:v1

The following keys were added:
- resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.modifyEntryContacts (Total Keys: 12)
- resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.modifyEntryOverview (Total Keys: 12)
- schemas.GoogleCloudDatacatalogV1BusinessContext (Total Keys: 4)
- schemas.GoogleCloudDatacatalogV1Contacts (Total Keys: 8)
- schemas.GoogleCloudDatacatalogV1Entry.properties.businessContext.$ref (Total Keys: 1)
- schemas.GoogleCloudDatacatalogV1EntryOverview (Total Keys: 3)
- schemas.GoogleCloudDatacatalogV1ModifyEntryContactsRequest (Total Keys: 3)
- schemas.GoogleCloudDatacatalogV1ModifyEntryOverviewRequest (Total Keys: 3)
  • Loading branch information
yoshi-automation committed Jan 11, 2022
1 parent 610263d commit 135360c
Show file tree
Hide file tree
Showing 5 changed files with 307 additions and 7 deletions.
13 changes: 13 additions & 0 deletions docs/dyn/datacatalog_v1.entries.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,19 @@ <h3>Method Details</h3>
&quot;viewQuery&quot;: &quot;A String&quot;, # Output only. The query that defines the table view.
},
},
&quot;businessContext&quot;: { # Business Context of the entry. # Business Context of the entry.
&quot;contacts&quot;: { # Contact people for the entry. # Contact people for the entry.
&quot;people&quot;: [ # The list of contact people for the entry.
{ # A contact person for the entry.
&quot;designation&quot;: &quot;A String&quot;, # Designation of the person, for example, Data Steward.
&quot;email&quot;: &quot;A String&quot;, # Email of the person in the format of `john.doe@xyz`, ``, or `John Doe`.
},
],
},
&quot;entryOverview&quot;: { # Entry overview fields for rich text descriptions of entries. # Entry overview fields for rich text descriptions of entries.
&quot;overview&quot;: &quot;A String&quot;, # Entry overview with support for rich text. The overview must only contain Unicode characters, and should be formatted using HTML. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
},
},
&quot;dataSource&quot;: { # Physical location of an entry. # Output only. Physical location of the entry.
&quot;resource&quot;: &quot;A String&quot;, # Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
&quot;service&quot;: &quot;A String&quot;, # Service that physically stores the data.
Expand Down
150 changes: 150 additions & 0 deletions docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,12 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#modifyEntryContacts">modifyEntryContacts(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Modifies contacts, part of the business context of an Entry. To call this method, you must have the `datacatalog.entries.updateContacts` IAM permission on the corresponding project.</p>
<p class="toc_element">
<code><a href="#modifyEntryOverview">modifyEntryOverview(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Modifies entry overview, part of the business context of an Entry. To call this method, you must have the `datacatalog.entries.updateOverview` IAM permission on the corresponding project.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing entry. You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).</p>
Expand Down Expand Up @@ -143,6 +149,19 @@ <h3>Method Details</h3>
&quot;viewQuery&quot;: &quot;A String&quot;, # Output only. The query that defines the table view.
},
},
&quot;businessContext&quot;: { # Business Context of the entry. # Business Context of the entry.
&quot;contacts&quot;: { # Contact people for the entry. # Contact people for the entry.
&quot;people&quot;: [ # The list of contact people for the entry.
{ # A contact person for the entry.
&quot;designation&quot;: &quot;A String&quot;, # Designation of the person, for example, Data Steward.
&quot;email&quot;: &quot;A String&quot;, # Email of the person in the format of `john.doe@xyz`, ``, or `John Doe`.
},
],
},
&quot;entryOverview&quot;: { # Entry overview fields for rich text descriptions of entries. # Entry overview fields for rich text descriptions of entries.
&quot;overview&quot;: &quot;A String&quot;, # Entry overview with support for rich text. The overview must only contain Unicode characters, and should be formatted using HTML. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
},
},
&quot;dataSource&quot;: { # Physical location of an entry. # Output only. Physical location of the entry.
&quot;resource&quot;: &quot;A String&quot;, # Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
&quot;service&quot;: &quot;A String&quot;, # Service that physically stores the data.
Expand Down Expand Up @@ -267,6 +286,19 @@ <h3>Method Details</h3>
&quot;viewQuery&quot;: &quot;A String&quot;, # Output only. The query that defines the table view.
},
},
&quot;businessContext&quot;: { # Business Context of the entry. # Business Context of the entry.
&quot;contacts&quot;: { # Contact people for the entry. # Contact people for the entry.
&quot;people&quot;: [ # The list of contact people for the entry.
{ # A contact person for the entry.
&quot;designation&quot;: &quot;A String&quot;, # Designation of the person, for example, Data Steward.
&quot;email&quot;: &quot;A String&quot;, # Email of the person in the format of `john.doe@xyz`, ``, or `John Doe`.
},
],
},
&quot;entryOverview&quot;: { # Entry overview fields for rich text descriptions of entries. # Entry overview fields for rich text descriptions of entries.
&quot;overview&quot;: &quot;A String&quot;, # Entry overview with support for rich text. The overview must only contain Unicode characters, and should be formatted using HTML. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
},
},
&quot;dataSource&quot;: { # Physical location of an entry. # Output only. Physical location of the entry.
&quot;resource&quot;: &quot;A String&quot;, # Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
&quot;service&quot;: &quot;A String&quot;, # Service that physically stores the data.
Expand Down Expand Up @@ -415,6 +447,19 @@ <h3>Method Details</h3>
&quot;viewQuery&quot;: &quot;A String&quot;, # Output only. The query that defines the table view.
},
},
&quot;businessContext&quot;: { # Business Context of the entry. # Business Context of the entry.
&quot;contacts&quot;: { # Contact people for the entry. # Contact people for the entry.
&quot;people&quot;: [ # The list of contact people for the entry.
{ # A contact person for the entry.
&quot;designation&quot;: &quot;A String&quot;, # Designation of the person, for example, Data Steward.
&quot;email&quot;: &quot;A String&quot;, # Email of the person in the format of `john.doe@xyz`, ``, or `John Doe`.
},
],
},
&quot;entryOverview&quot;: { # Entry overview fields for rich text descriptions of entries. # Entry overview fields for rich text descriptions of entries.
&quot;overview&quot;: &quot;A String&quot;, # Entry overview with support for rich text. The overview must only contain Unicode characters, and should be formatted using HTML. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
},
},
&quot;dataSource&quot;: { # Physical location of an entry. # Output only. Physical location of the entry.
&quot;resource&quot;: &quot;A String&quot;, # Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
&quot;service&quot;: &quot;A String&quot;, # Service that physically stores the data.
Expand Down Expand Up @@ -593,6 +638,19 @@ <h3>Method Details</h3>
&quot;viewQuery&quot;: &quot;A String&quot;, # Output only. The query that defines the table view.
},
},
&quot;businessContext&quot;: { # Business Context of the entry. # Business Context of the entry.
&quot;contacts&quot;: { # Contact people for the entry. # Contact people for the entry.
&quot;people&quot;: [ # The list of contact people for the entry.
{ # A contact person for the entry.
&quot;designation&quot;: &quot;A String&quot;, # Designation of the person, for example, Data Steward.
&quot;email&quot;: &quot;A String&quot;, # Email of the person in the format of `john.doe@xyz`, ``, or `John Doe`.
},
],
},
&quot;entryOverview&quot;: { # Entry overview fields for rich text descriptions of entries. # Entry overview fields for rich text descriptions of entries.
&quot;overview&quot;: &quot;A String&quot;, # Entry overview with support for rich text. The overview must only contain Unicode characters, and should be formatted using HTML. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
},
},
&quot;dataSource&quot;: { # Physical location of an entry. # Output only. Physical location of the entry.
&quot;resource&quot;: &quot;A String&quot;, # Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
&quot;service&quot;: &quot;A String&quot;, # Service that physically stores the data.
Expand Down Expand Up @@ -710,6 +768,72 @@ <h3>Method Details</h3>
</pre>
</div>

<div class="method">
<code class="details" id="modifyEntryContacts">modifyEntryContacts(name, body=None, x__xgafv=None)</code>
<pre>Modifies contacts, part of the business context of an Entry. To call this method, you must have the `datacatalog.entries.updateContacts` IAM permission on the corresponding project.

Args:
name: string, Required. The full resource name of the entry. (required)
body: object, The request body.
The object takes the form of:

{ # Request message for ModifyEntryContacts.
&quot;contacts&quot;: { # Contact people for the entry. # Required. The new value for the Contacts.
&quot;people&quot;: [ # The list of contact people for the entry.
{ # A contact person for the entry.
&quot;designation&quot;: &quot;A String&quot;, # Designation of the person, for example, Data Steward.
&quot;email&quot;: &quot;A String&quot;, # Email of the person in the format of `john.doe@xyz`, ``, or `John Doe`.
},
],
},
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Contact people for the entry.
&quot;people&quot;: [ # The list of contact people for the entry.
{ # A contact person for the entry.
&quot;designation&quot;: &quot;A String&quot;, # Designation of the person, for example, Data Steward.
&quot;email&quot;: &quot;A String&quot;, # Email of the person in the format of `john.doe@xyz`, ``, or `John Doe`.
},
],
}</pre>
</div>

<div class="method">
<code class="details" id="modifyEntryOverview">modifyEntryOverview(name, body=None, x__xgafv=None)</code>
<pre>Modifies entry overview, part of the business context of an Entry. To call this method, you must have the `datacatalog.entries.updateOverview` IAM permission on the corresponding project.

Args:
name: string, Required. The full resource name of the entry. (required)
body: object, The request body.
The object takes the form of:

{ # Request message for ModifyEntryOverview.
&quot;entryOverview&quot;: { # Entry overview fields for rich text descriptions of entries. # Required. The new value for the Entry Overview.
&quot;overview&quot;: &quot;A String&quot;, # Entry overview with support for rich text. The overview must only contain Unicode characters, and should be formatted using HTML. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
},
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Entry overview fields for rich text descriptions of entries.
&quot;overview&quot;: &quot;A String&quot;, # Entry overview with support for rich text. The overview must only contain Unicode characters, and should be formatted using HTML. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
}</pre>
</div>

<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing entry. You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Expand All @@ -735,6 +859,19 @@ <h3>Method Details</h3>
&quot;viewQuery&quot;: &quot;A String&quot;, # Output only. The query that defines the table view.
},
},
&quot;businessContext&quot;: { # Business Context of the entry. # Business Context of the entry.
&quot;contacts&quot;: { # Contact people for the entry. # Contact people for the entry.
&quot;people&quot;: [ # The list of contact people for the entry.
{ # A contact person for the entry.
&quot;designation&quot;: &quot;A String&quot;, # Designation of the person, for example, Data Steward.
&quot;email&quot;: &quot;A String&quot;, # Email of the person in the format of `john.doe@xyz`, ``, or `John Doe`.
},
],
},
&quot;entryOverview&quot;: { # Entry overview fields for rich text descriptions of entries. # Entry overview fields for rich text descriptions of entries.
&quot;overview&quot;: &quot;A String&quot;, # Entry overview with support for rich text. The overview must only contain Unicode characters, and should be formatted using HTML. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
},
},
&quot;dataSource&quot;: { # Physical location of an entry. # Output only. Physical location of the entry.
&quot;resource&quot;: &quot;A String&quot;, # Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
&quot;service&quot;: &quot;A String&quot;, # Service that physically stores the data.
Expand Down Expand Up @@ -859,6 +996,19 @@ <h3>Method Details</h3>
&quot;viewQuery&quot;: &quot;A String&quot;, # Output only. The query that defines the table view.
},
},
&quot;businessContext&quot;: { # Business Context of the entry. # Business Context of the entry.
&quot;contacts&quot;: { # Contact people for the entry. # Contact people for the entry.
&quot;people&quot;: [ # The list of contact people for the entry.
{ # A contact person for the entry.
&quot;designation&quot;: &quot;A String&quot;, # Designation of the person, for example, Data Steward.
&quot;email&quot;: &quot;A String&quot;, # Email of the person in the format of `john.doe@xyz`, ``, or `John Doe`.
},
],
},
&quot;entryOverview&quot;: { # Entry overview fields for rich text descriptions of entries. # Entry overview fields for rich text descriptions of entries.
&quot;overview&quot;: &quot;A String&quot;, # Entry overview with support for rich text. The overview must only contain Unicode characters, and should be formatted using HTML. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
},
},
&quot;dataSource&quot;: { # Physical location of an entry. # Output only. Physical location of the entry.
&quot;resource&quot;: &quot;A String&quot;, # Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
&quot;service&quot;: &quot;A String&quot;, # Service that physically stores the data.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h2>Instance Methods</h2>
<p class="firstline">Deletes a tag.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists tags assigned to an Entry.</p>
<p class="firstline">Lists tags assigned to an Entry. The columns in the response are lowercased.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
Expand Down Expand Up @@ -178,7 +178,7 @@ <h3>Method Details</h3>

<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists tags assigned to an Entry.
<pre>Lists tags assigned to an Entry. The columns in the response are lowercased.

Args:
parent: string, Required. The name of the Data Catalog resource to list the tags of. The resource can be an Entry or an EntryGroup (without `/entries/{entries}` at the end). (required)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h2>Instance Methods</h2>
<p class="firstline">Deletes a tag.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists tags assigned to an Entry.</p>
<p class="firstline">Lists tags assigned to an Entry. The columns in the response are lowercased.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
Expand Down Expand Up @@ -178,7 +178,7 @@ <h3>Method Details</h3>

<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists tags assigned to an Entry.
<pre>Lists tags assigned to an Entry. The columns in the response are lowercased.

Args:
parent: string, Required. The name of the Data Catalog resource to list the tags of. The resource can be an Entry or an EntryGroup (without `/entries/{entries}` at the end). (required)
Expand Down
Loading

0 comments on commit 135360c

Please # to comment.