Skip to content

Commit 6096d3b

Browse files
feat(analyticshub): update the api
#### analyticshub:v1 The following keys were added: - schemas.GooglePubsubV1Subscription.properties.messageTransforms (Total Keys: 2) - schemas.JavaScriptUDF (Total Keys: 4) - schemas.MessageTransform (Total Keys: 4)
1 parent 60125ab commit 6096d3b

File tree

2 files changed

+56
-10
lines changed

2 files changed

+56
-10
lines changed

docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ <h2>Instance Methods</h2>
108108
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
109109
<p class="firstline">Sets the IAM policy.</p>
110110
<p class="toc_element">
111-
<code><a href="#subscribe">subscribe(name, body=None, x__xgafv=None)</a></code></p>
111+
<code><a href="#subscribe">subscribe(name, body, x__xgafv=None)</a></code></p>
112112
<p class="firstline">Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.</p>
113113
<p class="toc_element">
114114
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
@@ -130,7 +130,7 @@ <h3>Method Details</h3>
130130

131131
{ # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.
132132
&quot;bigqueryDataset&quot;: { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber&#x27;s subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber&#x27;s project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source.
133-
&quot;dataset&quot;: &quot;A String&quot;, # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
133+
&quot;dataset&quot;: &quot;A String&quot;, # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
134134
&quot;restrictedExportPolicy&quot;: { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset.
135135
&quot;enabled&quot;: True or False, # Optional. If true, enable restricted export.
136136
&quot;restrictDirectTableAccess&quot;: True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table.
@@ -194,7 +194,7 @@ <h3>Method Details</h3>
194194

195195
{ # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.
196196
&quot;bigqueryDataset&quot;: { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber&#x27;s subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber&#x27;s project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source.
197-
&quot;dataset&quot;: &quot;A String&quot;, # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
197+
&quot;dataset&quot;: &quot;A String&quot;, # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
198198
&quot;restrictedExportPolicy&quot;: { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset.
199199
&quot;enabled&quot;: True or False, # Optional. If true, enable restricted export.
200200
&quot;restrictDirectTableAccess&quot;: True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table.
@@ -282,7 +282,7 @@ <h3>Method Details</h3>
282282

283283
{ # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.
284284
&quot;bigqueryDataset&quot;: { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber&#x27;s subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber&#x27;s project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source.
285-
&quot;dataset&quot;: &quot;A String&quot;, # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
285+
&quot;dataset&quot;: &quot;A String&quot;, # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
286286
&quot;restrictedExportPolicy&quot;: { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset.
287287
&quot;enabled&quot;: True or False, # Optional. If true, enable restricted export.
288288
&quot;restrictDirectTableAccess&quot;: True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table.
@@ -412,7 +412,7 @@ <h3>Method Details</h3>
412412
&quot;listings&quot;: [ # The list of Listing.
413413
{ # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.
414414
&quot;bigqueryDataset&quot;: { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber&#x27;s subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber&#x27;s project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source.
415-
&quot;dataset&quot;: &quot;A String&quot;, # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
415+
&quot;dataset&quot;: &quot;A String&quot;, # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
416416
&quot;restrictedExportPolicy&quot;: { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset.
417417
&quot;enabled&quot;: True or False, # Optional. If true, enable restricted export.
418418
&quot;restrictDirectTableAccess&quot;: True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table.
@@ -563,7 +563,7 @@ <h3>Method Details</h3>
563563

564564
{ # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.
565565
&quot;bigqueryDataset&quot;: { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber&#x27;s subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber&#x27;s project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source.
566-
&quot;dataset&quot;: &quot;A String&quot;, # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
566+
&quot;dataset&quot;: &quot;A String&quot;, # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
567567
&quot;restrictedExportPolicy&quot;: { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset.
568568
&quot;enabled&quot;: True or False, # Optional. If true, enable restricted export.
569569
&quot;restrictDirectTableAccess&quot;: True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table.
@@ -627,7 +627,7 @@ <h3>Method Details</h3>
627627

628628
{ # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.
629629
&quot;bigqueryDataset&quot;: { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber&#x27;s subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber&#x27;s project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source.
630-
&quot;dataset&quot;: &quot;A String&quot;, # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
630+
&quot;dataset&quot;: &quot;A String&quot;, # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
631631
&quot;restrictedExportPolicy&quot;: { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset.
632632
&quot;enabled&quot;: True or False, # Optional. If true, enable restricted export.
633633
&quot;restrictDirectTableAccess&quot;: True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table.
@@ -767,7 +767,7 @@ <h3>Method Details</h3>
767767
</div>
768768

769769
<div class="method">
770-
<code class="details" id="subscribe">subscribe(name, body=None, x__xgafv=None)</code>
770+
<code class="details" id="subscribe">subscribe(name, body, x__xgafv=None)</code>
771771
<pre>Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber&#x27;s project.
772772

773773
Args:
@@ -836,6 +836,15 @@ <h3>Method Details</h3>
836836
&quot;a_key&quot;: &quot;A String&quot;,
837837
},
838838
&quot;messageRetentionDuration&quot;: &quot;A String&quot;, # Optional. How long to retain unacknowledged messages in the subscription&#x27;s backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes.
839+
&quot;messageTransforms&quot;: [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.
840+
{ # All supported message transforms types.
841+
&quot;enabled&quot;: True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`.
842+
&quot;javascriptUdf&quot;: { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF&#x27;s are specified on a resource, each must have a unique `function_name`.
843+
&quot;code&quot;: &quot;A String&quot;, # Required. JavaScript code that contains a function `function_name` with the below signature: ``` /** * Transforms a Pub/Sub message. * @return {(Object)&gt;|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) &#x27;data&#x27; : {string} * - (optional) &#x27;attributes&#x27; : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)&gt;} Pub/Sub * message. Keys: * - (required) &#x27;data&#x27; : {string} * - (required) &#x27;attributes&#x27; : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) &#x27;message_id&#x27; : {string} * - (optional) &#x27;publish_time&#x27;: {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) &#x27;ordering_key&#x27;: {string} */ function (message, metadata) { } ```
844+
&quot;functionName&quot;: &quot;A String&quot;, # Required. Name of the JavasScript function that should applied to Pub/Sub messages.
845+
},
846+
},
847+
],
839848
&quot;name&quot;: &quot;A String&quot;, # Required. Name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.
840849
&quot;pushConfig&quot;: { # Configuration for a push delivery endpoint. # Optional. If push delivery is used with this subscription, this field is used to configure it.
841850
&quot;attributes&quot;: { # Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { &quot;x-goog-version&quot;: &quot;v1&quot; }`

googleapiclient/discovery_cache/documents/analyticshub.v1.json

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1022,7 +1022,7 @@
10221022
}
10231023
}
10241024
},
1025-
"revision": "20250126",
1025+
"revision": "20250203",
10261026
"rootUrl": "https://analyticshub.googleapis.com/",
10271027
"schemas": {
10281028
"AnalyticsHubSubscriptionInfo": {
@@ -1160,7 +1160,7 @@
11601160
"id": "BigQueryDatasetSource",
11611161
"properties": {
11621162
"dataset": {
1163-
"description": "Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`",
1163+
"description": "Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`",
11641164
"type": "string"
11651165
},
11661166
"restrictedExportPolicy": {
@@ -1620,6 +1620,13 @@
16201620
"format": "google-duration",
16211621
"type": "string"
16221622
},
1623+
"messageTransforms": {
1624+
"description": "Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.",
1625+
"items": {
1626+
"$ref": "MessageTransform"
1627+
},
1628+
"type": "array"
1629+
},
16231630
"name": {
16241631
"description": "Required. Name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.",
16251632
"type": "string"
@@ -1660,6 +1667,21 @@
16601667
},
16611668
"type": "object"
16621669
},
1670+
"JavaScriptUDF": {
1671+
"description": "User-defined JavaScript function that can transform or filter a Pub/Sub message.",
1672+
"id": "JavaScriptUDF",
1673+
"properties": {
1674+
"code": {
1675+
"description": "Required. JavaScript code that contains a function `function_name` with the below signature: ``` /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } ```",
1676+
"type": "string"
1677+
},
1678+
"functionName": {
1679+
"description": "Required. Name of the JavasScript function that should applied to Pub/Sub messages.",
1680+
"type": "string"
1681+
}
1682+
},
1683+
"type": "object"
1684+
},
16631685
"LinkedResource": {
16641686
"description": "Reference to a linked resource tracked by this Subscription.",
16651687
"id": "LinkedResource",
@@ -1927,6 +1949,21 @@
19271949
},
19281950
"type": "object"
19291951
},
1952+
"MessageTransform": {
1953+
"description": "All supported message transforms types.",
1954+
"id": "MessageTransform",
1955+
"properties": {
1956+
"enabled": {
1957+
"description": "Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`.",
1958+
"type": "boolean"
1959+
},
1960+
"javascriptUdf": {
1961+
"$ref": "JavaScriptUDF",
1962+
"description": "Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`."
1963+
}
1964+
},
1965+
"type": "object"
1966+
},
19301967
"NoWrapper": {
19311968
"description": "Sets the `data` field as the HTTP body for delivery.",
19321969
"id": "NoWrapper",

0 commit comments

Comments
 (0)