Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 24d3897

Browse files
committedMay 24, 2023
feat(pubsub): update the api
#### pubsub:v1 The following keys were added: - schemas.AvroConfig (Total Keys: 3) - schemas.CloudStorageConfig (Total Keys: 13) - schemas.Subscription.properties.cloudStorageConfig.$ref (Total Keys: 1) - schemas.TextConfig (Total Keys: 2)
1 parent 3ac6dde commit 24d3897

File tree

4 files changed

+179
-25
lines changed

4 files changed

+179
-25
lines changed
 

‎docs/dyn/pubsub_v1.projects.subscriptions.html

+98-20
Large diffs are not rendered by default.

‎googleapiclient/discovery_cache/documents/pubsub.v1.json

+79-3
Original file line numberDiff line numberDiff line change
@@ -1565,7 +1565,7 @@
15651565
}
15661566
}
15671567
},
1568-
"revision": "20230404",
1568+
"revision": "20230509",
15691569
"rootUrl": "https://pubsub.googleapis.com/",
15701570
"schemas": {
15711571
"AcknowledgeRequest": {
@@ -1582,6 +1582,17 @@
15821582
},
15831583
"type": "object"
15841584
},
1585+
"AvroConfig": {
1586+
"description": "Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.",
1587+
"id": "AvroConfig",
1588+
"properties": {
1589+
"writeMetadata": {
1590+
"description": "When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output.",
1591+
"type": "boolean"
1592+
}
1593+
},
1594+
"type": "object"
1595+
},
15851596
"BigQueryConfig": {
15861597
"description": "Configuration for a BigQuery subscription.",
15871598
"id": "BigQueryConfig",
@@ -1646,6 +1657,60 @@
16461657
},
16471658
"type": "object"
16481659
},
1660+
"CloudStorageConfig": {
1661+
"description": "Configuration for a Cloud Storage subscription.",
1662+
"id": "CloudStorageConfig",
1663+
"properties": {
1664+
"avroConfig": {
1665+
"$ref": "AvroConfig",
1666+
"description": "If set, message data will be written to Cloud Storage in Avro format."
1667+
},
1668+
"bucket": {
1669+
"description": "Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like \"gs://\". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).",
1670+
"type": "string"
1671+
},
1672+
"filenamePrefix": {
1673+
"description": "User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming).",
1674+
"type": "string"
1675+
},
1676+
"filenameSuffix": {
1677+
"description": "User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming).",
1678+
"type": "string"
1679+
},
1680+
"maxBytes": {
1681+
"description": "The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.",
1682+
"format": "int64",
1683+
"type": "string"
1684+
},
1685+
"maxDuration": {
1686+
"description": "The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.",
1687+
"format": "google-duration",
1688+
"type": "string"
1689+
},
1690+
"state": {
1691+
"description": "Output only. An output-only field that indicates whether or not the subscription can receive messages.",
1692+
"enum": [
1693+
"STATE_UNSPECIFIED",
1694+
"ACTIVE",
1695+
"PERMISSION_DENIED",
1696+
"NOT_FOUND"
1697+
],
1698+
"enumDescriptions": [
1699+
"Default value. This value is unused.",
1700+
"The subscription can actively send messages to Cloud Storage.",
1701+
"Cannot write to the Cloud Storage bucket because of permission denied errors.",
1702+
"Cannot write to the Cloud Storage bucket because it does not exist."
1703+
],
1704+
"readOnly": true,
1705+
"type": "string"
1706+
},
1707+
"textConfig": {
1708+
"$ref": "TextConfig",
1709+
"description": "If set, message data will be written to Cloud Storage in text format."
1710+
}
1711+
},
1712+
"type": "object"
1713+
},
16491714
"CommitSchemaRequest": {
16501715
"description": "Request for CommitSchema method.",
16511716
"id": "CommitSchemaRequest",
@@ -1909,14 +1974,15 @@
19091974
"type": "object"
19101975
},
19111976
"OidcToken": {
1912-
"description": "Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). [Service account email](https://cloud.google.com/iam/docs/service-accounts) used for generating the OIDC token. For more information on setting up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/push).",
1977+
"description": "Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect).",
19131978
"id": "OidcToken",
19141979
"properties": {
19151980
"audience": {
19161981
"description": "Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.",
19171982
"type": "string"
19181983
},
19191984
"serviceAccountEmail": {
1985+
"description": "[Service account email](https://cloud.google.com/iam/docs/service-accounts) used for generating the OIDC token. For more information on setting up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/push).",
19201986
"type": "string"
19211987
}
19221988
},
@@ -2240,7 +2306,7 @@
22402306
"type": "object"
22412307
},
22422308
"Subscription": {
2243-
"description": "A subscription resource. If none of `push_config` or `bigquery_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set.",
2309+
"description": "A subscription resource. If none of `push_config`, `bigquery_config`, or `cloud_storage_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set.",
22442310
"id": "Subscription",
22452311
"properties": {
22462312
"ackDeadlineSeconds": {
@@ -2252,6 +2318,10 @@
22522318
"$ref": "BigQueryConfig",
22532319
"description": "If delivery to BigQuery is used with this subscription, this field is used to configure it."
22542320
},
2321+
"cloudStorageConfig": {
2322+
"$ref": "CloudStorageConfig",
2323+
"description": "If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it."
2324+
},
22552325
"deadLetterPolicy": {
22562326
"$ref": "DeadLetterPolicy",
22572327
"description": "A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription."
@@ -2360,6 +2430,12 @@
23602430
},
23612431
"type": "object"
23622432
},
2433+
"TextConfig": {
2434+
"description": "Configuration for writing message data in text format. Message payloads will be written to files as raw text, separated by a newline.",
2435+
"id": "TextConfig",
2436+
"properties": {},
2437+
"type": "object"
2438+
},
23632439
"Topic": {
23642440
"description": "A topic resource.",
23652441
"id": "Topic",

‎googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -457,7 +457,7 @@
457457
}
458458
}
459459
},
460-
"revision": "20230404",
460+
"revision": "20230509",
461461
"rootUrl": "https://pubsub.googleapis.com/",
462462
"schemas": {
463463
"AcknowledgeRequest": {

‎googleapiclient/discovery_cache/documents/pubsub.v1beta2.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -724,7 +724,7 @@
724724
}
725725
}
726726
},
727-
"revision": "20230404",
727+
"revision": "20230509",
728728
"rootUrl": "https://pubsub.googleapis.com/",
729729
"schemas": {
730730
"AcknowledgeRequest": {

0 commit comments

Comments
 (0)
Please sign in to comment.