Skip to content

Commit a87f90d

Browse files
feat(datacatalog): update the api
#### datacatalog:v1 The following keys were added: - resources.projects.resources.locations.resources.entryGroups.resources.entries.resources.tags.methods.reconcile (Total Keys: 12)
1 parent c55e711 commit a87f90d

File tree

3 files changed

+234
-2
lines changed

3 files changed

+234
-2
lines changed

docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.tags.html

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@ <h2>Instance Methods</h2>
9292
<p class="toc_element">
9393
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
9494
<p class="firstline">Updates an existing tag.</p>
95+
<p class="toc_element">
96+
<code><a href="#reconcile">reconcile(parent, body=None, x__xgafv=None)</a></code></p>
97+
<p class="firstline">`ReconcileTags` creates or updates a list of tags on the entry. If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list. `ReconcileTags` returns a long-running operation resource that can be queried with Operations.GetOperation to return ReconcileTagsMetadata and a ReconcileTagsResponse message.</p>
9598
<h3>Method Details</h3>
9699
<div class="method">
97100
<code class="details" id="close">close()</code>
@@ -294,4 +297,69 @@ <h3>Method Details</h3>
294297
}</pre>
295298
</div>
296299

300+
<div class="method">
301+
<code class="details" id="reconcile">reconcile(parent, body=None, x__xgafv=None)</code>
302+
<pre>`ReconcileTags` creates or updates a list of tags on the entry. If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list. `ReconcileTags` returns a long-running operation resource that can be queried with Operations.GetOperation to return ReconcileTagsMetadata and a ReconcileTagsResponse message.
303+
304+
Args:
305+
parent: string, Required. Name of Entry to be tagged. (required)
306+
body: object, The request body.
307+
The object takes the form of:
308+
309+
{ # Request message for ReconcileTags.
310+
&quot;forceDeleteMissing&quot;: True or False, # If set to `true`, deletes entry tags related to a tag template not listed in the tags source from an entry. If set to `false`, unlisted tags are retained.
311+
&quot;tagTemplate&quot;: &quot;A String&quot;, # Required. The name of the tag template, which is used for reconciliation.
312+
&quot;tags&quot;: [ # A list of tags to apply to an entry. A tag can specify a tag template, which must be the template specified in the `ReconcileTagsRequest`. The sole entry and each of its columns must be mentioned at most once.
313+
{ # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags.
314+
&quot;column&quot;: &quot;A String&quot;, # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`.
315+
&quot;fields&quot;: { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.
316+
&quot;a_key&quot;: { # Contains the value and additional information on a field within a Tag.
317+
&quot;boolValue&quot;: True or False, # The value of a tag field with a boolean type.
318+
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of this field.
319+
&quot;doubleValue&quot;: 3.14, # The value of a tag field with a double type.
320+
&quot;enumValue&quot;: { # An enum value. # The value of a tag field with an enum type. This value must be one of the allowed values listed in this enum.
321+
&quot;displayName&quot;: &quot;A String&quot;, # The display name of the enum value.
322+
},
323+
&quot;order&quot;: 42, # Output only. The order of this field with respect to other fields in this tag. Can be set by Tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don&#x27;t have to be sequential.
324+
&quot;richtextValue&quot;: &quot;A String&quot;, # The value of a tag field with a rich text type. 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.
325+
&quot;stringValue&quot;: &quot;A String&quot;, # The value of a tag field with a string type. The maximum length is 2000 UTF-8 characters.
326+
&quot;timestampValue&quot;: &quot;A String&quot;, # The value of a tag field with a timestamp type.
327+
},
328+
},
329+
&quot;name&quot;: &quot;A String&quot;, # The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.
330+
&quot;template&quot;: &quot;A String&quot;, # Required. The resource name of the tag template this tag uses. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}` This field cannot be modified after creation.
331+
&quot;templateDisplayName&quot;: &quot;A String&quot;, # Output only. The display name of the tag template.
332+
},
333+
],
334+
}
335+
336+
x__xgafv: string, V1 error format.
337+
Allowed values
338+
1 - v1 error format
339+
2 - v2 error format
340+
341+
Returns:
342+
An object of the form:
343+
344+
{ # This resource represents a long-running operation that is the result of a network API call.
345+
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
346+
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
347+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
348+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
349+
{
350+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
351+
},
352+
],
353+
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
354+
},
355+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
356+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
357+
},
358+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
359+
&quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
360+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
361+
},
362+
}</pre>
363+
</div>
364+
297365
</body></html>

googleapiclient/discovery_cache/documents/datacatalog.v1.json

Lines changed: 109 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -901,6 +901,34 @@
901901
"scopes": [
902902
"https://www.googleapis.com/auth/cloud-platform"
903903
]
904+
},
905+
"reconcile": {
906+
"description": "`ReconcileTags` creates or updates a list of tags on the entry. If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list. `ReconcileTags` returns a long-running operation resource that can be queried with Operations.GetOperation to return ReconcileTagsMetadata and a ReconcileTagsResponse message.",
907+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags:reconcile",
908+
"httpMethod": "POST",
909+
"id": "datacatalog.projects.locations.entryGroups.entries.tags.reconcile",
910+
"parameterOrder": [
911+
"parent"
912+
],
913+
"parameters": {
914+
"parent": {
915+
"description": "Required. Name of Entry to be tagged.",
916+
"location": "path",
917+
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$",
918+
"required": true,
919+
"type": "string"
920+
}
921+
},
922+
"path": "v1/{+parent}/tags:reconcile",
923+
"request": {
924+
"$ref": "GoogleCloudDatacatalogV1ReconcileTagsRequest"
925+
},
926+
"response": {
927+
"$ref": "Operation"
928+
},
929+
"scopes": [
930+
"https://www.googleapis.com/auth/cloud-platform"
931+
]
904932
}
905933
}
906934
}
@@ -2106,7 +2134,7 @@
21062134
}
21072135
}
21082136
},
2109-
"revision": "20230303",
2137+
"revision": "20230313",
21102138
"rootUrl": "https://datacatalog.googleapis.com/",
21112139
"schemas": {
21122140
"Binding": {
@@ -2600,6 +2628,7 @@
26002628
"CLOUD_PUBSUB",
26012629
"DATAPROC_METASTORE",
26022630
"DATAPLEX",
2631+
"CLOUD_SPANNER",
26032632
"CLOUD_SQL",
26042633
"LOOKER"
26052634
],
@@ -2609,6 +2638,7 @@
26092638
"Cloud Pub/Sub.",
26102639
"Dataproc Metastore.",
26112640
"Dataplex.",
2641+
"Cloud Spanner",
26122642
"Cloud Sql",
26132643
"Looker"
26142644
],
@@ -2743,6 +2773,7 @@
27432773
"CLOUD_PUBSUB",
27442774
"DATAPROC_METASTORE",
27452775
"DATAPLEX",
2776+
"CLOUD_SPANNER",
27462777
"CLOUD_SQL",
27472778
"LOOKER"
27482779
],
@@ -2752,6 +2783,7 @@
27522783
"Cloud Pub/Sub.",
27532784
"Dataproc Metastore.",
27542785
"Dataplex.",
2786+
"Cloud Spanner",
27552787
"Cloud Sql",
27562788
"Looker"
27572789
],
@@ -3387,6 +3419,80 @@
33873419
},
33883420
"type": "object"
33893421
},
3422+
"GoogleCloudDatacatalogV1ReconcileTagsMetadata": {
3423+
"description": "Long-running operation metadata message returned by the ReconcileTags.",
3424+
"id": "GoogleCloudDatacatalogV1ReconcileTagsMetadata",
3425+
"properties": {
3426+
"errors": {
3427+
"additionalProperties": {
3428+
"$ref": "Status"
3429+
},
3430+
"description": "Maps the name of each tagged column (or empty string for a sole entry) to tagging operation status.",
3431+
"type": "object"
3432+
},
3433+
"state": {
3434+
"description": "State of the reconciliation operation.",
3435+
"enum": [
3436+
"RECONCILIATION_STATE_UNSPECIFIED",
3437+
"RECONCILIATION_QUEUED",
3438+
"RECONCILIATION_IN_PROGRESS",
3439+
"RECONCILIATION_DONE"
3440+
],
3441+
"enumDescriptions": [
3442+
"Default value. This value is unused.",
3443+
"The reconciliation has been queued and awaits for execution.",
3444+
"The reconciliation is in progress.",
3445+
"The reconciliation has been finished."
3446+
],
3447+
"type": "string"
3448+
}
3449+
},
3450+
"type": "object"
3451+
},
3452+
"GoogleCloudDatacatalogV1ReconcileTagsRequest": {
3453+
"description": "Request message for ReconcileTags.",
3454+
"id": "GoogleCloudDatacatalogV1ReconcileTagsRequest",
3455+
"properties": {
3456+
"forceDeleteMissing": {
3457+
"description": "If set to `true`, deletes entry tags related to a tag template not listed in the tags source from an entry. If set to `false`, unlisted tags are retained.",
3458+
"type": "boolean"
3459+
},
3460+
"tagTemplate": {
3461+
"description": "Required. The name of the tag template, which is used for reconciliation.",
3462+
"type": "string"
3463+
},
3464+
"tags": {
3465+
"description": "A list of tags to apply to an entry. A tag can specify a tag template, which must be the template specified in the `ReconcileTagsRequest`. The sole entry and each of its columns must be mentioned at most once.",
3466+
"items": {
3467+
"$ref": "GoogleCloudDatacatalogV1Tag"
3468+
},
3469+
"type": "array"
3470+
}
3471+
},
3472+
"type": "object"
3473+
},
3474+
"GoogleCloudDatacatalogV1ReconcileTagsResponse": {
3475+
"description": "Long-running operation response message returned by ReconcileTags.",
3476+
"id": "GoogleCloudDatacatalogV1ReconcileTagsResponse",
3477+
"properties": {
3478+
"createdTagsCount": {
3479+
"description": "Number of tags created in the request.",
3480+
"format": "int64",
3481+
"type": "string"
3482+
},
3483+
"deletedTagsCount": {
3484+
"description": "Number of tags deleted in the request.",
3485+
"format": "int64",
3486+
"type": "string"
3487+
},
3488+
"updatedTagsCount": {
3489+
"description": "Number of tags updated in the request.",
3490+
"format": "int64",
3491+
"type": "string"
3492+
}
3493+
},
3494+
"type": "object"
3495+
},
33903496
"GoogleCloudDatacatalogV1RenameTagTemplateFieldEnumValueRequest": {
33913497
"description": "Request message for RenameTagTemplateFieldEnumValue.",
33923498
"id": "GoogleCloudDatacatalogV1RenameTagTemplateFieldEnumValueRequest",
@@ -3626,6 +3732,7 @@
36263732
"CLOUD_PUBSUB",
36273733
"DATAPROC_METASTORE",
36283734
"DATAPLEX",
3735+
"CLOUD_SPANNER",
36293736
"CLOUD_SQL",
36303737
"LOOKER"
36313738
],
@@ -3635,6 +3742,7 @@
36353742
"Cloud Pub/Sub.",
36363743
"Dataproc Metastore.",
36373744
"Dataplex.",
3745+
"Cloud Spanner",
36383746
"Cloud Sql",
36393747
"Looker"
36403748
],

googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1813,7 +1813,7 @@
18131813
}
18141814
}
18151815
},
1816-
"revision": "20230303",
1816+
"revision": "20230313",
18171817
"rootUrl": "https://datacatalog.googleapis.com/",
18181818
"schemas": {
18191819
"Binding": {
@@ -2296,6 +2296,7 @@
22962296
"CLOUD_PUBSUB",
22972297
"DATAPROC_METASTORE",
22982298
"DATAPLEX",
2299+
"CLOUD_SPANNER",
22992300
"CLOUD_SQL",
23002301
"LOOKER"
23012302
],
@@ -2305,6 +2306,7 @@
23052306
"Cloud Pub/Sub.",
23062307
"Dataproc Metastore.",
23072308
"Dataplex.",
2309+
"Cloud Spanner",
23082310
"Cloud Sql",
23092311
"Looker"
23102312
],
@@ -2439,6 +2441,7 @@
24392441
"CLOUD_PUBSUB",
24402442
"DATAPROC_METASTORE",
24412443
"DATAPLEX",
2444+
"CLOUD_SPANNER",
24422445
"CLOUD_SQL",
24432446
"LOOKER"
24442447
],
@@ -2448,6 +2451,7 @@
24482451
"Cloud Pub/Sub.",
24492452
"Dataproc Metastore.",
24502453
"Dataplex.",
2454+
"Cloud Spanner",
24512455
"Cloud Sql",
24522456
"Looker"
24532457
],
@@ -2794,6 +2798,58 @@
27942798
},
27952799
"type": "object"
27962800
},
2801+
"GoogleCloudDatacatalogV1ReconcileTagsMetadata": {
2802+
"description": "Long-running operation metadata message returned by the ReconcileTags.",
2803+
"id": "GoogleCloudDatacatalogV1ReconcileTagsMetadata",
2804+
"properties": {
2805+
"errors": {
2806+
"additionalProperties": {
2807+
"$ref": "Status"
2808+
},
2809+
"description": "Maps the name of each tagged column (or empty string for a sole entry) to tagging operation status.",
2810+
"type": "object"
2811+
},
2812+
"state": {
2813+
"description": "State of the reconciliation operation.",
2814+
"enum": [
2815+
"RECONCILIATION_STATE_UNSPECIFIED",
2816+
"RECONCILIATION_QUEUED",
2817+
"RECONCILIATION_IN_PROGRESS",
2818+
"RECONCILIATION_DONE"
2819+
],
2820+
"enumDescriptions": [
2821+
"Default value. This value is unused.",
2822+
"The reconciliation has been queued and awaits for execution.",
2823+
"The reconciliation is in progress.",
2824+
"The reconciliation has been finished."
2825+
],
2826+
"type": "string"
2827+
}
2828+
},
2829+
"type": "object"
2830+
},
2831+
"GoogleCloudDatacatalogV1ReconcileTagsResponse": {
2832+
"description": "Long-running operation response message returned by ReconcileTags.",
2833+
"id": "GoogleCloudDatacatalogV1ReconcileTagsResponse",
2834+
"properties": {
2835+
"createdTagsCount": {
2836+
"description": "Number of tags created in the request.",
2837+
"format": "int64",
2838+
"type": "string"
2839+
},
2840+
"deletedTagsCount": {
2841+
"description": "Number of tags deleted in the request.",
2842+
"format": "int64",
2843+
"type": "string"
2844+
},
2845+
"updatedTagsCount": {
2846+
"description": "Number of tags updated in the request.",
2847+
"format": "int64",
2848+
"type": "string"
2849+
}
2850+
},
2851+
"type": "object"
2852+
},
27972853
"GoogleCloudDatacatalogV1RoutineSpec": {
27982854
"description": "Specification that applies to a routine. Valid only for entries with the `ROUTINE` type.",
27992855
"id": "GoogleCloudDatacatalogV1RoutineSpec",

0 commit comments

Comments
 (0)