# Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. fullname: - spec shortname: spec description: "" type: object requirementlevel: Required children: - fullname: - spec - ackDeadlineSeconds shortname: ackDeadlineSeconds description: |- This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call subscriptions.modifyAckDeadline with the corresponding ackId if using pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. type: integer requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - bigqueryConfig shortname: bigqueryConfig description: |- If delivery to BigQuery is used with this subscription, this field is used to configure it. Either pushConfig or bigQueryConfig can be set, but not both. If both are empty, then the subscriber will pull and ack messages using API methods. type: object requirementlevel: Optional children: - fullname: - spec - bigqueryConfig - dropUnknownFields shortname: dropUnknownFields description: |- When true and useTopicSchema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. type: boolean requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - bigqueryConfig - tableRef shortname: tableRef description: The name of the table to which to write data. type: object requirementlevel: RequiredWhenParentPresent children: - fullname: - spec - bigqueryConfig - tableRef - external shortname: external description: 'Allowed value: string of the format `{{project}}.{{dataset_id}}.{{value}}`, where {{value}} is the `name` field of a `BigQueryTable` resource.' type: string requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - bigqueryConfig - tableRef - name shortname: name description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' type: string requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - bigqueryConfig - tableRef - namespace shortname: namespace description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/' type: string requirementlevel: Optional children: [] additionalproperties: [] additionalproperties: [] - fullname: - spec - bigqueryConfig - useTopicSchema shortname: useTopicSchema description: When true, use the topic's schema as the columns to write to in BigQuery, if it exists. type: boolean requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - bigqueryConfig - writeMetadata shortname: writeMetadata description: |- When true, write the subscription name, messageId, publishTime, attributes, and orderingKey to additional columns in the table. The subscription name, messageId, and publishTime fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column. type: boolean requirementlevel: Optional children: [] additionalproperties: [] additionalproperties: [] - fullname: - spec - deadLetterPolicy shortname: deadLetterPolicy 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 subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. type: object requirementlevel: Optional children: - fullname: - spec - deadLetterPolicy - deadLetterTopicRef shortname: deadLetterTopicRef description: "" type: object requirementlevel: Optional children: - fullname: - spec - deadLetterPolicy - deadLetterTopicRef - external shortname: external description: 'Allowed value: string of the format `projects/{{project}}/topics/{{value}}`, where {{value}} is the `name` field of a `PubSubTopic` resource.' type: string requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - deadLetterPolicy - deadLetterTopicRef - name shortname: name description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' type: string requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - deadLetterPolicy - deadLetterTopicRef - namespace shortname: namespace description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/' type: string requirementlevel: Optional children: [] additionalproperties: [] additionalproperties: [] - fullname: - spec - deadLetterPolicy - maxDeliveryAttempts shortname: maxDeliveryAttempts description: |- The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used. type: integer requirementlevel: Optional children: [] additionalproperties: [] additionalproperties: [] - fullname: - spec - enableExactlyOnceDelivery shortname: enableExactlyOnceDelivery description: |- If 'true', Pub/Sub provides the following guarantees for the delivery of a message with a given value of messageId on this Subscriptions': - The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. - An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when 'enable_exactly_once_delivery' is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct messageId values. type: boolean requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - enableMessageOrdering shortname: enableMessageOrdering description: |- Immutable. If 'true', messages published with the same orderingKey in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. type: boolean requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - expirationPolicy shortname: expirationPolicy description: |- A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expirationPolicy is not set, a default policy with ttl of 31 days will be used. If it is set but ttl is "", the resource never expires. The minimum allowed value for expirationPolicy.ttl is 1 day. type: object requirementlevel: Optional children: - fullname: - spec - expirationPolicy - ttl shortname: ttl description: |- Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. If ttl is set to "", the associated resource never expires. A duration in seconds with up to nine fractional digits, terminated by 's'. Example - "3.5s". type: string requirementlevel: RequiredWhenParentPresent children: [] additionalproperties: [] additionalproperties: [] - fullname: - spec - filter shortname: filter description: |- Immutable. The subscription only delivers the messages that match the filter. Pub/Sub automatically acknowledges the messages that don't match the filter. You can filter messages by their attributes. The maximum length of a filter is 256 bytes. After creating the subscription, you can't modify the filter. type: string requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - messageRetentionDuration shortname: messageRetentionDuration description: |- 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 subscriptions.seek can be done. Defaults to 7 days. Cannot be more than 7 days ('"604800s"') or less than 10 minutes ('"600s"'). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: '"600.5s"'. type: string requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - pushConfig shortname: pushConfig description: |- If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods. type: object requirementlevel: Optional children: - fullname: - spec - pushConfig - attributes shortname: attributes description: |- Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The 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). The endpoint version is based on the version of the Pub/Sub API. If not present during the subscriptions.create call, it will default to the version of the API used to make such call. If not present during a subscriptions.modifyPushConfig call, its value will not be changed. subscriptions.get calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this 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. type: 'map (key: string, value: string)' requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - pushConfig - oidcToken shortname: oidcToken description: |- If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message. type: object requirementlevel: Optional children: - fullname: - spec - pushConfig - oidcToken - audience shortname: audience 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. type: string requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - pushConfig - oidcToken - serviceAccountEmail shortname: serviceAccountEmail description: |- Service account email to be used for generating the OIDC token. The caller (for subscriptions.create, subscriptions.patch, and subscriptions.modifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account. type: string requirementlevel: RequiredWhenParentPresent children: [] additionalproperties: [] additionalproperties: [] - fullname: - spec - pushConfig - pushEndpoint shortname: pushEndpoint description: |- A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". type: string requirementlevel: RequiredWhenParentPresent children: [] additionalproperties: [] additionalproperties: [] - fullname: - spec - resourceID shortname: resourceID description: Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. type: string requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - retainAckedMessages shortname: retainAckedMessages description: |- Indicates whether to retain acknowledged messages. If 'true', then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the messageRetentionDuration window. type: boolean requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - retryPolicy shortname: retryPolicy description: |- A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. type: object requirementlevel: Optional children: - fullname: - spec - retryPolicy - maximumBackoff shortname: maximumBackoff description: |- The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". type: string requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - retryPolicy - minimumBackoff shortname: minimumBackoff description: |- The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". type: string requirementlevel: Optional children: [] additionalproperties: [] additionalproperties: [] - fullname: - spec - topicRef shortname: topicRef description: Reference to a PubSubTopic. type: object requirementlevel: Required children: - fullname: - spec - topicRef - external shortname: external description: 'Allowed value: string of the format `projects/{{project}}/topics/{{value}}`, where {{value}} is the `name` field of a `PubSubTopic` resource.' type: string requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - topicRef - name shortname: name description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' type: string requirementlevel: Optional children: [] additionalproperties: [] - fullname: - spec - topicRef - namespace shortname: namespace description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/' type: string requirementlevel: Optional children: [] additionalproperties: [] additionalproperties: [] additionalproperties: []