---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# gcp_pubsub_subscription{% #gcp_pubsub_subscription %}

## `ack_deadline_seconds`{% #ack_deadline_seconds %}

**Type**: `INT32`**Provider name**: `ackDeadlineSeconds`**Description**: 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.

## `analytics_hub_subscription_info`{% #analytics_hub_subscription_info %}

**Type**: `STRUCT`**Provider name**: `analyticsHubSubscriptionInfo`**Description**: Output only. Information about the associated Analytics Hub subscription. Only set if the subscritpion is created by Analytics Hub.

- `listing`**Type**: `STRING`**Provider name**: `listing`**Description**: Optional. The name of the associated Analytics Hub listing resource. Pattern: "projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}"
- `subscription`**Type**: `STRING`**Provider name**: `subscription`**Description**: Optional. The name of the associated Analytics Hub subscription resource. Pattern: "projects/{project}/locations/{location}/subscriptions/{subscription}"

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `bigquery_config`{% #bigquery_config %}

**Type**: `STRUCT`**Provider name**: `bigqueryConfig`**Description**: Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.

- `drop_unknown_fields`**Type**: `BOOLEAN`**Provider name**: `dropUnknownFields`**Description**: 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.
- `service_account_email`**Type**: `STRING`**Provider name**: `serviceAccountEmail`**Description**: 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](https://cloud.google.com/iam/docs/service-agents), [service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com](mailto:service-%7bproject_number%7d@gcp-sa-pubsub.iam.gserviceaccount.com), is used.
- `state`**Type**: `STRING`**Provider name**: `state`**Description**: Output only. An output-only field that indicates whether or not the subscription can receive messages.**Possible values**:
  - `STATE_UNSPECIFIED` - Default value. This value is unused.
  - `ACTIVE` - The subscription can actively send messages to BigQuery
  - `PERMISSION_DENIED` - 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](https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account) - bigquery.googleapis.com API is not enabled for the project ([instructions](https://cloud.google.com/service-usage/docs/enable-disable))
  - `NOT_FOUND` - Cannot write to the BigQuery table because it does not exist.
  - `SCHEMA_MISMATCH` - Cannot write to the BigQuery table due to a schema mismatch.
  - `IN_TRANSIT_LOCATION_RESTRICTION` - Cannot write to the destination because enforce_in_transit is set to true and the destination locations are not in the allowed regions.
- `table`**Type**: `STRING`**Provider name**: `table`**Description**: Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
- `use_table_schema`**Type**: `BOOLEAN`**Provider name**: `useTableSchema`**Description**: 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.
- `use_topic_schema`**Type**: `BOOLEAN`**Provider name**: `useTopicSchema`**Description**: 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.
- `write_metadata`**Type**: `BOOLEAN`**Provider name**: `writeMetadata`**Description**: 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.

## `cloud_storage_config`{% #cloud_storage_config %}

**Type**: `STRUCT`**Provider name**: `cloudStorageConfig`**Description**: Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.

- `avro_config`**Type**: `STRUCT`**Provider name**: `avroConfig`**Description**: Optional. If set, message data will be written to Cloud Storage in Avro format.
  - `use_topic_schema`**Type**: `BOOLEAN`**Provider name**: `useTopicSchema`**Description**: Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.
  - `write_metadata`**Type**: `BOOLEAN`**Provider name**: `writeMetadata`**Description**: 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.
- `bucket`**Type**: `STRING`**Provider name**: `bucket`**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)](https://cloud.google.com/storage/docs/buckets#naming%29).
- `filename_datetime_format`**Type**: `STRING`**Provider name**: `filenameDatetimeFormat`**Description**: Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the [datetime format guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).
- `filename_prefix`**Type**: `STRING`**Provider name**: `filenamePrefix`**Description**: Optional. User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming).
- `filename_suffix`**Type**: `STRING`**Provider name**: `filenameSuffix`**Description**: Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in "/".
- `max_bytes`**Type**: `INT64`**Provider name**: `maxBytes`**Description**: 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.
- `max_duration`**Type**: `STRING`**Provider name**: `maxDuration`**Description**: 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.
- `max_messages`**Type**: `INT64`**Provider name**: `maxMessages`**Description**: Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
- `service_account_email`**Type**: `STRING`**Provider name**: `serviceAccountEmail`**Description**: 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](https://cloud.google.com/iam/docs/service-agents), [service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com](mailto:service-%7bproject_number%7d@gcp-sa-pubsub.iam.gserviceaccount.com), is used.
- `state`**Type**: `STRING`**Provider name**: `state`**Description**: Output only. An output-only field that indicates whether or not the subscription can receive messages.**Possible values**:
  - `STATE_UNSPECIFIED` - Default value. This value is unused.
  - `ACTIVE` - The subscription can actively send messages to Cloud Storage.
  - `PERMISSION_DENIED` - Cannot write to the Cloud Storage bucket because of permission denied errors.
  - `NOT_FOUND` - Cannot write to the Cloud Storage bucket because it does not exist.
  - `IN_TRANSIT_LOCATION_RESTRICTION` - Cannot write to the destination because enforce_in_transit is set to true and the destination locations are not in the allowed regions.
  - `SCHEMA_MISMATCH` - Cannot write to the Cloud Storage bucket due to an incompatibility between the topic schema and subscription settings.
- `text_config`**Type**: `STRUCT`**Provider name**: `textConfig`**Description**: Optional. If set, message data will be written to Cloud Storage in text format.

## `dead_letter_policy`{% #dead_letter_policy %}

**Type**: `STRUCT`**Provider name**: `deadLetterPolicy`**Description**: 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](mailto:service-%7bproject_number%7d@gcp-sa-pubsub.iam.gserviceaccount.com)) must have permission to Acknowledge() messages on this subscription.

- `dead_letter_topic`**Type**: `STRING`**Provider name**: `deadLetterTopic`**Description**: 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](mailto:service-%7bproject_number%7d@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.
- `max_delivery_attempts`**Type**: `INT32`**Provider name**: `maxDeliveryAttempts`**Description**: 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.

## `detached`{% #detached %}

**Type**: `BOOLEAN`**Provider name**: `detached`**Description**: 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.

## `enable_exactly_once_delivery`{% #enable_exactly_once_delivery %}

**Type**: `BOOLEAN`**Provider name**: `enableExactlyOnceDelivery`**Description**: 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.

## `enable_message_ordering`{% #enable_message_ordering %}

**Type**: `BOOLEAN`**Provider name**: `enableMessageOrdering`**Description**: 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.

## `expiration_policy`{% #expiration_policy %}

**Type**: `STRUCT`**Provider name**: `expirationPolicy`**Description**: 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.

- `ttl`**Type**: `STRING`**Provider name**: `ttl`**Description**: 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.

## `filter`{% #filter %}

**Type**: `STRING`**Provider name**: `filter`**Description**: Optional. An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `message_retention_duration`{% #message_retention_duration %}

**Type**: `STRING`**Provider name**: `messageRetentionDuration`**Description**: 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.

## `message_transforms`{% #message_transforms %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `messageTransforms`**Description**: Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.

- `enabled`**Type**: `BOOLEAN`**Provider name**: `enabled`**Description**: Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`.
- `javascript_udf`**Type**: `STRUCT`**Provider name**: `javascriptUdf`**Description**: Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
  - `code`**Type**: `STRING`**Provider name**: `code`**Description**: Required. JavaScript code that contains a function `function_name` with the below signature: `/** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { }`
  - `function_name`**Type**: `STRING`**Provider name**: `functionName`**Description**: Required. Name of the JavasScript function that should applied to Pub/Sub messages.

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: 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"`.

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `push_config`{% #push_config %}

**Type**: `STRUCT`**Provider name**: `pushConfig`**Description**: Optional. If push delivery is used with this subscription, this field is used to configure it.

- `no_wrapper`**Type**: `STRUCT`**Provider name**: `noWrapper`**Description**: Optional. When set, the payload to the push endpoint is not wrapped.

  - `write_metadata`**Type**: `BOOLEAN`**Provider name**: `writeMetadata`**Description**: Optional. When true, writes the Pub/Sub message metadata to `x-goog-pubsub-:` headers of the HTTP request. Writes the Pub/Sub message attributes to `:` headers of the HTTP request.

- `oidc_token`**Type**: `STRUCT`**Provider name**: `oidcToken`**Description**: 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.

  - `audience`**Type**: `STRING`**Provider name**: `audience`**Description**: 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](https://tools.ietf.org/html/rfc7519#section-4.1.3) Note: if not specified, the Push endpoint URL will be used.
  - `service_account_email`**Type**: `STRING`**Provider name**: `serviceAccountEmail`**Description**: Optional. [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).

- `pubsub_wrapper`**Type**: `STRUCT`**Provider name**: `pubsubWrapper`**Description**: 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)](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage%29).

- `push_endpoint`**Type**: `STRING`**Provider name**: `pushEndpoint`**Description**: Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use `https://example.com/push`.

## `region_id`{% #region_id %}

**Type**: `STRING`

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `retain_acked_messages`{% #retain_acked_messages %}

**Type**: `BOOLEAN`**Provider name**: `retainAckedMessages`**Description**: 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](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time)) in the past to replay previously-acknowledged messages.

## `retry_policy`{% #retry_policy %}

**Type**: `STRUCT`**Provider name**: `retryPolicy`**Description**: 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.

- `maximum_backoff`**Type**: `STRING`**Provider name**: `maximumBackoff`**Description**: Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
- `minimum_backoff`**Type**: `STRING`**Provider name**: `minimumBackoff`**Description**: Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.

## `state`{% #state %}

**Type**: `STRING`**Provider name**: `state`**Description**: Output only. An output-only field indicating whether or not the subscription can receive messages.**Possible values**:

- `STATE_UNSPECIFIED` - Default value. This value is unused.
- `ACTIVE` - The subscription can actively receive messages
- `RESOURCE_ERROR` - 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.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `topic`{% #topic %}

**Type**: `STRING`**Provider name**: `topic`**Description**: 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.

## `topic_message_retention_duration`{% #topic_message_retention_duration %}

**Type**: `STRING`**Provider name**: `topicMessageRetentionDuration`**Description**: 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.

## `zone_id`{% #zone_id %}

**Type**: `STRING`