Skip to content

Commit c3abadc

Browse files
yoshi-automationsofisl
yoshi-automation
authored and
sofisl
committed
feat(pubsub): update the API
#### pubsub:v1 The following keys were added: - schemas.AwsMsk.description - schemas.AwsMsk.id - schemas.AwsMsk.properties.awsRoleArn.description - schemas.AwsMsk.properties.awsRoleArn.type - schemas.AwsMsk.properties.clusterArn.description - schemas.AwsMsk.properties.clusterArn.type - schemas.AwsMsk.properties.gcpServiceAccount.description - schemas.AwsMsk.properties.gcpServiceAccount.type - schemas.AwsMsk.properties.state.description - schemas.AwsMsk.properties.state.enum - schemas.AwsMsk.properties.state.enumDescriptions - schemas.AwsMsk.properties.state.readOnly - schemas.AwsMsk.properties.state.type - schemas.AwsMsk.properties.topic.description - schemas.AwsMsk.properties.topic.type - schemas.AwsMsk.type - schemas.AzureEventHubs.description - schemas.AzureEventHubs.id - schemas.AzureEventHubs.properties.clientId.description - schemas.AzureEventHubs.properties.clientId.type - schemas.AzureEventHubs.properties.eventHub.description - schemas.AzureEventHubs.properties.eventHub.type - schemas.AzureEventHubs.properties.gcpServiceAccount.description - schemas.AzureEventHubs.properties.gcpServiceAccount.type - schemas.AzureEventHubs.properties.namespace.description - schemas.AzureEventHubs.properties.namespace.type - schemas.AzureEventHubs.properties.resourceGroup.description - schemas.AzureEventHubs.properties.resourceGroup.type - schemas.AzureEventHubs.properties.state.description - schemas.AzureEventHubs.properties.state.enum - schemas.AzureEventHubs.properties.state.enumDescriptions - schemas.AzureEventHubs.properties.state.readOnly - schemas.AzureEventHubs.properties.state.type - schemas.AzureEventHubs.properties.subscriptionId.description - schemas.AzureEventHubs.properties.subscriptionId.type - schemas.AzureEventHubs.properties.tenantId.description - schemas.AzureEventHubs.properties.tenantId.type - schemas.AzureEventHubs.type - schemas.ConfluentCloud.description - schemas.ConfluentCloud.id - schemas.ConfluentCloud.properties.bootstrapServer.description - schemas.ConfluentCloud.properties.bootstrapServer.type - schemas.ConfluentCloud.properties.clusterId.description - schemas.ConfluentCloud.properties.clusterId.type - schemas.ConfluentCloud.properties.gcpServiceAccount.description - schemas.ConfluentCloud.properties.gcpServiceAccount.type - schemas.ConfluentCloud.properties.identityPoolId.description - schemas.ConfluentCloud.properties.identityPoolId.type - schemas.ConfluentCloud.properties.state.description - schemas.ConfluentCloud.properties.state.enum - schemas.ConfluentCloud.properties.state.enumDescriptions - schemas.ConfluentCloud.properties.state.readOnly - schemas.ConfluentCloud.properties.state.type - schemas.ConfluentCloud.properties.topic.description - schemas.ConfluentCloud.properties.topic.type - schemas.ConfluentCloud.type - schemas.IngestionDataSourceSettings.properties.awsMsk.$ref - schemas.IngestionDataSourceSettings.properties.awsMsk.description - schemas.IngestionDataSourceSettings.properties.azureEventHubs.$ref - schemas.IngestionDataSourceSettings.properties.azureEventHubs.description - schemas.IngestionDataSourceSettings.properties.confluentCloud.$ref - schemas.IngestionDataSourceSettings.properties.confluentCloud.description The following keys were changed: - schemas.AnalyticsHubSubscriptionInfo.description
1 parent 36722ba commit c3abadc

File tree

2 files changed

+272
-3
lines changed

2 files changed

+272
-3
lines changed

‎discovery/pubsub-v1.json

Lines changed: 168 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1638,7 +1638,7 @@
16381638
}
16391639
}
16401640
},
1641-
"revision": "20240918",
1641+
"revision": "20241231",
16421642
"rootUrl": "https://pubsub.googleapis.com/",
16431643
"schemas": {
16441644
"AcknowledgeRequest": {
@@ -1656,7 +1656,7 @@
16561656
"type": "object"
16571657
},
16581658
"AnalyticsHubSubscriptionInfo": {
1659-
"description": "Information about an associated Analytics Hub subscription (https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions).",
1659+
"description": "Information about an associated [Analytics Hub subscription](https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions).",
16601660
"id": "AnalyticsHubSubscriptionInfo",
16611661
"properties": {
16621662
"listing": {
@@ -1735,6 +1735,110 @@
17351735
},
17361736
"type": "object"
17371737
},
1738+
"AwsMsk": {
1739+
"description": "Ingestion settings for Amazon MSK.",
1740+
"id": "AwsMsk",
1741+
"properties": {
1742+
"awsRoleArn": {
1743+
"description": "Required. AWS role ARN to be used for Federated Identity authentication with Amazon MSK. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.",
1744+
"type": "string"
1745+
},
1746+
"clusterArn": {
1747+
"description": "Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.",
1748+
"type": "string"
1749+
},
1750+
"gcpServiceAccount": {
1751+
"description": "Required. The GCP service account to be used for Federated Identity authentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` call for the provided role). The `aws_role_arn` must be set up with `accounts.google.com:sub` equals to this service account number.",
1752+
"type": "string"
1753+
},
1754+
"state": {
1755+
"description": "Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.",
1756+
"enum": [
1757+
"STATE_UNSPECIFIED",
1758+
"ACTIVE",
1759+
"MSK_PERMISSION_DENIED",
1760+
"PUBLISH_PERMISSION_DENIED",
1761+
"CLUSTER_NOT_FOUND",
1762+
"TOPIC_NOT_FOUND"
1763+
],
1764+
"enumDescriptions": [
1765+
"Default value. This value is unused.",
1766+
"Ingestion is active.",
1767+
"Permission denied encountered while consuming data from Amazon MSK.",
1768+
"Permission denied encountered while publishing to the topic.",
1769+
"The provided MSK cluster wasn't found.",
1770+
"The provided topic wasn't found."
1771+
],
1772+
"readOnly": true,
1773+
"type": "string"
1774+
},
1775+
"topic": {
1776+
"description": "Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.",
1777+
"type": "string"
1778+
}
1779+
},
1780+
"type": "object"
1781+
},
1782+
"AzureEventHubs": {
1783+
"description": "Ingestion settings for Azure Event Hubs.",
1784+
"id": "AzureEventHubs",
1785+
"properties": {
1786+
"clientId": {
1787+
"description": "Optional. The client id of the Azure application that is being used to authenticate Pub/Sub.",
1788+
"type": "string"
1789+
},
1790+
"eventHub": {
1791+
"description": "Optional. The name of the Event Hub.",
1792+
"type": "string"
1793+
},
1794+
"gcpServiceAccount": {
1795+
"description": "Optional. The GCP service account to be used for Federated Identity authentication.",
1796+
"type": "string"
1797+
},
1798+
"namespace": {
1799+
"description": "Optional. The name of the Event Hubs namespace.",
1800+
"type": "string"
1801+
},
1802+
"resourceGroup": {
1803+
"description": "Optional. Name of the resource group within the azure subscription.",
1804+
"type": "string"
1805+
},
1806+
"state": {
1807+
"description": "Output only. An output-only field that indicates the state of the Event Hubs ingestion source.",
1808+
"enum": [
1809+
"STATE_UNSPECIFIED",
1810+
"ACTIVE",
1811+
"EVENT_HUBS_PERMISSION_DENIED",
1812+
"PUBLISH_PERMISSION_DENIED",
1813+
"NAMESPACE_NOT_FOUND",
1814+
"EVENT_HUB_NOT_FOUND",
1815+
"SUBSCRIPTION_NOT_FOUND",
1816+
"RESOURCE_GROUP_NOT_FOUND"
1817+
],
1818+
"enumDescriptions": [
1819+
"Default value. This value is unused.",
1820+
"Ingestion is active.",
1821+
"Permission denied encountered while consuming data from Event Hubs. This can happen when `client_id`, or `tenant_id` are invalid. Or the right permissions haven't been granted.",
1822+
"Permission denied encountered while publishing to the topic.",
1823+
"The provided Event Hubs namespace couldn't be found.",
1824+
"The provided Event Hub couldn't be found.",
1825+
"The provided Event Hubs subscription couldn't be found.",
1826+
"The provided Event Hubs resource group couldn't be found."
1827+
],
1828+
"readOnly": true,
1829+
"type": "string"
1830+
},
1831+
"subscriptionId": {
1832+
"description": "Optional. The Azure subscription id.",
1833+
"type": "string"
1834+
},
1835+
"tenantId": {
1836+
"description": "Optional. The tenant id of the Azure application that is being used to authenticate Pub/Sub.",
1837+
"type": "string"
1838+
}
1839+
},
1840+
"type": "object"
1841+
},
17381842
"BigQueryConfig": {
17391843
"description": "Configuration for a BigQuery subscription.",
17401844
"id": "BigQueryConfig",
@@ -1944,6 +2048,56 @@
19442048
},
19452049
"type": "object"
19462050
},
2051+
"ConfluentCloud": {
2052+
"description": "Ingestion settings for Confluent Cloud.",
2053+
"id": "ConfluentCloud",
2054+
"properties": {
2055+
"bootstrapServer": {
2056+
"description": "Required. The address of the bootstrap server. The format is url:port.",
2057+
"type": "string"
2058+
},
2059+
"clusterId": {
2060+
"description": "Required. The id of the cluster.",
2061+
"type": "string"
2062+
},
2063+
"gcpServiceAccount": {
2064+
"description": "Required. The GCP service account to be used for Federated Identity authentication with `identity_pool_id`.",
2065+
"type": "string"
2066+
},
2067+
"identityPoolId": {
2068+
"description": "Required. The id of the identity pool to be used for Federated Identity authentication with Confluent Cloud. See https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools.",
2069+
"type": "string"
2070+
},
2071+
"state": {
2072+
"description": "Output only. An output-only field that indicates the state of the Confluent Cloud ingestion source.",
2073+
"enum": [
2074+
"STATE_UNSPECIFIED",
2075+
"ACTIVE",
2076+
"CONFLUENT_CLOUD_PERMISSION_DENIED",
2077+
"PUBLISH_PERMISSION_DENIED",
2078+
"UNREACHABLE_BOOTSTRAP_SERVER",
2079+
"CLUSTER_NOT_FOUND",
2080+
"TOPIC_NOT_FOUND"
2081+
],
2082+
"enumDescriptions": [
2083+
"Default value. This value is unused.",
2084+
"Ingestion is active.",
2085+
"Permission denied encountered while consuming data from Confluent Cloud.",
2086+
"Permission denied encountered while publishing to the topic.",
2087+
"The provided bootstrap server address is unreachable.",
2088+
"The provided cluster wasn't found.",
2089+
"The provided topic wasn't found."
2090+
],
2091+
"readOnly": true,
2092+
"type": "string"
2093+
},
2094+
"topic": {
2095+
"description": "Required. The name of the topic in the Confluent Cloud cluster that Pub/Sub will import from.",
2096+
"type": "string"
2097+
}
2098+
},
2099+
"type": "object"
2100+
},
19472101
"CreateSnapshotRequest": {
19482102
"description": "Request for the `CreateSnapshot` method.",
19492103
"id": "CreateSnapshotRequest",
@@ -2033,10 +2187,22 @@
20332187
"$ref": "AwsKinesis",
20342188
"description": "Optional. Amazon Kinesis Data Streams."
20352189
},
2190+
"awsMsk": {
2191+
"$ref": "AwsMsk",
2192+
"description": "Optional. Amazon MSK."
2193+
},
2194+
"azureEventHubs": {
2195+
"$ref": "AzureEventHubs",
2196+
"description": "Optional. Azure Event Hubs."
2197+
},
20362198
"cloudStorage": {
20372199
"$ref": "CloudStorage",
20382200
"description": "Optional. Cloud Storage."
20392201
},
2202+
"confluentCloud": {
2203+
"$ref": "ConfluentCloud",
2204+
"description": "Optional. Confluent Cloud."
2205+
},
20402206
"platformLogsSettings": {
20412207
"$ref": "PlatformLogsSettings",
20422208
"description": "Optional. Platform Logs settings. If unset, no Platform Logs will be generated."

‎src/apis/pubsub/v1.ts

Lines changed: 104 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ export namespace pubsub_v1 {
134134
ackIds?: string[] | null;
135135
}
136136
/**
137-
* Information about an associated Analytics Hub subscription (https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions).
137+
* Information about an associated [Analytics Hub subscription](https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions).
138138
*/
139139
export interface Schema$AnalyticsHubSubscriptionInfo {
140140
/**
@@ -188,6 +188,68 @@ export namespace pubsub_v1 {
188188
*/
189189
streamArn?: string | null;
190190
}
191+
/**
192+
* Ingestion settings for Amazon MSK.
193+
*/
194+
export interface Schema$AwsMsk {
195+
/**
196+
* Required. AWS role ARN to be used for Federated Identity authentication with Amazon MSK. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.
197+
*/
198+
awsRoleArn?: string | null;
199+
/**
200+
* Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.
201+
*/
202+
clusterArn?: string | null;
203+
/**
204+
* Required. The GCP service account to be used for Federated Identity authentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` call for the provided role). The `aws_role_arn` must be set up with `accounts.google.com:sub` equals to this service account number.
205+
*/
206+
gcpServiceAccount?: string | null;
207+
/**
208+
* Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.
209+
*/
210+
state?: string | null;
211+
/**
212+
* Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.
213+
*/
214+
topic?: string | null;
215+
}
216+
/**
217+
* Ingestion settings for Azure Event Hubs.
218+
*/
219+
export interface Schema$AzureEventHubs {
220+
/**
221+
* Optional. The client id of the Azure application that is being used to authenticate Pub/Sub.
222+
*/
223+
clientId?: string | null;
224+
/**
225+
* Optional. The name of the Event Hub.
226+
*/
227+
eventHub?: string | null;
228+
/**
229+
* Optional. The GCP service account to be used for Federated Identity authentication.
230+
*/
231+
gcpServiceAccount?: string | null;
232+
/**
233+
* Optional. The name of the Event Hubs namespace.
234+
*/
235+
namespace?: string | null;
236+
/**
237+
* Optional. Name of the resource group within the azure subscription.
238+
*/
239+
resourceGroup?: string | null;
240+
/**
241+
* Output only. An output-only field that indicates the state of the Event Hubs ingestion source.
242+
*/
243+
state?: string | null;
244+
/**
245+
* Optional. The Azure subscription id.
246+
*/
247+
subscriptionId?: string | null;
248+
/**
249+
* Optional. The tenant id of the Azure application that is being used to authenticate Pub/Sub.
250+
*/
251+
tenantId?: string | null;
252+
}
191253
/**
192254
* Configuration for a BigQuery subscription.
193255
*/
@@ -329,6 +391,35 @@ export namespace pubsub_v1 {
329391
*/
330392
schema?: Schema$Schema;
331393
}
394+
/**
395+
* Ingestion settings for Confluent Cloud.
396+
*/
397+
export interface Schema$ConfluentCloud {
398+
/**
399+
* Required. The address of the bootstrap server. The format is url:port.
400+
*/
401+
bootstrapServer?: string | null;
402+
/**
403+
* Required. The id of the cluster.
404+
*/
405+
clusterId?: string | null;
406+
/**
407+
* Required. The GCP service account to be used for Federated Identity authentication with `identity_pool_id`.
408+
*/
409+
gcpServiceAccount?: string | null;
410+
/**
411+
* Required. The id of the identity pool to be used for Federated Identity authentication with Confluent Cloud. See https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools.
412+
*/
413+
identityPoolId?: string | null;
414+
/**
415+
* Output only. An output-only field that indicates the state of the Confluent Cloud ingestion source.
416+
*/
417+
state?: string | null;
418+
/**
419+
* Required. The name of the topic in the Confluent Cloud cluster that Pub/Sub will import from.
420+
*/
421+
topic?: string | null;
422+
}
332423
/**
333424
* Request for the `CreateSnapshot` method.
334425
*/
@@ -401,10 +492,22 @@ export namespace pubsub_v1 {
401492
* Optional. Amazon Kinesis Data Streams.
402493
*/
403494
awsKinesis?: Schema$AwsKinesis;
495+
/**
496+
* Optional. Amazon MSK.
497+
*/
498+
awsMsk?: Schema$AwsMsk;
499+
/**
500+
* Optional. Azure Event Hubs.
501+
*/
502+
azureEventHubs?: Schema$AzureEventHubs;
404503
/**
405504
* Optional. Cloud Storage.
406505
*/
407506
cloudStorage?: Schema$CloudStorage;
507+
/**
508+
* Optional. Confluent Cloud.
509+
*/
510+
confluentCloud?: Schema$ConfluentCloud;
408511
/**
409512
* Optional. Platform Logs settings. If unset, no Platform Logs will be generated.
410513
*/

0 commit comments

Comments
 (0)