|
1565 | 1565 | }
|
1566 | 1566 | }
|
1567 | 1567 | },
|
1568 |
| - "revision": "20230404", |
| 1568 | + "revision": "20230509", |
1569 | 1569 | "rootUrl": "https://pubsub.googleapis.com/",
|
1570 | 1570 | "schemas": {
|
1571 | 1571 | "AcknowledgeRequest": {
|
|
1582 | 1582 | },
|
1583 | 1583 | "type": "object"
|
1584 | 1584 | },
|
| 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 | + }, |
1585 | 1596 | "BigQueryConfig": {
|
1586 | 1597 | "description": "Configuration for a BigQuery subscription.",
|
1587 | 1598 | "id": "BigQueryConfig",
|
|
1646 | 1657 | },
|
1647 | 1658 | "type": "object"
|
1648 | 1659 | },
|
| 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 | + }, |
1649 | 1714 | "CommitSchemaRequest": {
|
1650 | 1715 | "description": "Request for CommitSchema method.",
|
1651 | 1716 | "id": "CommitSchemaRequest",
|
|
1909 | 1974 | "type": "object"
|
1910 | 1975 | },
|
1911 | 1976 | "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).", |
1913 | 1978 | "id": "OidcToken",
|
1914 | 1979 | "properties": {
|
1915 | 1980 | "audience": {
|
1916 | 1981 | "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.",
|
1917 | 1982 | "type": "string"
|
1918 | 1983 | },
|
1919 | 1984 | "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).", |
1920 | 1986 | "type": "string"
|
1921 | 1987 | }
|
1922 | 1988 | },
|
|
2240 | 2306 | "type": "object"
|
2241 | 2307 | },
|
2242 | 2308 | "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.", |
2244 | 2310 | "id": "Subscription",
|
2245 | 2311 | "properties": {
|
2246 | 2312 | "ackDeadlineSeconds": {
|
|
2252 | 2318 | "$ref": "BigQueryConfig",
|
2253 | 2319 | "description": "If delivery to BigQuery is used with this subscription, this field is used to configure it."
|
2254 | 2320 | },
|
| 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 | + }, |
2255 | 2325 | "deadLetterPolicy": {
|
2256 | 2326 | "$ref": "DeadLetterPolicy",
|
2257 | 2327 | "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 | 2430 | },
|
2361 | 2431 | "type": "object"
|
2362 | 2432 | },
|
| 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 | + }, |
2363 | 2439 | "Topic": {
|
2364 | 2440 | "description": "A topic resource.",
|
2365 | 2441 | "id": "Topic",
|
|
0 commit comments