Optional. Successfully processed acknowledgment IDs.

Optional. List of acknowledgment IDs that were malformed or whose acknowledgment deadline has expired.

Optional. List of acknowledgment IDs that were out of order.

Optional. List of acknowledgment IDs that failed processing with temporary issues.

Required. The subscription whose message is being acknowledged. Format is projects/{project}/subscriptions/{sub}.

Required. The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the Pull response. Must not be empty.

Optional. The name of the associated Analytics Hub listing resource. Pattern: "projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}"

Optional. The name of the associated Analytics Hub subscription resource. Pattern: "projects/{project}/locations/{location}/subscriptions/{subscription}"

Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.

Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.

Output only. An output-only field that indicates the state of the Kinesis ingestion source.

Required. The Kinesis stream ARN to ingest data from.

Required. The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode. The consumer must be already created and ready to be used.

Required. AWS role ARN to be used for Federated Identity authentication with Kinesis. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.

Required. The GCP service account to be used for Federated Identity authentication with Kinesis (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.

Optional. The stream ARN of the Kinesis stream being ingested from.

Optional. The partition key of the message that failed to be ingested.

Optional. The sequence number of the message that failed to be ingested.

Optional. The Pub/Sub message failed schema validation.

Optional. Failure encountered when applying a message transformation to the Pub/Sub message.

Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.

Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.

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.

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.

Optional. The ARN of the cluster of the topic being ingested from.

Optional. The name of the Kafka topic being ingested from.

Optional. The partition ID of the message that failed to be ingested.

Optional. The offset within the partition of the message that failed to be ingested.

Optional. The Pub/Sub API limits prevented the desired message from being published.

Optional. The Pub/Sub message failed schema validation.

Optional. Failure encountered when applying a message transformation to the Pub/Sub message.

Output only. An output-only field that indicates the state of the Event Hubs ingestion source.

Optional. Name of the resource group within the azure subscription.

Optional. The name of the Event Hubs namespace.

Optional. The name of the Event Hub.

Optional. The client id of the Azure application that is being used to authenticate Pub/Sub.

Optional. The tenant id of the Azure application that is being used to authenticate Pub/Sub.

Optional. The Azure subscription id.

Optional. The GCP service account to be used for Federated Identity authentication.

Optional. The namespace containing the event hub being ingested from.

Optional. The name of the event hub being ingested from.

Optional. The partition ID of the message that failed to be ingested.

Optional. The offset within the partition of the message that failed to be ingested.

Optional. The Pub/Sub API limits prevented the desired message from being published.

Optional. The Pub/Sub message failed schema validation.

Optional. Failure encountered when applying a message transformation to the Pub/Sub message.

Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}

Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. use_topic_schema and use_table_schema cannot be enabled at the same time.

Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time 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.

Optional. When true and use_topic_schema 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.

Output only. An output-only field that indicates whether or not the subscription can receive messages.

Optional. When true, use the BigQuery table's schema as the columns to write to in BigQuery. use_table_schema and use_topic_schema cannot be enabled at the same time.

Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

Output only. An output-only field that indicates the state of the Cloud Storage ingestion source.

Optional. Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).

Optional. Only objects with a larger or equal creation timestamp will be ingested.

Optional. Glob pattern used to match objects that will be ingested. If unset, all objects will be ingested. See the supported patterns.

Optional. Data from Cloud Storage will be interpreted as text.

Optional. Data from Cloud Storage will be interpreted in Avro format.

Optional. It will be assumed data from Cloud Storage was written via Cloud Storage subscriptions.

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).

Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.

Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".

Optional. 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 acknowledgment deadline.

Optional. 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.

Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.

Output only. An output-only field that indicates whether or not the subscription can receive messages.

Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.

Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

Optional. If set, message data will be written to Cloud Storage in text format.

Optional. If set, message data will be written to Cloud Storage in Avro format.

Optional. Name of the Cloud Storage bucket used for ingestion.

Optional. Name of the Cloud Storage object which contained the section that couldn't be ingested.

Optional. Generation of the Cloud Storage object which contained the section that couldn't be ingested.

Optional. Failure encountered when parsing an Avro file.

Optional. The Pub/Sub API limits prevented the desired message from being published.

Optional. The Pub/Sub message failed schema validation.

Optional. Failure encountered when applying a message transformation to the Pub/Sub message.

Required. The name of the schema we are revising. Format is projects/{project}/schemas/{schema}.

Required. The schema revision to commit.

Output only. An output-only field that indicates the state of the Confluent Cloud ingestion source.

Required. The address of the bootstrap server. The format is url:port.

Required. The id of the cluster.

Required. The name of the topic in the Confluent Cloud cluster that Pub/Sub will import from.

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.

Required. The GCP service account to be used for Federated Identity authentication with identity_pool_id.

Optional. The cluster ID containing the topic being ingested from.

Optional. The name of the Kafka topic being ingested from.

Optional. The partition ID of the message that failed to be ingested.

Optional. The offset within the partition of the message that failed to be ingested.

Optional. The Pub/Sub API limits prevented the desired message from being published.

Optional. The Pub/Sub message failed schema validation.

Optional. Failure encountered when applying a message transformation to the Pub/Sub message.

Required. The name of the project in which to create the schema. Format is projects/{project-id}.

Required. The schema object to create.

This schema's name parameter is ignored. The schema object returned by CreateSchema will have a name made using the given parent and schema_id.

The ID to use for the schema, which will become the final component of the schema's resource name.

See https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names for resource name constraints.

Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is projects/{project}/snapshots/{snap}.

Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the CreateSnapshot request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is projects/{project}/subscriptions/{sub}.

Optional. See Creating and managing labels.

Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic.

The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.

Optional. 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 acknowledgment 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.

Required. Name of the schema to delete. Format is projects/{project}/schemas/{schema}.

Required. The name of the schema revision to be deleted, with a revision ID explicitly included.

Example: projects/123/schemas/my-schema@c7cfa2a8

Optional. This field is deprecated and should not be used for specifying the revision ID. The revision ID should be specified via the name parameter.

Required. The name of the snapshot to delete. Format is projects/{project}/snapshots/{snap}.

Required. The subscription to delete. Format is projects/{project}/subscriptions/{sub}.

Required. Name of the topic to delete. Format is projects/{project}/topics/{topic}.

Required. The subscription to detach. Format is projects/{project}/subscriptions/{subscription}.

Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.

Required. The name of the schema to get. Format is projects/{project}/schemas/{schema}.

The set of fields to return in the response. If not set, returns a Schema with all fields filled out. Set to BASIC to omit the definition.

Required. The name of the snapshot to get. Format is projects/{project}/snapshots/{snap}.

Required. The name of the subscription to get. Format is projects/{project}/subscriptions/{sub}.

Required. The name of the topic to get. Format is projects/{project}/topics/{topic}.

Optional. Platform Logs settings. If unset, no Platform Logs will be generated.

Optional. Amazon Kinesis Data Streams.

Optional. Cloud Storage.

Optional. Azure Event Hubs.

Optional. Amazon MSK.

Optional. Confluent Cloud.

Required. Name of the import topic. Format is: projects/{project_name}/topics/{topic_name}.

Required. Error details explaining why ingestion to Pub/Sub has failed.

Optional. Failure when ingesting from Cloud Storage.

Optional. Failure when ingesting from Amazon MSK.

Optional. Failure when ingesting from Azure Event Hubs.

Optional. Failure when ingesting from Confluent Cloud.

Optional. Failure when ingesting from AWS Kinesis.

Required. Name of the JavasScript function that should applied to Pub/Sub messages.

Required. JavaScript code that contains a function function_name with the below signature:

  /**
  * Transforms a Pub/Sub message.

  * @return {(Object<string, (string | Object<string, string>)>|null)} - To
  * filter a message, return `null`. To transform a message return a map
  * with the following keys:
  *   - (required) 'data' : {string}
  *   - (optional) 'attributes' : {Object<string, string>}
  * Returning empty `attributes` will remove all attributes from the
  * message.
  *
  * @param  {(Object<string, (string | Object<string, string>)>} Pub/Sub
  * message. Keys:
  *   - (required) 'data' : {string}
  *   - (required) 'attributes' : {Object<string, string>}
  *
  * @param  {Object<string, any>} metadata - Pub/Sub message metadata.
  * Keys:
  *   - (optional) 'message_id'  : {string}
  *   - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format
  *   - (optional) 'ordering_key': {string}
  */

  function <function_name>(message, metadata) {
  }

Required. The name of the schema to list revisions for.

The set of Schema fields to return in the response. If not set, returns Schemas with name and type, but not definition. Set to FULL to retrieve all fields.

The maximum number of revisions to return per page.

The page token, received from a previous ListSchemaRevisions call. Provide this to retrieve the subsequent page.

The revisions of the schema.

A token that can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

Required. The name of the project in which to list schemas. Format is projects/{project-id}.

The set of Schema fields to return in the response. If not set, returns Schemas with name and type, but not definition. Set to FULL to retrieve all fields.

Maximum number of schemas to return.

The value returned by the last ListSchemasResponse; indicates that this is a continuation of a prior ListSchemas call, and that the system should return the next page of data.

The resulting schemas.

If not empty, indicates that there may be more schemas that match the request; this value should be passed in a new ListSchemasRequest.

Required. The name of the project in which to list snapshots. Format is projects/{project-id}.

Optional. Maximum number of snapshots to return.

Optional. The value returned by the last ListSnapshotsResponse; indicates that this is a continuation of a prior ListSnapshots call, and that the system should return the next page of data.

Optional. The resulting snapshots.

Optional. If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new ListSnapshotsRequest.

Required. The name of the project in which to list subscriptions. Format is projects/{project-id}.

Optional. Maximum number of subscriptions to return.

Optional. The value returned by the last ListSubscriptionsResponse; indicates that this is a continuation of a prior ListSubscriptions call, and that the system should return the next page of data.

Optional. The subscriptions that match the request.

Optional. If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new ListSubscriptionsRequest to get more subscriptions.

Required. The name of the topic that snapshots are attached to. Format is projects/{project}/topics/{topic}.

Optional. Maximum number of snapshot names to return.

Optional. The value returned by the last ListTopicSnapshotsResponse; indicates that this is a continuation of a prior ListTopicSnapshots call, and that the system should return the next page of data.

Optional. The names of the snapshots that match the request.

Optional. If not empty, indicates that there may be more snapshots that match the request; this value should be passed in a new ListTopicSnapshotsRequest to get more snapshots.

Required. The name of the topic that subscriptions are attached to. Format is projects/{project}/topics/{topic}.

Optional. Maximum number of subscription names to return.

Optional. The value returned by the last ListTopicSubscriptionsResponse; indicates that this is a continuation of a prior ListTopicSubscriptions call, and that the system should return the next page of data.

Optional. The names of subscriptions attached to the topic specified in the request.

Optional. If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new ListTopicSubscriptionsRequest to get more subscriptions.

Required. The name of the project in which to list topics. Format is projects/{project-id}.

Optional. Maximum number of topics to return.

Optional. The value returned by the last ListTopicsResponse; indicates that this is a continuation of a prior ListTopics call, and that the system should return the next page of data.

Optional. The resulting topics.

Optional. If not empty, indicates that there may be more topics that match the request; this value should be passed in a new ListTopicsRequest.

Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.

Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.

Optional. This field is deprecated, use the disabled field to disable transforms.

Optional. If true, the transform is disabled and will not be applied to messages. Defaults to false.

Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique function_name.

Optional. Successfully processed acknowledgment IDs.

Optional. List of acknowledgment IDs that were malformed or whose acknowledgment deadline has expired.

Optional. List of acknowledgment IDs that failed processing with temporary issues.

Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.

Required. The new ack deadline with respect to the time this request was sent to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10 seconds after the ModifyAckDeadline call was made. Specifying zero might immediately make the message available for delivery to another subscriber client. This typically results in an increase in the rate of message redeliveries (that is, duplicates). The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify in a single request is 600 seconds (10 minutes).

Required. List of acknowledgment IDs.

Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.

Required. The push configuration for future deliveries.

An empty pushConfig indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if Pull or StreamingPull is not called.

Optional. When true, writes the Pub/Sub message metadata to x-goog-pubsub-<KEY>:<VAL> headers of the HTTP request. Writes the Pub/Sub message attributes to <KEY>:<VAL> headers of the HTTP request.

Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.

Optional. 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.

Optional. The minimum severity level of Platform Logs that will be written.

Required. The messages in the request will be published on this topic. Format is projects/{project}/topics/{topic}.

Required. The messages to publish.

Optional. The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.

Optional. The message data field. If this field is empty, the message must contain at least one attribute.

Optional. Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.

ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by the publisher in a Publish call.

The time at which the message was published, populated by the server when it receives the Publish call. It must not be populated by the publisher in a Publish call.

Optional. If non-empty, identifies related messages for which publish order should be respected. If a Subscription has enable_message_ordering set to true, messages published with the same non-empty ordering_key value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All PubsubMessages published in a given PublishRequest must specify the same ordering_key value. For more information, see ordering messages.

Required. The subscription from which messages should be pulled. Format is projects/{project}/subscriptions/{sub}.

Optional. If this field set to true, the system will respond immediately even if it there are no messages available to return in the Pull response. Otherwise, the system may wait (for a bounded amount of time) until at least one message is available, rather than returning no messages. Warning: setting this field to true is discouraged because it adversely impacts the performance of Pull operations. We recommend that users do not set this field.

Required. The maximum number of messages to return for this request. Must be a positive integer. The Pub/Sub system may return fewer than the number specified.

Optional. Received Pub/Sub messages. The list will be empty if there are no more messages available in the backlog, or if no messages could be returned before the request timeout. For JSON, the response can be entirely empty. The Pub/Sub system may return fewer than the maxMessages requested even if there are more messages available in the backlog.

Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.

Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery.

The only 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).

If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute.

The only supported values for the x-goog-version 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.

For example: attributes { "x-goog-version": "v1" }

Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).

Optional. When set, the payload to the push endpoint is not wrapped.

Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.

Optional. This ID can be used to acknowledge the received message.

Optional. The message.

Optional. The approximate number of times that Pub/Sub has attempted to deliver the associated message to a subscriber.

More precisely, this is 1 + (number of NACKs) + (number of ack_deadline exceeds) for this message.

A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library.

Upon the first delivery of a given message, delivery_attempt will have a value of 1. The value is calculated at best effort and is approximate.

If a DeadLetterPolicy is not set on the subscription, this will be 0.

Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.

Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.

Required. The schema being rolled back with revision id.

Required. The revision ID to roll back to. It must be a revision of the same schema.

Example: c7cfa2a8

Required. Name of the schema. Format is projects/{project}/schemas/{schema}.

The type of the schema definition.

The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in type.

Output only. Immutable. The revision ID of the schema.

Output only. The timestamp that the revision was created.

Required. The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be _deleted-schema_ if the schema has been deleted.

Optional. The encoding of messages validated against schema.

Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.

Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.

Required. The subscription to affect.

Optional. The time to seek to. Messages retained in the subscription that were published before this time are marked as acknowledged, and messages retained in the subscription that were published after this time are marked as unacknowledged. Note that this operation affects only those messages retained in the subscription (configured by the combination of message_retention_duration and retain_acked_messages). For example, if time corresponds to a point before the message retention window (or to a point before the system's notion of the subscription creation time), only retained messages will be marked as unacknowledged, and already-expunged messages will not be restored.

Optional. The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription. Format is projects/{project}/snapshots/{snap}.

Optional. The name of the snapshot.

Optional. The name of the topic from which this snapshot is retaining messages.

Optional. The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is 7 days - (age of oldest unacked message in the subscription). For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.

Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).

Required. The subscription for which to initialize the new stream. This must be provided in the first request on the stream, and must not be set in subsequent requests from client to server. Format is projects/{project}/subscriptions/{sub}.

Optional. List of acknowledgment IDs for acknowledging previously received messages (received on this stream or a different stream). If an ack ID has expired, the corresponding message may be redelivered later. Acknowledging a message more than once will not result in an error. If the acknowledgment ID is malformed, the stream will be aborted with status INVALID_ARGUMENT.

Optional. The list of new ack deadlines for the IDs listed in modify_deadline_ack_ids. The size of this list must be the same as the size of modify_deadline_ack_ids. If it differs the stream will be aborted with INVALID_ARGUMENT. Each element in this list is applied to the element in the same position in modify_deadline_ack_ids. The new ack deadline is with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after this request is received. If the value is 0, the message is immediately made available for another streaming or non-streaming pull request. If the value is < 0 (an error), the stream will be aborted with status INVALID_ARGUMENT.

Optional. List of acknowledgment IDs whose deadline will be modified based on the corresponding element in modify_deadline_seconds. This field can be used to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted.

Required. The ack deadline to use for the stream. This must be provided in the first request on the stream, but it can also be updated on subsequent requests from client to server. The minimum deadline you can specify is 10 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).

Optional. A unique identifier that is used to distinguish client instances from each other. Only needs to be provided on the initial request. When a stream disconnects and reconnects for the same stream, the client_id should be set to the same value so that state associated with the old stream can be transferred to the new stream. The same client_id should not be used for different client instances.

Optional. Flow control settings for the maximum number of outstanding messages. When there are max_outstanding_messages currently sent to the streaming pull client that have not yet been acked or nacked, the server stops sending more messages. The sending of messages resumes once the number of outstanding messages is less than this value. If the value is <= 0, there is no limit to the number of outstanding messages. This property can only be set on the initial StreamingPullRequest. If it is set on a subsequent request, the stream will be aborted with status INVALID_ARGUMENT.

Optional. Flow control settings for the maximum number of outstanding bytes. When there are max_outstanding_bytes or more worth of messages currently sent to the streaming pull client that have not yet been acked or nacked, the server will stop sending more messages. The sending of messages resumes once the number of outstanding bytes is less than this value. If the value is <= 0, there is no limit to the number of outstanding bytes. This property can only be set on the initial StreamingPullRequest. If it is set on a subsequent request, the stream will be aborted with status INVALID_ARGUMENT.

Optional. Received Pub/Sub messages. This will not be empty.

Optional. This field will only be set if enable_exactly_once_delivery is set to true and is not guaranteed to be populated.

Optional. Properties associated with this subscription.

Optional. This field will only be set if enable_exactly_once_delivery is set to true and is not guaranteed to be populated.

Required. The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}". {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".

Required. The name of the topic from which this subscription is receiving messages. Format is projects/{project}/topics/{topic}. The value of this field will be _deleted-topic_ if the topic has been deleted.

Optional. If push delivery is used with this subscription, this field is used to configure it.

Optional. The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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 ModifyAckDeadline with the corresponding ack_id if using non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming 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.

Optional. 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 message_retention_duration window. This must be true if you would like to [Seek to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.

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.

Optional. See Creating and managing labels.

Optional. If true, messages published with the same ordering_key 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.

Optional. 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 expiration_policy is not set, a default policy with ttl of 31 days will be used. The minimum allowed value for expiration_policy.ttl is 1 day. If expiration_policy is set, but expiration_policy.ttl is not set, the subscription never expires.

Optional. An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.

Optional. 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 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.

Optional. 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 acknowledgment deadline exceeded events for a given message.

Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.

Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of message_id on this subscription:

• The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgment 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 message_id values.

Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last topic_message_retention_duration are always available to subscribers. See the message_retention_duration field in Topic. This field is set only in responses from the server; it is ignored if it is set in any requests.

Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.

Output only. An output-only field indicating whether or not the subscription can receive messages.

Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.

Output only. Information about the associated Analytics Hub subscription. Only set if the subscritpion is created by Analytics Hub.

Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.

Optional. True iff exactly once delivery is enabled for this subscription.

Optional. True iff message ordering is enabled for this subscription.

Optional. When unset, '\n' is used.

Required. The name of the topic. It must have the format "projects/{project}/topics/{topic}". {topic} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".

Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).

Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.

Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.

The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

Optional. Settings for validating messages published against a schema.

Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.

Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last message_retention_duration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to message_retention_duration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.

Output only. An output-only field indicating the state of the topic.

Optional. Settings for ingestion from a data source into this topic.

Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified.

Required. The updated snapshot object.

Required. Indicates which fields in the provided snapshot to update. Must be specified and non-empty.

Required. The updated subscription object.

Required. Indicates which fields in the provided subscription to update. Must be specified and non-empty.

Required. The updated topic object.

Required. Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if update_mask contains "message_storage_policy" but the message_storage_policy is not set in the topic provided above, then the updated value is determined by the policy configured at the project or organization level.

Required. The name of the project in which to validate schemas. Format is projects/{project-id}.

Message to validate against the provided schema_spec.

The encoding expected for messages

Name of the schema against which to validate.

Format is projects/{project}/schemas/{schema}.

Ad-hoc schema against which to validate

Required. The name of the project in which to validate schemas. Format is projects/{project-id}.

Required. The schema object to validate.

Unspecified

JSON encoding

Binary encoding, as defined by the schema type. For some schema types, binary encoding may not be available.

The default / unset value. The API will default to the BASIC view.

Include the name and type of the schema, but not the definition.

Include all Schema object fields.

Default value. Logs level is unspecified. Logs will be disabled.

Logs will be disabled.

Debug logs and higher-severity logs will be written.

Info logs and higher-severity logs will be written.

Warning logs and higher-severity logs will be written.

Only error logs will be written.

Default value. This value is unused.

Ingestion is active.

Permission denied encountered while consuming data from Kinesis. This can happen if: - The provided aws_role_arn does not exist or does not have the appropriate permissions attached. - The provided aws_role_arn is not set up properly for Identity Federation using gcp_service_account. - The Pub/Sub SA is not granted the iam.serviceAccounts.getOpenIdToken permission on gcp_service_account.

Permission denied encountered while publishing to the topic. This can happen if the Pub/Sub SA has not been granted the appropriate publish permissions

The Kinesis stream does not exist.

The Kinesis consumer does not exist.

Default value. This value is unused.

Ingestion is active.

Permission denied encountered while calling the Cloud Storage API. This can happen if the Pub/Sub SA has not been granted the appropriate permissions: - storage.objects.list: to list the objects in a bucket. - storage.objects.get: to read the objects in a bucket. - storage.buckets.get: to verify the bucket exists.

Permission denied encountered while publishing to the topic. This can happen if the Pub/Sub SA has not been granted the appropriate publish permissions

The provided Cloud Storage bucket doesn't exist.

The Cloud Storage bucket has too many objects, ingestion will be paused.

Default value. This value is unused.

Ingestion is active.

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.

Permission denied encountered while publishing to the topic.

The provided Event Hubs namespace couldn't be found.

The provided Event Hub couldn't be found.

The provided Event Hubs subscription couldn't be found.

The provided Event Hubs resource group couldn't be found.

Default value. This value is unused.

Ingestion is active.

Permission denied encountered while consuming data from Amazon MSK.

Permission denied encountered while publishing to the topic.

The provided MSK cluster wasn't found.

The provided topic wasn't found.

Default value. This value is unused.

Ingestion is active.

Permission denied encountered while consuming data from Confluent Cloud.

Permission denied encountered while publishing to the topic.

The provided bootstrap server address is unreachable.

The provided cluster wasn't found.

The provided topic wasn't found.

Default value. This value is unused.

The topic does not have any persistent errors.

Ingestion from the data source has encountered a permanent error. See the more detailed error state in the corresponding ingestion source configuration.

Default value. This value is unused.

The subscription can actively receive messages

The subscription cannot receive messages because of an error with the resource to which it pushes messages. See the more detailed error state in the corresponding configuration.

Default value. This value is unused.

The subscription can actively send messages to BigQuery

Cannot write to the BigQuery table because of permission denied errors. This can happen if - Pub/Sub SA has not been granted the appropriate BigQuery IAM permissions - bigquery.googleapis.com API is not enabled for the project (instructions)

Cannot write to the BigQuery table because it does not exist.

Cannot write to the BigQuery table due to a schema mismatch.

Cannot write to the destination because enforce_in_transit is set to true and the destination locations are not in the allowed regions.

Default value. This value is unused.

The subscription can actively send messages to Cloud Storage.

Cannot write to the Cloud Storage bucket because of permission denied errors.

Cannot write to the Cloud Storage bucket because it does not exist.

Cannot write to the destination because enforce_in_transit is set to true and the destination locations are not in the allowed regions.

Cannot write to the Cloud Storage bucket due to an incompatibility between the topic schema and subscription settings.

Default value. This value is unused.

A Protocol Buffer schema definition.

An Avro schema definition.