You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/dyn/pubsub_v1.projects.subscriptions.html
+12-6
Original file line number
Diff line number
Diff line change
@@ -213,7 +213,8 @@ <h3>Method Details</h3>
213
213
"messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription'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.
214
214
"messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.
215
215
{ # All supported message transforms types.
216
-
"enabled": 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`.
216
+
"disabled": True or False, # Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.
217
+
"enabled": True or False, # Optional. This field is deprecated, use the `disabled` field to disable transforms.
217
218
"javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
218
219
"code": "A String", # 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) { } ```
219
220
"functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages.
@@ -303,7 +304,8 @@ <h3>Method Details</h3>
303
304
"messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription'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.
304
305
"messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.
305
306
{ # All supported message transforms types.
306
-
"enabled": 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`.
307
+
"disabled": True or False, # Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.
308
+
"enabled": True or False, # Optional. This field is deprecated, use the `disabled` field to disable transforms.
307
309
"javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
308
310
"code": "A String", # 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) { } ```
309
311
"functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages.
@@ -436,7 +438,8 @@ <h3>Method Details</h3>
436
438
"messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription'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.
437
439
"messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.
438
440
{ # All supported message transforms types.
439
-
"enabled": 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`.
441
+
"disabled": True or False, # Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.
442
+
"enabled": True or False, # Optional. This field is deprecated, use the `disabled` field to disable transforms.
440
443
"javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
441
444
"code": "A String", # 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) { } ```
442
445
"functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages.
@@ -573,7 +576,8 @@ <h3>Method Details</h3>
573
576
"messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription'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.
574
577
"messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.
575
578
{ # All supported message transforms types.
576
-
"enabled": 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`.
579
+
"disabled": True or False, # Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.
580
+
"enabled": True or False, # Optional. This field is deprecated, use the `disabled` field to disable transforms.
577
581
"javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
578
582
"code": "A String", # 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) { } ```
579
583
"functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages.
@@ -749,7 +753,8 @@ <h3>Method Details</h3>
749
753
"messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription'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.
750
754
"messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.
751
755
{ # All supported message transforms types.
752
-
"enabled": 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`.
756
+
"disabled": True or False, # Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.
757
+
"enabled": True or False, # Optional. This field is deprecated, use the `disabled` field to disable transforms.
753
758
"javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
754
759
"code": "A String", # 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) { } ```
755
760
"functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages.
@@ -841,7 +846,8 @@ <h3>Method Details</h3>
841
846
"messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription'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.
842
847
"messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.
843
848
{ # All supported message transforms types.
844
-
"enabled": 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`.
849
+
"disabled": True or False, # Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.
850
+
"enabled": True or False, # Optional. This field is deprecated, use the `disabled` field to disable transforms.
845
851
"javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
846
852
"code": "A String", # 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) { } ```
847
853
"functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages.
Copy file name to clipboardexpand all lines: docs/dyn/pubsub_v1.projects.topics.html
+12-6
Original file line number
Diff line number
Diff line change
@@ -196,7 +196,8 @@ <h3>Method Details</h3>
196
196
},
197
197
"messageTransforms": [ # Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified.
198
198
{ # All supported message transforms types.
199
-
"enabled": 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`.
199
+
"disabled": True or False, # Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.
200
+
"enabled": True or False, # Optional. This field is deprecated, use the `disabled` field to disable transforms.
200
201
"javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
201
202
"code": "A String", # 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) { } ```
202
203
"functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages.
@@ -286,7 +287,8 @@ <h3>Method Details</h3>
286
287
},
287
288
"messageTransforms": [ # Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified.
288
289
{ # All supported message transforms types.
289
-
"enabled": 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`.
290
+
"disabled": True or False, # Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.
291
+
"enabled": True or False, # Optional. This field is deprecated, use the `disabled` field to disable transforms.
290
292
"javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
291
293
"code": "A String", # 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) { } ```
292
294
"functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages.
@@ -401,7 +403,8 @@ <h3>Method Details</h3>
401
403
},
402
404
"messageTransforms": [ # Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified.
403
405
{ # All supported message transforms types.
404
-
"enabled": 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`.
406
+
"disabled": True or False, # Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.
407
+
"enabled": True or False, # Optional. This field is deprecated, use the `disabled` field to disable transforms.
405
408
"javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
406
409
"code": "A String", # 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) { } ```
407
410
"functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages.
@@ -538,7 +541,8 @@ <h3>Method Details</h3>
538
541
},
539
542
"messageTransforms": [ # Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified.
540
543
{ # All supported message transforms types.
541
-
"enabled": 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`.
544
+
"disabled": True or False, # Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.
545
+
"enabled": True or False, # Optional. This field is deprecated, use the `disabled` field to disable transforms.
542
546
"javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
543
547
"code": "A String", # 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) { } ```
544
548
"functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages.
@@ -647,7 +651,8 @@ <h3>Method Details</h3>
647
651
},
648
652
"messageTransforms": [ # Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified.
649
653
{ # All supported message transforms types.
650
-
"enabled": 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`.
654
+
"disabled": True or False, # Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.
655
+
"enabled": True or False, # Optional. This field is deprecated, use the `disabled` field to disable transforms.
651
656
"javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
652
657
"code": "A String", # 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) { } ```
653
658
"functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages.
@@ -739,7 +744,8 @@ <h3>Method Details</h3>
739
744
},
740
745
"messageTransforms": [ # Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified.
741
746
{ # All supported message transforms types.
742
-
"enabled": 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`.
747
+
"disabled": True or False, # Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.
748
+
"enabled": True or False, # Optional. This field is deprecated, use the `disabled` field to disable transforms.
743
749
"javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
744
750
"code": "A String", # 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) { } ```
745
751
"functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages.
Copy file name to clipboardexpand all lines: googleapiclient/discovery_cache/documents/pubsub.v1.json
+7-2
Original file line number
Diff line number
Diff line change
@@ -1638,7 +1638,7 @@
1638
1638
}
1639
1639
}
1640
1640
},
1641
-
"revision": "20250218",
1641
+
"revision": "20250311",
1642
1642
"rootUrl": "https://pubsub.googleapis.com/",
1643
1643
"schemas": {
1644
1644
"AcknowledgeRequest": {
@@ -2373,8 +2373,13 @@
2373
2373
"description": "All supported message transforms types.",
2374
2374
"id": "MessageTransform",
2375
2375
"properties": {
2376
+
"disabled": {
2377
+
"description": "Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.",
2378
+
"type": "boolean"
2379
+
},
2376
2380
"enabled": {
2377
-
"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`.",
2381
+
"deprecated": true,
2382
+
"description": "Optional. This field is deprecated, use the `disabled` field to disable transforms.",
0 commit comments